Skip to content

NIKU-SINGH/IngestFlow

Repository files navigation

IngestFlow

Alt text

  • Scalable & Fault-Tolerant Log Ingestion with IngestFlow: Harness Redpanda's Speed and Elasticsearch's Robust Search for Effortless Log Management

Contents

  1. Introduction
  2. Problem Statement
  3. Requirements
  4. Features Implemented
  5. Demo Video
  6. Solution Architecture
  7. Technologies Used
  8. Why this Architecture
  9. Benchmarking
  10. How it Can be Improved Further
  11. Commit Histories
  12. References Used
  13. Note of Thanks

🌐 Introduction

🤔 Problem Statement

Develop a log ingestor system that can efficiently handle vast volumes of log data, and offer a simple interface for querying this data using full-text search or specific field filters.

Both the systems (the log ingestor and the query interface) can be built using any programming language of your choice.

The logs should be ingested (in the log ingestor) over HTTP, on port 3000.

📝 Requirements

Log Ingestor:

  • Develop a mechanism to ingest logs in the provided format.
  • Ensure scalability to handle high volumes of logs efficiently.
  • Mitigate potential bottlenecks such as I/O operations, database write speeds, etc.
  • Make sure that the logs are ingested via an HTTP server, which runs on port 3000 by default.

Query Interface:

  • Offer a user interface (Web UI or CLI) for full-text search across logs.
  • Include filters based on:
    • level
    • message
    • resourceId
    • timestamp
    • traceId
    • spanId
    • commit
    • metadata.parentResourceId
  • Aim for efficient and quick search results.

⚙️ Features Implemented

  • Log Ingestor
  • Ability to send http response
  • Loadbalancing
  • Redpanda and Kafka support
  • Logstash integration
  • Elasticsearch support
  • PostgreSQL support
  • Query Interface

📹 Demo Video

https://www.loom.com/share/cd05ff3e9dbe4963afdff4dc5de35f0a

💡 Solution Proposed

🏛️ Proposed Architecture

Alt text

Alt text

💻 Technologies Used

Frontend

Technology Used Reason
ReactJS UI Development
Vite Fast Development
Tailwind CSS Styling Efficiency
Axios HTTP Requests

Backend

Technology Used Reason
Node.js Server-Side JavaScript and Backend Development
Express Minimalist Web Application Framework for Node.js
PostgreSQL Robust Relational Database Management System
Elasticsearch Distributed Search and Analytics Engine
Logstash Data Processing and Ingestion Tool for Elasticsearch
Pino Fast and Low Overhead Node.js Logger
Apache Kafka Distributed Streaming Platform for Real-Time Data
Docker Container Orchestration
NGINX Load Balancer and Web Server
Redpanda Modern Streaming Platform Built on Kafka

🏆 Why this Architecure

📊 Benchmarking

For testing a Node.js application to assess its performance and scalability some of the tools that I can use are

  1. Artillery
  2. K6

🔄 How it can be Improved Further

⚒️ Usage

Forking the Repository

To get started with this project, fork the repository by clicking on the "Fork" button in the upper right corner of the page.

Local Installation

  1. Clone the forked repository to your local machine.

    git clone https://github.com/dyte-submissions/november-2023-hiring-NIKU-SINGH.git
  2. Navigate to the project directory.

    cd november-2023-hiring-NIKU-SINGH
  3. Install dependencies.

    npm install

Docker Installation

  1. Ensure Docker is installed on your system. If not, download and install it from Docker's official website.

  2. Run the Docker Container

    docker compose up --build

Sending Requests with cURL

Once the project is running either locally or using Docker, you can interact with the endpoint using cURL commands.

Example: Sending a GET request to the endpoint to check health status

curl -X POST -H "Content-Type: application/json" -d '{"name": "Niku", "message": "Your app is lovely please Star and Fork it"}' http://localhost:3000

📖 References Used

🙏 Note of Thanks

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published