Docs: Grafana internal metrics update (#23448)

* Update metrics.md * Updated metrics.md and configuration.md * Added links to data sources * Update metrics.md * Update docs/sources/administration/metrics.md Co-Authored-By: Carl Bergquist <carl@grafana.com> Co-authored-by: Carl Bergquist <carl@grafana.com> Co-authored-by: bergquist <carl.bergquist@gmail.com>
2020-04-17 07:37:09 -07:00
parent 97c5e2971d
commit 43fc6c3a17
4 changed files with 92 additions and 6 deletions
@@ -1,5 +1,5 @@
 +++
-title = "Internal metrics"
+title = "Internal Grafana metrics"
 description = "Internal metrics exposed by Grafana"
 keywords = ["grafana", "metrics", "internal metrics"]
 type = "docs"
@@ -8,8 +8,87 @@ parent = "admin"
 weight = 8
 +++

-# Internal metrics
+# Internal Grafana metrics

-Grafana collects some metrics about itself internally. Currently, Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus.
+Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus.

-To emit internal metrics you have to enable the option under the [metrics] section in your [grafana.ini](http://docs.grafana.org/installation/configuration/#enabled-6) config file. If you want to push metrics to Graphite, you must also configure the [metrics.graphite](http://docs.grafana.org/installation/configuration/#metrics-graphite) section.
+For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../installation/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../installation/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../installation/configuration.md" >}}).
+
+## Available metrics
+
+When enabled, Grafana exposes a number of metrics, including:
+
+* Active Grafana instances
+* Number of dashboards, users, and playlists
+* http status codes
+* Requests by routing group
+* Grafana active alerts
+* Grafana performance
+
+## Pull metrics from Grafana into Prometheus
+
+These instructions assume you have already added Prometheus as a data source in Grafana.
+
+1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: 
+
+   ```
+   # Metrics available at HTTP API Url /metrics
+   [metrics]
+   # Disable / Enable internal metrics
+   enabled           = true
+
+   # Disable total stats (stat_totals_*) metrics to be generated
+   disable_total_stats = false
+   ```
+
+1. (optional) If you want to require authorization to view the metrics endpoint, then uncomment and set the following options:
+
+   ```
+   basic_auth_username =
+   basic_auth_password =
+   ```
+
+1. Restart Grafana. Grafana now exposes metrics at http://localhost:3000/metrics.
+1. Add the job to your prometheus.yml file.
+   Example:
+
+   ```
+   - job_name: 'grafana_metrics'
+
+      scrape_interval: 15s
+      scrape_timeout: 5s
+  
+      static_configs:
+        - targets: ['localhost:3000']
+   ```
+1. Restart Prometheus. Your new job should appear on the Targets tab.
+1. In Grafana, hover your mouse over the **Configuration** (gear) icon on the left sidebar and then click **Data Sources**.
+1. Select the **Prometheus** data source.
+1. On the Dashboards tab, **Import** the Grafana metrics dashboard. All scraped Grafana metrics are available in the dashboard.
+
+## View Grafana metrics in Graphite
+
+These instructions assume you have already added Graphite as a data source in Grafana.
+
+1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: 
+
+   ```
+   # Metrics available at HTTP API Url /metrics
+   [metrics]
+   # Disable / Enable internal metrics
+   enabled           = true
+
+   # Disable total stats (stat_totals_*) metrics to be generated
+   disable_total_stats = false
+   ```
+
+1. Enable [metrics.graphite] options:
+   ```
+   # Send internal metrics to Graphite
+   [metrics.graphite]
+   # Enable by setting the address setting (ex localhost:2003)
+   address = <hostname or ip>:<port#>
+   prefix = prod.grafana.%(instance_name)s.
+   ```
+
+1. Restart Grafana. Grafana now exposes metrics at http://localhost:3000/metrics and sends them to the Graphite location you specified.