# shubnimkar/tracealyzer-log-parser architecture

> Architecture diagram of the GitHub repository shubnimkar/tracealyzer-log-parser, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shubnimkar/tracealyzer-log-parser
- Repository: https://github.com/shubnimkar/tracealyzer-log-parser

## Overview

##### Project Type and Purpose
- Full-stack web application (MERN) for universal log parsing, storage, querying, and visualization.
- Extensible “plugin” architecture for multiple log formats (Nginx, JSON, Syslog, Docker, Kernel).
- Dockerized deployment via Docker Compose, with MongoDB Atlas as the cloud datastore.

##### Main Components
A. Frontend Container
– React app (frontend/src) served via Nginx (frontend/nginx.conf).
– UI components: Upload, Logs Viewer, Stats, ThemeSwitcher.
– Context providers for FileContext and ThemeContext.
B. Reverse Proxy (optional)
C. Backend Container
– Node.js + Express server (backend/app.js).
– Routes (backend/routes/logRoutes.js) → Controllers (backend/controllers/logController.js) → Models (backend/models/Log.js).
– Parser subsystem (backend/parser/*.js), plus detectLogType utility (backend/utils/detectLogType.js).
– Uploads storage (backend/uploads/…) for temporary file storage.
D. Database
– MongoDB Atlas cluster (cloud).
E. Orchestration
– Docker Compose network linking frontend, backend, and any other services.

##### Relationships & Data Flows
- User in Browser → HTTP(s) → Frontend Container (React + Nginx)
- Frontend → REST API calls → Backend (Express)
– POST /upload → upload file → detectLogType → select appropriate parser → parse → construct Log document → save to MongoDB → respond with stored entries or a status code
- Backend → MongoDB Atlas (CRUD operations)

##### Architectural Patterns & Design Principles
- Modular Parser Architecture: each `apacheParser.js`, `jsonParser.js`, etc., implements a common interface. This is a plugin pattern.
- MVC-style segregation in the backend: Routes → Controllers → Models.
- Context API in React for global state (files, theme).
- Docker Compose for environment consistency and network isolation.

##### Relevant Technologies & Frameworks
- Frontend: React, Tailwind, Chart.js.
- Backend: Node.js, Express.
- Database: MongoDB Atlas (Mongoose implied by model files).
- Parsing Logic: Custom JS modules under `backend/parser`.
- Deployment: Docker, Docker Compose, Nginx (for static assets).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Docker Compose Orchestration
    subgraph "Docker Compose" 
        direction TB
        DC["docker-compose.yml"]:::external
        click DC "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/docker-compose.yml"
    end

    %% Frontend Layer
    subgraph "Frontend Container (React + Nginx)" 
        direction TB
        FN["frontend/Dockerfile"]:::frontend
        NG["nginx.conf"]:::frontend
        click FN "https://github.com/shubnimkar/tracealyzer-log-parser/tree/master/frontend/Dockerfile"
        click NG "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/nginx.conf"

        subgraph "React Application" 
            direction TB
            RA["App.js"]:::frontend
            RS["src"]:::frontend
            click RA "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/App.js"
            click RS "https://github.com/shubnimkar/tracealyzer-log-parser/tree/master/frontend/src"
            subgraph "UI Components"
                direction TB
                UPL["Upload.js"]:::frontend
                LOGC["Logs.js"]:::frontend
                STATS["Stats.js"]:::frontend
                THEME["ThemeSwitcher.js"]:::frontend
                click UPL "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/components/Upload.js"
                click LOGC "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/components/Logs.js"
                click STATS "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/components/Stats.js"
                click THEME "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/components/ThemeSwitcher.js"
            end
            subgraph "Context Providers"
                direction TB
                FC["FileContext.js"]:::frontend
                TC["ThemeContext.js"]:::frontend
                click FC "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/contexts/FileContext.js"
                click TC "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/frontend/src/contexts/ThemeContext.js"
            end
        end
    end

    %% Backend Layer
    subgraph "Backend Container (Express API)"
        direction TB
        BD["backend/Dockerfile"]:::backend
        APP["app.js"]:::backend
        click BD "https://github.com/shubnimkar/tracealyzer-log-parser/tree/master/backend/Dockerfile"
        click APP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/app.js"

        subgraph "Routes"
            LR["logRoutes.js"]:::backend
            click LR "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/routes/logRoutes.js"
        end

        subgraph "Controllers"
            LC["logController.js"]:::backend
            click LC "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/controllers/logController.js"
        end

        subgraph "Models"
            LM["Log.js"]:::backend
            click LM "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/models/Log.js"
        end

        subgraph "Parser Subsystem (Plugin Architecture)"
            direction TB
            PI["index.js"]:::backend
            click PI "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/index.js"
            AP["apacheParser.js"]:::backend
            JP["jsonParser.js"]:::backend
            NP["nginxParser.js"]:::backend
            SP["syslogParser.js"]:::backend
            DP["dockerParser.js"]:::backend
            KP["kernelParser.js"]:::backend
            click AP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/apacheParser.js"
            click JP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/jsonParser.js"
            click NP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/nginxParser.js"
            click SP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/syslogParser.js"
            click DP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/dockerParser.js"
            click KP "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/parser/kernelParser.js"
        end

        UT["detectLogType.js"]:::backend
        click UT "https://github.com/shubnimkar/tracealyzer-log-parser/blob/master/backend/utils/detectLogType.js"

        UP["uploads/"]:::backend
        click UP "https://github.com/shubnimkar/tracealyzer-log-parser/tree/master/backend/uploads/"
    end

    %% Database Layer
    DB["MongoDB Atlas"]:::database

    %% External Entities
    Browser["User Browser"]:::external

    %% Connections
    Browser -->|"HTTP(S) Request"| FN
    FN -->|"Serves Static React"| NG
    NG -->|"Delivers App"| RS
    RS -->|"Uses API"| APP
    APP -->|"Routes to"| LR
    LR -->|"Calls"| LC
    LC -->|"Uses Model"| LM
    LC -->|"Detects Type"| UT
    UT -->|"Loads Parser"| PI
    PI -->|"Invokes"| AP
    PI -->|"Invokes"| JP
    PI -->|"Invokes"| NP
    PI -->|"Invokes"| SP
    PI -->|"Invokes"| DP
    PI -->|"Invokes"| KP
    LC -->|"Stores Upload"| UP
    LM -->|"CRUD"| DB
    APP -->|"Env:MONGO_URI"| DB

    %% Docker Compose network links
    DC --> FN
    DC --> BD

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef backend fill:#90EE90,stroke:#333,stroke-width:1px
    classDef database fill:#FFFF99,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
