# marcobreveglieri/prometheus-client-delphi architecture

> Architecture diagram of the GitHub repository marcobreveglieri/prometheus-client-delphi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/marcobreveglieri/prometheus-client-delphi
- Repository: https://github.com/marcobreveglieri/prometheus-client-delphi

## Overview

##### Project Type and Purpose
- This is a client‐library project (“Prometheus Client for Delphi”), not a standalone service.
- Its purpose is to provide Delphi applications with the ability to define, register, update, and expose Prometheus metrics (counters, gauges, histograms, etc.) in the Prometheus text exposition format.
- It also ships sample integrations (DMVC, Horse, WebBroker, WiRL) and automated tests.

##### File Structure Analysis
- Top‐level:
- Source/ – the core Delphi packages and units (Collectors, Registry, Exposers, Labels, Metrics).
- Samples/ – starter apps showing how to integrate the library with different web frameworks.
- Tests/ – unit and fixture code verifying collectors and registry behavior.
- Prometheus.Client.groupproj – Delphi group project file aggregating packages.
- boss.json / boss-lock.json – BOSS package manager descriptors.
- Core design pattern: a central CollectorRegistry holds Collector instances; Collectors are grouped by metric type and labeled; Exposers format registry contents to text.

##### Reading the README
- Confirms core components: TCollectorRegistry, concrete collector types (TCounter, TGauge, THistogram), text based exposer.
- Mentions middleware for popular Delphi web frameworks to automatically expose “/metrics” endpoints.
- Highlights customization via custom collectors.

- Prometheus.Client.Core (Registry, Collector base types)
- Collectors Module (Counter, Gauge, Histogram, Summary)
- Exposition Module (TextExposer, middleware adapters)
- Sample Web Apps (DMVC, Horse, WebBroker, WiRL)
- External System: Prometheus Server (scrapes /metrics)
- Tests (validating collector behaviors)
- Sample App → instantiates collectors → registers them in → CollectorRegistry
- Application code → updates metrics via → Collector instances
- HTTP Middleware or manual call → invokes → TextExposer → reads Registry → produces HTTP response
- Prometheus Server → scrapes → /metrics endpoint → ingests time series data
- Tests → import → Collectors & Registry → assert metric values
c. Architectural Patterns & Principles:
- Singleton or default instance for CollectorRegistry
- Factory or builder pattern via “.Create(…)” and “.Register()” fluent API
- Separation of concerns: collecting vs. formatting vs. HTTP serving
d. Technologies & Frameworks:
- Delphi (Object Pascal) packages and units
- BOSS package manager configuration files
- Web frameworks: Delphi MVC Framework, Horse, WebBroker, WiRL
- Indy TIdHTTP for manual exposition examples
- Prometheus text format as the output protocol

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core Library
    subgraph "Prometheus.Client.Core" 
        direction TB
        CollectorBase["Collector Base Types"]:::core
        SimpleCollector["SimpleCollector"]:::core
        CR[(CollectorRegistry)]:::core
        Labels["Labels & Metrics Definitions"]:::core
        Resources["Resource Bundles"]:::core
    end

    %% Collectors
    subgraph "Collectors Module" 
        direction TB
        Counter["TCounter Collector"]:::core
        Gauge["TGauge Collector"]:::core
        Histogram["THistogram Collector"]:::core
    end

    %% Exposition
    subgraph "Exposition Module"
        direction TB
        TextExposer["TextExposer"]:::core
    end

    %% Sample Integrations
    subgraph "Sample Integrations" 
        direction TB
        DMVC["DMVC Starter App"]:::sample
        Horse["Horse Starter App"]:::sample
        WebBroker["WebBroker Starter App"]:::sample
        WiRL["WiRL Starter App"]:::sample
    end

    %% Tests
    subgraph "Automated Tests"
        direction TB
        TestRunner["Test Runner"]:::test
        FixtureCounter["Counter Fixtures"]:::test
        FixtureGauge["Gauge Fixtures"]:::test
        FixtureHistogram["Histogram Fixtures"]:::test
    end

    %% External
    PromServer["Prometheus Server"]:::external

    %% Relationships
    DMVC -->|instantiates| Counter
    Horse -->|instantiates| Counter
    WebBroker -->|instantiates| Counter
    WiRL -->|instantiates| Counter

    DMVC -->|instantiates| Gauge
    Horse -->|instantiates| Gauge
    WebBroker -->|instantiates| Gauge
    WiRL -->|instantiates| Gauge

    DMVC -->|instantiates| Histogram
    Horse -->|instantiates| Histogram
    WebBroker -->|instantiates| Histogram
    WiRL -->|instantiates| Histogram

    Counter -->|registers| CR
    Gauge -->|registers| CR
    Histogram -->|registers| CR

    DMVC -->|uses middleware| TextExposer
    Horse -->|uses middleware| TextExposer
    WebBroker -->|uses middleware| TextExposer
    WiRL -->|uses middleware| TextExposer

    TextExposer -->|reads| CR
    CR -->|provides metrics| TextExposer

    PromServer -->|scrapes /metrics| TextExposer

    TestRunner -->|runs| FixtureCounter
    TestRunner -->|runs| FixtureGauge
    TestRunner -->|runs| FixtureHistogram

    FixtureCounter -->|imports| Counter
    FixtureGauge -->|imports| Gauge
    FixtureHistogram -->|imports| Histogram
    FixtureCounter -->|imports| CR
    FixtureGauge -->|imports| CR
    FixtureHistogram -->|imports| CR

    Counter -->|extends| CollectorBase
    Gauge -->|extends| CollectorBase
    Histogram -->|extends| CollectorBase

    CollectorBase -->|uses| Resources
    Labels -->|defines| Counter
    Labels -->|defines| Gauge
    Labels -->|defines| Histogram

    %% Click Events
    click CollectorBase "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Collector.pas"
    click SimpleCollector "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.SimpleCollector.pas"
    click CR "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Registry.pas"
    click Labels "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Labels.pas"
    click Resources "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Resources.pas"
    click Counter "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Collectors.Counter.pas"
    click Gauge "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Collectors.Gauge.pas"
    click Histogram "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Collectors.Histogram.pas"
    click TextExposer "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Source/Prometheus.Exposers.Text.pas"
    click DMVC "https://github.com/marcobreveglieri/prometheus-client-delphi/tree/main/Samples/Starter-DMVC"
    click Horse "https://github.com/marcobreveglieri/prometheus-client-delphi/tree/main/Samples/Starter-Horse"
    click WebBroker "https://github.com/marcobreveglieri/prometheus-client-delphi/tree/main/Samples/Starter-WebBroker"
    click WiRL "https://github.com/marcobreveglieri/prometheus-client-delphi/tree/main/Samples/Starter-WiRL"
    click FixtureCounter "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Tests/Fixtures/Prometheus.Tests.Fixtures.Collectors.Counter.pas"
    click FixtureGauge "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Tests/Fixtures/Prometheus.Tests.Fixtures.Collectors.Gauge.pas"
    click FixtureHistogram "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Tests/Fixtures/Prometheus.Tests.Fixtures.Collectors.Histogram.pas"
    click TestRunner "https://github.com/marcobreveglieri/prometheus-client-delphi/blob/main/Tests/Prometheus.Client.Tests.dpr"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef sample fill:#90EE90,stroke:#000,stroke-width:1px
    classDef external fill:#FFA500,stroke:#000,stroke-width:1px
    classDef test fill:#D3D3D3,stroke:#000,stroke-width:1px
```
