diff options
| author | Paul Buetow <paul@buetow.org> | 2025-12-31 17:35:34 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-12-31 17:35:34 +0200 |
| commit | a578683ec769946ae92ed787a57698a28da638c1 (patch) | |
| tree | 94df336f1d6ec71a823d077242923381c79139f1 | |
| parent | 8349f41705111606717477a17930c7d2cd1ccabf (diff) | |
Document Admin API and updated out-of-order configuration
Updated Prometheus documentation to reflect current configuration:
- Added web.enable-admin-api flag documentation
- Updated outOfOrderTimeWindow from 720h to 744h (31 days)
- Added Data Deletion section with cleanup script usage
- Documented manual deletion via Admin API endpoints
Provides complete guide for data cleanup after benchmark testing.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
| -rw-r--r-- | f3s/prometheus/README.md | 38 |
1 files changed, 34 insertions, 4 deletions
diff --git a/f3s/prometheus/README.md b/f3s/prometheus/README.md index 9cd6a19..2dc6e7f 100644 --- a/f3s/prometheus/README.md +++ b/f3s/prometheus/README.md @@ -35,26 +35,29 @@ The following features are enabled in `persistence-values.yaml`: ```yaml prometheus: prometheusSpec: - # Enable Remote Write receiver endpoint + # Enable Remote Write receiver endpoint and Admin API additionalArgs: - name: web.enable-remote-write-receiver value: "" + - name: web.enable-admin-api + value: "" # Enable out-of-order ingestion for backfilling enableFeatures: - exemplar-storage - otlp-write-receiver - # Allow backfilling up to 30 days in the past + # Allow backfilling up to 31 days in the past (provides 1-day buffer for 30-day datasets) tsdb: - outOfOrderTimeWindow: 720h # 30 days + outOfOrderTimeWindow: 744h # 31 days ``` ### What This Enables - **Remote Write API**: HTTP endpoint at `/api/v1/write` for ingesting metrics with custom timestamps +- **Admin API**: HTTP endpoints at `/api/v1/admin/tsdb/*` for data deletion and management - **Out-of-Order Ingestion**: Allows writing data points older than existing data for the same time series -- **30-Day Window**: Can backfill data up to 30 days in the past (configured via `outOfOrderTimeWindow`) +- **31-Day Window**: Can backfill data up to 31 days in the past (configured via `outOfOrderTimeWindow`, provides 1-day buffer for 30-day datasets) ### Use Cases @@ -65,6 +68,33 @@ This configuration is designed for: Example: The [Epimetheus](https://github.com/pbuetow/epimetheus) tool uses this to push test metrics with historic timestamps. +### Data Deletion + +The Admin API enables selective deletion of time series data for cleanup after testing: + +**Delete specific metrics:** +```bash +curl -X POST 'http://localhost:9090/api/v1/admin/tsdb/delete_series?match[]=metric_name' +``` + +**Clean up tombstones** (free disk space): +```bash +curl -X POST 'http://localhost:9090/api/v1/admin/tsdb/clean_tombstones' +``` + +**Using the cleanup script:** + +The [Epimetheus repository](https://github.com/pbuetow/epimetheus) includes `cleanup-benchmark-data.sh` which automates deletion of all benchmark metrics: +```bash +# Requires port-forward to Prometheus +kubectl port-forward -n monitoring svc/prometheus-kube-prometheus-prometheus 9090:9090 + +# Run cleanup +./cleanup-benchmark-data.sh +``` + +The script deletes all `epimetheus_benchmark_*` metrics and cleans up tombstones automatically. + ### Performance Considerations **Important**: This is NOT a production-ready configuration. Enabling these features has trade-offs: |
