improve grafana configuration steps #5795

prushh · 2023-12-14T16:35:39Z

Proposed Changes

Improve configuration steps for Grafana dashboards based on Fix grafana_dashboard value to automate JSON import knative-extensions/monitoring#25

netlify · 2023-12-14T16:35:45Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`b8d6af8`
🔍 Latest deploy log	https://app.netlify.com/sites/knative/deploys/658577bdb418e40008376c83
😎 Deploy Preview	https://deploy-preview-5795--knative.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

prushh · 2023-12-14T16:39:46Z

docs/snippets/collecting-metrics.md

+        ```
+        If you have an existing configmaps check the value of `grafana_dashboard` label. In case this is `true`, add the `labelValue: true` attribute to the helm chart above.
+        ```bash
+        kubectl -n knative-serving get configmaps/knative-serving-dashboards -o jsonpath="{.metadata.labels.grafana_dashboard}"; echo


How can I adapt namespace and cm name based on the selected section? (Serving/Eventing)

Let's omit this part about printing that value. Also let's be specific where to add the value. eg after searchNamespace: ALL.

ReToCode · 2023-12-15T06:51:39Z

/assign @skonto

docs/snippets/collecting-metrics.md

skonto · 2023-12-19T14:50:08Z

docs/snippets/collecting-metrics.md

+              enabled: true
+              searchNamespace: ALL
+        ```
+        If you have an existing configmaps check the value of `grafana_dashboard` label. In case this is `true`, add the `labelValue: true` attribute to the helm chart above.


s/configmaps/configmap

skonto · 2023-12-19T14:53:11Z

docs/snippets/collecting-metrics.md

+    password: prom-operator
+    ```
+
+    !!! tip


Although this might be useful if password changes etc (I know I mentioned it on the other PR), let's omit it for now as it seems a bit not that Knative related, we are going a bit too far. I think it belongs at the Prometheus operator side.
In general it would be nice if we could point to a doc page for the Prometheus operator for all these details.

I can try to find one that suits us!

I did some research, and in my opinion the most useful link is https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/README.md (in particular the Configuration section).

There is also a Further Information section where they linked external resources like Prometheus Operator, Prometheus and Grafana.

What do you think?

We could add a pointer to that instead of the tip, but it does not say much about credentials and not sure if it is going to help a novice. So for now let's not add anything, remove the tip and in the future we can always revise it.

Done with the latest commit 😄

skonto · 2023-12-20T12:05:57Z

docs/snippets/collecting-metrics.md

-1. Grafana dashboards can be imported from the [`knative-extensions` repository](https://github.com/knative-extensions/monitoring/tree/main/grafana).
+### Access the Prometheus instance locally
+
+By default, the Prometheus instance is only exposed on a private service named `prometheus-operated`.


s/prometheus-operated/prometheus-kube-prometheus-prometheus

skonto · 2023-12-20T13:18:59Z

docs/snippets/collecting-metrics.md

+
+1. Access the console in your browser via `http://localhost:9090`.
+
+### Setting up Grafana


nit: Setting up Grafana dashboards? 🤔
Otherwise it seems like we are installing Grafana, maybe the top level title should be: "Setting up the Prometheus Stack" and mention that it includes Grafana by default.

Describe kube-prometheus-stack and components

skonto · 2023-12-21T07:59:03Z

docs/snippets/collecting-metrics.md


-[Prometheus](https://prometheus.io/) is an open-source tool for collecting,
-aggregating timeseries metrics and alerting. It can also be used to scrape the OpenTelemetry Collector that is demonstrated below when Prometheus is used.
+[Prometheus Stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) is a preconfigured collection of Kubernetes manifests, Grafana dashboards, and Prometheus rules, combined to provide end-to-end Kubernetes cluster monitoring with Prometheus using the Prometheus Operator. The stack includes by default some Prometheus packages and Grafana.


nit: Let's put this after Prometheus and Grafana bellow.

The section titles are okay? I'm not sure about Import Grafana dashboard

Let's move "Import Grafana dashboards" after "Access the Grafana instance locally". These should be at the same level.

skonto · 2023-12-22T08:17:25Z

docs/snippets/collecting-metrics.md


-By default, the Prometheus instance is only exposed on a private service named `prometheus-operated`.
+#### Access the Grafana instance locally


This should be one level up, ###

skonto · 2024-01-05T13:20:14Z

@prushh thank you!
/lgtm
/approve

knative-prow · 2024-01-05T13:20:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: prushh, skonto

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:

~~OWNERS~~ [skonto]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* improve grafana configuration steps * update metrics documentation * fix prometheus svc name * fix section titles Describe kube-prometheus-stack and components * fix prometheus stack sections order * fix grafana sections order and level

improve grafana configuration steps

8e655b1

knative-prow bot requested review from skonto and snneji December 14, 2023 16:35

knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 14, 2023

prushh commented Dec 14, 2023

View reviewed changes

knative-prow bot assigned skonto Dec 15, 2023

skonto reviewed Dec 19, 2023

View reviewed changes

docs/snippets/collecting-metrics.md Outdated Show resolved Hide resolved

skonto reviewed Dec 19, 2023

View reviewed changes

update metrics documentation

6827f1a

skonto reviewed Dec 20, 2023

View reviewed changes

fix prometheus svc name

036680f

skonto reviewed Dec 20, 2023

View reviewed changes

fix section titles

c5a3d1b

Describe kube-prometheus-stack and components

skonto reviewed Dec 21, 2023

View reviewed changes

fix prometheus stack sections order

9f59f97

skonto reviewed Dec 22, 2023

View reviewed changes

fix grafana sections order and level

b8d6af8

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jan 5, 2024

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 5, 2024

knative-prow bot merged commit 6630e4b into knative:main Jan 5, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve grafana configuration steps #5795

improve grafana configuration steps #5795

prushh commented Dec 14, 2023

netlify bot commented Dec 14, 2023 •

edited

Loading

prushh Dec 14, 2023

skonto Dec 19, 2023

ReToCode commented Dec 15, 2023

skonto Dec 19, 2023

skonto Dec 19, 2023 •

edited

Loading

prushh Dec 19, 2023

prushh Dec 20, 2023

skonto Dec 20, 2023

prushh Dec 20, 2023

skonto Dec 20, 2023

prushh Dec 20, 2023

skonto Dec 20, 2023 •

edited

Loading

skonto Dec 21, 2023 •

edited

Loading

prushh Dec 21, 2023

skonto Dec 22, 2023

skonto Dec 22, 2023

skonto commented Jan 5, 2024

knative-prow bot commented Jan 5, 2024


		1. Access the console in your browser via `http://localhost:9090`.

		### Setting up Grafana


		By default, the Prometheus instance is only exposed on a private service named `prometheus-operated`.
		#### Access the Grafana instance locally

improve grafana configuration steps #5795

improve grafana configuration steps #5795

Conversation

prushh commented Dec 14, 2023

Proposed Changes

netlify bot commented Dec 14, 2023 • edited Loading

✅ Deploy Preview for knative ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ReToCode commented Dec 15, 2023

Choose a reason for hiding this comment

skonto Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skonto Dec 20, 2023 • edited Loading

Choose a reason for hiding this comment

skonto Dec 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skonto commented Jan 5, 2024

knative-prow bot commented Jan 5, 2024

netlify bot commented Dec 14, 2023 •

edited

Loading

skonto Dec 19, 2023 •

edited

Loading

skonto Dec 20, 2023 •

edited

Loading

skonto Dec 21, 2023 •

edited

Loading