mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 01:02:10 +08:00
0961de396e
* docs>getting-started>prometheus * get started page highlight * spelling * formatting * drilldown instead of explore * node_exporter spelling bypass * spelling bypass * metrics support * typo * all pretty, no pity * applied suggestions * all pretty, no pity2
218 lines
11 KiB
Markdown
218 lines
11 KiB
Markdown
---
|
||
aliases:
|
||
- ../data-sources/prometheus/
|
||
- ../features/datasources/prometheus/
|
||
description: Guide for using Prometheus in Grafana
|
||
keywords:
|
||
- grafana
|
||
- prometheus
|
||
- guide
|
||
labels:
|
||
products:
|
||
- cloud
|
||
- enterprise
|
||
- oss
|
||
menuTitle: Prometheus
|
||
title: Prometheus data source
|
||
weight: 1300
|
||
refs:
|
||
build-dashboards:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/build-dashboards/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/build-dashboards/
|
||
get-started-prometheus:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/getting-started/get-started-grafana-prometheus/#get-started-with-grafana-and-prometheus
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/getting-started/get-started-grafana-prometheus/#get-started-with-grafana-and-prometheus
|
||
configure-grafana-configuration-file-location:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#configuration-file-location
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#configuration-file-location
|
||
provisioning-data-sources:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/provisioning/#data-sources
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/provisioning/#data-sources
|
||
explore:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/explore/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/explore/
|
||
set-up-grafana-monitoring:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/set-up-grafana-monitoring/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/set-up-grafana-monitoring/
|
||
configure-grafana:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/
|
||
administration-documentation:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/
|
||
annotate-visualizations:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/build-dashboards/annotate-visualizations/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana-cloud/visualizations/dashboards/build-dashboards/annotate-visualizations/
|
||
exemplars:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/fundamentals/exemplars/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/fundamentals/exemplars/
|
||
intro-to-prometheus:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/fundamentals/intro-to-prometheus/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/fundamentals/intro-to-prometheus/
|
||
configure-prometheus-data-source:
|
||
- pattern: /docs/grafana/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/datasources/prometheus/configure-prometheus-data-source/
|
||
- pattern: /docs/grafana-cloud/
|
||
destination: /docs/grafana/<GRAFANA_VERSION>/datasources/prometheus/configure-prometheus-data-source/
|
||
---
|
||
|
||
# Prometheus data source
|
||
|
||
Prometheus is an open source database that uses a telemetry collector agent to scrape and store metrics used for monitoring and alerting. Grafana provides native support for Prometheus. If you are just getting started with Prometheus, see [What is Prometheus?](ref:intro-to-prometheus).
|
||
|
||
{{% admonition type="tip" %}}
|
||
For instructions on downloading Prometheus see [Get started with Grafana and Prometheus](ref:get-started-prometheus).
|
||
|
||
If you’re ready to start visualizing your metrics, check out our Prometheus Learning Journeys:
|
||
|
||
- [Connect to a Prometheus data source in Grafana Cloud](https://www.grafana.com/docs/learning-journeys/prometheus/) to visualize your metrics directly from where they are stored.
|
||
- [Send metrics to Grafana Cloud using Prometheus remote write](https://www.grafana.com/docs/learning-journeys/prom-remote-write/) to explore Grafana Cloud without making significant changes to your existing configuration.
|
||
{{% /admonition %}}
|
||
|
||
For instructions on how to add a data source to Grafana, refer to the [administration documentation](ref:administration-documentation).
|
||
Only users with the organization `administrator` role can add data sources and edit existing data sources.
|
||
Administrators can also [configure the data source via YAML](#provision-the-data-source) with Grafana's provisioning system.
|
||
|
||
Once you've added the Prometheus data source, you can [configure it](ref:configure-prometheus-data-source) so that your Grafana instance's users can create queries in its [query editor](query-editor/) when they [build dashboards](ref:build-dashboards), use [Explore](ref:explore), and [annotate visualizations](ref:annotate-visualizations).
|
||
|
||
The following guides will help you get started with the Prometheus data source:
|
||
|
||
- [Configure the Prometheus data source](ref:configure-prometheus-data-source)
|
||
- [Prometheus query editor](query-editor/)
|
||
- [Template variables](template-variables/)
|
||
|
||
## Prometheus API
|
||
|
||
The Prometheus data source also works with other projects that implement the [Prometheus querying API](https://prometheus.io/docs/prometheus/latest/querying/api/).
|
||
|
||
For more information on how to query other Prometheus-compatible projects from Grafana, refer to the specific project's documentation:
|
||
|
||
- [Grafana Mimir](/docs/mimir/latest/)
|
||
- [Thanos](https://thanos.io/tip/components/query.md/)
|
||
|
||
## Provision the data source
|
||
|
||
You can define and configure the data source in YAML files as part of Grafana's provisioning system.
|
||
For more information about provisioning, and for available configuration options, refer to [Provisioning Grafana](ref:provisioning-data-sources).
|
||
|
||
{{% admonition type="note" %}}
|
||
Once you have provisioned a data source you cannot edit it.
|
||
{{% /admonition %}}
|
||
|
||
### Provisioning example
|
||
|
||
```yaml
|
||
apiVersion: 1
|
||
|
||
datasources:
|
||
- name: Prometheus
|
||
type: prometheus
|
||
access: proxy
|
||
# Access mode - proxy (server in the UI) or direct (browser in the UI).
|
||
url: http://localhost:9090
|
||
jsonData:
|
||
httpMethod: POST
|
||
manageAlerts: true
|
||
prometheusType: Prometheus
|
||
prometheusVersion: 2.44.0
|
||
cacheLevel: 'High'
|
||
disableRecordingRules: false
|
||
incrementalQueryOverlapWindow: 10m
|
||
exemplarTraceIdDestinations:
|
||
# Field with internal link pointing to data source in Grafana.
|
||
# datasourceUid value can be anything, but it should be unique across all defined data source uids.
|
||
- datasourceUid: my_jaeger_uid
|
||
name: traceID
|
||
|
||
# Field with external link.
|
||
- name: traceID
|
||
url: 'http://localhost:3000/explore?orgId=1&left=%5B%22now-1h%22,%22now%22,%22Jaeger%22,%7B%22query%22:%22$${__value.raw}%22%7D%5D'
|
||
```
|
||
|
||
## View Grafana metrics with Prometheus
|
||
|
||
Grafana exposes metrics for Prometheus on the `/metrics` endpoint.
|
||
We also bundle a dashboard within Grafana so you can start viewing your metrics faster.
|
||
|
||
**To import the bundled dashboard:**
|
||
|
||
1. Navigate to the data source's [configuration page](ref:configure-prometheus-data-source).
|
||
1. Select the **Dashboards** tab.
|
||
|
||
This displays dashboards for Grafana and Prometheus.
|
||
|
||
1. Select **Import** for the dashboard to import.
|
||
|
||
For details about these metrics, refer to [Internal Grafana metrics](ref:set-up-grafana-monitoring).
|
||
|
||
## Amazon Managed Service for Prometheus
|
||
|
||
The Prometheus data source with Amazon Managed Service for Prometheus is deprecated. Please use the [Amazon Managed service for Prometheus data source](https://grafana.com/grafana/plugins/grafana-amazonprometheus-datasource/). Migrations steps are detailed in the link.
|
||
|
||
## Azure authentication settings
|
||
|
||
The Prometheus data source works with Azure authentication. To configure Azure authentication see [Configure Azure Active Directory (AD) authentication](/docs/grafana/latest/datasources/azure-monitor/#configure-azure-active-directory-ad-authentication).
|
||
|
||
In Grafana Enterprise, update the .ini configuration file: [Configure Grafana](ref:configure-grafana). Depending on your setup, the .ini file is located [here](ref:configure-grafana-configuration-file-location).
|
||
Add the following setting in the **[auth]** section :
|
||
|
||
```bash
|
||
[auth]
|
||
azure_auth_enabled = true
|
||
```
|
||
|
||
{{% admonition type="note" %}}
|
||
If you are using Azure authentication settings do not enable `Forward OAuth identity`. Both use the same HTTP authorization headers. Azure settings will get overwritten by the Oauth token.
|
||
{{% /admonition %}}
|
||
|
||
## Exemplars
|
||
|
||
Exemplars associate higher-cardinality metadata from a specific event with traditional time series data. See [Introduction to exemplars](ref:exemplars) in Prometheus documentation for detailed information on how they work.
|
||
|
||
{{% admonition type="note" %}}
|
||
Available in Prometheus v2.26 and higher with Grafana v7.4 and higher.
|
||
{{% /admonition %}}
|
||
|
||
Grafana can show exemplars data alongside a metric both in Explore and in Dashboards.
|
||
|
||
{{< figure src="/static/img/docs/v74/exemplars.png" class="docs-image--no-shadow" caption="Screenshot showing the detail window of an Exemplar" >}}
|
||
|
||
See the Exemplars section in [Configure Prometheus data source](ref:configure-prometheus-data-source).
|
||
|
||
{{< figure src="/static/img/docs/prometheus/exemplars-10-1.png" max-width="500px" class="docs-image--no-shadow" caption="Exemplars" >}}
|
||
|
||
## Incremental dashboard queries (beta)
|
||
|
||
As of Grafana 10, the Prometheus data source can be configured to query live dashboards incrementally, instead of re-querying the entire duration on each dashboard refresh.
|
||
|
||
This can be toggled on or off in the data source configuration or provisioning file (under `incrementalQuerying` in jsonData).
|
||
Additionally, the amount of overlap between incremental queries can be configured using the `incrementalQueryOverlapWindow` jsonData field, the default value is `10m` (10 minutes).
|
||
|
||
Increasing the duration of the `incrementalQueryOverlapWindow` will increase the size of every incremental query, but might be helpful for instances that have inconsistent results for recent data.
|
||
|
||
## Recording Rules (beta)
|
||
|
||
The Prometheus data source can be configured to disable recording rules under the data source configuration or provisioning file (under `disableRecordingRules` in jsonData).
|