diff options
Diffstat (limited to 'docs/reference/test-metrics.md')
| -rw-r--r-- | docs/reference/test-metrics.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/reference/test-metrics.md b/docs/reference/test-metrics.md new file mode 100644 index 0000000..a1af41e --- /dev/null +++ b/docs/reference/test-metrics.md @@ -0,0 +1,35 @@ +# Test Metrics + +Generated metrics use the `epimetheus_test_` prefix so they are easy to identify as test data. + +## Counter: `epimetheus_test_requests_total` + +- **Type:** Counter (monotonically increasing) +- **Description:** Total number of requests processed +- **Use case:** Total events, requests, errors + +## Gauge: `epimetheus_test_active_connections` + +- **Type:** Gauge (can increase or decrease) +- **Description:** Current number of active connections (0–100) +- **Use case:** Current state, capacity + +## Gauge: `epimetheus_test_temperature_celsius` + +- **Type:** Gauge +- **Description:** Current temperature in Celsius (0–50°C) +- **Use case:** Environmental monitoring + +## Histogram: `epimetheus_test_request_duration_seconds` + +- **Type:** Histogram (distribution) +- **Description:** Request duration distribution +- **Buckets:** 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10 seconds +- **Use case:** Latency, SLO tracking + +## Labeled counter: `epimetheus_test_jobs_processed_total` + +- **Type:** Counter with labels +- **Description:** Jobs processed by type and status +- **Labels:** `job_type` (email, report, backup), `status` (success, failed) +- **Use case:** Categorized counting, multi-dimensional metrics |