Add a tutorial on creating a simple Grafana dashboard #5251
Conversation
This file contains 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
kazydek
added
area/documentation
kazydek
requested review from
bszwarc,
klaudiagrz,
majakurcius,
mmitoraj and
tomekpapiernik
as code owners
added 3 commits
August 8, 2019 05:47
mmitoraj
requested changes
Aug 8, 2019
|
|
||
|  | ||
|
|
||
| 5. Select the **Instant** query to be able to retrieve the last value for each time series. |
There was a problem hiding this comment.
Suggested change
| 5. Select the **Instant** query to be able to retrieve the last value for each time series. | |
| 5. Toggle the **Instant** query to be able to retrieve the last value for each time series. |
Just a suggestion to avoid Select. However, I don't understand the last part: "to be able to retrieve the last value for each time series."
There was a problem hiding this comment.
You are right, that's not too clear :) I will update it. The idea is that this option allows you to retrieve the "instant" data from the metric.
|
|
||
|  | ||
|
|
||
| 7. Save the changes by clicking the disk icon in the top right corner of the page. Provide a name for the dashboard. |
There was a problem hiding this comment.
Suggested change
| 7. Save the changes by clicking the disk icon in the top right corner of the page. Provide a name for the dashboard. | |
| 7. Click the disk icon in the top right corner of the page to save the changes. Provide a name for the dashboard. |
|
|
||
| ## Steps | ||
|
|
||
| Access the Grafana UI, select the `cpu_temperature_celsius` metric, the Gauge dashboard type, and start the configuration. |
There was a problem hiding this comment.
Suggested change
| Access the Grafana UI, select the `cpu_temperature_celsius` metric, the Gauge dashboard type, and start the configuration. | |
| Access the Grafana UI, select the `cpu_temperature_celsius` metric and the Gauge dashboard type, and start the configuration. |
or
Suggested change
| Access the Grafana UI, select the `cpu_temperature_celsius` metric, the Gauge dashboard type, and start the configuration. | |
| Follow these guidelines to access the Grafana UI and create, configure, and test a Gauge type dashboard for the `cpu_temperature_celsius` metric. |
🤔 still not perfect, what I mean is that not all the steps are mentioned in the section - testing is not (but it's actually only about refreshing the browser so maybe it’s not needed here).
There was a problem hiding this comment.
Hmm, I will think about improving that.
There was a problem hiding this comment.
is that ok? Follow these sections to create the Gauge dashboard type for the `cpu_temperature_celsius` metric.
|
|
||
| ### Create the dashboard | ||
|
|
||
| 1. Navigate to Grafana. It is available under the `https://grafana.{DOMAIN}` address, where `{DOMAIN}` is the domain of your Kyma cluster, such as `https://grafana.34.63.57.190.xip.io` or `https://grafana.nightly.a.build.kyma-project.io/`. You can also access it by clicking on **Stats & Metrics** on the left navigation menu in the Console UI. |
There was a problem hiding this comment.
Suggested change
| 1. Navigate to Grafana. It is available under the `https://grafana.{DOMAIN}` address, where `{DOMAIN}` is the domain of your Kyma cluster, such as `https://grafana.34.63.57.190.xip.io` or `https://grafana.nightly.a.build.kyma-project.io/`. You can also access it by clicking on **Stats & Metrics** on the left navigation menu in the Console UI. | |
| 1. Navigate to Grafana. It is available under the `https://grafana.{DOMAIN}` address, where `{DOMAIN}` is the domain of your Kyma cluster, such as `https://grafana.34.63.57.190.xip.io` or `https://grafana.nightly.a.build.kyma-project.io/`. To access it from the Console UI, click **Stats & Metrics** on the left navigation menu. |
|
|
||
|  | ||
|
|
||
| 4. Select Prometheus data source from the **Queries to** drop-down list and choose the `cpu_temperature_celsius` metric. |
There was a problem hiding this comment.
Suggested change
| 4. Select Prometheus data source from the **Queries to** drop-down list and choose the `cpu_temperature_celsius` metric. | |
| 4. Choose Prometheus data source from the **Queries to** drop-down list and pick the `cpu_temperature_celsius` metric. |
There was a problem hiding this comment.
I left "select" but I changed "choose" into "pick".
|
|
||
| ### Configure the dashboard | ||
|
|
||
| To edit the dashboard settings, click the **Panel Title** and select **Edit**. |
There was a problem hiding this comment.
Suggested change
| To edit the dashboard settings, click the **Panel Title** and select **Edit**. | |
| To edit the dashboard settings, click the **Panel Title** button and select **Edit**. |
or
Suggested change
| To edit the dashboard settings, click the **Panel Title** and select **Edit**. | |
| To edit the dashboard settings, go to the **Panel Title** options and select **Edit**. |
|
|
||
|  | ||
|
|
||
| 5. Save the changes by clicking the disk icon in the top right corner of the page. Add an optional note to describe the changes made. |
There was a problem hiding this comment.
Suggested change
| 5. Save the changes by clicking the disk icon in the top right corner of the page. Add an optional note to describe the changes made. | |
| 5. Click the disk icon in the top right corner of the page to save the changes. Add an optional note to describe the changes made. |
mmitoraj
approved these changes
Aug 8, 2019
kazydek
requested review from
aerfio,
akucharska,
m00g3n,
magicmatatjahu,
hudymi and
pkosiec
as code owners
hudymi
approved these changes
Aug 8, 2019
|
|
||
| ### Create the dashboard | ||
|
|
||
| 1. Navigate to Grafana. It is available under the `https://grafana.{DOMAIN}` address, where `{DOMAIN}` is the domain of your Kyma cluster, such as `https://grafana.34.63.57.190.xip.io` or `https://grafana.nightly.a.build.kyma-project.io/`. To access it from the Console UI, click **Stats & Metrics** on the left navigation menu. |
There was a problem hiding this comment.
I'm not sure if we should mention nightly cluster in examples as it is not available for everyone.
There was a problem hiding this comment.
As discussed, I will change it into https://grafana.example.com/.
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.
Description
Changes proposed in this pull request:
Related issue(s)
See also #4884