docs(Cockpit): add new federation documentation for Cockpit - int-add-observability-federate-doc #5179
Conversation
…Cockpit datasource
| <Message type="important"> | ||
| The `/federate` endpoint will not be charged during beta phase but please note that after the beta, this endpoint will incurs additional costs. | ||
| For more information, you can check [this tutorial](../how-to/federate-scaleway-metrics.mdx) | ||
| </Message> |
There was a problem hiding this comment.
| <Message type="important"> | |
| The `/federate` endpoint will not be charged during beta phase but please note that after the beta, this endpoint will incurs additional costs. | |
| For more information, you can check [this tutorial](../how-to/federate-scaleway-metrics.mdx) | |
| </Message> | |
| <Message type="important"> | |
| The `/federate` endpoint will not be billed during the beta phase. After the beta, the endpoint will incur additional costs. | |
| Refer to the [How to federate metrics](/cockpit/how-to/federate-scaleway-metrics) documentation page for more information. | |
| </Message> |
There was a problem hiding this comment.
the /federate is not a mimir endpoint, and mimic the prometheus endpoint. Shall we split the list to keep it separate from other mimir endpoints with an introductory sentence saying that there is an additional endpoint we support ? There is a risk users will try to look into mimir documentations to have more information on that endpoint. Or (maybe lighter?) we can leave it in the list but explicitly say in the important banner that it's not a mimir endpoint and to refer to the How to federate metrics documentation page for more information on how to use this endpoint ?
| categories: | ||
| - observability | ||
| dates: | ||
| validation: TBD |
There was a problem hiding this comment.
Just a reminder to update the dates before publishing
| content: | ||
| h1: How to federate Scaleway metrics with your own Prometheus | ||
| paragraph: Learn how to retrieve the Scaleway product metrics with federation to re-use them within your own Prometheus using Scaleway's comprehensive guide. This tutorial covers retrieving your Scaleway product metrics by federation of your Cockpit datasources and retrieving those metrics within Prometheus. | ||
| tags: federation cockpit metrics observability monitoring prometheus |
There was a problem hiding this comment.
| tags: federation cockpit metrics observability monitoring prometheus | |
| tags: federation cockpit metrics prometheus |
There was a problem hiding this comment.
Since Cockpit is the Observability product and that federation is used to setup monitoring, don't you think we should keep these ?
Is it bad to have to many tags ?
| - observability | ||
| dates: | ||
| validation: TBD | ||
| posted: TBD |
| </Message> | ||
|
|
||
| <Message type="important"> | ||
| - Federating Scaleway product metrics is a billable feature. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information. |
There was a problem hiding this comment.
| - Federating Scaleway product metrics is a billable feature. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information. | |
| Federating Scaleway product metrics is a billable feature. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information. |
There was a problem hiding this comment.
I would remove this banner - we already have just above an info banner saying it's in beta and will eventually occur costs in the future. + there is no information yet in Cockpit's pricing page around this.
nerda-codes
added
the
do not merge
| <Message type="important"> | ||
| The `/federate` endpoint will not be charged during beta phase but please note that after the beta, this endpoint will incurs additional costs. | ||
| For more information, you can check [this tutorial](../how-to/federate-scaleway-metrics.mdx) | ||
| </Message> |
There was a problem hiding this comment.
the /federate is not a mimir endpoint, and mimic the prometheus endpoint. Shall we split the list to keep it separate from other mimir endpoints with an introductory sentence saying that there is an additional endpoint we support ? There is a risk users will try to look into mimir documentations to have more information on that endpoint. Or (maybe lighter?) we can leave it in the list but explicitly say in the important banner that it's not a mimir endpoint and to refer to the How to federate metrics documentation page for more information on how to use this endpoint ?
| - 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 | ||
| - [Created](/cockpit/how-to/create-token/) a Cockpit token with read access in the same region as the metrics data source | ||
| - [Created](/iam/how-to/create-api-keys/) an API key and retrieved your API secret key |
There was a problem hiding this comment.
why do you need an API key ? (only if we want to create the token from Scw API ?)
| </Message> | ||
|
|
||
| <Message type="important"> | ||
| - Federating Scaleway product metrics is a billable feature. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information. |
There was a problem hiding this comment.
I would remove this banner - we already have just above an info banner saying it's in beta and will eventually occur costs in the future. + there is no information yet in Cockpit's pricing page around this.
| <Message type="info"> | ||
| Please note that you should not include `https://` in the `SCW_DATASOURCE_URL` | ||
| </Message> | ||
|
|
There was a problem hiding this comment.
Shall we add a small explanatory paragraph on the scrape interval here ? explaining what it is and guidelines (> 1minutes, esp. if they're federating scw data that has 1 or 5mn intervals).
And if they scrape every minute a metric that is only available every 5minutes they will have repeated metric points no ? What happens in that case ?
There was a problem hiding this comment.
- what is the honor-labels: true param ? can we say what it does and what happens if they put true or false ?
| command: | ||
| - '--config.file=/etc/prometheus/prometheus.yml' | ||
| ``` | ||
| 2. Go to http://localhost:9090/targets and you should see your newly created target, federating your Scaleway product metrics |
There was a problem hiding this comment.
Shall we add a small paragraph explaining how they can monitor what they're exporting with this endpoint (check the volumes that go out in our Cockpit Grafana metrics explorer, say what metrics have that information). Maybe we can update the doc later, as this is not yet in our dashboard ...
| posted: TBD | ||
| --- | ||
|
|
||
| In this page, we will show you how to federate your Scaleway product metrics using the `/federate` endpoint of your Scaleway datasources with a [Prometheus](https://prometheus.io) configuration. |
There was a problem hiding this comment.
Maybe it would be nice to have one or two sentences explaining what federation is and what's the point of federating data ? to bring all your data together in a single prometheus data source ? or to downsample metrics (?) for longer retention.
Co-authored-by: ldecarvalho-doc <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: Jessica <[email protected]>
Co-authored-by: ldecarvalho-doc <[email protected]>
Co-authored-by: ldecarvalho-doc <[email protected]>
Your checklist for this pull request
Description
Add a new documentation "How-to" on how to federate Scaleway product metrics with the new /federate endpoint on Cockpit datasources.
Also add the endpoint in the
supported endpointdocumentation with precision about beta phase