-
Notifications
You must be signed in to change notification settings - Fork 258
docs(cockpit): add supported API endpoints for data source management #4895
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
169 changes: 169 additions & 0 deletions
169
pages/cockpit/reference-content/cockpit-supported-endpoints.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
| <Message type="important"> | ||
| Scaleway does not support all endpoints from these upstream APIs. Refer to the exact lists below to find out which endpoints are supported. | ||
| </Message> | ||
|
|
||
| <Macro id="requirements" /> | ||
|
|
||
| - 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://<data-source-id>.metrics.cockpit.<region>.scw.cloud`. You must replace `<data-source-id>` with the ID of your data source and `<region>` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). | ||
|
|
||
nerda-codes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Refer to the [official Mimir documentation](https://grafana.com/docs/mimir/latest/references/http-api/) for more details about the endpoints below. | ||
|
|
||
| <Concept> | ||
| ## Mimir write endpoints | ||
|
|
||
| Method: `POST`. | ||
|
|
||
| - Path: `/api/v1/push` | ||
| - Path: `/otlp/v1/metrics` | ||
| </Concept> | ||
|
|
||
| <Concept> | ||
| ## 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` | ||
| </Concept> | ||
|
|
||
| <Concept> | ||
| ## 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/*` | ||
| </Concept> | ||
|
|
||
|
|
||
| ## Loki supported endpoints (logs) | ||
|
|
||
| The base URL pattern for logs is the following: `https://<data-source-id>.logs.cockpit.<region>.scw.cloud`. You must replace `<data-source-id>` with the ID of your data source and `<region>` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). | ||
|
|
||
nerda-codes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Refer to the [official Loki documentation](https://grafana.com/docs/loki/latest/reference/loki-http-api/) for more details about the endpoints below. | ||
|
|
||
| <Concept> | ||
| ## Loki write endpoints | ||
|
|
||
| Method: `POST`. | ||
|
|
||
| - Path: `/loki/api/v1/push` | ||
| - Path: `/otlp/v1/logs` | ||
| </Concept> | ||
|
|
||
| <Concept> | ||
| ## 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` | ||
| </Concept> | ||
|
|
||
| <Concept> | ||
| ## 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` | ||
| </Concept> | ||
|
|
||
| ## Tempo supported endpoints (traces) | ||
|
|
||
| The base URL pattern for traces is the following: `https://<data-source-id>.traces.cockpit.<region>.scw.cloud`. You must replace `<data-source-id>` with the ID of your data source and `<region>` with the region where your data source is located (`fr-par`, `nl-ams`, or `pl-waw`). | ||
|
|
||
nerda-codes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Refer to the [official Tempo documentation](https://grafana.com/docs/tempo/latest/api_docs/) for more details about the endpoints below. | ||
|
|
||
| <Concept> | ||
| ## Tempo write endpoints | ||
|
|
||
| Method: `POST`. | ||
|
|
||
| - Path: `/otlp/v1/traces` | ||
| - Path: `/opentelemetry.proto.collector.trace.v1.TraceService/Export` | ||
| - Path: `/jaeger` | ||
| - Path: `/zipkin` | ||
| </Concept> | ||
|
|
||
| <Concept> | ||
| ## 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` | ||
| </Concept> | ||
|
|
||
| ## Prometheus alert manager supported endpoints | ||
|
|
||
| The base URL pattern for the alert manager is the following: `https://<alert-manager-id>.alertmanager.cockpit.<region>.scw.cloud`. You must replace `<alert-manager-id>` with the ID of your alert manager and `<region>` 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. | ||
|
|
||
nerda-codes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <Message type="important"> | ||
| 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. | ||
| </Message> | ||
|
|
||
| <Concept> | ||
| ## Alert manager endpoints | ||
|
|
||
| Methods: `GET`, `POST`, and `DELETE`. | ||
|
|
||
| - Path: `/alertmanager/*` | ||
| - Path: `/api/v1/alerts` | ||
| </Concept> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.