Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update documentation for layout labels and ranges

pull/10616/head
Chris Goller 2016-11-29 15:22:17 -06:00 committed by Will Piers
parent 38394152d6
commit a9d194ea82
1 changed files with 52 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
docs/LAYOUT.md
View File

@ -5,41 +5,52 @@ Chronograf's applications are built by layout configurations that can be found i
To create a new layout use the `new_apps.sh` script in the `canned` directory. This script takes an argument, which is the name of the layout you want, often this will map to the InfluxDB measurement, but it does not have to. For this example I will be creating a layout for the zombocom daemon zombocomd. So first step is the run `new_app.sh zombocomd` this will create a file called `zombocomd.json`. The file will look something like:
```json
{
"id": "d77917f4-9305-4c9c-beba-c29bf17a0fd2",
"measurement": "zombocomd",
"app": "zombocomd",
"cells": [{
"x": 0,
"y": 0,
"w": 4,
"h": 4,
"i": "b75694f1-5764-4d1d-9d67-564455985894",
"name": "Running Zombo Average",
"queries": [{
"query": "SELECT mean(\"zombo\") FROM zombocomd",
"db": "telegraf",
"rp": "",
"groupbys": ["\"pod\""],
"wheres": []
}]
{
"id": "d77917f4-9305-4c9c-beba-c29bf17a0fd2",
"measurement": "zombocomd",
"app": "zombocomd",
"cells": [
{
"x": 0,
"y": 0,
"w": 4,
"h": 4,
"i": "b75694f1-5764-4d1d-9d67-564455985894",
"name": "Running Zombo Average",
"queries": [
{
"query": "SELECT mean(\"zombo\") FROM zombocomd",
"db": "telegraf",
"rp": "",
"groupbys": [
"\"pod\""
],
}
]
},
{
"x": 0,
"y": 0,
"w": 4,
"h": 4,
"i": "b75694f1-5764-4d1d-9d67-564455985894",
"name": "Anythings Per Second",
"queries": [{
"query": "SELECT non_negative_derivative(max(\"anything\"), 1s) FROM zombocomd",
"db": "telegraf",
"rp": "",
"groupbys": [],
"wheres": []
}]
}]
}
"x": 0,
"y": 0,
"w": 4,
"h": 4,
"i": "7a6bc880-054e-455c-becd-c0ebbbe109ce",
"name": "Anythings Per Second",
"queries": [
{
"query": "SELECT non_negative_derivative(max(\"anything\"), 1s) FROM zombocomd",
"db": "telegraf",
"rp": "",
"label": "anything/s",
"range": {
"upper": 100,
"lower": 10
},
"wheres": ["\"status\" = 'critical'"]
}
]
}
]
}
```
The meaning of the fields are as follows:
@ -49,17 +60,19 @@ The meaning of the fields are as follows:
* cell - An array of graphs
* x - Not currently used
* y - Not currently used
* yranges - Optional key specifying the default y-axes ranges (must come in pairs)
* ylabels - Optional key specifying the user-facing names of the y-axes. Indices in ylabels correspond with yrange pairs
* w - The width of the graph, for the initial release set to 4 to make everything line up properly.
* h - The height of the graph, for the initial release set to 4 to make everything line up properly
* i - A unique ID for the graph
* name - The displayed name of the graph
* queries - An array of InfluxQL queries. Note: queries must use an aggregate function since chronograf adds a group by time function to keep the data points manageable.
* db - The name of the database for the query
* rp - The [retention policy](https://docs.influxdata.com/influxdb/v1.1/concepts/glossary/#retention-policy-rp) for the database
* groupbys - An array of GROUP BY clauses to use on the query
* wheres - An array of WHERE clauses to add to the query
* queries.[].db - The name of the database for the query
* queries.[].rp - The [retention policy](https://docs.influxdata.com/influxdb/v1.1/concepts/glossary/#retention-policy-rp) for the database
* queries.[].groupbys - An optional array of GROUP BY clauses to use on the query
* queries.[].wheres - An optional array of WHERE clauses to add to the query
* queries.[].label - Optional key specifying the user-facing name of the y-axes
* queries.[].range.upper - Optional key specifying the default upper bound of the y-axis
* queries.[].range.lower - Optional key specifying the default lower bound of the y-axis
The above example will create two graphs. The first graph will show the mean number of zombos created then group the zombos by pod and by time. It is important to note that all queries have a `GROUP BY` time(x) appended to them. In this case `x` is determined by the duration of the query. The second graph will show the number of the "anything" [field](https://docs.influxdata.com/influxdb/v1.1/concepts/glossary/#field) per second average.
For real world examples of when to use the `groupbys` see the docker examples and for `wheres` examples see the kubernetes examples in the `canned` directory.