# gladioluss/docker_healthcheck_exporter architecture

> Architecture diagram of the GitHub repository gladioluss/docker_healthcheck_exporter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gladioluss/docker_healthcheck_exporter
- Repository: https://github.com/gladioluss/docker_healthcheck_exporter

## Overview

Docker Healthcheck Exporter periodically reads container health from Docker, caches a snapshot, and serves Prometheus metrics from that snapshot; it can also write metrics to a configured textfile. The CLI loads settings and starts the web app, whose lifecycle starts and stops the collector. Collection applies name and label filters, classifies health states, and includes Compose labels. The graph reflects the shown calls and README-described scraping and capabilities; Docker and Prometheus are external. Configuration includes remote-Docker options, but the excerpts do not show how those settings reach the Docker client.

Main entry points: [`docker_healthcheck_exporter/app.py`](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py) (Web app and refresh loop), [`docker_healthcheck_exporter/collector.py`](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/collector.py) (Container collector), [`docker_healthcheck_exporter/__main__.py`](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/__main__.py) (CLI entry point), [`docker_healthcheck_exporter/config.py`](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/config.py) (Settings loader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_startup["Startup and configuration"]
  node_cli["CLI entry point<br/>[__main__.py]"]
  node_settings["Settings loader<br/>[config.py]"]
end

subgraph group_collection["Docker collection"]
  node_collector["Container collector<br/>[collector.py]"]
  node_snapshot[("Cached snapshot<br/>[app.py]")]
end

subgraph group_serving["Metrics serving"]
  node_app["Web app and refresh loop<br/>[app.py]"]
  node_renderer["Prometheus renderer<br/>[metrics.py]"]
  node_metrics_endpoint["Metrics endpoint<br/>[app.py]"]
  node_health_endpoint["Health endpoint<br/>[app.py]"]
end

subgraph group_operations["Logging and integrations"]
  node_textfile["Metrics textfile"]
  node_logger["Logging<br/>[logger.py]"]
end

node_operator(("Operator"))
node_environment(("Environment settings"))
node_docker["Docker Engine"]
node_prometheus(("Prometheus scraper"))

node_operator -->|"starts"| node_cli
node_cli -->|"loads settings"| node_settings
node_environment -->|"provides values"| node_settings
node_cli -->|"runs server"| node_app
node_app -->|"loads settings"| node_settings
node_app -->|"starts and stops"| node_collector
node_app -->|"refreshes via"| node_collector
node_collector -->|"lists and inspects"| node_docker
node_collector -->|"returns statuses"| node_snapshot
node_app -->|"updates"| node_snapshot
node_app -->|"renders snapshot"| node_renderer
node_prometheus -->|"scrapes"| node_metrics_endpoint
node_metrics_endpoint -->|"reads metrics text"| node_app
node_app -->|"writes metrics"| node_textfile
node_operator -->|"checks health"| node_health_endpoint
node_cli -->|"configures logging"| node_logger
node_app -->|"logs events"| node_logger
node_collector -->|"logs events"| node_logger

click node_cli "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/__main__.py"
click node_settings "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/config.py"
click node_app "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py"
click node_collector "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/collector.py"
click node_snapshot "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py"
click node_renderer "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/metrics.py"
click node_metrics_endpoint "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py"
click node_health_endpoint "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py"
click node_logger "https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/logger.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_settings toneBlue
class node_collector,node_snapshot toneAmber
class node_app,node_renderer,node_metrics_endpoint,node_health_endpoint toneMint
class node_textfile,node_logger toneRose
class node_operator,node_environment,node_docker,node_prometheus toneIndigo
```

## Components

### Startup and configuration

- [CLI entry point](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/__main__.py): `docker_healthcheck_exporter/__main__.py`
- [Settings loader](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/config.py): `docker_healthcheck_exporter/config.py`

### Docker collection

- [Container collector](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/collector.py): `docker_healthcheck_exporter/collector.py`
- [Cached snapshot](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py): `docker_healthcheck_exporter/app.py`

### Metrics serving

- [Web app and refresh loop](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py): `docker_healthcheck_exporter/app.py`
- [Prometheus renderer](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/metrics.py): `docker_healthcheck_exporter/metrics.py`
- [Metrics endpoint](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py): `docker_healthcheck_exporter/app.py`
- [Health endpoint](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/app.py): `docker_healthcheck_exporter/app.py`

### Logging and integrations

- **Metrics textfile**
- [Logging](https://github.com/gladioluss/docker_healthcheck_exporter/blob/main/docker_healthcheck_exporter/logger.py): `docker_healthcheck_exporter/logger.py`

### Other components

- **Operator**
- **Environment settings**
- **Docker Engine**
- **Prometheus scraper**

## Connections

- Operator → CLI entry point: starts (evidence: `README.md`)
- CLI entry point → Settings loader: loads settings (evidence: `docker_healthcheck_exporter/__main__.py`)
- Environment settings → Settings loader: provides values (evidence: `docker_healthcheck_exporter/config.py`)
- CLI entry point → Web app and refresh loop: runs server (evidence: `docker_healthcheck_exporter/__main__.py`)
- Web app and refresh loop → Settings loader: loads settings (evidence: `docker_healthcheck_exporter/app.py`)
- Web app and refresh loop → Container collector: starts and stops (evidence: `docker_healthcheck_exporter/app.py`)
- Web app and refresh loop → Container collector: refreshes via (evidence: `docker_healthcheck_exporter/app.py`)
- Container collector → Docker Engine: lists and inspects (evidence: `docker_healthcheck_exporter/collector.py`)
- Container collector → Cached snapshot: returns statuses (evidence: `docker_healthcheck_exporter/app.py`)
- Web app and refresh loop → Cached snapshot: updates (evidence: `docker_healthcheck_exporter/app.py`)
- Web app and refresh loop → Prometheus renderer: renders snapshot (evidence: `docker_healthcheck_exporter/app.py`)
- Prometheus scraper → Metrics endpoint: scrapes (evidence: `README.md`)
- Metrics endpoint → Web app and refresh loop: reads metrics text (evidence: `docker_healthcheck_exporter/app.py`)
- Web app and refresh loop → Metrics textfile: writes metrics (evidence: `docker_healthcheck_exporter/app.py`)
- Operator → Health endpoint: checks health (evidence: `docker_healthcheck_exporter/app.py`)
- CLI entry point → Logging: configures logging (evidence: `docker_healthcheck_exporter/__main__.py`)
- Web app and refresh loop → Logging: logs events (evidence: `docker_healthcheck_exporter/app.py`)
- Container collector → Logging: logs events (evidence: `docker_healthcheck_exporter/collector.py`)
