beatz174-bit
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
# Prometheus Runtime Inventory
|
|
|
|
This document is generated by `scripts/export_prometheus_inventory.py` from Prometheus runtime data. Commit the generated update whenever architecture/runtime inventory changes.
|
|
|
|
## Usage
|
|
|
|
Required:
|
|
|
|
- `PROMETHEUS_URL`
|
|
|
|
Optional:
|
|
|
|
- `PROMETHEUS_TIMEOUT` (default: `10` seconds)
|
|
- `PROMETHEUS_BEARER_TOKEN`
|
|
- `PROMETHEUS_USERNAME`
|
|
- `PROMETHEUS_PASSWORD`
|
|
- `PROMETHEUS_VERIFY_TLS` (default: `true`)
|
|
|
|
Run:
|
|
|
|
```bash
|
|
export PROMETHEUS_URL="https://prometheus.example.com"
|
|
python3 scripts/export_prometheus_inventory.py --output-dir docs/runtime
|
|
```
|
|
|
|
## Outputs
|
|
|
|
- Raw API snapshots: `docs/runtime/prometheus-targets.json`, query result snapshots, and optional label-query snapshots.
|
|
- Normalized inventory: `docs/runtime/prometheus-inventory.json`
|
|
- Human summary: `docs/prometheus-inventory.md` (this file)
|
|
|
|
## Diagram/Docs pipeline note
|
|
|
|
Treat Prometheus data as observed runtime telemetry. Do not infer placement/topology/network boundaries unless labels or other repo sources explicitly provide that information.
|
|
|
|
## Status
|
|
|
|
Inventory has not been generated in this environment because no `PROMETHEUS_URL` was provided for execution.
|