Update metrics documentation #4138
Conversation
|
✔️ Deploy Preview for knative ready! 🔨 Explore the source changes: 89a9332 🔍 Inspect the deploy log: https://app.netlify.com/sites/knative/deploys/617154b40deec800070bfaba 😎 Browse the preview: https://deploy-preview-4138--knative.netlify.app/development/admin/observability/collecting-metrics/collecting-metrics |
knative-prow-robot
added
the
size/M
|
/hold pending knative-extensions/monitoring#9 |
knative-prow-robot
added
do-not-merge/hold
abrennan89
added
kind/observability
triage/needs-eng-input
| @@ -18,6 +59,9 @@ In the following example, you can configure a single collector instance using a | |||
|
|
|||
| !!! tip | |||
| For more complex deployments, you can automate some of these steps by using the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator). | |||
|
|
|||
| !!! caution | |||
| The Grafana dashboards at https://github.com/knative-sandbox/monitoring/tree/main/grafana don't work with metrics scraped from OpenTelemetry Collector. | |||
There was a problem hiding this comment.
We should provide this at some point to complete the story.
There was a problem hiding this comment.
There is an issue for this. knative/pkg#2174
There was a problem hiding this comment.
Once the metrics are identical, this will be solved
| ```bash | ||
| kubectl apply -f https://raw.githubusercontent.com/knative-sandbox/monitoring/main/servicemonitor.yaml | ||
| ``` | ||
| 1. Grafana dashboards can be imported from https://github.com/knative-sandbox/monitoring/tree/main/grafana. |
There was a problem hiding this comment.
Could you elaborate more on this (a few screen shots could help I guess). User has to copy for example the content from https://raw.githubusercontent.com/knative-sandbox/monitoring/main/grafana/knative-control-plane-efficiency.json and import it. Do we plan to publish these at grafana.com so we can import them via a url?
There was a problem hiding this comment.
I have reworked this now.
https://github.com/knative-sandbox/monitoring/pull/9/files
I added grafana/dashboards.yaml file.
| ## About Prometheus | ||
|
|
||
| [Prometheus](https://prometheus.io/) is an open-source tool for collecting and | ||
| aggregating timeseries metrics. It can be used to scrape the OpenTelemetry collector that you created in the previous step. |
There was a problem hiding this comment.
... or its main usage is as a standalone monitoring and alerting system. Here Prometheus is described as a complement of OTEL which is not really the case.
|
@upodroid thanks for adding this part it is important for the getting started UX of Knative Observability. I tested it locally on Minikube. I left a few comments about UX mainly. Let's make it as smooth as possible. |
|
@upodroid gentle ping. |
|
I'll have this ready by the end of the day, i'm retesting the PR in the monitoring repo now. |
knative-prow-robot
added
size/L
|
@upodroid just a few minor ones. Thanks for the updates! |
|
@upodroid let's rebase. |
knative-prow-robot
added
the
needs-rebase
|
@abrennan89 @upodroid let's get this merged once rebased. I run the PR locally renders fine. /lgtm. |
knative-prow-robot
removed
the
needs-rebase
|
This is ready now |
Does it matter that this isn't merged yet? |
|
It shouldn't as long as we merge it before v1 is cut at the end of the month. @dprotaso should be back on Monday the 25th to merge it. |
|
/unhold |
knative-prow-robot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, upodroid The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
knative-prow-robot
added
the
approved
|
The monitoring PR is merged. |
|
Thank you @upodroid! Great job! |
Fixes: #2931
Proposed Changes