# salahbdg/logging-tracing-monitoring-observability architecture

> Architecture diagram of the GitHub repository salahbdg/logging-tracing-monitoring-observability, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/salahbdg/logging-tracing-monitoring-observability
- Repository: https://github.com/salahbdg/logging-tracing-monitoring-observability

## Overview

##### Project Type and Purpose
- This is a full‐stack, microservice‐oriented web application for “doodle,” with an Angular frontend and a Quarkus‐based backend.
- Its primary purpose is to demonstrate end‐to‐end observability: logging, metrics, and tracing using Grafana, Prometheus, Loki, Promtail, and Jaeger.

##### File Structure
- Top-level directories:
- front/ contains an Angular single-page application (src/app, assets, environments, etc.).
- api/ houses a Quarkus service (Maven project, Dockerfiles, Docker Compose, domain, DAO, resources, services).
- Observability configuration files (prometheus.yml, promtail-config.yaml, grafana-dashboard.json).
- The backend follows a layered pattern: domain → DAO (ChoiceRepository, PollRepository, …) → DTOs → resources (REST endpoints) → services (email, utils).

##### Extract Key Notes from the README
- Frontend runs via `npm start` (Angular dev server) or served statically from Quarkus (`index.html` under META-INF/resources).
- Backend runs via `./mvnw quarkus:dev` or Docker Compose.
- Observability services launched alongside the API: Prometheus, Grafana, Jaeger, Loki, Promtail.

##### Main Components & Relationships
a. User Interface
– Component: Angular App (Browser)
– Communication: HTTP(S) calls to Quarkus REST API
b. Core Backend
– Component: Quarkus API Service
– Data store: MySQL (JDBC)
– External services:
- Etherpad Service (REST) – for ICS generation features
- SMTP Mail Service – for sending poll invitations
c. Observability Layer
– Metrics:
- Quarkus exposes `/q/metrics` (SmallRye Metrics)
- Prometheus scrapes metrics (port 9090)
– Tracing:
- Quarkus with `quarkus-smallrye-opentracing` sends spans to Jaeger
- Jaeger all-in-one UI (port 16686) collects and displays traces
– Logging:
- Quarkus logs are picked up by Promtail
- Promtail forwards logs to Loki (port 3100)
– Visualization: Grafana reads from Prometheus, Loki, and Jaeger, displaying dashboards (port 3000)

##### Architectural Patterns & Design Principles
- Layered architecture in the backend (DAO → domain → service → resource).
- Externalize cross-cutting concerns (metrics, logs, traces) into a dedicated “Observability” micro-layer.
- Infrastructure as code: Docker Compose orchestrates API and observability services in a single network.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        AngularApp["Angular App\n(Node 4200)"]:::ui
    end

    %% Backend Core
    subgraph "Backend Core"
        ApiService["Quarkus API Service\n(8080)"]:::backend
        subgraph "Resource Layer"
            ExportResource["ExportResource"]:::backend
            ICSResource["ICSResources"]:::backend
        end
        subgraph "Service Layer"
            SendEmail["SendEmail"]:::backend
            Utils["Utils"]:::backend
        end
        subgraph "DAO Layer"
            ChoiceRepo["ChoiceRepository"]:::backend
            PollRepo["PollRepository"]:::backend
        end
        subgraph "Domain Layer"
            ChoiceEntity["Choice"]:::backend
            PollEntity["Poll"]:::backend
            UserEntity["User"]:::backend
        end
        subgraph "DTO Layer"
            EventDTO["EventDTO"]:::backend
            ChoiceUserDTO["ChoiceUser"]:::backend
        end
        StaticSPA["index.html\n(Quarkus-served SPA)"]:::backend
        DockerCompose["docker-compose.yaml"]:::backend
        DockerJVM["Dockerfile.jvm"]:::backend
        DockerNative["Dockerfile.native"]:::backend
    end

    %% Data & External Services
    subgraph "Data & External Services"
        MySQL["MySQL\n(3306)"]:::data
        Etherpad["Etherpad Service\n(REST)"]:::data
        SMTP["SMTP Mail Service"]:::data
    end

    %% Observability
    subgraph "Observability"
        Prometheus["Prometheus\n(9090)"]:::obs
        Grafana["Grafana\n(3000)"]:::obs
        Loki["Loki\n(3100)"]:::obs
        Promtail["Promtail"]:::obs
        Jaeger["Jaeger UI\n(16686)"]:::obs
    end

    %% Connections
    AngularApp -->|"HTTP"| ApiService
    ApiService -->|"JDBC"| MySQL
    ApiService -->|"/features/export"| ExportResource
    ApiService -->|"/features/ics"| ICSResource
    ExportResource -->|"calls"| SendEmail
    ICSResource -->|"uses"| Utils
    SendEmail -->|"SMTP"| SMTP
    ApiService -->|"REST"| Etherpad
    ApiService -->|"exposes /q/metrics"| Prometheus
    ApiService -->|"sends spans"| Jaeger
    Promtail -->|"forwards logs"| Loki
    Grafana -->|"reads metrics"| Prometheus
    Grafana -->|"reads logs"| Loki
    Grafana -->|"reads traces"| Jaeger
    StaticSPA -->|"served by"| ApiService
    DockerCompose --> ApiService
    DockerCompose --> Prometheus
    DockerCompose --> Grafana
    DockerCompose --> Loki
    DockerCompose --> Promtail
    DockerCompose --> Jaeger

    %% Click Events
    click AngularApp "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/front/"
    click ApiService "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/"
    click ExportResource "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/java/fr/istic/tlc/resources/features/ExportResource.java"
    click ICSResource "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/java/fr/istic/tlc/resources/ICSResources.java"
    click SendEmail "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/java/fr/istic/tlc/services/SendEmail.java"
    click Utils "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/java/fr/istic/tlc/services/Utils.java"
    click ChoiceRepo "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/dao"
    click PollRepo "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/dao"
    click ChoiceEntity "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/domain"
    click PollEntity "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/domain"
    click UserEntity "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/domain"
    click EventDTO "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/dto"
    click ChoiceUserDTO "https://github.com/salahbdg/logging-tracing-monitoring-observability/tree/main/api/src/main/java/fr/istic/tlc/dto"
    click StaticSPA "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/resources/META-INF/resources/index.html"
    click DockerCompose "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/docker-compose.yaml"
    click DockerJVM "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/docker/Dockerfile.jvm"
    click DockerNative "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/src/main/docker/Dockerfile.native"
    click Prometheus "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/prometheus.yml"
    click Promtail "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/api/promtail-config.yaml"
    click Grafana "https://github.com/salahbdg/logging-tracing-monitoring-observability/blob/main/grafana-dashboard.json"

    %% Styles
    classDef ui fill:#AED6F1,stroke:#217DBB,color:#000
    classDef backend fill:#ABEBC6,stroke:#1F7A1F,color:#000
    classDef data fill:#F9E79F,stroke:#B58900,color:#000
    classDef obs fill:#D7BDE2,stroke:#7F1F7F,color:#000
```
