mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 05:31:49 +08:00
132 lines
6.4 KiB
Markdown
132 lines
6.4 KiB
Markdown
+++
|
||
title = "Using Graphite in Grafana"
|
||
description = "Guide for using graphite in Grafana"
|
||
keywords = ["grafana", "graphite", "guide"]
|
||
type = "docs"
|
||
aliases = ["/datasources/graphite"]
|
||
[menu.docs]
|
||
name = "Graphite"
|
||
identifier = "graphite"
|
||
parent = "datasources"
|
||
weight = 1
|
||
+++
|
||
|
||
# Using Graphite in Grafana
|
||
|
||
Grafana has an advanced Graphite query editor that lets you quickly navigate the metric space, add functions,
|
||
change function parameters and much more. The editor can handle all types of graphite queries. It can even handle complex nested
|
||
queries through the use of query references.
|
||
|
||
## Adding the data source
|
||
|
||
1. Open the side menu by clicking the Grafana icon in the top header.
|
||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||
3. Click the `+ Add data source` button in the top header.
|
||
4. Select `Graphite` from the *Type* dropdown.
|
||
|
||
> NOTE: If you're not seeing the `Data Sources` link in your side menu it means that your current user does not have the `Admin` role for the current organization.
|
||
|
||
Name | Description
|
||
------------ | -------------
|
||
*Name* | The data source name. This is how you refer to the data source in panels & queries.
|
||
*Default* | Default data source means that it will be pre-selected for new panels.
|
||
*Url* | The HTTP protocol, IP, and port of your graphite-web or graphite-api install.
|
||
*Access* | Server (default) = URL needs to be accessible from the Grafana backend/server, Browser = URL needs to be accessible from the browser.
|
||
|
||
Access mode controls how requests to the data source will be handled. Server should be the preferred way if nothing else stated.
|
||
|
||
### Server access mode (Default)
|
||
|
||
All requests will be made from the browser to Grafana backend/server which in turn will forward the requests to the data source and by that circumvent possible Cross-Origin Resource Sharing (CORS) requirements. The URL needs to be accessible from the grafana backend/server if you select this access mode.
|
||
|
||
### Browser access mode
|
||
|
||
All requests will be made from the browser directly to the data source and may be subject to Cross-Origin Resource Sharing (CORS) requirements. The URL needs to be accessible from the browser if you select this access mode.
|
||
|
||
## Metric editor
|
||
|
||
### Navigate metric segments
|
||
|
||
Click the ``Select metric`` link to start navigating the metric space. One you start you can continue using the mouse
|
||
or keyboard arrow keys. You can select a wildcard and still continue.
|
||
|
||
{{< docs-imagebox img="/img/docs/v45/graphite_query1_still.png"
|
||
animated-gif="/img/docs/v45/graphite_query1.gif" >}}
|
||
|
||
|
||
### Functions
|
||
|
||
Click the plus icon to the right to add a function. You can search for the function or select it from the menu. Once
|
||
a function is selected it will be added and your focus will be in the text box of the first parameter. To later change
|
||
a parameter just click on it and it will turn into a text box. To delete a function click the function name followed
|
||
by the x icon.
|
||
|
||
{{< docs-imagebox img="/img/docs/v45/graphite_query2_still.png"
|
||
animated-gif="/img/docs/v45/graphite_query2.gif" >}}
|
||
|
||
|
||
### Optional parameters
|
||
|
||
Some functions like aliasByNode support an optional second argument. To add this parameter specify for example 3,-2 as the first parameter and the function editor will adapt and move the -2 to a second parameter. To remove the second optional parameter just click on it and leave it blank and the editor will remove it.
|
||
|
||
{{< docs-imagebox img="/img/docs/v45/graphite_query3_still.png"
|
||
animated-gif="/img/docs/v45/graphite_query3.gif" >}}
|
||
|
||
|
||
### Nested Queries
|
||
|
||
You can reference queries by the row “letter” that they’re on (similar to Microsoft Excel). If you add a second query to a graph, you can reference the first query simply by typing in #A. This provides an easy and convenient way to build compounded queries.
|
||
|
||
{{< docs-imagebox img="/img/docs/v45/graphite_nested_queries_still.png"
|
||
animated-gif="/img/docs/v45/graphite_nested_queries.gif" >}}
|
||
|
||
|
||
## Point consolidation
|
||
|
||
All Graphite metrics are consolidated so that Graphite doesn't return more data points than there are pixels in the graph. By default,
|
||
this consolidation is done using `avg` function. You can control how Graphite consolidates metrics by adding the Graphite consolidateBy function.
|
||
|
||
> *Notice* This means that legend summary values (max, min, total) cannot be all correct at the same time. They are calculated
|
||
> client side by Grafana. And depending on your consolidation function only one or two can be correct at the same time.
|
||
|
||
## Templating
|
||
|
||
Instead of hard-coding things like server, application and sensor name in you metric queries you can use variables in their place.
|
||
Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns makes it easy to change the data
|
||
being displayed in your dashboard.
|
||
|
||
Checkout the [Templating]({{< relref "reference/templating.md" >}}) documentation for an introduction to the templating feature and the different
|
||
types of template variables.
|
||
|
||
### Query variable
|
||
|
||
The query you specify in the query field should be a metric find type of query. For example, a query like `prod.servers.*` will fill the
|
||
variable with all possible values that exist in the wildcard position.
|
||
|
||
You can also create nested variables that use other variables in their definition. For example
|
||
`apps.$app.servers.*` uses the variable `$app` in its query definition.
|
||
|
||
### Variable usage
|
||
|
||
You can use a variable in a metric node path or as a parameter to a function.
|
||
|
||
|
||
There are two syntaxes:
|
||
|
||
- `$<varname>` Example: apps.frontend.$server.requests.count
|
||
- `[[varname]]` Example: apps.frontend.[[server]].requests.count
|
||
|
||
Why two ways? The first syntax is easier to read and write but does not allow you to use a variable in the middle of a word. Use
|
||
the second syntax in expressions like `my.server[[serverNumber]].count`.
|
||
|
||
Example:
|
||
[Graphite Templated Dashboard](http://play.grafana.org/dashboard/db/graphite-templated-nested)
|
||
|
||
## Annotations
|
||
|
||
[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
|
||
queries via the Dashboard menu / Annotations view.
|
||
|
||
Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox,
|
||
specify a tag or wildcard (leave empty should also work)
|