From 57d0f457c8c62a4e7b9666330f3dda8d3c8af5fe Mon Sep 17 00:00:00 2001 From: Alvin Lin Date: Thu, 23 Mar 2023 14:59:13 -0700 Subject: [PATCH 1/2] Add build info API to documentataion Signed-off-by: Alvin Lin --- docs/api/_index.md | 126 +++++++++++++++++++++++++-------------------- 1 file changed, 69 insertions(+), 57 deletions(-) diff --git a/docs/api/_index.md b/docs/api/_index.md index 695e8252e30..c1640aecf28 100644 --- a/docs/api/_index.md +++ b/docs/api/_index.md @@ -15,63 +15,64 @@ For the sake of clarity, in this document we have grouped API endpoints by servi ## Endpoints -| API | Service | Endpoint | -| --- | ------- | -------- | -| [Index page](#index-page) | _All services_ | `GET /` | -| [Configuration](#configuration) | _All services_ | `GET /config` | -| [Runtime Configuration](#runtime-configuration) | _All services_ | `GET /runtime_config` | -| [Services status](#services-status) | _All services_ | `GET /services` | -| [Readiness probe](#readiness-probe) | _All services_ | `GET /ready` | -| [Metrics](#metrics) | _All services_ | `GET /metrics` | -| [Pprof](#pprof) | _All services_ | `GET /debug/pprof` | -| [Fgprof](#fgprof) | _All services_ | `GET /debug/fgprof` | -| [Remote write](#remote-write) | Distributor | `POST /api/v1/push` | -| [Tenants stats](#tenants-stats) | Distributor | `GET /distributor/all_user_stats` | -| [HA tracker status](#ha-tracker-status) | Distributor | `GET /distributor/ha_tracker` | -| [Flush blocks](#flush-blocks) | Ingester | `GET,POST /ingester/flush` | -| [Shutdown](#shutdown) | Ingester | `GET,POST /ingester/shutdown` | -| [Ingesters ring status](#ingesters-ring-status) | Ingester | `GET /ingester/ring` | -| [Instant query](#instant-query) | Querier, Query-frontend | `GET,POST /api/v1/query` | -| [Range query](#range-query) | Querier, Query-frontend | `GET,POST /api/v1/query_range` | -| [Exemplar query](#exemplar-query) | Querier, Query-frontend | `GET,POST /api/v1/query_exemplars` | -| [Get series by label matchers](#get-series-by-label-matchers) | Querier, Query-frontend | `GET,POST /api/v1/series` | -| [Get label names](#get-label-names) | Querier, Query-frontend | `GET,POST /api/v1/labels` | -| [Get label values](#get-label-values) | Querier, Query-frontend | `GET /api/v1/label/{name}/values` | -| [Get metric metadata](#get-metric-metadata) | Querier, Query-frontend | `GET /api/v1/metadata` | -| [Remote read](#remote-read) | Querier, Query-frontend | `POST /api/v1/read` | -| [Get tenant ingestion stats](#get-tenant-ingestion-stats) | Querier | `GET /api/v1/user_stats` | -| [Ruler ring status](#ruler-ring-status) | Ruler | `GET /ruler/ring` | -| [Ruler rules ](#ruler-rule-groups) | Ruler | `GET /ruler/rule_groups` | -| [List rules](#list-rules) | Ruler | `GET /api/v1/rules` | -| [List alerts](#list-alerts) | Ruler | `GET /api/v1/alerts` | -| [List rule groups](#list-rule-groups) | Ruler | `GET /api/v1/rules` | -| [Get rule groups by namespace](#get-rule-groups-by-namespace) | Ruler | `GET /api/v1/rules/{namespace}` | -| [Get rule group](#get-rule-group) | Ruler | `GET /api/v1/rules/{namespace}/{groupName}` | -| [Set rule group](#set-rule-group) | Ruler | `POST /api/v1/rules/{namespace}` | -| [Delete rule group](#delete-rule-group) | Ruler | `DELETE /api/v1/rules/{namespace}/{groupName}` | -| [Delete namespace](#delete-namespace) | Ruler | `DELETE /api/v1/rules/{namespace}` | -| [Delete tenant configuration](#delete-tenant-configuration) | Ruler | `POST /ruler/delete_tenant_config` | -| [Alertmanager status](#alertmanager-status) | Alertmanager | `GET /multitenant_alertmanager/status` | -| [Alertmanager configs](#alertmanager-configs) | Alertmanager | `GET /multitenant_alertmanager/configs` | -| [Alertmanager ring status](#alertmanager-ring-status) | Alertmanager | `GET /multitenant_alertmanager/ring` | -| [Alertmanager UI](#alertmanager-ui) | Alertmanager | `GET /` | -| [Alertmanager Delete Tenant Configuration](#alertmanager-delete-tenant-configuration) | Alertmanager | `POST /multitenant_alertmanager/delete_tenant_config` | -| [Get Alertmanager configuration](#get-alertmanager-configuration) | Alertmanager | `GET /api/v1/alerts` | -| [Set Alertmanager configuration](#set-alertmanager-configuration) | Alertmanager | `POST /api/v1/alerts` | -| [Delete Alertmanager configuration](#delete-alertmanager-configuration) | Alertmanager | `DELETE /api/v1/alerts` | -| [Tenant delete request](#tenant-delete-request) | Purger | `POST /purger/delete_tenant` | -| [Tenant delete status](#tenant-delete-status) | Purger | `GET /purger/delete_tenant_status` | -| [Store-gateway ring status](#store-gateway-ring-status) | Store-gateway | `GET /store-gateway/ring` | -| [Compactor ring status](#compactor-ring-status) | Compactor | `GET /compactor/ring` | -| [Get rule files](#get-rule-files) | Configs API (deprecated) | `GET /api/prom/configs/rules` | -| [Set rule files](#set-rule-files) | Configs API (deprecated) | `POST /api/prom/configs/rules` | -| [Get template files](#get-template-files) | Configs API (deprecated) | `GET /api/prom/configs/templates` | -| [Set template files](#set-template-files) | Configs API (deprecated) | `POST /api/prom/configs/templates` | -| [Get Alertmanager config file](#get-alertmanager-config-file) | Configs API (deprecated) | `GET /api/prom/configs/alertmanager` | -| [Set Alertmanager config file](#set-alertmanager-config-file) | Configs API (deprecated) | `POST /api/prom/configs/alertmanager` | -| [Validate Alertmanager config](#validate-alertmanager-config-file) | Configs API (deprecated) | `POST /api/prom/configs/alertmanager/validate` | -| [Deactivate configs](#deactivate-configs) | Configs API (deprecated) | `DELETE /api/prom/configs/deactivate` | -| [Restore configs](#restore-configs) | Configs API (deprecated) | `POST /api/prom/configs/restore` | +| API | Service | Available Since | Endpoint | +| --- | ------- | --------------- | ---------| +| [Index page](#index-page) | _All services_ || `GET /` | +| [Configuration](#configuration) | _All services_ || `GET /config` | +| [Runtime Configuration](#runtime-configuration) | _All services_ || `GET /runtime_config` | +| [Services status](#services-status) | _All services_ || `GET /services` | +| [Readiness probe](#readiness-probe) | _All services_ || `GET /ready` | +| [Metrics](#metrics) | _All services_ || `GET /metrics` | +| [Pprof](#pprof) | _All services_ || `GET /debug/pprof` | +| [Fgprof](#fgprof) | _All services_ || `GET /debug/fgprof` | +| [Remote write](#remote-write) | Distributor || `POST /api/v1/push` | +| [Tenants stats](#tenants-stats) | Distributor || `GET /distributor/all_user_stats` | +| [HA tracker status](#ha-tracker-status) | Distributor || `GET /distributor/ha_tracker` | +| [Flush blocks](#flush-blocks) | Ingester || `GET,POST /ingester/flush` | +| [Shutdown](#shutdown) | Ingester || `GET,POST /ingester/shutdown` | +| [Ingesters ring status](#ingesters-ring-status) | Ingester || `GET /ingester/ring` | +| [Instant query](#instant-query) | Querier, Query-frontend || `GET,POST /api/v1/query` | +| [Range query](#range-query) | Querier, Query-frontend || `GET,POST /api/v1/query_range` | +| [Exemplar query](#exemplar-query) | Querier, Query-frontend || `GET,POST /api/v1/query_exemplars` | +| [Get series by label matchers](#get-series-by-label-matchers) | Querier, Query-frontend || `GET,POST /api/v1/series` | +| [Get label names](#get-label-names) | Querier, Query-frontend || `GET,POST /api/v1/labels` | +| [Get label values](#get-label-values) | Querier, Query-frontend || `GET /api/v1/label/{name}/values` | +| [Get metric metadata](#get-metric-metadata) | Querier, Query-frontend || `GET /api/v1/metadata` | +| [Remote read](#remote-read) | Querier, Query-frontend || `POST /api/v1/read` | +| [Build information](#build-information) | Querier, Query-frontend |v1.15.0| `GET /api/v1/status/buildinfo` | +| [Get tenant ingestion stats](#get-tenant-ingestion-stats) | Querier || `GET /api/v1/user_stats` | +| [Ruler ring status](#ruler-ring-status) | Ruler || `GET /ruler/ring` | +| [Ruler rules ](#ruler-rule-groups) | Ruler || `GET /ruler/rule_groups` | +| [List rules](#list-rules) | Ruler || `GET /api/v1/rules` | +| [List alerts](#list-alerts) | Ruler || `GET /api/v1/alerts` | +| [List rule groups](#list-rule-groups) | Ruler || `GET /api/v1/rules` | +| [Get rule groups by namespace](#get-rule-groups-by-namespace) | Ruler || `GET /api/v1/rules/{namespace}` | +| [Get rule group](#get-rule-group) | Ruler || `GET /api/v1/rules/{namespace}/{groupName}` | +| [Set rule group](#set-rule-group) | Ruler || `POST /api/v1/rules/{namespace}` | +| [Delete rule group](#delete-rule-group) | Ruler || `DELETE /api/v1/rules/{namespace}/{groupName}` | +| [Delete namespace](#delete-namespace) | Ruler || `DELETE /api/v1/rules/{namespace}` | +| [Delete tenant configuration](#delete-tenant-configuration) | Ruler || `POST /ruler/delete_tenant_config` | +| [Alertmanager status](#alertmanager-status) | Alertmanager || `GET /multitenant_alertmanager/status` | +| [Alertmanager configs](#alertmanager-configs) | Alertmanager || `GET /multitenant_alertmanager/configs` | +| [Alertmanager ring status](#alertmanager-ring-status) | Alertmanager || `GET /multitenant_alertmanager/ring` | +| [Alertmanager UI](#alertmanager-ui) | Alertmanager || `GET /` | +| [Alertmanager Delete Tenant Configuration](#alertmanager-delete-tenant-configuration) | Alertmanager || `POST /multitenant_alertmanager/delete_tenant_config` | +| [Get Alertmanager configuration](#get-alertmanager-configuration) | Alertmanager || `GET /api/v1/alerts` | +| [Set Alertmanager configuration](#set-alertmanager-configuration) | Alertmanager || `POST /api/v1/alerts` | +| [Delete Alertmanager configuration](#delete-alertmanager-configuration) | Alertmanager || `DELETE /api/v1/alerts` | +| [Tenant delete request](#tenant-delete-request) | Purger || `POST /purger/delete_tenant` | +| [Tenant delete status](#tenant-delete-status) | Purger || `GET /purger/delete_tenant_status` | +| [Store-gateway ring status](#store-gateway-ring-status) | Store-gateway || `GET /store-gateway/ring` | +| [Compactor ring status](#compactor-ring-status) | Compactor || `GET /compactor/ring` | +| [Get rule files](#get-rule-files) | Configs API (deprecated) || `GET /api/prom/configs/rules` | +| [Set rule files](#set-rule-files) | Configs API (deprecated) || `POST /api/prom/configs/rules` | +| [Get template files](#get-template-files) | Configs API (deprecated) || `GET /api/prom/configs/templates` | +| [Set template files](#set-template-files) | Configs API (deprecated) || `POST /api/prom/configs/templates` | +| [Get Alertmanager config file](#get-alertmanager-config-file) | Configs API (deprecated) || `GET /api/prom/configs/alertmanager` | +| [Set Alertmanager config file](#set-alertmanager-config-file) | Configs API (deprecated) || `POST /api/prom/configs/alertmanager` | +| [Validate Alertmanager config](#validate-alertmanager-config-file) | Configs API (deprecated) || `POST /api/prom/configs/alertmanager/validate` | +| [Deactivate configs](#deactivate-configs) | Configs API (deprecated) || `DELETE /api/prom/configs/deactivate` | +| [Restore configs](#restore-configs) | Configs API (deprecated) || `POST /api/prom/configs/restore` | ### Path prefixes @@ -409,6 +410,17 @@ _For more information, please check out Prometheus [Remote storage integrations] _Requires [authentication](#authentication)._ +### Build Information + +``` +GET /api/v1/status/buildinfo +# Legacy +GET /api/v1/status/buildinfo +``` + +Prometheus-compatible [build information](https://prometheus.io/docs/prometheus/latest/querying/api/#build-information) endpoint. + +_Requires [authentication](#authentication)._ ## Querier From 9e8c7ff6833bc9760fe00b24fbb89bb68427119e Mon Sep 17 00:00:00 2001 From: Alvin Lin Date: Thu, 23 Mar 2023 15:19:46 -0700 Subject: [PATCH 2/2] remove trailing space Signed-off-by: Alvin Lin --- docs/api/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/_index.md b/docs/api/_index.md index c1640aecf28..a4572059cf0 100644 --- a/docs/api/_index.md +++ b/docs/api/_index.md @@ -39,7 +39,7 @@ For the sake of clarity, in this document we have grouped API endpoints by servi | [Get label values](#get-label-values) | Querier, Query-frontend || `GET /api/v1/label/{name}/values` | | [Get metric metadata](#get-metric-metadata) | Querier, Query-frontend || `GET /api/v1/metadata` | | [Remote read](#remote-read) | Querier, Query-frontend || `POST /api/v1/read` | -| [Build information](#build-information) | Querier, Query-frontend |v1.15.0| `GET /api/v1/status/buildinfo` | +| [Build information](#build-information) | Querier, Query-frontend |v1.15.0| `GET /api/v1/status/buildinfo` | | [Get tenant ingestion stats](#get-tenant-ingestion-stats) | Querier || `GET /api/v1/user_stats` | | [Ruler ring status](#ruler-ring-status) | Ruler || `GET /ruler/ring` | | [Ruler rules ](#ruler-rule-groups) | Ruler || `GET /ruler/rule_groups` |