update metrics ingestion doc #2538
Merged
Conversation
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
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Quentin Bisson <[email protected]>
| @@ -68,14 +68,14 @@ spec: | |||
|
|
|||
| No matter if you are using Helm Charts or GitOps and Kustomize, just put the ServiceMonitor CR next to your app and apply it in the same way. Once it's applied you can check either the _ServiceMonitors Overview_ or _ServiceMonitors Details_ dashboards, or just search for the new metrics ingested in your installation's Grafana to make sure that your containers are being scraped by the new monitoring agents. | |||
|
|
|||
| __Warning:__ The ServiceMonitor needs to be labeled with `application.giantswarm.io/team: <YOUR-TEAM-NAME>` for the metrics agent to be able to discover it and start collecting metrics. | |||
| __Warning:__ The ServiceMonitor needs to be labeled with `observability.giantswarm.io/tenant: <YOUR-TENANT-NAME>` for the metrics agent to be able to discover it and start collecting metrics. | |||
There was a problem hiding this comment.
We also need a warning to explain that the tenant needs to be in a grafana organization right?
There was a problem hiding this comment.
That's done. WDYT ?
| @@ -68,14 +68,14 @@ spec: | |||
|
|
|||
| No matter if you are using Helm Charts or GitOps and Kustomize, just put the ServiceMonitor CR next to your app and apply it in the same way. Once it's applied you can check either the _ServiceMonitors Overview_ or _ServiceMonitors Details_ dashboards, or just search for the new metrics ingested in your installation's Grafana to make sure that your containers are being scraped by the new monitoring agents. | |||
|
|
|||
| __Warning:__ The ServiceMonitor needs to be labeled with `application.giantswarm.io/team: <YOUR-TEAM-NAME>` for the metrics agent to be able to discover it and start collecting metrics. | |||
| __Warning:__ The ServiceMonitor needs to be labeled with `observability.giantswarm.io/tenant: <YOUR-TENANT-NAME>` for the metrics agent to be able to discover it and start collecting metrics. | |||
|
|
|||
| ## ServiceMonitor vs. PodMonitor | |||
|
|
|||
| In most cases, a ServiceMonitor should cover most of your monitoring use cases but it can happen on rare occasions that a container doesn't need a service to run and it doesn't make sense to create one just for the sake of monitoring it. That's when the PodMonitor comes into action. You can find a few other examples where PodMonitor makes sense [in this discussion](https://github.com/prometheus-operator/prometheus-operator/issues/3119) in the Prometheus Operator Project. | |||
There was a problem hiding this comment.
And I think we need to add a link to the podlogs?
There was a problem hiding this comment.
I saw that in the issue but I'm not sure what link we're trying to make between those 2
There was a problem hiding this comment.
I think the goal is more for navigation purposes, like if you want to also collect logs, go there kind of thing
|
Great work @QuantumEnigmaa @Rotfuks you might want to take a look once you're done with your exam :) |
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
…dex.md Co-authored-by: Quentin Bisson <[email protected]>
|
|
||
| As we now support multi-tenancy for metrics, you __need__ to attribute a tenant name to your servicemonitors and podmonitors to have those routed to the adequate tenant. This means that you will have to replace the `application.giantswarm.io/team: <YOUR-TEAM-NAME>` label by the `observability.giantswarm.io/tenant: <YOUR-TENANT-NAME>` one. | ||
|
|
||
| For now, servicemonitors and podmonitors that only have the `application.giantswarm.io/team` label are routed to the "Giant Swarm" tenant by default. |
There was a problem hiding this comment.
@pipo02mix where can we add service and podmonitors so vale accepts them?
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
|
LGTM but I'll let @Rotfuks give the green button because I know he has thoughts :) |
…dex.md Co-authored-by: Quentin Bisson <[email protected]>
Rotfuks
reviewed
Mar 24, 2025
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
src/content/tutorials/observability/data-ingestion/metrics/_index.md
Outdated
Show resolved
Hide resolved
…dex.md Co-authored-by: Dominik Kress <[email protected]>
…dex.md Co-authored-by: Dominik Kress <[email protected]>
…dex.md Co-authored-by: Dominik Kress <[email protected]>
QuentinBisson
approved these changes
Mar 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it
Towards giantswarm/roadmap#3938
Things to check/remember before submitting
last_review_datein the front matter header of the pages you've touched.