# spscommerce/fulfillment-celery-exporter architecture

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

- Interactive diagram: https://gitdiagram.com/spscommerce/fulfillment-celery-exporter
- Repository: https://github.com/spscommerce/fulfillment-celery-exporter

## Overview

celery-exporter consumes Celery’s brokered events, updates Prometheus task and worker metrics, and serves them over HTTP for scraping; it also provides a broker health endpoint. Its Celery-mixin supplies Grafana dashboards and Prometheus alerts. Runtime relationships are grounded in the sampled source; the mixin’s role and dashboard/alert capabilities are documented in the README, but its generation internals were not sampled.

Main entry points: [`src/exporter.py`](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/exporter.py) (Event exporter), [`src/cli.py`](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/cli.py) (CLI options), [`src/http_server.py`](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/http_server.py) (HTTP endpoints), [`celery-mixin/dashboards/dashboards.libsonnet`](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/dashboards/dashboards.libsonnet) (Dashboard mixin)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Exporter runtime"]
  node_cli["CLI options<br/>[cli.py]"]
  node_help["Metric help<br/>[help.py]"]
  node_exporter["Event exporter<br/>[exporter.py]"]
  node_http["HTTP endpoints<br/>[http_server.py]"]
end

subgraph group_assets["Monitoring assets"]
  node_dashboards["Dashboard definitions"]
  node_dashboard_mixin["Dashboard mixin"]
  node_alert_rules["Alert rules"]
  node_alert_mixin["Alert mixin<br/>[alerts.libsonnet]"]
end

subgraph group_external["External systems"]
  node_workers["Celery workers"]
  node_broker[("Message broker")]
  node_prometheus["Prometheus"]
  node_grafana["Grafana"]
end

node_operator(("Operator"))

node_operator -->|"configures"| node_cli
node_cli -->|"starts"| node_exporter
node_cli -->|"loads help"| node_help
node_workers -->|"send events"| node_broker
node_broker -->|"supplies events"| node_exporter
node_exporter -->|"connects"| node_broker
node_exporter -->|"starts server"| node_http
node_prometheus -->|"scrapes metrics"| node_http
node_http -->|"checks health"| node_broker
node_dashboards -.->|"defines dashboards"| node_dashboard_mixin
node_dashboard_mixin -->|"provides dashboards"| node_grafana
node_alert_rules -.->|"defines alerts"| node_alert_mixin
node_alert_mixin -->|"provides alerts"| node_prometheus

click node_cli "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/cli.py"
click node_help "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/help.py"
click node_exporter "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/exporter.py"
click node_http "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/http_server.py"
click node_dashboards "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/dashboards/dashboards.libsonnet"
click node_dashboard_mixin "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/dashboards/dashboards.libsonnet"
click node_alert_rules "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/prometheus-alerts.yaml"
click node_alert_mixin "https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/alerts/alerts.libsonnet"

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_help,node_exporter,node_http toneBlue
class node_dashboards,node_dashboard_mixin,node_alert_rules,node_alert_mixin toneAmber
class node_workers,node_broker,node_prometheus,node_grafana toneMint
class node_operator toneIndigo
```

## Components

### Exporter runtime

- [CLI options](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/cli.py): `src/cli.py`
- [Metric help](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/help.py): `src/help.py`
- [Event exporter](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/exporter.py): `src/exporter.py`
- [HTTP endpoints](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/src/http_server.py): `src/http_server.py`

### Monitoring assets

- [Dashboard definitions](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/dashboards/dashboards.libsonnet): `celery-mixin/dashboards/dashboards.libsonnet`
- [Dashboard mixin](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/dashboards/dashboards.libsonnet): `celery-mixin/dashboards/dashboards.libsonnet`
- [Alert rules](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/prometheus-alerts.yaml): `celery-mixin/prometheus-alerts.yaml`
- [Alert mixin](https://github.com/spscommerce/fulfillment-celery-exporter/blob/main/celery-mixin/alerts/alerts.libsonnet): `celery-mixin/alerts/alerts.libsonnet`

### External systems

- **Celery workers**
- **Message broker**
- **Prometheus**
- **Grafana**

### Other components

- **Operator**

## Connections

- Operator → CLI options: configures (evidence: `README.md`)
- CLI options → Event exporter: starts (evidence: `src/cli.py`)
- CLI options → Metric help: loads help (evidence: `src/cli.py`)
- Celery workers → Message broker: send events (evidence: `README.md`)
- Message broker → Event exporter: supplies events (evidence: `README.md`)
- Event exporter → Message broker: connects (evidence: `src/exporter.py`)
- Event exporter → HTTP endpoints: starts server (evidence: `src/exporter.py`)
- Prometheus → HTTP endpoints: scrapes metrics (evidence: `README.md`)
- HTTP endpoints → Message broker: checks health (evidence: `src/http_server.py`)
- Dashboard definitions → Dashboard mixin: defines dashboards
- Dashboard mixin → Grafana: provides dashboards (evidence: `README.md`)
- Alert rules → Alert mixin: defines alerts
- Alert mixin → Prometheus: provides alerts (evidence: `README.md`)
