### Legend
-The legend hand be hidden by checking the ``Show`` checkbox. If it's shown, it can be
-displayed as a table of values by checking the ``Table`` checkbox. Series with no
-values can be hidden from the legend using the ``Hide empty`` checkbox.
+The legend hand be hidden by checking the **Show** checkbox. If it's shown, it can be
+displayed as a table of values by checking the **Table** checkbox. Series with no
+values can be hidden from the legend using the **Hide empty** checkbox.
### Legend Values
Additional values can be shown along-side the legend names:
-- ``Total`` - Sum of all values returned from metric query
-- ``Current`` - Last value returned from the metric query
-- ``Min`` - Minimum of all values returned from metric query
-- ``Max`` - Maximum of all values returned from the metric query
-- ``Avg`` - Average of all values returned from metric query
-- ``Decimals`` - Controls how many decimals are displayed for legend values (and graph hover tooltips)
+
+- **Total** - Sum of all values returned from metric query
+- **Current** - Last value returned from the metric query
+- **Min** - Minimum of all values returned from metric query
+- **Max** - Maximum of all values returned from the metric query
+- **Avg** - Average of all values returned from metric query
+- **Decimals** - Controls how many decimals are displayed for legend values (and graph hover tooltips)
The legend values are calculated client side by Grafana and depend on what type of
aggregation or point consolidation your metric query is using. All the above legend values cannot
@@ -115,23 +117,23 @@ the graph crosses a particular threshold.
### Chart Options
-- ``Bar`` - Display values as a bar chart
-- ``Lines`` - Display values as a line graph
-- ``Points`` - Display points for values
+- **Bar** - Display values as a bar chart
+- **Lines** - Display values as a line graph
+- **Points** - Display points for values
### Line Options
-- ``Line Fill`` - Amount of color fill for a series. 0 is none.
-- ``Line Width`` - The width of the line for a series.
-- ``Null point mode`` - How null values are displayed
-- ``Staircase line`` - Draws adjacent points as staircase
+- **Line Fill** - Amount of color fill for a series. 0 is none.
+- **Line Width** - The width of the line for a series.
+- **Null point mode** - How null values are displayed
+- **Staircase line** - Draws adjacent points as staircase
### Multiple Series
If there are multiple series, they can be displayed as a group.
-- ``Stack`` - Each series is stacked on top of another
-- ``Percent`` - Each series is drawn as a percentage of the total of all series
+- **Stack** - Each series is stacked on top of another
+- **Percent** - Each series is drawn as a percentage of the total of all series
If you have stack enabled, you can select what the mouse hover feature should show.
@@ -140,12 +142,12 @@ If you have stack enabled, you can select what the mouse hover feature should sh
### Rendering
-- ``Flot`` - Render the graphs in the browser using Flot (default)
-- ``Graphite PNG`` - Render the graph on the server using graphite's render API.
+- **Flot** - Render the graphs in the browser using Flot (default)
+- **Graphite PNG** - Render the graph on the server using graphite's render API.
### Tooltip
-- ``All series`` - Show all series on the same tooltip and a x crosshairs to help follow all series
+- **All series** - Show all series on the same tooltip and a x crosshairs to help follow all series
### Series Specific Overrides
@@ -158,12 +160,6 @@ There is an option under Series overrides to draw lines as dashes. Set Dashes to
## Time Range
-<<<<<<< HEAD
The time range tab allows you to override the dashboard time range and specify a panel specific time. Either through a relative from now time option or through a timeshift.
{{< docs-imagebox img="/img/docs/v45/graph-time-range.png" max-width= "900px" >}}
-||||||| merged common ancestors
-
-=======
-
->>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
diff --git a/docs/sources/features/panels/singlestat.md b/docs/sources/features/panels/singlestat.md
index cf04419dbc5..5e2cb36600b 100644
--- a/docs/sources/features/panels/singlestat.md
+++ b/docs/sources/features/panels/singlestat.md
@@ -22,20 +22,20 @@ The singlestat panel has a normal query editor to allow you define your exact me
{{< docs-imagebox img="/img/docs/v45/singlestat-value-options.png" class="docs-image--no-shadow" max-width="900px" >}}
-1. `Stats`: The Stats field let you set the function (min, max, average, current, total, first, delta, range) that your entire query is reduced into a single value with. This reduces the entire query into a single summary value that is displayed.
- * `min` - The smallest value in the series
- * `max` - The largest value in the series
- * `avg` - The average of all the non-null values in the series
- * `current` - The last value in the series. If the series ends on null the previous value will be used.
- * `total` - The sum of all the non-null values in the series
- * `first` - The first value in the series
- * `delta` - The total incremental increase (of a counter) in the series. An attempt is made to account for counter resets, but this will only be accurate for single instance metrics. Used to show total counter increase in time series.
- * `diff` - The difference betwen 'current' (last value) and 'first'.
- * `range` - The difference between 'min' and 'max'. Useful the show the range of change for a gauge.
-2. `Prefix/Postfix`: The Prefix/Postfix fields let you define a custom label to appear *before/after* the value. The `$__name` variable can be used here to use the series name or alias from the metric query.
-3. `Units`: Units are appended to the the Singlestat within the panel, and will respect the color and threshold settings for the value.
-4. `Decimals`: The Decimal field allows you to override the automatic decimal precision, and set it explicitly.
-5. `Font Size`: You can use this section to select the font size of the different texts in the Singlestat Panel, i.e. prefix, value and postfix.
+1. **Stats**: The Stats field let you set the function (min, max, average, current, total, first, delta, range) that your entire query is reduced into a single value with. This reduces the entire query into a single summary value that is displayed.
+ * **min** - The smallest value in the series
+ * **max** - The largest value in the series
+ * **avg** - The average of all the non-null values in the series
+ * **current** - The last value in the series. If the series ends on null the previous value will be used.
+ * **total** - The sum of all the non-null values in the series
+ * **first** - The first value in the series
+ * **delta** - The total incremental increase (of a counter) in the series. An attempt is made to account for counter resets, but this will only be accurate for single instance metrics. Used to show total counter increase in time series.
+ * **diff** - The difference betwen 'current' (last value) and 'first'.
+ * **range** - The difference between 'min' and 'max'. Useful the show the range of change for a gauge.
+2. **Prefix/Postfix**: The Prefix/Postfix fields let you define a custom label to appear *before/after* the value. The `$__name` variable can be used here to use the series name or alias from the metric query.
+3. **Units**: Units are appended to the the Singlestat within the panel, and will respect the color and threshold settings for the value.
+4. **Decimals**: The Decimal field allows you to override the automatic decimal precision, and set it explicitly.
+5. **Font Size**: You can use this section to select the font size of the different texts in the Singlestat Panel, i.e. prefix, value and postfix.
### Coloring
@@ -43,11 +43,11 @@ The coloring options of the Singlestat Panel config allow you to dynamically cha
{{< docs-imagebox img="/img/docs/v45/singlestat-color-options.png" max-width="500px" class="docs-image--right docs-image--no-shadow">}}
-1. `Background`: This checkbox applies the configured thresholds and colors to the entirety of the Singlestat Panel background.
-2. `Thresholds`: Change the background and value colors dynamically within the panel, depending on the Singlestat value. The threshold field accepts **2 comma-separated** values which represent 3 ranges that correspond to the three colors directly to the right. For example: if the thresholds are 70, 90 then the first color represents < 70, the second color represents between 70 and 90 and the third color represents > 90.
-3. `Colors`: Select a color and opacity
-4. `Value`: This checkbox applies the configured thresholds and colors to the summary stat.
-5. `Invert order`: This link toggles the threshold color order.For example: Green, Orange, Red (
) will become Red, Orange, Green (
).
+1. **Background**: This checkbox applies the configured thresholds and colors to the entirety of the Singlestat Panel background.
+2. **Thresholds**: Change the background and value colors dynamically within the panel, depending on the Singlestat value. The threshold field accepts **2 comma-separated** values which represent 3 ranges that correspond to the three colors directly to the right. For example: if the thresholds are 70, 90 then the first color represents < 70, the second color represents between 70 and 90 and the third color represents > 90.
+3. **Colors**: Select a color and opacity
+4. **Value**: This checkbox applies the configured thresholds and colors to the summary stat.
+5. **Invert order**: This link toggles the threshold color order.For example: Green, Orange, Red () will become Red, Orange, Green ().
### Spark Lines
@@ -55,62 +55,35 @@ Sparklines are a great way of seeing the historical data related to the summary
{{< docs-imagebox img="/img/docs/v45/singlestat-spark-options.png" max-width="500px" class="docs-image--right docs-image--no-shadow">}}
-1. `Show`: The show checkbox will toggle whether the spark line is shown in the Panel. When unselected, only the Singlestat value will appear.
-2. `Full Height`: Check if you want the sparklines to take up the full panel height, or uncheck if they should be below the main Singlestat value.
-3. `Line Color`: This color selection applies to the color of the sparkline itself.
-4. `Fill Color`: This color selection applies to the area below the sparkline.
+1. **Show**: The show checkbox will toggle whether the spark line is shown in the Panel. When unselected, only the Singlestat value will appear.
+2. **Full Height**: Check if you want the sparklines to take up the full panel height, or uncheck if they should be below the main Singlestat value.
+3. **Line Color**: This color selection applies to the color of the sparkline itself.
+4. **Fill Color**: This color selection applies to the area below the sparkline.
> ***Pro-tip:*** Reduce the opacity on fill colors for nice looking panels.
-<<<<<<< HEAD
### Gauge
Gauges gives a clear picture of how high a value is in it's context. It's a great way to see if a value is close to the thresholds. The gauge uses the colors set in the color options.
{{< docs-imagebox img="/img/docs/v45/singlestat-gauge-options.png" max-width="500px" class="docs-image--right docs-image--no-shadow">}}
-1. `Show`: The show checkbox will toggle wether the gauge is shown in the panel. When unselected, only the Singlestat value will appear.
-2. `Min/Max`: This sets the start and end point for the gauge.
-3. `Threshold Labels`: Check if you want to show the threshold labels. Thresholds are set in the color options.
-4. `Threshold Markers`: Check if you want to have a second meter showing the thresholds.
+1. **Show**: The show checkbox will toggle wether the gauge is shown in the panel. When unselected, only the Singlestat value will appear.
+2. **Min/Max**: This sets the start and end point for the gauge.
+3. **Threshold Labels**: Check if you want to show the threshold labels. Thresholds are set in the color options.
+4. **Threshold Markers**: Check if you want to have a second meter showing the thresholds.
-||||||| merged common ancestors
-=======
-### Gauge
-
-Gauges gives a clear picture of how high a value is in it's context. It's a great way to see if a value is close to the thresholds. The gauge uses the colors set in the color options.
-
-{{< docs-imagebox img="/img/docs/v45/singlestat-gauge-options.png" max-width="500px" class="docs-image--right docs-image--no-shadow">}}
-
-1. `Show`: The show checkbox will toggle wether the gauge is shown in the panel. When unselected, only the Singlestat value will appear.
-2. `Min/Max`: This sets the start and end point for the gauge.
-3. `Threshold Labels`: Check if you want to show the threshold labels. Thresholds are set in the color options.
-4. `Threshold Markers`: Check if you want to have a second meter showing the thresholds.
-
->>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
### Value to text mapping
-<<<<<<< HEAD
{{< docs-imagebox img="/img/docs/v45/singlestat-value-mapping.png" class="docs-image--right docs-image--no-shadow">}}
Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message.
-||||||| merged common ancestors
-Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message.
-=======
-{{< docs-imagebox img="/img/docs/v45/singlestat-value-mapping.png" class="docs-image--right docs-image--no-shadow">}}
->>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
-<<<<<<< HEAD
-||||||| merged common ancestors
-
-=======
-Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message.
->>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
## Troubleshooting
diff --git a/docs/sources/features/panels/table_panel.md b/docs/sources/features/panels/table_panel.md
index 9c112c81265..a3e56c72960 100644
--- a/docs/sources/features/panels/table_panel.md
+++ b/docs/sources/features/panels/table_panel.md
@@ -25,8 +25,8 @@ The table panel has many ways to manipulate your data for optimal presentation.
{{< docs-imagebox img="/img/docs/v45/table_options.png" class="docs-image--no-shadow" max-width= "500px" >}}
-1. `Data`: Control how your query is transformed into a table.
-2. `Paging`: Table display options.
+1. **Data**: Control how your query is transformed into a table.
+2. **Paging**: Table display options.
## Data to Table
@@ -43,20 +43,20 @@ you want in the table. Only applicable for some transforms.
{{< docs-imagebox img="/img/docs/v45/table_ts_to_rows.png" >}}
-In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series.
+In the most simple mode you can turn time series to rows. This means you get a **Time**, **Metric** and a **Value** column. Where **Metric** is the name of the time series.
### Time series to columns
{{< docs-imagebox img="/img/docs/v45/table_ts_to_columns.png" >}}
-This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series.
+This transform allows you to take multiple time series and group them by time. Which will result in the primary column being **Time** and a column for each time series.
### Time series aggregations
{{< docs-imagebox img="/img/docs/v45/table_ts_to_aggregations.png" >}}
-This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added.
+This table transformation will lay out your table into rows by metric, allowing columns of **Avg**, **Min**, **Max**, **Total**, **Current** and **Count**. More than one column can be added.
### Annotations
@@ -70,7 +70,7 @@ mode then any queries you have in the metrics tab will be ignored.
{{< docs-imagebox img="/img/docs/v45/table_json_data.png" max-width="500px" >}}
-If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a `date histogram` use this
+If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a **date histogram** use this
transform mode and pick the columns using the **Columns** section.
@@ -80,9 +80,9 @@ transform mode and pick the columns using the **Columns** section.
{{< docs-imagebox img="/img/docs/v45/table_paging.png" class="docs-image--no-shadow docs-image--right" max-width="350px" >}}
-1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages.
-2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows.
-3. `Font Size`: The `font size` field allows you to increase or decrease the size for the panel, relative to the default font size.
+1. **Rows Per Page**: The table display fields allow you to control how many rows per page there should be. For example, if your table had 95 records with a rows per page value of 10, your table would be split across 10 pages.
+2. **Scroll**: The scroll bar checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows.
+3. **Font Size**: The font size field allows you to increase or decrease the size for the panel, relative to the default font size.
## Column Styles
@@ -91,9 +91,9 @@ The column styles allow you control how dates and numbers are formatted.
{{< docs-imagebox img="/img/docs/v45/table_column_styles.png" class="docs-image--no-shadow" >}}
-1. `Name or regex`: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values.
-2. `Column Header`: Title for the column, when using a Regex the title can include replacement strings like `$1`.
-3. `Add column style rule`: Add new column rule.
-4. `Thresholds` and `Coloring`: Specify color mode and thresholds limits.
-5. `Type`: The three supported types of types are `Number`, `String` and `Date`. `Unit` and `Decimals`: Specify unit and decimal precision for numbers.`Format`: Specify date format for dates.
+1. **Name or regex**: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values.
+2. **Column Header**: Title for the column, when using a Regex the title can include replacement strings like `$1`.
+3. **Add column style rule**: Add new column rule.
+4. **Thresholds and Coloring**: Specify color mode and thresholds limits.
+5. **Type**: The three supported types of types are **Number**, **String** and **Date**. **Unit** and **Decimals**: Specify unit and decimal precision for numbers. **Format**: Specify date format for dates.
diff --git a/docs/sources/features/panels/text.md b/docs/sources/features/panels/text.md
index ae37df16b9e..cc8269793bd 100644
--- a/docs/sources/features/panels/text.md
+++ b/docs/sources/features/panels/text.md
@@ -18,6 +18,6 @@ The text panel lets you make information and description panels etc. for your da
{{< docs-imagebox img="/img/docs/v45/text-options.png" max-width="600px" class="docs-image--no-shadow">}}
-1. `Mode`: Here you can choose between markdown, HTML or text.
-2. `Content`: Here you write your content.
+1. **Mode**: Here you can choose between markdown, HTML or text.
+2. **Content**: Here you write your content.
diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md
index 55bec79c7f8..3ef5fb1136a 100644
--- a/docs/sources/http_api/admin.md
+++ b/docs/sources/http_api/admin.md
@@ -23,158 +23,162 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
- GET /api/admin/settings
- Accept: application/json
- Content-Type: application/json
+```bash
+GET /api/admin/settings
+Accept: application/json
+Content-Type: application/json
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
-
- {
- "DEFAULT":
- {
- "app_mode":"production"},
- "analytics":
- {
- "google_analytics_ua_id":"",
- "reporting_enabled":"false"
- },
- "auth.anonymous":{
- "enabled":"true",
- "org_name":"Main Org.",
- "org_role":"Viewer"
- },
- "auth.basic":{
- "enabled":"false"
- },
- "auth.github":{
- "allow_sign_up":"false",
- "allowed_domains":"",
- "allowed_organizations":"",
- "api_url":"https://api.github.com/user",
- "auth_url":"https://github.com/login/oauth/authorize",
- "client_id":"some_id",
- "client_secret":"************",
- "enabled":"false",
- "scopes":"user:email",
- "team_ids":"",
- "token_url":"https://github.com/login/oauth/access_token"
- },
- "auth.google":{
- "allow_sign_up":"false","allowed_domains":"",
- "api_url":"https://www.googleapis.com/oauth2/v1/userinfo",
- "auth_url":"https://accounts.google.com/o/oauth2/auth",
- "client_id":"some_client_id",
- "client_secret":"************",
- "enabled":"false",
- "scopes":"https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
- "token_url":"https://accounts.google.com/o/oauth2/token"
- },
- "auth.ldap":{
- "config_file":"/etc/grafana/ldap.toml",
- "enabled":"false"
- },
- "auth.proxy":{
- "auto_sign_up":"true",
- "enabled":"false",
- "header_name":"X-WEBAUTH-USER",
- "header_property":"username"
- },
- "dashboards.json":{
- "enabled":"false",
- "path":"/var/lib/grafana/dashboards"
- },
- "database":{
- "host":"127.0.0.1:0000",
- "name":"grafana",
- "password":"************",
- "path":"grafana.db",
- "ssl_mode":"disable",
- "type":"sqlite3",
- "user":"root"
- },
- "emails":{
- "templates_pattern":"emails/*.html",
- "welcome_email_on_sign_up":"false"
- },
- "event_publisher":{
- "enabled":"false",
- "exchange":"grafana_events",
- "rabbitmq_url":"amqp://localhost/"
- },
- "log":{
- "buffer_len":"10000",
- "level":"Info",
- "mode":"file"
- },
- "log.console":{
- "level":""
- },
- "log.file":{
- "daily_rotate":"true",
- "file_name":"",
- "level":"",
- "log_rotate":"true",
- "max_days":"7",
- "max_lines":"1000000",
- "max_lines_shift":"28",
- "max_size_shift":""
- },
- "paths":{
- "data":"/tsdb/grafana",
- "logs":"/logs/apps/grafana"},
- "security":{
- "admin_password":"************",
- "admin_user":"admin",
- "cookie_remember_name":"grafana_remember",
- "cookie_username":"grafana_user",
- "disable_gravatar":"false",
- "login_remember_days":"7",
- "secret_key":"************"
- },
- "server":{
- "cert_file":"",
- "cert_key":"",
- "domain":"mygraf.com",
- "enable_gzip":"false",
- "enforce_domain":"false",
- "http_addr":"127.0.0.1",
- "http_port":"0000",
- "protocol":"http",
- "root_url":"%(protocol)s://%(domain)s:%(http_port)s/",
- "router_logging":"true",
- "data_proxy_logging":"true",
- "static_root_path":"public"
- },
- "session":{
- "cookie_name":"grafana_sess",
- "cookie_secure":"false",
- "gc_interval_time":"",
- "provider":"file",
- "provider_config":"sessions",
- "session_life_time":"86400"
- },
- "smtp":{
- "cert_file":"",
- "enabled":"false",
- "from_address":"admin@grafana.localhost",
- "from_name":"Grafana",
- "ehlo_identity":"dashboard.example.com",
- "host":"localhost:25",
- "key_file":"",
- "password":"************",
- "skip_verify":"false",
- "user":""},
- "users":{
- "allow_org_create":"true",
- "allow_sign_up":"false",
- "auto_assign_org":"true",
- "auto_assign_org_role":"Viewer"
- }
- }
+```bash
+HTTP/1.1 200
+Content-Type: application/json
+{
+"DEFAULT":
+{
+ "app_mode":"production"},
+ "analytics":
+ {
+ "google_analytics_ua_id":"",
+ "reporting_enabled":"false"
+ },
+ "auth.anonymous":{
+ "enabled":"true",
+ "org_name":"Main Org.",
+ "org_role":"Viewer"
+ },
+ "auth.basic":{
+ "enabled":"false"
+ },
+ "auth.github":{
+ "allow_sign_up":"false",
+ "allowed_domains":"",
+ "allowed_organizations":"",
+ "api_url":"https://api.github.com/user",
+ "auth_url":"https://github.com/login/oauth/authorize",
+ "client_id":"some_id",
+ "client_secret":"************",
+ "enabled":"false",
+ "scopes":"user:email",
+ "team_ids":"",
+ "token_url":"https://github.com/login/oauth/access_token"
+ },
+ "auth.google":{
+ "allow_sign_up":"false","allowed_domains":"",
+ "api_url":"https://www.googleapis.com/oauth2/v1/userinfo",
+ "auth_url":"https://accounts.google.com/o/oauth2/auth",
+ "client_id":"some_client_id",
+ "client_secret":"************",
+ "enabled":"false",
+ "scopes":"https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
+ "token_url":"https://accounts.google.com/o/oauth2/token"
+ },
+ "auth.ldap":{
+ "config_file":"/etc/grafana/ldap.toml",
+ "enabled":"false"
+ },
+ "auth.proxy":{
+ "auto_sign_up":"true",
+ "enabled":"false",
+ "header_name":"X-WEBAUTH-USER",
+ "header_property":"username"
+ },
+ "dashboards.json":{
+ "enabled":"false",
+ "path":"/var/lib/grafana/dashboards"
+ },
+ "database":{
+ "host":"127.0.0.1:0000",
+ "name":"grafana",
+ "password":"************",
+ "path":"grafana.db",
+ "ssl_mode":"disable",
+ "type":"sqlite3",
+ "user":"root"
+ },
+ "emails":{
+ "templates_pattern":"emails/*.html",
+ "welcome_email_on_sign_up":"false"
+ },
+ "event_publisher":{
+ "enabled":"false",
+ "exchange":"grafana_events",
+ "rabbitmq_url":"amqp://localhost/"
+ },
+ "log":{
+ "buffer_len":"10000",
+ "level":"Info",
+ "mode":"file"
+ },
+ "log.console":{
+ "level":""
+ },
+ "log.file":{
+ "daily_rotate":"true",
+ "file_name":"",
+ "level":"",
+ "log_rotate":"true",
+ "max_days":"7",
+ "max_lines":"1000000",
+ "max_lines_shift":"28",
+ "max_size_shift":""
+ },
+ "paths":{
+ "data":"/tsdb/grafana",
+ "logs":"/logs/apps/grafana"},
+ "security":{
+ "admin_password":"************",
+ "admin_user":"admin",
+ "cookie_remember_name":"grafana_remember",
+ "cookie_username":"grafana_user",
+ "disable_gravatar":"false",
+ "login_remember_days":"7",
+ "secret_key":"************"
+ },
+ "server":{
+ "cert_file":"",
+ "cert_key":"",
+ "domain":"mygraf.com",
+ "enable_gzip":"false",
+ "enforce_domain":"false",
+ "http_addr":"127.0.0.1",
+ "http_port":"0000",
+ "protocol":"http",
+ "root_url":"%(protocol)s://%(domain)s:%(http_port)s/",
+ "router_logging":"true",
+ "data_proxy_logging":"true",
+ "static_root_path":"public"
+ },
+ "session":{
+ "cookie_name":"grafana_sess",
+ "cookie_secure":"false",
+ "gc_interval_time":"",
+ "provider":"file",
+ "provider_config":"sessions",
+ "session_life_time":"86400"
+ },
+ "smtp":{
+ "cert_file":"",
+ "enabled":"false",
+ "from_address":"admin@grafana.localhost",
+ "from_name":"Grafana",
+ "ehlo_identity":"dashboard.example.com",
+ "host":"localhost:25",
+ "key_file":"",
+ "password":"************",
+ "skip_verify":"false",
+ "user":""
+ },
+ "users":{
+ "allow_org_create":"true",
+ "allow_sign_up":"false",
+ "auto_assign_org":"true",
+ "auto_assign_org_role":"Viewer"
+ }
+}
+```
## Grafana Stats
`GET /api/admin/stats`
@@ -183,26 +187,30 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
- GET /api/admin/stats
- Accept: application/json
- Content-Type: application/json
+```bash
+GET /api/admin/stats
+Accept: application/json
+Content-Type: application/json
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {
- "user_count":2,
- "org_count":1,
- "dashboard_count":4,
- "db_snapshot_count":2,
- "db_tag_count":6,
- "data_source_count":1,
- "playlist_count":1,
- "starred_db_count":2,
- "grafana_admin_count":2
- }
+{
+ "user_count":2,
+ "org_count":1,
+ "dashboard_count":4,
+ "db_snapshot_count":2,
+ "db_tag_count":6,
+ "data_source_count":1,
+ "playlist_count":1,
+ "starred_db_count":2,
+ "grafana_admin_count":2
+}
+```
## Global Users
@@ -211,24 +219,28 @@ Only works with Basic Authentication (username and password). See [introduction]
Create new user. Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
**Example Request**:
+```json
- POST /api/admin/users HTTP/1.1
- Accept: application/json
- Content-Type: application/json
+POST /api/admin/users HTTP/1.1
+Accept: application/json
+Content-Type: application/json
- {
- "name":"User",
- "email":"user@graf.com",
- "login":"user",
- "password":"userpassword"
- }
+{
+ "name":"User",
+ "email":"user@graf.com",
+ "login":"user",
+ "password":"userpassword"
+}
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {"id":5,"message":"User created"}
+{"id":5,"message":"User created"}
+```
## Password for User
@@ -239,18 +251,22 @@ Change password for a specific user.
**Example Request**:
- PUT /api/admin/users/2/password HTTP/1.1
- Accept: application/json
- Content-Type: application/json
+```json
+PUT /api/admin/users/2/password HTTP/1.1
+Accept: application/json
+Content-Type: application/json
- {"password":"userpassword"}
+{"password":"userpassword"}
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {"message": "User password updated"}
+{"message": "User password updated"}
+```
## Permissions
@@ -260,18 +276,22 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
- PUT /api/admin/users/2/permissions HTTP/1.1
- Accept: application/json
- Content-Type: application/json
+```json
+PUT /api/admin/users/2/permissions HTTP/1.1
+Accept: application/json
+Content-Type: application/json
- {"isGrafanaAdmin": true}
+{"isGrafanaAdmin": true}
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {message: "User permissions updated"}
+{message: "User permissions updated"}
+```
## Delete global User
@@ -281,16 +301,20 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
- DELETE /api/admin/users/2 HTTP/1.1
- Accept: application/json
- Content-Type: application/json
+```json
+DELETE /api/admin/users/2 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {message: "User deleted"}
+{message: "User deleted"}
+```
## Pause all alerts
@@ -300,13 +324,15 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
- POST /api/admin/pause-all-alerts HTTP/1.1
- Accept: application/json
- Content-Type: application/json
+```json
+POST /api/admin/pause-all-alerts HTTP/1.1
+Accept: application/json
+Content-Type: application/json
- {
- "paused": true
- }
+{
+ "paused": true
+}
+```
JSON Body schema:
@@ -314,7 +340,9 @@ JSON Body schema:
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```json
+HTTP/1.1 200
+Content-Type: application/json
- {state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}
+{state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}
+```
\ No newline at end of file
diff --git a/docs/sources/http_api/alerting.md b/docs/sources/http_api/alerting.md
index 1aab7253373..c5172c64203 100644
--- a/docs/sources/http_api/alerting.md
+++ b/docs/sources/http_api/alerting.md
@@ -23,11 +23,12 @@ This API can also be used to create, update and delete alert notifications.
**Example Request**:
- GET /api/alerts HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
-
+```http
+GET /api/alerts HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
Querystring Parameters:
These parameters are used as querystring parameters. For example:
@@ -41,28 +42,30 @@ This API can also be used to create, update and delete alert notifications.
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- [
+```http
+HTTP/1.1 200
+Content-Type: application/json
+[
+ {
+ "id": 1,
+ "dashboardId": 1,
+ "panelId": 1,
+ "name": "fire place sensor",
+ "message": "Someone is trying to break in through the fire place",
+ "state": "alerting",
+ "evalDate": "0001-01-01T00:00:00Z",
+ "evalData": [
{
- "id": 1,
- "dashboardId": 1,
- "panelId": 1,
- "name": "fire place sensor",
- "message": "Someone is trying to break in through the fire place",
- "state": "alerting",
- "evalDate": "0001-01-01T00:00:00Z",
- "evalData": [
- {
- "metric": "fire",
- "tags": null,
- "value": 5.349999999999999
- }
- "newStateDate": "2016-12-25",
- "executionError": "",
- "dashboardUri": "http://grafana.com/dashboard/db/sensors"
+ "metric": "fire",
+ "tags": null,
+ "value": 5.349999999999999
}
- ]
+ "newStateDate": "2016-12-25",
+ "executionError": "",
+ "dashboardUri": "http://grafana.com/dashboard/db/sensors"
+ }
+]
+```
## Get one alert
@@ -70,26 +73,30 @@ This API can also be used to create, update and delete alert notifications.
**Example Request**:
- GET /api/alerts/1 HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```http
+GET /api/alerts/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- {
- "id": 1,
- "dashboardId": 1,
- "panelId": 1,
- "name": "fire place sensor",
- "message": "Someone is trying to break in through the fire place",
- "state": "alerting",
- "newStateDate": "2016-12-25",
- "executionError": "",
- "dashboardUri": "http://grafana.com/dashboard/db/sensors"
- }
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+ "id": 1,
+ "dashboardId": 1,
+ "panelId": 1,
+ "name": "fire place sensor",
+ "message": "Someone is trying to break in through the fire place",
+ "state": "alerting",
+ "newStateDate": "2016-12-25",
+ "executionError": "",
+ "dashboardUri": "http://grafana.com/dashboard/db/sensors"
+}
+```
## Pause alert
@@ -97,14 +104,16 @@ This API can also be used to create, update and delete alert notifications.
**Example Request**:
- POST /api/alerts/1/pause HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```http
+POST /api/alerts/1/pause HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
- {
- "paused": true
- }
+{
+ "paused": true
+}
+```
The :id query parameter is the id of the alert to be paused or unpaused.
@@ -114,13 +123,15 @@ JSON Body Schema:
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- {
- "alertId": 1,
- "state": "Paused",
- "message": "alert paused"
- }
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+ "alertId": 1,
+ "state": "Paused",
+ "message": "alert paused"
+}
+```
## Get alert notifications
@@ -128,26 +139,29 @@ JSON Body Schema:
**Example Request**:
- GET /api/alert-notifications HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
-
+```http
+GET /api/alert-notifications HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
+```http
+HTTP/1.1 200
+Content-Type: application/json
- {
- "id": 1,
- "name": "Team A",
- "type": "email",
- "isDefault": true,
- "created": "2017-01-01 12:45",
- "updated": "2017-01-01 12:45"
- }
+{
+ "id": 1,
+ "name": "Team A",
+ "type": "email",
+ "isDefault": true,
+ "created": "2017-01-01 12:45",
+ "updated": "2017-01-01 12:45"
+}
+```
## Create alert notification
@@ -155,34 +169,37 @@ JSON Body Schema:
**Example Request**:
- POST /api/alert-notifications HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
-
- {
- "name": "new alert notification", //Required
- "type": "email", //Required
- "isDefault": false,
- "settings": {
- "addresses": "carl@grafana.com;dev@grafana.com"
- }
- }
+```http
+POST /api/alert-notifications HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+{
+ "name": "new alert notification", //Required
+ "type": "email", //Required
+ "isDefault": false,
+ "settings": {
+ "addresses": "carl@grafana.com;dev@grafana.com"
+ }
+}
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- {
- "id": 1,
- "name": "new alert notification",
- "type": "email",
- "isDefault": false,
- "settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
- "created": "2017-01-01 12:34",
- "updated": "2017-01-01 12:34"
- }
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+ "id": 1,
+ "name": "new alert notification",
+ "type": "email",
+ "isDefault": false,
+ "settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
+ "created": "2017-01-01 12:34",
+ "updated": "2017-01-01 12:34"
+}
+```
## Update alert notification
@@ -190,35 +207,38 @@ JSON Body Schema:
**Example Request**:
- PUT /api/alert-notifications/1 HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
-
- {
- "id": 1,
- "name": "new alert notification", //Required
- "type": "email", //Required
- "isDefault": false,
- "settings": {
- "addresses: "carl@grafana.com;dev@grafana.com"
- }
- }
+```http
+PUT /api/alert-notifications/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+{
+ "id": 1,
+ "name": "new alert notification", //Required
+ "type": "email", //Required
+ "isDefault": false,
+ "settings": {
+ "addresses: "carl@grafana.com;dev@grafana.com"
+ }
+}
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- {
- "id": 1,
- "name": "new alert notification",
- "type": "email",
- "isDefault": false,
- "settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
- "created": "2017-01-01 12:34",
- "updated": "2017-01-01 12:34"
- }
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+ "id": 1,
+ "name": "new alert notification",
+ "type": "email",
+ "isDefault": false,
+ "settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
+ "created": "2017-01-01 12:34",
+ "updated": "2017-01-01 12:34"
+}
+```
## Delete alert notification
@@ -226,15 +246,19 @@ JSON Body Schema:
**Example Request**:
- DELETE /api/alert-notifications/1 HTTP/1.1
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```http
+DELETE /api/alert-notifications/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
**Example Response**:
- HTTP/1.1 200
- Content-Type: application/json
- {
- "message": "Notification deleted"
- }
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+ "message": "Notification deleted"
+}
+```
\ No newline at end of file
diff --git a/docs/sources/http_api/annotations.md b/docs/sources/http_api/annotations.md
new file mode 100644
index 00000000000..2f148e9aded
--- /dev/null
+++ b/docs/sources/http_api/annotations.md
@@ -0,0 +1,189 @@
++++
+title = "Annotations HTTP API "
+description = "Grafana Annotations HTTP API"
+keywords = ["grafana", "http", "documentation", "api", "annotation", "annotations", "comment"]
+aliases = ["/http_api/annotations/"]
+type = "docs"
+[menu.docs]
+name = "Annotations"
+identifier = "annotationshttp"
+parent = "http_api"
++++
+
+# Annotations resources / actions
+
+This is the API documentation for the new Grafana Annotations feature released in Grafana 4.6. Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annotations can be global annotations that can be shown on any dashboard by configuring an annotation data source - they are filtered by tags. Or they can be tied to a panel on a dashboard and are then only shown on that panel.
+
+## Find Annotations
+
+`GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100`
+
+**Example Request**:
+
+```http
+GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Basic YWRtaW46YWRtaW4=
+```
+
+
+Query Parameters:
+
+- `from`: epoch datetime in milliseconds. Optional.
+- `to`: epoch datetime in milliseconds. Optional.
+- `limit`: number. Optional - default is 10. Max limit for results returned.
+- `alertId`: number. Optional. Find annotations for a specified alert.
+- `dashboardId`: number. Optional. Find annotations that are scoped to a specific dashboard
+- `panelId`: number. Optional. Find annotations that are scoped to a specific panel
+- `tags`: string. Optional. Use this to filter global annotations. Global annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. To do an "AND" filtering with multiple tags, specify the tags parameter multiple times e.g. `tags=tag1&tags=tag2`.
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+[
+ {
+ "id": 1124,
+ "alertId": 0,
+ "dashboardId": 468,
+ "panelId": 2,
+ "userId": 1,
+ "userName": "",
+ "newState": "",
+ "prevState": "",
+ "time": 1507266395000,
+ "text": "test",
+ "metric": "",
+ "regionId": 1123,
+ "type": "event",
+ "tags": [
+ "tag1",
+ "tag2"
+ ],
+ "data": {}
+ },
+ {
+ "id": 1123,
+ "alertId": 0,
+ "dashboardId": 468,
+ "panelId": 2,
+ "userId": 1,
+ "userName": "",
+ "newState": "",
+ "prevState": "",
+ "time": 1507265111000,
+ "text": "test",
+ "metric": "",
+ "regionId": 1123,
+ "type": "event",
+ "tags": [
+ "tag1",
+ "tag2"
+ ],
+ "data": {}
+ }
+]
+```
+
+## Create Annotation
+
+Creates an annotation in the Grafana database. The `dashboardId` and `panelId` fields are optional. If they are not specified then a global annotation is created and can be queried in any dashboard that adds the Grafana annotations data source.
+
+`POST /api/annotations`
+
+**Example Request**:
+
+```json
+POST /api/annotations HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+
+{
+ "dashboardId":468,
+ "panelId":1,
+ "time":1507037197339,
+ "isRegion":true,
+ "timeEnd":1507180805056,
+ "tags":["tag1","tag2"],
+ "text":"Annotation Description"
+}
+```
+
+**Example Response**:
+
+```json
+HTTP/1.1 200
+Content-Type: application/json
+
+{"message":"Annotation added"}
+```
+
+## Update Annotation
+
+`PUT /api/annotations/:id`
+
+**Example Request**:
+
+```json
+PUT /api/annotations/1141 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+
+{
+ "time":1507037197339,
+ "isRegion":true,
+ "timeEnd":1507180805056,
+ "text":"Annotation Description",
+ "tags":["tag3","tag4","tag5"]
+}
+```
+
+## Delete Annotation By Id
+
+`DELETE /api/annotation/:id`
+
+Deletes the annotation that matches the specified id.
+
+**Example Request**:
+
+```http
+DELETE /api/annotation/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+
+{"message":"Annotation deleted"}
+```
+
+## Delete Annotation By RegionId
+
+`DELETE /api/annotation/region/:id`
+
+Deletes the annotation that matches the specified region id. A region is an annotation that covers a timerange and has a start and end time. In the Grafana database, this is a stored as two annotations connected by a region id.
+
+**Example Request**:
+
+```http
+DELETE /api/annotation/region/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+
+{"message":"Annotation region deleted"}
+```
diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md
index d8ded124ac5..b526031fdeb 100644
--- a/docs/sources/http_api/auth.md
+++ b/docs/sources/http_api/auth.md
@@ -21,7 +21,7 @@ If basic auth is enabled (it is enabled by default) you can authenticate your HT
standard basic auth. Basic auth will also authenticate LDAP users.
curl example:
-```
+```bash
?curl http://admin:admin@localhost:3000/api/org
{"id":1,"name":"Main Org."}
```
@@ -36,9 +36,11 @@ You use the token in all requests in the `Authorization` header, like this:
**Example**:
- GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
- Accept: application/json
- Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```http
+GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
The `Authorization` header value should be `Bearer - -
-{colorPaletteItems}
+