IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Prometheus: Metrics explorer add docs and image (#69965)

Browse Source 
* add docs and image

* update spelling and image

* titles are in sentence case

* run checks

* add text to differentiate the metrics explorer and the metrics browser

* spelling

* capitalize Prometheus

Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>

* code mode code style

Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>

* remove metric select option image tag

* caps for Prometheus

---------

Co-authored-by: lwandz13 <larissa.wandzura@grafana.com>
Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>
This commit is contained in:
Brendan O'Handley 2023-06-29 10:54:08 -04:00 committed by GitHub
parent 59be79b5f4
commit 8cc8834407
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sources/datasources/prometheus/query-editor/index.md
View File

@ -126,6 +126,24 @@ When you are ready to create a query, you can choose the specific metric name fr
The data source requests the list of available metrics from the Prometheus server based on the selected time rage.
You can also enter text into the selector when the dropdown is open to search and filter the list.
#### Metrics explorer
{{< figure src="/static/img/docs/prometheus/screenshot-grafana-prometheus-metrics-explorer-2.png" max-width="500px" class="docs-image--no-shadow" caption="Metrics explorer" >}}
If you would like to explore your metrics in the query builder further, you can open the **Metrics Explorer** by clicking the first option in the metric select component of the query builder.
The metrics explorer is different than the metrics browser. The metrics explorer is only found in the query builder section. The metrics browser is only found in the code editor. The metrics explorer does not have the ability to browse labels yet, but the metrics browser can display all labels on a metric name.
The metrics explorer displays all metrics in a paginated table list. The list shows the total number of metrics, as well as the name, type and description for each metric. You can enter text into the search input to filter results.
You can also filter by type.
There are also additional settings for the following items:
- Include description in search. Search by name **and** description
- Include results with no metadata. Many Prometheus metrics have no metadata. This allows users to include metrics with undefined type and description.
- Disable text wrap.
- Enable regex search. This uses the Prometheus API to enable regex search for the metric name.
### Label filters
Select desired labels and their values from the dropdown list.
@ -184,7 +202,7 @@ The autocompletion dropdown includes documentation for the suggested items where
### Metrics browser
The metrics browser locates metrics and selects relevant labels to help you build basic queries.
When you click **Metrics browser**, it displays all available metrics and labels.
When you click **Metrics browser** in `Code` mode, it displays all available metrics and labels.
If supported by your Prometheus instance, each metric also displays its `HELP` and `TYPE` as a tooltip.
{{< figure src="/static/img/docs/prometheus/metric-browser.png" max-width="500px" class="docs-image--no-shadow" caption="Metrics browser" >}}