diff --git a/menu/navigation.json b/menu/navigation.json index e347a21d35..b9244d4c7d 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -3849,6 +3849,10 @@ { "label": "Cockpit capabilities and limits", "slug": "cockpit-limitations" + }, + { + "label": "Cockpit supported API endpoints for data source management", + "slug": "cockpit-supported-endpoints" } ], "label": "Additional Content", diff --git a/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx b/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx new file mode 100644 index 0000000000..2c245a01b0 --- /dev/null +++ b/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx @@ -0,0 +1,169 @@ +--- +meta: + title: Cockpit supported API endpoints for data source management + description: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir, Loki, Tempo and Prometheus endpoints +content: + h1: Cockpit supported API endpoints for data source management + paragraph: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir, Loki, Tempo and Prometheus endpoints +tags: observability cockpit endpoints mimir loki telemetry prometheus tempo datasource-management +dates: + validation: 2025-05-05 + posted: 2025-05-05 +categories: + - observability +--- + +Cockpit supports telemetry ingestion and querying using the following open-source technologies: + +- [Mimir](https://grafana.com/oss/mimir/) for metrics +- [Loki](https://grafana.com/oss/loki/) for logs +- [Tempo](https://grafana.com/oss/tempo/) for traces +- [Prometheus](https://prometheus.io/docs/alerting/latest/alertmanager/) for the alert manager + +Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage telemetry data from Cockpit. + + + Scaleway does not support all endpoints from these upstream APIs. Refer to the exact lists below to find out which endpoints are supported. + + + + + - A Scaleway account logged into the [console](https://console.scaleway.com) + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization or Project + - [Created](/cockpit/how-to/create-token/) a Cockpit token with the right [permissions](/cockpit/concepts/#cockpit-tokens) + - Retrieved the URL of your data source from the [Scaleway console](https://console.scaleway.com/cockpit/dataSource) or the [API](https://www.scaleway.com/en/developers/api/cockpit/regional-api/#path-data-sources-list-data-sources) + +## Mimir supported endpoints (metrics) + +The base URL pattern for metrics is the following: `https://.metrics.cockpit..scw.cloud`. You must replace `` with the ID of your data source and `` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). + +Refer to the [official Mimir documentation](https://grafana.com/docs/mimir/latest/references/http-api/) for more details about the endpoints below. + + + ## Mimir write endpoints + + Method: `POST`. + + - Path: `/api/v1/push` + - Path: `/otlp/v1/metrics` + + + + ## Mimir query endpoints + + Methods: `GET` and `POST`. + + - Path: `/prometheus/api/v1/query` + - Path: `/prometheus/api/v1/query_range` + - Path: `/prometheus/api/v1/query_exemplars` + - Path: `/prometheus/api/v1/series` + - Path: `/prometheus/api/v1/labels` + - Path: `/prometheus/api/v1/label/*` + - Path: `/prometheus/api/v1/metadata` + - Path: `/prometheus/api/v1/read` + - Path: `/prometheus/api/v1/status/buildinfo` + + + + ## Mimir rules endpoints + + Methods: `GET`, `POST`, and `DELETE`. + + - Path: `/prometheus/api/v1/rules` + - Path: `/prometheus/api/v1/alerts` + - Path: `/prometheus/config/v1/rules` + - Path: `/prometheus/config/v1/rules/*` + + + +## Loki supported endpoints (logs) + +The base URL pattern for logs is the following: `https://.logs.cockpit..scw.cloud`. You must replace `` with the ID of your data source and `` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). + +Refer to the [official Loki documentation](https://grafana.com/docs/loki/latest/reference/loki-http-api/) for more details about the endpoints below. + + + ## Loki write endpoints + + Method: `POST`. + + - Path: `/loki/api/v1/push` + - Path: `/otlp/v1/logs` + + + + ## Loki query endpoints + + Methods: `GET` and `POST`. + + - Path: `/loki/api/v1/query` + - Path: `/loki/api/v1/query_range` + - Path: `/loki/api/v1/labels` + - Path: `/loki/api/v1/label` + - Path: `/loki/api/v1/label/*` + - Path: `/loki/api/v1/tail` + - Path: `/loki/api/v1/series` + + + + ## Loki rules endpoints + + Methods: `GET`, `POST`, and `DELETE`. + + - Path: `/loki/api/v1/rules` + - Path: `/loki/api/v1/rules/*` + - Path: `/api/prom/rules` + - Path: `/api/prom/rules/*` + - Path: `/prometheus/api/v1/rules` + - Path: `/prometheus/api/v1/alerts` + + +## Tempo supported endpoints (traces) + +The base URL pattern for traces is the following: `https://.traces.cockpit..scw.cloud`. You must replace `` with the ID of your data source and `` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). + +Refer to the [official Tempo documentation](https://grafana.com/docs/tempo/latest/api_docs/) for more details about the endpoints below. + + + ## Tempo write endpoints + + Method: `POST`. + + - Path: `/otlp/v1/traces` + - Path: `/opentelemetry.proto.collector.trace.v1.TraceService/Export` + - Path: `/jaeger` + - Path: `/zipkin` + + + + ## Tempo query endpoints + + Method: `GET`. + + - Path: `/api/echo` + - Path: `/api/traces/*` + - Path: `/api/search` + - Path: `/api/search/tags` + - Path: `/api/v2/search/tags` + - Path: `/api/search/tag/*/values` + - Path: `/api/v2/search/tag/*/values` + + +## Prometheus alert manager supported endpoints + +The base URL pattern for the alert manager is the following: `https://.alertmanager.cockpit..scw.cloud`. You must replace `` with the ID of your alert manager and `` with the region where the alert manager is enabled (`fr-par`, `nl-ams`, or `pl-waw`). + +Refer to the [official Prometheus alert manager documentation](https://prometheus.io/docs/prometheus/latest/querying/api/#alerts) for more details about the endpoints below. + + + You must use the [Cockpit API](https://www.scaleway.com/en/developers/api/cockpit/regional-api/#path-alert-manager-get-the-alert-manager) to retrieve the ID of the alert manager. + + + + ## Alert manager endpoints + + Methods: `GET`, `POST`, and `DELETE`. + + - Path: `/alertmanager/*` + - Path: `/api/v1/alerts` + \ No newline at end of file