Docs: Refactor inconsistent unordered lists (#27826)
* Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
John S
Diana Payton
@@ -18,12 +18,12 @@ For more information about configuration options related to Grafana metrics, ref
|
||||
|
||||
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
|
||||
- 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
|
||||
|
||||
|
||||
@@ -108,25 +108,25 @@ In this example we use Apache as a reverse proxy in front of Grafana. Apache han
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
* The first 4 lines of the virtualhost configuration are standard, so we won’t go into detail on what they do.
|
||||
- The first four lines of the virtualhost configuration are standard, so we won’t go into detail on what they do.
|
||||
|
||||
* We use a **\<proxy>** configuration block for applying our authentication rules to every proxied request. These rules include requiring basic authentication where user:password credentials are stored in the **/etc/apache2/grafana_htpasswd** file. This file can be created with the `htpasswd` command.
|
||||
- We use a **\<proxy>** configuration block for applying our authentication rules to every proxied request. These rules include requiring basic authentication where user:password credentials are stored in the **/etc/apache2/grafana_htpasswd** file. This file can be created with the `htpasswd` command.
|
||||
|
||||
* The next part of the configuration is the tricky part. We use Apache’s rewrite engine to create our **X-WEBAUTH-USER header**, populated with the authenticated user.
|
||||
- The next part of the configuration is the tricky part. We use Apache’s rewrite engine to create our **X-WEBAUTH-USER header**, populated with the authenticated user.
|
||||
|
||||
* **RewriteRule .* - [E=PROXY_USER:%{LA-U:REMOTE_USER}, NS]**: This line is a little bit of magic. What it does, is for every request use the rewriteEngines look-ahead (LA-U) feature to determine what the REMOTE_USER variable would be set to after processing the request. Then assign the result to the variable PROXY_USER. This is necessary as the REMOTE_USER variable is not available to the RequestHeader function.
|
||||
- **RewriteRule .* - [E=PROXY_USER:%{LA-U:REMOTE_USER}, NS]**: This line is a little bit of magic. What it does, is for every request use the rewriteEngines look-ahead (LA-U) feature to determine what the REMOTE_USER variable would be set to after processing the request. Then assign the result to the variable PROXY_USER. This is necessary as the REMOTE_USER variable is not available to the RequestHeader function.
|
||||
|
||||
* **RequestHeader set X-WEBAUTH-USER “%{PROXY_USER}e”**: With the authenticated username now stored in the PROXY_USER variable, we create a new HTTP request header that will be sent to our backend Grafana containing the username.
|
||||
- **RequestHeader set X-WEBAUTH-USER “%{PROXY_USER}e”**: With the authenticated username now stored in the PROXY_USER variable, we create a new HTTP request header that will be sent to our backend Grafana containing the username.
|
||||
|
||||
* The **RequestHeader unset Authorization** removes the Authorization header from the HTTP request before it is forwarded to Grafana. This ensures that Grafana does not try to authenticate the user using these credentials (BasicAuth is a supported authentication handler in Grafana).
|
||||
- The **RequestHeader unset Authorization** removes the Authorization header from the HTTP request before it is forwarded to Grafana. This ensures that Grafana does not try to authenticate the user using these credentials (BasicAuth is a supported authentication handler in Grafana).
|
||||
|
||||
* The last 3 lines are then just standard reverse proxy configuration to direct all authenticated requests to our Grafana server running on port 3000.
|
||||
- The last 3 lines are then just standard reverse proxy configuration to direct all authenticated requests to our Grafana server running on port 3000.
|
||||
|
||||
## Full walk through using Docker.
|
||||
## Full walkthrough using Docker.
|
||||
|
||||
For this example, we use the official Grafana docker image available at [Docker Hub](https://hub.docker.com/r/grafana/grafana/)
|
||||
For this example, we use the official Grafana Docker image available at [Docker Hub](https://hub.docker.com/r/grafana/grafana/).
|
||||
|
||||
* Create a file `grafana.ini` with the following contents
|
||||
- Create a file `grafana.ini` with the following contents
|
||||
|
||||
```bash
|
||||
[users]
|
||||
@@ -152,7 +152,7 @@ docker run -i -v $(pwd)/grafana.ini:/etc/grafana/grafana.ini --name grafana graf
|
||||
|
||||
For this example we use the official Apache docker image available at [Docker Hub](https://hub.docker.com/_/httpd/)
|
||||
|
||||
* Create a file `httpd.conf` with the following contents
|
||||
- Create a file `httpd.conf` with the following contents
|
||||
|
||||
```bash
|
||||
ServerRoot "/usr/local/apache2"
|
||||
@@ -207,13 +207,13 @@ ProxyPass / http://grafana:3000/
|
||||
ProxyPassReverse / http://grafana:3000/
|
||||
```
|
||||
|
||||
* Create a htpasswd file. We create a new user **anthony** with the password **password**
|
||||
- Create a htpasswd file. We create a new user **anthony** with the password **password**
|
||||
|
||||
```bash
|
||||
htpasswd -bc htpasswd anthony password
|
||||
```
|
||||
|
||||
* Launch the httpd container using our custom httpd.conf and our htpasswd file. The container will listen on port 80, and we create a link to the **grafana** container so that this container can resolve the hostname **grafana** to the grafana container’s ip address.
|
||||
- Launch the httpd container using our custom httpd.conf and our htpasswd file. The container will listen on port 80, and we create a link to the **grafana** container so that this container can resolve the hostname **grafana** to the Grafana container’s IP address.
|
||||
|
||||
```bash
|
||||
docker run -i -p 80:80 --link grafana:grafana -v $(pwd)/httpd.conf:/usr/local/apache2/conf/httpd.conf -v $(pwd)/htpasswd:/tmp/htpasswd httpd:2.4
|
||||
|
||||
@@ -200,8 +200,8 @@ Users with nested/recursive group membership must have an LDAP server that suppo
|
||||
and configure `group_search_filter` in a way that it returns the groups the submitted username is a member of.
|
||||
|
||||
To configure `group_search_filter`:
|
||||
* You can set `group_search_base_dns` to specify where the matching groups are defined.
|
||||
* If you do not use `group_search_base_dns`, then the previously defined `search_base_dns` is used.
|
||||
- You can set `group_search_base_dns` to specify where the matching groups are defined.
|
||||
- If you do not use `group_search_base_dns`, then the previously defined `search_base_dns` is used.
|
||||
|
||||
**Active Directory example:**
|
||||
|
||||
@@ -320,9 +320,9 @@ org_role = "Viewer"
|
||||
|
||||
Assuming the following Active Directory server setup:
|
||||
|
||||
* IP address: `10.0.0.1`
|
||||
* Domain: `CORP`
|
||||
* DNS name: `corp.local`
|
||||
- IP address: `10.0.0.1`
|
||||
- Domain: `CORP`
|
||||
- DNS name: `corp.local`
|
||||
|
||||
**LDAP specific configuration file (ldap.toml):**
|
||||
```bash
|
||||
|
||||
@@ -12,7 +12,7 @@ Grafana has a number of keyboard shortcuts available. Press Shift + `?` on your
|
||||
|
||||
**Popular shortcuts:**
|
||||
|
||||
* Ctrl+S saves the current dashboard.
|
||||
* Ctrl+F opens the dashboard finder / search.
|
||||
* Ctrl+H hides all controls (good for tv displays).
|
||||
* Press Escape to exit graph when in fullscreen or edit mode.
|
||||
- Ctrl+S saves the current dashboard.
|
||||
- Ctrl+F opens the dashboard finder / search.
|
||||
- Ctrl+H hides all controls (good for tv displays).
|
||||
- Press Escape to exit graph when in fullscreen or edit mode.
|
||||
|
||||
@@ -12,32 +12,32 @@ This page lists resources for developers who want to contribute to the Grafana s
|
||||
|
||||
These resources are useful for all developers.
|
||||
|
||||
* [Contributing to Grafana](https://github.com/grafana/grafana/blob/master/CONTRIBUTING.md): Start here to learn how you can contribute your skills to make Grafana even better.
|
||||
- [Contributing to Grafana](https://github.com/grafana/grafana/blob/master/CONTRIBUTING.md): Start here to learn how you can contribute your skills to make Grafana even better.
|
||||
|
||||
* [Developer guide](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md): A guide to help you get started developing Grafana software, includes instructions for how to configure Grafana for development.
|
||||
- [Developer guide](https://github.com/grafana/grafana/blob/master/contribute/developer-guide.md): A guide to help you get started developing Grafana software, includes instructions for how to configure Grafana for development.
|
||||
|
||||
* [Contributing to documentation](https://github.com/grafana/grafana/blob/master/contribute/documentation.md): A guide to help you contribute to Grafana documentation, includes links to beginner-friendly issues.
|
||||
- [Contributing to documentation](https://github.com/grafana/grafana/blob/master/contribute/documentation.md): A guide to help you contribute to Grafana documentation, includes links to beginner-friendly issues.
|
||||
|
||||
* [Architecture guides](https://github.com/grafana/grafana/tree/master/contribute/architecture): These guides explain Grafana’s background architecture.
|
||||
- [Architecture guides](https://github.com/grafana/grafana/tree/master/contribute/architecture): These guides explain Grafana’s background architecture.
|
||||
|
||||
* [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md): A guide for new contributors about how to create your first Grafana pull request.
|
||||
- [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md): A guide for new contributors about how to create your first Grafana pull request.
|
||||
|
||||
* [REST APIs](https://grafana.com/docs/grafana/latest/http_api/) allow you to interact programmatically with the Grafana backend.
|
||||
- [REST APIs](https://grafana.com/docs/grafana/latest/http_api/) allow you to interact programmatically with the Grafana backend.
|
||||
|
||||
## Best practices and style
|
||||
|
||||
Our [style guides](https://github.com/grafana/grafana/tree/master/contribute/style-guides) outline Grafana style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
|
||||
|
||||
* [Backend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/backend.md) explains how we want to write Go code in the future.
|
||||
- [Backend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/backend.md) explains how we want to write Go code in the future.
|
||||
|
||||
* [Documentation style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/documentation-style-guide.md) applies to all documentation created for Grafana products.
|
||||
- [Documentation style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/documentation-style-guide.md) applies to all documentation created for Grafana products.
|
||||
|
||||
* [End to end test framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/e2e.md) provides guidance for Grafana e2e tests.
|
||||
- [End to end test framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/e2e.md) provides guidance for Grafana e2e tests.
|
||||
|
||||
* [Frontend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/frontend.md) provides rules and guidance on developing in React for Grafana.
|
||||
- [Frontend style guide](https://github.com/grafana/grafana/blob/master/contribute/style-guides/frontend.md) provides rules and guidance on developing in React for Grafana.
|
||||
|
||||
* [Redux framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/redux.md) explains how Grafana handles Redux boilerplate code.
|
||||
- [Redux framework](https://github.com/grafana/grafana/blob/master/contribute/style-guides/redux.md) explains how Grafana handles Redux boilerplate code.
|
||||
|
||||
* [Styling Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/styling.md) expands on styling React components with Emotion.
|
||||
- [Styling Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/styling.md) expands on styling React components with Emotion.
|
||||
|
||||
* [Theming Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/themes.md) explains how to use themes and ThemeContext in Grafana code.
|
||||
- [Theming Grafana](https://github.com/grafana/grafana/blob/master/contribute/style-guides/themes.md) explains how to use themes and ThemeContext in Grafana code.
|
||||
|
||||
@@ -27,13 +27,13 @@ Grafana Enterprise includes integrations with more ways to authenticate your use
|
||||
|
||||
Supported auth providers:
|
||||
|
||||
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
* [Azure AD OAuth]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}})
|
||||
* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
* [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}})
|
||||
* [SAML]({{< relref "saml.md#configure-team-sync" >}})
|
||||
- [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
- [Azure AD OAuth]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}})
|
||||
- [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
- [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
- [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
- [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}})
|
||||
- [SAML]({{< relref "saml.md#configure-team-sync" >}})
|
||||
|
||||
### Enhanced LDAP integration
|
||||
|
||||
@@ -47,25 +47,25 @@ With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you
|
||||
|
||||
With Grafana Enterprise, you get access to new features, including:
|
||||
|
||||
* [Data source permissions]({{< relref "datasource_permissions.md" >}}) to restrict query access to specific teams and users.
|
||||
* [Reporting]({{< relref "reporting.md" >}}) to generate a PDF report from any dashboard and set up a schedule to have it emailed to whoever you choose.
|
||||
* [Export dashboard as PDF]({{< relref "export-pdf.md" >}})
|
||||
* [White labeling]({{< relref "white-labeling.md" >}}) to customize Grafana from the brand and logo to the footer links.
|
||||
* [Usage insights]({{< relref "usage-insights.md" >}}) to understand how your Grafana instance is used.
|
||||
* [Vault integration]({{< relref "vault.md" >}}) to manage your configuration or provisioning secrets with Vault.
|
||||
- [Data source permissions]({{< relref "datasource_permissions.md" >}}) to restrict query access to specific teams and users.
|
||||
- [Reporting]({{< relref "reporting.md" >}}) to generate a PDF report from any dashboard and set up a schedule to have it emailed to whoever you choose.
|
||||
- [Export dashboard as PDF]({{< relref "export-pdf.md" >}})
|
||||
- [White labeling]({{< relref "white-labeling.md" >}}) to customize Grafana from the brand and logo to the footer links.
|
||||
- [Usage insights]({{< relref "usage-insights.md" >}}) to understand how your Grafana instance is used.
|
||||
- [Vault integration]({{< relref "vault.md" >}}) to manage your configuration or provisioning secrets with Vault.
|
||||
|
||||
## Enterprise plugins
|
||||
|
||||
With a Grafana Enterprise license, you get access to premium plugins, including:
|
||||
|
||||
* [Amazon Timestream](https://grafana.com/plugins/grafana-timestream-datasource)
|
||||
* [AppDynamics](https://grafana.com/plugins/dlopes7-appdynamics-datasource)
|
||||
* [DataDog](https://grafana.com/plugins/grafana-datadog-datasource)
|
||||
* [Dynatrace](https://grafana.com/plugins/grafana-dynatrace-datasource)
|
||||
* [New Relic](https://grafana.com/plugins/grafana-newrelic-datasource)
|
||||
* [Oracle Database](https://grafana.com/plugins/grafana-oracle-datasource)
|
||||
* [ServiceNow](https://grafana.com/grafana/plugins/grafana-servicenow-datasource)
|
||||
* [Splunk](https://grafana.com/plugins/grafana-splunk-datasource)
|
||||
- [Amazon Timestream](https://grafana.com/plugins/grafana-timestream-datasource)
|
||||
- [AppDynamics](https://grafana.com/plugins/dlopes7-appdynamics-datasource)
|
||||
- [DataDog](https://grafana.com/plugins/grafana-datadog-datasource)
|
||||
- [Dynatrace](https://grafana.com/plugins/grafana-dynatrace-datasource)
|
||||
- [New Relic](https://grafana.com/plugins/grafana-newrelic-datasource)
|
||||
- [Oracle Database](https://grafana.com/plugins/grafana-oracle-datasource)
|
||||
- [ServiceNow](https://grafana.com/grafana/plugins/grafana-servicenow-datasource)
|
||||
- [Splunk](https://grafana.com/plugins/grafana-splunk-datasource)
|
||||
|
||||
## Try Grafana Enterprise
|
||||
|
||||
|
||||
@@ -38,8 +38,8 @@ Your current data source permissions will keep working as expected, but you'll b
|
||||
|
||||
### LDAP authentication
|
||||
|
||||
* LDAP synchronization is not affected by an expired license.
|
||||
* Enhanced LDAP debugging is unavailable.
|
||||
- LDAP synchronization is not affected by an expired license.
|
||||
- Enhanced LDAP debugging is unavailable.
|
||||
|
||||
### SAML authentication
|
||||
|
||||
@@ -47,8 +47,8 @@ SAML authentication is not affected by an expired license.
|
||||
|
||||
### Reporting
|
||||
|
||||
* You're unable to configure new reports or generate previews.
|
||||
* Scheduled reports are not generated or sent.
|
||||
- You're unable to configure new reports or generate previews.
|
||||
- Scheduled reports are not generated or sent.
|
||||
|
||||
### Enterprise plugins
|
||||
|
||||
|
||||
@@ -21,8 +21,8 @@ Any changes you make to a dashboard used in a report are reflected the next time
|
||||
|
||||
## Requirements
|
||||
|
||||
* SMTP must be configured for reports to be sent. Refer to [SMTP]({{< relref "../administration/configuration.md#smtp" >}}) in [Configuration]({{< relref "../administration/configuration.md" >}}) for more information.
|
||||
* The Image Renderer plugin must be installed or the remote rendering service must be set up. Refer to [Image rendering]({{< relref "../administration/image_rendering.md" >}}) for more information.
|
||||
- SMTP must be configured for reports to be sent. Refer to [SMTP]({{< relref "../administration/configuration.md#smtp" >}}) in [Configuration]({{< relref "../administration/configuration.md" >}}) for more information.
|
||||
- The Image Renderer plugin must be installed or the remote rendering service must be set up. Refer to [Image rendering]({{< relref "../administration/image_rendering.md" >}}) for more information.
|
||||
|
||||
## Create or update a report
|
||||
|
||||
@@ -30,12 +30,12 @@ Currently only Organization Admins can create reports.
|
||||
|
||||
1. Click on the reports icon in the side menu. The Reports tab allows you to view, create, and update your reports.
|
||||
1. Enter report information. All fields are required unless otherwise indicated.
|
||||
* **Name -** Name of the report as you want it to appear in the Reports list.
|
||||
* **Source dashboard -** Select the dashboard to generate the report from.
|
||||
* **Recipients -** Enter the emails of the people or teams that you want to receive the report.
|
||||
* **Reply to -** (optional) The address that will appear in the **Reply to** field of the email.
|
||||
* **Message -** (optional) Message body in the email with the report.
|
||||
* **Time range -** (optional) Use custom time range for the report. For more information check [Report time range]({{< relref "#report-time-range" >}}).
|
||||
- **Name -** Name of the report as you want it to appear in the Reports list.
|
||||
- **Source dashboard -** Select the dashboard to generate the report from.
|
||||
- **Recipients -** Enter the emails of the people or teams that you want to receive the report.
|
||||
- **Reply to -** (optional) The address that will appear in the **Reply to** field of the email.
|
||||
- **Message -** (optional) Message body in the email with the report.
|
||||
- **Time range -** (optional) Use custom time range for the report. For more information check [Report time range]({{< relref "#report-time-range" >}}).
|
||||
1. **Preview PDF** to make sure the report appears as you expect. Update if necessary.
|
||||
1. Enter scheduling information. Options vary depending on the frequency you select.
|
||||
1. Select the orientation option for generated report: **Portrait** or **Landscape**.
|
||||
@@ -66,23 +66,23 @@ All scheduling indicates when the reporting service will start rendering the das
|
||||
|
||||
Hourly reports are generated once per hour. All fields are required.
|
||||
|
||||
* **At minute -** The number of minutes after full hour when the report should be generated.
|
||||
* **Time zone -** Time zone to determine the offset of the full hour. Does not currently change the time in the rendered report.
|
||||
- **At minute -** The number of minutes after full hour when the report should be generated.
|
||||
- **Time zone -** Time zone to determine the offset of the full hour. Does not currently change the time in the rendered report.
|
||||
|
||||
#### Daily
|
||||
|
||||
Daily reports are generated once per day. All fields are required.
|
||||
|
||||
* **Time -** Time the report is sent, in 24-hour format.
|
||||
* **Time zone -** Time zone for the **Time** field.
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
|
||||
#### Weekly
|
||||
|
||||
Weekly reports are generated once per week. All fields are required.
|
||||
|
||||
* **Day -** Weekday which the report should be sent on.
|
||||
* **Time -** Time the report is sent, in 24-hour format.
|
||||
* **Time zone -** Time zone for the **Time** field.
|
||||
- **Day -** Weekday which the report should be sent on.
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
|
||||
#### Monthly
|
||||
|
||||
@@ -90,9 +90,9 @@ Weekly reports are generated once per week. All fields are required.
|
||||
|
||||
Monthly reports are generated once per month. All fields are required.
|
||||
|
||||
* **Day in month -** Day of the month when the report should be sent. You can select `last` for reports that should go out on the last day of the month.
|
||||
* **Time -** Time the report is sent, in 24-hour format.
|
||||
* **Time zone -** Time zone for the **Time** field.
|
||||
- **Day in month -** Day of the month when the report should be sent. You can select `last` for reports that should go out on the last day of the month.
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
|
||||
#### Never
|
||||
|
||||
|
||||
@@ -22,20 +22,20 @@ The SAML single-sign-on (SSO) standard is varied and flexible. Our implementatio
|
||||
|
||||
Grafana supports the following SAML 2.0 bindings:
|
||||
|
||||
* From the Service Provider (SP) to the Identity Provider (IdP):
|
||||
- From the Service Provider (SP) to the Identity Provider (IdP):
|
||||
- `HTTP-POST` binding
|
||||
- `HTTP-Redirect` binding
|
||||
|
||||
* From the Identity Provider (IdP) to the Service Provider (SP):
|
||||
- From the Identity Provider (IdP) to the Service Provider (SP):
|
||||
- `HTTP-POST` binding
|
||||
|
||||
In terms of security:
|
||||
* Grafana supports signed and encrypted assertions.
|
||||
* Grafana does not support signed or encrypted requests.
|
||||
- Grafana supports signed and encrypted assertions.
|
||||
- Grafana does not support signed or encrypted requests.
|
||||
|
||||
In terms of initiation:
|
||||
* Grafana supports SP-initiated requests.
|
||||
* Grafana does not support IdP-initiated request.
|
||||
- Grafana supports SP-initiated requests.
|
||||
- Grafana does not support IdP-initiated request.
|
||||
|
||||
## Set up SAML authentication
|
||||
|
||||
@@ -72,8 +72,8 @@ Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) fo
|
||||
The SAML SSO standard uses asymmetric encryption to exchange information between the SP (Grafana) and the IdP. To perform such encryption, you need a public part and a private part. In this case, the X.509 certificate provides the public part, while the private key provides the private part.
|
||||
|
||||
Grafana supports two ways of specifying both the `certificate` and `private_key`.
|
||||
* Without a suffix (`certificate` or `private_key`), the configuration assumes you've supplied the base64-encoded file contents.
|
||||
* With the `_path` suffix (`certificate_path` or `private_key_path`), then Grafana treats the value entered as a file path and attempts to read the file from the file system.
|
||||
- Without a suffix (`certificate` or `private_key`), the configuration assumes you've supplied the base64-encoded file contents.
|
||||
- With the `_path` suffix (`certificate_path` or `private_key_path`), then Grafana treats the value entered as a file path and attempts to read the file from the file system.
|
||||
|
||||
You can only use one form of each configuration option. Using multiple forms, such as both `certificate` and `certificate_path`, results in an error.
|
||||
|
||||
@@ -82,9 +82,9 @@ You can only use one form of each configuration option. Using multiple forms, su
|
||||
You also need to define the public part of the IdP for message verification. The SAML IdP metadata XML defines where and how Grafana exchanges user information.
|
||||
|
||||
Grafana supports three ways of specifying the IdP metadata.
|
||||
* Without a suffix `idp_metadata`, Grafana assumes base64-encoded XML file contents.
|
||||
* With the `_path` suffix, Grafana assumes a file path and attempts to read the file from the file system.
|
||||
* With the `_url` suffix, Grafana assumes a URL and attempts to load the metadata from the given location.
|
||||
- Without a suffix `idp_metadata`, Grafana assumes base64-encoded XML file contents.
|
||||
- With the `_path` suffix, Grafana assumes a file path and attempts to read the file from the file system.
|
||||
- With the `_url` suffix, Grafana assumes a URL and attempts to load the metadata from the given location.
|
||||
|
||||
### Maximum issue delay
|
||||
|
||||
@@ -104,8 +104,8 @@ For the SAML integration to work correctly, you need to make the IdP aware of th
|
||||
|
||||
The integration provides two key endpoints as part of Grafana:
|
||||
|
||||
* The `/saml/metadata` endpoint, which contains the SP metadata. You can either download and upload it manually, or youmake the IdP request it directly from the endpoint. Some providers name it Identifier or Entity ID.
|
||||
* The `/saml/acs` endpoint, which is intended to receive the ACS (Assertion Customer Service) callback. Some providers name it SSO URL or Reply URL.
|
||||
- The `/saml/metadata` endpoint, which contains the SP metadata. You can either download and upload it manually, or youmake the IdP request it directly from the endpoint. Some providers name it Identifier or Entity ID.
|
||||
- The `/saml/acs` endpoint, which is intended to receive the ACS (Assertion Customer Service) callback. Some providers name it SSO URL or Reply URL.
|
||||
|
||||
### Assertion mapping
|
||||
|
||||
@@ -171,8 +171,8 @@ org_mapping = Engineering:2, Sales:3
|
||||
|
||||
You can specify multiple organizations both for the IdP and Grafana:
|
||||
|
||||
* `org_mapping = Engineering:2, Sales:2` to map users from `Engineering` and `Sales` to `2` in Grafana.
|
||||
* `org_mapping = Engineering:2, Engineering:3` to assign `Engineering` to both `2` and `3` in Grafana.
|
||||
- `org_mapping = Engineering:2, Sales:2` to map users from `Engineering` and `Sales` to `2` in Grafana.
|
||||
- `org_mapping = Engineering:2, Engineering:3` to assign `Engineering` to both `2` and `3` in Grafana.
|
||||
|
||||
### Configure allowed organizations
|
||||
|
||||
|
||||
@@ -27,13 +27,13 @@ This mechanism allows Grafana to remove an existing synchronized user from a tea
|
||||
|
||||
## Supported providers
|
||||
|
||||
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
* [Azure AD]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}})
|
||||
* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
* [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}})
|
||||
* [SAML]({{< relref "saml.md#configure-team-sync" >}})
|
||||
- [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
- [Azure AD]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}})
|
||||
- [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
- [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
- [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
- [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}})
|
||||
- [SAML]({{< relref "saml.md#configure-team-sync" >}})
|
||||
|
||||
## Synchronize a Grafana team with an external group
|
||||
|
||||
|
||||
@@ -61,9 +61,9 @@ use Vault. Vault configuration is an extension of configuration's [variable expa
|
||||
`$__vault{<argument>}` syntax.
|
||||
|
||||
The argument to Vault consists of three parts separated by a colon:
|
||||
* The first part specifies which secrets engine should be used.
|
||||
* The second part specifies which secret should be accessed.
|
||||
* The third part specifies which field of that secret should be used.
|
||||
- The first part specifies which secrets engine should be used.
|
||||
- The second part specifies which secret should be accessed.
|
||||
- The third part specifies which field of that secret should be used.
|
||||
|
||||
For example, if you place a Key/Value secret for the Grafana admin user in _secret/grafana/admin_defaults_
|
||||
the syntax for accessing it's _password_ field would be `$__vault{kv:secret/grafana/admin_defaults:password}`.
|
||||
|
||||
@@ -21,19 +21,19 @@ The query language and capabilities of each data source are obviously very diffe
|
||||
|
||||
The following data sources are officially supported:
|
||||
|
||||
* [AWS CloudWatch]({{< relref "cloudwatch.md" >}})
|
||||
* [Azure Monitor]({{< relref "azuremonitor.md" >}})
|
||||
* [Elasticsearch]({{< relref "elasticsearch.md" >}})
|
||||
* [Google Cloud Monitoring]({{< relref "cloudmonitoring.md" >}})
|
||||
* [Graphite]({{< relref "graphite.md" >}})
|
||||
* [InfluxDB]({{< relref "influxdb.md" >}})
|
||||
* [Loki]({{< relref "loki.md" >}})
|
||||
* [Microsoft SQL Server (MSSQL)]({{< relref "mssql.md" >}})
|
||||
* [MySQL]({{< relref "mysql.md" >}})
|
||||
* [OpenTSDB]({{< relref "opentsdb.md" >}})
|
||||
* [PostgreSQL]({{< relref "postgres.md" >}})
|
||||
* [Prometheus]({{< relref "prometheus.md" >}})
|
||||
* [Testdata]({{< relref "testdata.md" >}})
|
||||
- [AWS CloudWatch]({{< relref "cloudwatch.md" >}})
|
||||
- [Azure Monitor]({{< relref "azuremonitor.md" >}})
|
||||
- [Elasticsearch]({{< relref "elasticsearch.md" >}})
|
||||
- [Google Cloud Monitoring]({{< relref "cloudmonitoring.md" >}})
|
||||
- [Graphite]({{< relref "graphite.md" >}})
|
||||
- [InfluxDB]({{< relref "influxdb.md" >}})
|
||||
- [Loki]({{< relref "loki.md" >}})
|
||||
- [Microsoft SQL Server (MSSQL)]({{< relref "mssql.md" >}})
|
||||
- [MySQL]({{< relref "mysql.md" >}})
|
||||
- [OpenTSDB]({{< relref "opentsdb.md" >}})
|
||||
- [PostgreSQL]({{< relref "postgres.md" >}})
|
||||
- [Prometheus]({{< relref "prometheus.md" >}})
|
||||
- [Testdata]({{< relref "testdata.md" >}})
|
||||
|
||||
In addition to the data sources that you have configured in your Grafana, there are three special data sources available:
|
||||
|
||||
|
||||
@@ -40,8 +40,8 @@ Just add it as a data source and you are ready to query your log data in [Explor
|
||||
|
||||
The Derived Fields configuration allows you to:
|
||||
|
||||
* Add fields parsed from the log message.
|
||||
* Add a link that uses the value of the field.
|
||||
- Add fields parsed from the log message.
|
||||
- Add a link that uses the value of the field.
|
||||
|
||||
You can use this functionality to link to your tracing backend directly from your logs, or link to a user profile page if a userId is present in the log line. These links appear in the [log details](/explore/#labels-and-parsed-fields).
|
||||
{{< docs-imagebox img="/img/docs/v65/loki_derived_fields.png" class="docs-image--no-shadow" caption="Screenshot of the derived fields configuration" >}}
|
||||
@@ -87,15 +87,15 @@ For the label part of the query expression, wrap it in curly braces `{}` and the
|
||||
|
||||
The following label matching operators are currently supported:
|
||||
|
||||
* `=` exactly equal.
|
||||
* `!=` not equal.
|
||||
* `=~` regex-match.
|
||||
* `!~` do not regex-match.
|
||||
- `=` exactly equal.
|
||||
- `!=` not equal.
|
||||
- `=~` regex-match.
|
||||
- `!~` do not regex-match.
|
||||
|
||||
Examples:
|
||||
|
||||
* `{name=~"mysql.+"}`
|
||||
* `{name!~"mysql.+"}`
|
||||
- `{name=~"mysql.+"}`
|
||||
- `{name!~"mysql.+"}`
|
||||
|
||||
The [same rules that apply for Prometheus Label Selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#instant-vector-selectors) apply for Loki Log Stream Selectors.
|
||||
|
||||
@@ -107,9 +107,9 @@ After writing the Log Stream Selector, you can filter the results further by wri
|
||||
|
||||
Example queries:
|
||||
|
||||
* `{job="mysql"} |= "error"`
|
||||
* `{name="kafka"} |~ "tsdb-ops.*io:2003"`
|
||||
* `{instance=~"kafka-[23]",name="kafka"} != "kafka.server:type=ReplicaManager"`
|
||||
- `{job="mysql"} |= "error"`
|
||||
- `{name="kafka"} |~ "tsdb-ops.*io:2003"`
|
||||
- `{instance=~"kafka-[23]",name="kafka"} != "kafka.server:type=ReplicaManager"`
|
||||
|
||||
Filter operators can be chained and will sequentially filter down the expression. The resulting log lines will satisfy every filter.
|
||||
|
||||
@@ -119,10 +119,10 @@ Filter operators can be chained and will sequentially filter down the expression
|
||||
|
||||
The following filter types are currently supported:
|
||||
|
||||
* `|=` line contains string.
|
||||
* `!=` line doesn't contain string.
|
||||
* `|~` line matches regular expression.
|
||||
* `!~` line does not match regular expression.
|
||||
- `|=` line contains string.
|
||||
- `!=` line doesn't contain string.
|
||||
- `|~` line matches regular expression.
|
||||
- `!~` line does not match regular expression.
|
||||
|
||||
> **Note:** For more details about LogQL, Loki's query language, refer to the [documentation](https://grafana.com/docs/loki/latest/logql/)
|
||||
|
||||
|
||||
@@ -43,19 +43,19 @@ Different user types will have different interests. Some suggestions are listed
|
||||
|
||||
All users might want to learn about:
|
||||
|
||||
* [Panels]({{< relref "../panels/panels-overview.md" >}})
|
||||
* [Dashboards]({{< relref "../dashboards/_index.md" >}})
|
||||
* [Data sources]({{< relref "../features/datasources/data-sources.md" >}}) and [Add a data source]({{< relref "../features/datasources/add-a-data-source.md" >}})
|
||||
* [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}})
|
||||
* [Explore workflow]({{< relref "../explore/index.md" >}})
|
||||
* [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc)
|
||||
- [Panels]({{< relref "../panels/panels-overview.md" >}})
|
||||
- [Dashboards]({{< relref "../dashboards/_index.md" >}})
|
||||
- [Data sources]({{< relref "../features/datasources/data-sources.md" >}}) and [Add a data source]({{< relref "../features/datasources/add-a-data-source.md" >}})
|
||||
- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}})
|
||||
- [Explore workflow]({{< relref "../explore/index.md" >}})
|
||||
- [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc)
|
||||
|
||||
### Admins
|
||||
|
||||
Administrators might want to learn about:
|
||||
|
||||
* [Grafana configuration]({{< relref "../administration/configuration.md" >}})
|
||||
* [Authentication]({{< relref "../auth/overview.md" >}})
|
||||
* [User permissions and roles]({{< relref "../permissions/overview.md" >}})
|
||||
* [Provisioning]({{< relref "../administration/provisioning.md" >}})
|
||||
* [Grafana CLI]({{< relref "../administration/cli.md" >}})
|
||||
- [Grafana configuration]({{< relref "../administration/configuration.md" >}})
|
||||
- [Authentication]({{< relref "../auth/overview.md" >}})
|
||||
- [User permissions and roles]({{< relref "../permissions/overview.md" >}})
|
||||
- [Provisioning]({{< relref "../administration/provisioning.md" >}})
|
||||
- [Grafana CLI]({{< relref "../administration/cli.md" >}})
|
||||
|
||||
@@ -36,8 +36,8 @@ plugin SDK / API.
|
||||
We’ve refactored our **Data Source** plugin architecture and added
|
||||
two new plugin types:
|
||||
|
||||
* **Panel** plugins let you add new panel types for your Dashboards.
|
||||
* **App** plugins bundle **Panels** plugins, **Data Sources** plugins,
|
||||
- **Panel** plugins let you add new panel types for your Dashboards.
|
||||
- **App** plugins bundle **Panels** plugins, **Data Sources** plugins,
|
||||
Dashboards, and Grafana **Pages**. Apps are a great way to provide an
|
||||
entire experience right within Grafana.
|
||||
|
||||
@@ -184,13 +184,13 @@ This is due to a simplification of the variable format system where template var
|
||||
now stored without any formatting (glob/regex/etc), this is done on the fly when the
|
||||
variable is interpolated.
|
||||
|
||||
* Plugin API: The plugin API has changed so if you are using a custom
|
||||
- Plugin API: The plugin API has changed so if you are using a custom
|
||||
data source (or panel) they need to be updated as well.
|
||||
|
||||
* InfluxDB 0.8: This data source is no longer included in releases,
|
||||
- InfluxDB 0.8: This data source is no longer included in releases,
|
||||
you can still install manually from [Grafana.com](https://grafana.com)
|
||||
|
||||
* KairosDB: This data source has also no longer shipped with Grafana,
|
||||
- KairosDB: This data source has also no longer shipped with Grafana,
|
||||
you can install it manually from [Grafana.com](https://grafana.com)
|
||||
|
||||
## Plugin showcase
|
||||
|
||||
@@ -32,11 +32,11 @@ Big thumbs up!
|
||||
|
||||
This release adds **five** new alert notifications channels, all of them contributed by the community.
|
||||
|
||||
* Hipchat
|
||||
* Telegram
|
||||
* LINE
|
||||
* Pushover
|
||||
* Threema
|
||||
- Hipchat
|
||||
- Telegram
|
||||
- LINE
|
||||
- Pushover
|
||||
- Threema
|
||||
|
||||
### Templating
|
||||
|
||||
|
||||
@@ -26,19 +26,19 @@ Initial feature request: [#4638](https://github.com/grafana/grafana/issues/4638)
|
||||
Pull Request: [#8472](https://github.com/grafana/grafana/pull/8472)
|
||||
|
||||
## Enhancements
|
||||
* **Elasticsearch**: Added filter aggregation label [#8420](https://github.com/grafana/grafana/pull/8420), thx [@tianzk](github.com/tianzk)
|
||||
* **Sensu**: Added option for source and handler [#8405](https://github.com/grafana/grafana/pull/8405), thx [@joemiller](github.com/joemiller)
|
||||
* **CSV**: Configurable csv export datetime format [#8058](https://github.com/grafana/grafana/issues/8058), thx [@cederigo](github.com/cederigo)
|
||||
* **Table Panel**: Column style that preserves formatting/indentation (like pre tag) [#6617](https://github.com/grafana/grafana/issues/6617)
|
||||
* **DingDing**: Add DingDing Alert Notifier [#8473](https://github.com/grafana/grafana/pull/8473) thx [@jiamliang](https://github.com/jiamliang)
|
||||
- **Elasticsearch**: Added filter aggregation label [#8420](https://github.com/grafana/grafana/pull/8420), thx [@tianzk](github.com/tianzk)
|
||||
- **Sensu**: Added option for source and handler [#8405](https://github.com/grafana/grafana/pull/8405), thx [@joemiller](github.com/joemiller)
|
||||
- **CSV**: Configurable csv export datetime format [#8058](https://github.com/grafana/grafana/issues/8058), thx [@cederigo](github.com/cederigo)
|
||||
- **Table Panel**: Column style that preserves formatting/indentation (like pre tag) [#6617](https://github.com/grafana/grafana/issues/6617)
|
||||
- **DingDing**: Add DingDing Alert Notifier [#8473](https://github.com/grafana/grafana/pull/8473) thx [@jiamliang](https://github.com/jiamliang)
|
||||
|
||||
## Minor Enhancements
|
||||
|
||||
* **Elasticsearch**: Add option for result set size in raw_document [#3426](https://github.com/grafana/grafana/issues/3426) [#8527](https://github.com/grafana/grafana/pull/8527), thx [@mk-dhia](github.com/mk-dhia)
|
||||
- **Elasticsearch**: Add option for result set size in raw_document [#3426](https://github.com/grafana/grafana/issues/3426) [#8527](https://github.com/grafana/grafana/pull/8527), thx [@mk-dhia](github.com/mk-dhia)
|
||||
|
||||
## Bug Fixes
|
||||
|
||||
* **Graph**: Bug fix for negative values in histogram mode [#8628](https://github.com/grafana/grafana/issues/8628)
|
||||
- **Graph**: Bug fix for negative values in histogram mode [#8628](https://github.com/grafana/grafana/issues/8628)
|
||||
|
||||
## Download
|
||||
|
||||
|
||||
@@ -37,21 +37,21 @@ More information [here](https://community.grafana.com/t/using-grafanas-query-ins
|
||||
|
||||
### New Features
|
||||
|
||||
* **Table panel**: Render cell values as links that can have an URL template that uses variables from current table row. [#3754](https://github.com/grafana/grafana/issues/3754)
|
||||
* **Elasticsearch**: Add ad hoc filters directly by clicking values in table panel [#8052](https://github.com/grafana/grafana/issues/8052).
|
||||
* **MySQL**: New rich query editor with syntax highlighting
|
||||
* **Prometheus**: New rich query editor with syntax highlighting, metric and range auto complete and integrated function docs. [#5117](https://github.com/grafana/grafana/issues/5117)
|
||||
- **Table panel**: Render cell values as links that can have an URL template that uses variables from current table row. [#3754](https://github.com/grafana/grafana/issues/3754)
|
||||
- **Elasticsearch**: Add ad hoc filters directly by clicking values in table panel [#8052](https://github.com/grafana/grafana/issues/8052).
|
||||
- **MySQL**: New rich query editor with syntax highlighting
|
||||
- **Prometheus**: New rich query editor with syntax highlighting, metric and range auto complete and integrated function docs. [#5117](https://github.com/grafana/grafana/issues/5117)
|
||||
|
||||
### Enhancements
|
||||
|
||||
* **GitHub OAuth**: Support for GitHub organizations with 100+ teams. [#8846](https://github.com/grafana/grafana/issues/8846), thx [@skwashd](https://github.com/skwashd)
|
||||
* **Graphite**: Calls to Graphite API /metrics/find now include panel or dashboard time range (from and until) in most cases, [#8055](https://github.com/grafana/grafana/issues/8055)
|
||||
* **Graphite**: Added new graphite 1.0 functions, available if you set version to 1.0.x in data source settings. New Functions: mapSeries, reduceSeries, isNonNull, groupByNodes, offsetToZero, grep, weightedAverage, removeEmptySeries, aggregateLine, averageOutsidePercentile, delay, exponentialMovingAverage, fallbackSeries, integralByInterval, interpolate, invert, linearRegression, movingMin, movingMax, movingSum, multiplySeriesWithWildcards, pow, powSeries, removeBetweenPercentile, squareRoot, timeSlice, closes [#8261](https://github.com/grafana/grafana/issues/8261)
|
||||
- **GitHub OAuth**: Support for GitHub organizations with 100+ teams. [#8846](https://github.com/grafana/grafana/issues/8846), thx [@skwashd](https://github.com/skwashd)
|
||||
- **Graphite**: Calls to Graphite API /metrics/find now include panel or dashboard time range (from and until) in most cases, [#8055](https://github.com/grafana/grafana/issues/8055)
|
||||
- **Graphite**: Added new graphite 1.0 functions, available if you set version to 1.0.x in data source settings. New Functions: mapSeries, reduceSeries, isNonNull, groupByNodes, offsetToZero, grep, weightedAverage, removeEmptySeries, aggregateLine, averageOutsidePercentile, delay, exponentialMovingAverage, fallbackSeries, integralByInterval, interpolate, invert, linearRegression, movingMin, movingMax, movingSum, multiplySeriesWithWildcards, pow, powSeries, removeBetweenPercentile, squareRoot, timeSlice, closes [#8261](https://github.com/grafana/grafana/issues/8261)
|
||||
- **Elasticsearch**: Ad-hoc filters now use query phrase match filters instead of term filters, works on non keyword/raw fields [#9095](https://github.com/grafana/grafana/issues/9095).
|
||||
|
||||
### Breaking change
|
||||
|
||||
* **InfluxDB/Elasticsearch**: The panel and data source option named "Group by time interval" is now named "Min time interval" and does now always define a lower limit for the auto group by time. Without having to use `>` prefix (that prefix still works). This should in theory have close to zero actual impact on existing dashboards. It does mean that if you used this setting to define a hard group by time interval of, say "1d", if you zoomed to a time range wide enough the time range could increase above the "1d" range as the setting is now always considered a lower limit.
|
||||
- **InfluxDB/Elasticsearch**: The panel and data source option named "Group by time interval" is now named "Min time interval" and does now always define a lower limit for the auto group by time. Without having to use `>` prefix (that prefix still works). This should in theory have close to zero actual impact on existing dashboards. It does mean that if you used this setting to define a hard group by time interval of, say "1d", if you zoomed to a time range wide enough the time range could increase above the "1d" range as the setting is now always considered a lower limit.
|
||||
|
||||
This option is now renamed (and moved to Options sub section above your queries):
|
||||
|
||||
@@ -61,10 +61,10 @@ Data source selection and options and help are now above your metric queries.
|
||||
|
||||
### Minor Changes
|
||||
|
||||
* **InfluxDB**: Change time range filter for absolute time ranges to be inclusive instead of exclusive [#8319](https://github.com/grafana/grafana/issues/8319), thx [@Oxydros](https://github.com/Oxydros)
|
||||
* **InfluxDB**: Added parenthesis around tag filters in queries [#9131](https://github.com/grafana/grafana/pull/9131)
|
||||
- **InfluxDB**: Change time range filter for absolute time ranges to be inclusive instead of exclusive [#8319](https://github.com/grafana/grafana/issues/8319), thx [@Oxydros](https://github.com/Oxydros)
|
||||
- **InfluxDB**: Added parenthesis around tag filters in queries [#9131](https://github.com/grafana/grafana/pull/9131)
|
||||
|
||||
## Bug Fixes
|
||||
|
||||
* **Modals**: Maintain scroll position after opening/leaving modal [#8800](https://github.com/grafana/grafana/issues/8800)
|
||||
* **Templating**: You cannot select data source variables as data source for other template variables [#7510](https://github.com/grafana/grafana/issues/7510)
|
||||
- **Modals**: Maintain scroll position after opening/leaving modal [#8800](https://github.com/grafana/grafana/issues/8800)
|
||||
- **Templating**: You cannot select data source variables as data source for other template variables [#7510](https://github.com/grafana/grafana/issues/7510)
|
||||
|
||||
@@ -43,32 +43,32 @@ This makes exploring and filtering Prometheus data much easier.
|
||||
|
||||
### New Features
|
||||
|
||||
* **GCS**: Adds support for Google Cloud Storage [#8370](https://github.com/grafana/grafana/issues/8370) thx [@chuhlomin](https://github.com/chuhlomin)
|
||||
* **Prometheus**: Adds /metrics endpoint for exposing Grafana metrics. [#9187](https://github.com/grafana/grafana/pull/9187)
|
||||
* **Graph**: Add support for local formatting in axis. [#1395](https://github.com/grafana/grafana/issues/1395), thx [@m0nhawk](https://github.com/m0nhawk)
|
||||
* **Jaeger**: Add support for open tracing using jaeger in Grafana. [#9213](https://github.com/grafana/grafana/pull/9213)
|
||||
* **Unit types**: New date and time unit types added, useful in singlestat to show dates and times. [#3678](https://github.com/grafana/grafana/issues/3678), [#6710](https://github.com/grafana/grafana/issues/6710), [#2764](https://github.com/grafana/grafana/issues/2764)
|
||||
* **CLI**: Make it possible to install plugins from any URL [#5873](https://github.com/grafana/grafana/issues/5873)
|
||||
* **Prometheus**: Add support for instant queries [#5765](https://github.com/grafana/grafana/issues/5765), thx [@mtanda](https://github.com/mtanda)
|
||||
* **Cloudwatch**: Add support for alerting using the cloudwatch data source [#8050](https://github.com/grafana/grafana/pull/8050), thx [@mtanda](https://github.com/mtanda)
|
||||
* **Pagerduty**: Include triggering series in pagerduty notification [#8479](https://github.com/grafana/grafana/issues/8479), thx [@rickymoorhouse](https://github.com/rickymoorhouse)
|
||||
* **Timezone**: Time ranges like Today and Yesterday now work correctly when timezone setting is set to UTC [#8916](https://github.com/grafana/grafana/issues/8916), thx [@ctide](https://github.com/ctide)
|
||||
* **Prometheus**: Align $__interval with the step parameters. [#9226](https://github.com/grafana/grafana/pull/9226), thx [@alin-amana](https://github.com/alin-amana)
|
||||
* **Prometheus**: Autocomplete for label name and label value [#9208](https://github.com/grafana/grafana/pull/9208), thx [@mtanda](https://github.com/mtanda)
|
||||
* **Postgres**: New Postgres data source [#9209](https://github.com/grafana/grafana/pull/9209), thx [@svenklemm](https://github.com/svenklemm)
|
||||
* **Data sources**: closes [#9371](https://github.com/grafana/grafana/issues/9371), [#5334](https://github.com/grafana/grafana/issues/5334), [#8812](https://github.com/grafana/grafana/issues/8812), thx [@mattbostock](https://github.com/mattbostock)
|
||||
- **GCS**: Adds support for Google Cloud Storage [#8370](https://github.com/grafana/grafana/issues/8370) thx [@chuhlomin](https://github.com/chuhlomin)
|
||||
- **Prometheus**: Adds /metrics endpoint for exposing Grafana metrics. [#9187](https://github.com/grafana/grafana/pull/9187)
|
||||
- **Graph**: Add support for local formatting in axis. [#1395](https://github.com/grafana/grafana/issues/1395), thx [@m0nhawk](https://github.com/m0nhawk)
|
||||
- **Jaeger**: Add support for open tracing using jaeger in Grafana. [#9213](https://github.com/grafana/grafana/pull/9213)
|
||||
- **Unit types**: New date and time unit types added, useful in singlestat to show dates and times. [#3678](https://github.com/grafana/grafana/issues/3678), [#6710](https://github.com/grafana/grafana/issues/6710), [#2764](https://github.com/grafana/grafana/issues/2764)
|
||||
- **CLI**: Make it possible to install plugins from any URL [#5873](https://github.com/grafana/grafana/issues/5873)
|
||||
- **Prometheus**: Add support for instant queries [#5765](https://github.com/grafana/grafana/issues/5765), thx [@mtanda](https://github.com/mtanda)
|
||||
- **Cloudwatch**: Add support for alerting using the cloudwatch data source [#8050](https://github.com/grafana/grafana/pull/8050), thx [@mtanda](https://github.com/mtanda)
|
||||
- **Pagerduty**: Include triggering series in pagerduty notification [#8479](https://github.com/grafana/grafana/issues/8479), thx [@rickymoorhouse](https://github.com/rickymoorhouse)
|
||||
- **Timezone**: Time ranges like Today and Yesterday now work correctly when timezone setting is set to UTC [#8916](https://github.com/grafana/grafana/issues/8916), thx [@ctide](https://github.com/ctide)
|
||||
- **Prometheus**: Align $__interval with the step parameters. [#9226](https://github.com/grafana/grafana/pull/9226), thx [@alin-amana](https://github.com/alin-amana)
|
||||
- **Prometheus**: Autocomplete for label name and label value [#9208](https://github.com/grafana/grafana/pull/9208), thx [@mtanda](https://github.com/mtanda)
|
||||
- **Postgres**: New Postgres data source [#9209](https://github.com/grafana/grafana/pull/9209), thx [@svenklemm](https://github.com/svenklemm)
|
||||
- **Data sources**: closes [#9371](https://github.com/grafana/grafana/issues/9371), [#5334](https://github.com/grafana/grafana/issues/5334), [#8812](https://github.com/grafana/grafana/issues/8812), thx [@mattbostock](https://github.com/mattbostock)
|
||||
|
||||
### Minor Changes
|
||||
|
||||
* **SMTP**: Make it possible to set specific EHLO for SMTP client. [#9319](https://github.com/grafana/grafana/issues/9319)
|
||||
* **Dataproxy**: Allow Grafana to renegotiate TLS connection [#9250](https://github.com/grafana/grafana/issues/9250)
|
||||
* **HTTP**: set net.Dialer.DualStack to true for all HTTP clients [#9367](https://github.com/grafana/grafana/pull/9367)
|
||||
* **Alerting**: Add diff and percent diff as series reducers [#9386](https://github.com/grafana/grafana/pull/9386), thx [@shanhuhai5739](https://github.com/shanhuhai5739)
|
||||
* **Slack**: Allow images to be uploaded to slack when Token is present [#7175](https://github.com/grafana/grafana/issues/7175), thx [@xginn8](https://github.com/xginn8)
|
||||
* **Opsgenie**: Use their latest API instead of old version [#9399](https://github.com/grafana/grafana/pull/9399), thx [@cglrkn](https://github.com/cglrkn)
|
||||
* **Table**: Add support for displaying the timestamp with milliseconds [#9429](https://github.com/grafana/grafana/pull/9429), thx [@s1061123](https://github.com/s1061123)
|
||||
* **Hipchat**: Add metrics, message and image to hipchat notifications [#9110](https://github.com/grafana/grafana/issues/9110), thx [@eloo](https://github.com/eloo)
|
||||
* **Postgres**: modify group by time macro so it can be used in select clause [#9527](https://github.com/grafana/grafana/pull/9527), thanks [@svenklemm](https://github.com/svenklemm)
|
||||
- **SMTP**: Make it possible to set specific EHLO for SMTP client. [#9319](https://github.com/grafana/grafana/issues/9319)
|
||||
- **Dataproxy**: Allow Grafana to renegotiate TLS connection [#9250](https://github.com/grafana/grafana/issues/9250)
|
||||
- **HTTP**: set net.Dialer.DualStack to true for all HTTP clients [#9367](https://github.com/grafana/grafana/pull/9367)
|
||||
- **Alerting**: Add diff and percent diff as series reducers [#9386](https://github.com/grafana/grafana/pull/9386), thx [@shanhuhai5739](https://github.com/shanhuhai5739)
|
||||
- **Slack**: Allow images to be uploaded to slack when Token is present [#7175](https://github.com/grafana/grafana/issues/7175), thx [@xginn8](https://github.com/xginn8)
|
||||
- **Opsgenie**: Use their latest API instead of old version [#9399](https://github.com/grafana/grafana/pull/9399), thx [@cglrkn](https://github.com/cglrkn)
|
||||
- **Table**: Add support for displaying the timestamp with milliseconds [#9429](https://github.com/grafana/grafana/pull/9429), thx [@s1061123](https://github.com/s1061123)
|
||||
- **Hipchat**: Add metrics, message and image to hipchat notifications [#9110](https://github.com/grafana/grafana/issues/9110), thx [@eloo](https://github.com/eloo)
|
||||
- **Postgres**: modify group by time macro so it can be used in select clause [#9527](https://github.com/grafana/grafana/pull/9527), thanks [@svenklemm](https://github.com/svenklemm)
|
||||
|
||||
### Tech
|
||||
* **Go**: Grafana is now built using golang 1.9
|
||||
- **Go**: Grafana is now built using golang 1.9
|
||||
|
||||
@@ -14,13 +14,13 @@ weight = -7
|
||||
|
||||
Grafana v5.1 brings new features, many enhancements and bug fixes. This article will detail the major new features and enhancements.
|
||||
|
||||
* [Improved scrolling experience]({{< relref "#improved-scrolling-experience" >}})
|
||||
* [Improved docker image]({{< relref "#improved-docker-image-breaking-change" >}}) with a breaking change!
|
||||
* [Heatmap support for Prometheus]({{< relref "#prometheus" >}})
|
||||
* [Microsoft SQL Server]({{< relref "#microsoft-sql-server" >}}) as metric and table data source!
|
||||
* [Dashboards and Panels]({{< relref "#dashboards-panels" >}}) Improved adding panels to dashboards and enhancements to Graph and Table panels.
|
||||
* [New variable interpolation syntax]({{< relref "#new-variable-interpolation-syntax" >}})
|
||||
* [Improved workflow for provisioned dashboards]({{< relref "#improved-workflow-for-provisioned-dashboards" >}})
|
||||
- [Improved scrolling experience]({{< relref "#improved-scrolling-experience" >}})
|
||||
- [Improved docker image]({{< relref "#improved-docker-image-breaking-change" >}}) with a breaking change!
|
||||
- [Heatmap support for Prometheus]({{< relref "#prometheus" >}})
|
||||
- [Microsoft SQL Server]({{< relref "#microsoft-sql-server" >}}) as metric and table data source!
|
||||
- [Dashboards and Panels]({{< relref "#dashboards-panels" >}}) Improved adding panels to dashboards and enhancements to Graph and Table panels.
|
||||
- [New variable interpolation syntax]({{< relref "#new-variable-interpolation-syntax" >}})
|
||||
- [Improved workflow for provisioned dashboards]({{< relref "#improved-workflow-for-provisioned-dashboards" >}})
|
||||
|
||||
## Improved scrolling experience
|
||||
|
||||
@@ -110,8 +110,8 @@ Filter Option | Example | Raw | Interpolated | Description
|
||||
|
||||
Grafana v5.1 brings an improved workflow for provisioned dashboards:
|
||||
|
||||
* A populated `id` property in JSON is now automatically removed when provisioning dashboards.
|
||||
* When making changes to a provisioned dashboard you can `Save` the dashboard which now will bring up a *Cannot save provisioned dashboard* dialog like seen in the screenshot to the right.
|
||||
- A populated `id` property in JSON is now automatically removed when provisioning dashboards.
|
||||
- When making changes to a provisioned dashboard you can `Save` the dashboard which now will bring up a *Cannot save provisioned dashboard* dialog like seen in the screenshot to the right.
|
||||
|
||||
|
||||
Available options in the dialog will let you `Copy JSON to Clipboard` and/or `Save JSON to file` which can help you synchronize your dashboard changes back to the provisioning source.
|
||||
|
||||
@@ -143,10 +143,10 @@ Read more about the short-lived token solution and how to configure it [here](/a
|
||||
|
||||
Besides these changes we have also made security improvements regarding Cross-Site Request Forgery (CSRF) and Cross-site Scripting (XSS) vulnerabilities:
|
||||
|
||||
* Cookies are per default using the [SameSite](/administration/configuration/#cookie-samesite) attribute to protect against CSRF attacks
|
||||
* Script tags in text panels are per default [disabled](/administration/configuration/#disable-sanitize-html) to protect against XSS attacks
|
||||
- Cookies are per default using the [SameSite](/administration/configuration/#cookie-samesite) attribute to protect against CSRF attacks
|
||||
- Script tags in text panels are per default [disabled](/administration/configuration/#disable-sanitize-html) to protect against XSS attacks
|
||||
|
||||
> If you're using [Auth Proxy Authentication](/auth/auth-proxy/) you still need to have user sessions set up and configured
|
||||
> **Note:** If you're using [Auth Proxy Authentication](/auth/auth-proxy/) you still need to have user sessions set up and configured
|
||||
but our goal is to remove this requirement in the near future.
|
||||
|
||||
## Named Colors
|
||||
|
||||
@@ -16,31 +16,31 @@ weight = 9
|
||||
The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving
|
||||
dashboards, creating users and updating data sources.
|
||||
|
||||
## Supported HTTP APIs:
|
||||
## Supported HTTP APIs
|
||||
|
||||
|
||||
* [Authentication API]({{< relref "auth.md" >}})
|
||||
* [Dashboard API]({{< relref "dashboard.md" >}})
|
||||
* [Dashboard Versions API]({{< relref "dashboard_versions.md" >}})
|
||||
* [Dashboard Permissions API]({{< relref "dashboard_permissions.md" >}})
|
||||
* [Folder API]({{< relref "folder.md" >}})
|
||||
* [Folder Permissions API]({{< relref "folder_permissions.md" >}})
|
||||
* [Folder/dashboard search API]({{< relref "folder_dashboard_search.md" >}})
|
||||
* [Data Source API]({{< relref "data_source.md" >}})
|
||||
* [Organization API]({{< relref "org.md" >}})
|
||||
* [Snapshot API]({{< relref "snapshot.md" >}})
|
||||
* [Annotations API]({{< relref "annotations.md" >}})
|
||||
* [Playlists API]({{< relref "playlist.md" >}})
|
||||
* [Alerting API]({{< relref "alerting.md" >}})
|
||||
* [Alert Notification Channels API]({{< relref "alerting_notification_channels.md" >}})
|
||||
* [User API]({{< relref "user.md" >}})
|
||||
* [Team API]({{< relref "team.md" >}})
|
||||
* [Admin API]({{< relref "admin.md" >}})
|
||||
* [Preferences API]({{< relref "preferences.md" >}})
|
||||
* [Other API]({{< relref "other.md" >}})
|
||||
- [Authentication API]({{< relref "auth.md" >}})
|
||||
- [Dashboard API]({{< relref "dashboard.md" >}})
|
||||
- [Dashboard Versions API]({{< relref "dashboard_versions.md" >}})
|
||||
- [Dashboard Permissions API]({{< relref "dashboard_permissions.md" >}})
|
||||
- [Folder API]({{< relref "folder.md" >}})
|
||||
- [Folder Permissions API]({{< relref "folder_permissions.md" >}})
|
||||
- [Folder/dashboard search API]({{< relref "folder_dashboard_search.md" >}})
|
||||
- [Data Source API]({{< relref "data_source.md" >}})
|
||||
- [Organization API]({{< relref "org.md" >}})
|
||||
- [Snapshot API]({{< relref "snapshot.md" >}})
|
||||
- [Annotations API]({{< relref "annotations.md" >}})
|
||||
- [Playlists API]({{< relref "playlist.md" >}})
|
||||
- [Alerting API]({{< relref "alerting.md" >}})
|
||||
- [Alert Notification Channels API]({{< relref "alerting_notification_channels.md" >}})
|
||||
- [User API]({{< relref "user.md" >}})
|
||||
- [Team API]({{< relref "team.md" >}})
|
||||
- [Admin API]({{< relref "admin.md" >}})
|
||||
- [Preferences API]({{< relref "preferences.md" >}})
|
||||
- [Other API]({{< relref "other.md" >}})
|
||||
|
||||
### Grafana Enterprise HTTP APIs
|
||||
|
||||
* [Data Source Permissions API]({{< relref "datasource_permissions.md" >}})
|
||||
* [External Group Sync API]({{< relref "external_group_sync.md" >}})
|
||||
* [Reporting API]({{< relref "reporting.md" >}})
|
||||
- [Data Source Permissions API]({{< relref "datasource_permissions.md" >}})
|
||||
- [External Group Sync API]({{< relref "external_group_sync.md" >}})
|
||||
- [Reporting API]({{< relref "reporting.md" >}})
|
||||
|
||||
@@ -93,8 +93,8 @@ If you install the `.deb` package, then you will need to manually update Grafana
|
||||
* The most recent Grafana version is selected by default.
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
- **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
1. Depending on which system you are running, click **Linux** or **ARM**.
|
||||
1. Copy and paste the code from the installation page into your command line and run. It follows the pattern shown below.
|
||||
|
||||
|
||||
@@ -157,9 +157,9 @@ The Docker container for Grafana has seen a major rewrite for 5.1.
|
||||
|
||||
**Important changes**
|
||||
|
||||
* File ownership is no longer modified during startup with `chown`.
|
||||
* Default user ID is now `472` instead of `104`.
|
||||
* Removed the following implicit volumes:
|
||||
- File ownership is no longer modified during startup with `chown`.
|
||||
- Default user ID is now `472` instead of `104`.
|
||||
- Removed the following implicit volumes:
|
||||
- `/var/lib/grafana`
|
||||
- `/etc/grafana`
|
||||
- `/var/log/grafana`
|
||||
|
||||
@@ -85,11 +85,11 @@ sudo yum install grafana-enterprise
|
||||
If you install manually with YUM, then you will need to manually update Grafana for each new version. To enable automatic updates for your Grafana installation please use the instructions below to install via our YUM repository.
|
||||
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
* The most recent Grafana version is selected by default.
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want enterprise features.
|
||||
- **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want enterprise features.
|
||||
1. Depending on which system you are running, click **Linux** or **ARM**.
|
||||
1. Copy and paste the code from the installation page into your command line and run. It follows the pattern shown below.
|
||||
|
||||
@@ -110,11 +110,11 @@ If you install with RPM, then you will need to manually update Grafana for each
|
||||
**Note:** The .rpm files are signed, you can verify the signature with this [public GPG key](https://packages.grafana.com/gpg.key).
|
||||
|
||||
1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install.
|
||||
* The most recent Grafana version is selected by default.
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
- **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
1. Depending on which system you are running, click **Linux** or **ARM**.
|
||||
1. Copy and paste the .rpm package URL and the local .rpm package information from the installation page into the pattern shown below, then run the commands.
|
||||
|
||||
|
||||
@@ -17,11 +17,11 @@ installation.
|
||||
|
||||
1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows).
|
||||
1. Select a Grafana version you want to install.
|
||||
* The most recent Grafana version is selected by default.
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
- **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
1. Click **Windows**.
|
||||
|
||||
You can either use the Windows installer or you can install a standalone Windows binary.
|
||||
|
||||
@@ -20,31 +20,31 @@ You can also use template variables in your data links URLs, refer to [Templates
|
||||
|
||||
These variables allow you to include the current time range in the data link URL.
|
||||
|
||||
* ``__url_time_range`` - current dashboard's time range (i.e. ``?from=now-6h&to=now``)
|
||||
* `$__from and $__to` - For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables.md#__from-and-__to" >}}).
|
||||
- ``__url_time_range`` - current dashboard's time range (i.e. ``?from=now-6h&to=now``)
|
||||
- `$__from and $__to` - For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables.md#__from-and-__to" >}}).
|
||||
|
||||
## Series variables
|
||||
|
||||
Series specific variables are available under ``__series`` namespace:
|
||||
|
||||
* ``__series.name`` - series name to the URL
|
||||
* ``__series.labels.<LABEL>`` - label's value to the URL. If your label contains dots use ``__series.labels["<LABEL>"]`` syntax
|
||||
- ``__series.name`` - series name to the URL
|
||||
- ``__series.labels.<LABEL>`` - label's value to the URL. If your label contains dots, then use ``__series.labels["<LABEL>"]`` syntax.
|
||||
|
||||
## Field variables
|
||||
|
||||
Field-specific variables are available under ``__field`` namespace:
|
||||
|
||||
* ``__field.name`` - the name of the field
|
||||
- ``__field.name`` - the name of the field
|
||||
|
||||
## Value variables
|
||||
|
||||
Value-specific variables are available under ``__value`` namespace:
|
||||
|
||||
* ``__value.time`` - value's timestamp (Unix ms epoch) to the URL (i.e. ``?time=1560268814105``)
|
||||
* ``__value.raw`` - raw value
|
||||
* ``__value.numeric`` - numeric representation of a value
|
||||
* ``__value.text`` - text representation of a value
|
||||
* ``__value.calc`` - calculation name if the value is result of calculation
|
||||
- ``__value.time`` - value's timestamp (Unix ms epoch) to the URL (i.e. ``?time=1560268814105``)
|
||||
- ``__value.raw`` - raw value
|
||||
- ``__value.numeric`` - numeric representation of a value
|
||||
- ``__value.text`` - text representation of a value
|
||||
- ``__value.calc`` - calculation name if the value is result of calculation
|
||||
|
||||
## Template variables
|
||||
|
||||
|
||||
@@ -19,10 +19,10 @@ The panel inspector displays Inspect: <NameOfPanelBeingInspected> at the top of
|
||||
|
||||
The panel inspector consists of four tabs:
|
||||
|
||||
* **Data tab -** Shows the raw data returned by the query with transformations applied. Field options such as overrides and value mappings are not applied by default.
|
||||
* **Stats tab -** Shows how long your query takes and how much it returns.
|
||||
* **JSON tab -** Allows you to view and copy the panel JSON, panel data JSON, and data frame structure JSON. This is useful if you are provisioning or administering Grafana.
|
||||
* **Query tab -** Shows you the requests to the server sent when Grafana queries the data source.
|
||||
- **Data tab -** Shows the raw data returned by the query with transformations applied. Field options such as overrides and value mappings are not applied by default.
|
||||
- **Stats tab -** Shows how long your query takes and how much it returns.
|
||||
- **JSON tab -** Allows you to view and copy the panel JSON, panel data JSON, and data frame structure JSON. This is useful if you are provisioning or administering Grafana.
|
||||
- **Query tab -** Shows you the requests to the server sent when Grafana queries the data source.
|
||||
|
||||
> **Note:** Not all panel types include all four tabs. For example, dashboard list panels do not have raw data to inspect, so they do not display the Stats, Data, or Query tabs.
|
||||
|
||||
@@ -46,8 +46,8 @@ View raw query results in a table. This is the data returned by the query with t
|
||||
|
||||
1. Open the panel inspector and then click the **Data** tab or in the panel menu click **Inspect > Data**.
|
||||
1. If your panel contains multiple queries or queries multiple nodes, then you have additional options.
|
||||
* **Select result -** Choose which result set data you want to view.
|
||||
* **Transform data**
|
||||
- **Select result -** Choose which result set data you want to view.
|
||||
- **Transform data**
|
||||
- **Join by time -** View raw data from all your queries at once, one result set per column. Click a column heading to reorder the data.
|
||||
|
||||
View raw query results in a table with field options and options overrides applied:
|
||||
@@ -78,9 +78,9 @@ Explore and export panel, panel data, and data frame JSON models.
|
||||
|
||||
1. Open the panel inspector and then click the **JSON** tab or in the panel menu click **Inspect > Panel JSON**.
|
||||
1. In Select source, choose one of the following options:
|
||||
* **Panel JSON -** Displays a JSON object representing the panel.
|
||||
* **Panel data -** Displays a JSON object representing the data that was passed to the panel.
|
||||
* **DataFrame structure -** Displays the raw result set with transformations, field configuration, and overrides configuration applied.
|
||||
- **Panel JSON -** Displays a JSON object representing the panel.
|
||||
- **Panel data -** Displays a JSON object representing the data that was passed to the panel.
|
||||
- **DataFrame structure -** Displays the raw result set with transformations, field configuration, and overrides configuration applied.
|
||||
1. You can expand or collapse portions of the JSON to explore it, or you can click **Copy to clipboard** and paste the JSON in another application.
|
||||
|
||||
### View raw request and response to data source
|
||||
|
||||
@@ -49,10 +49,10 @@ For more information about writing a query for your data source, refer to the sp
|
||||
|
||||
The Query tab consists of the following elements:
|
||||
|
||||
* Data source selector
|
||||
* Query options
|
||||
* Query inspector button
|
||||
* Query editor list
|
||||
- Data source selector
|
||||
- Query options
|
||||
- Query inspector button
|
||||
- Query editor list
|
||||
|
||||
{{< docs-imagebox img="/img/docs/queries/query-editor-7-2.png" class="docs-image--no-shadow" max-width="1000px" >}}
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ weight = 300
|
||||
Thresholds set the color of either the value text or the background depending on conditions that you define.
|
||||
|
||||
You can define thresholds one of two ways:
|
||||
* **Absolute** thresholds are defined based on a number. For example, 80 on a scale of 1 to 150.
|
||||
* **Percentage** thresholds are defined relative to minimum or maximum. For example, 80 percent.
|
||||
- **Absolute** thresholds are defined based on a number. For example, 80 on a scale of 1 to 150.
|
||||
- **Percentage** thresholds are defined relative to minimum or maximum. For example, 80 percent.
|
||||
|
||||
You can apply thresholds to the following visualizations:
|
||||
|
||||
@@ -26,9 +26,9 @@ You can apply thresholds to the following visualizations:
|
||||
## Default thresholds
|
||||
|
||||
On visualizations that support it, Grafana sets default threshold values of:
|
||||
* 80 = red
|
||||
* Base = green
|
||||
* Mode = Absolute
|
||||
- 80 = red
|
||||
- Base = green
|
||||
- Mode = Absolute
|
||||
|
||||
The **Base** value represents minus infinity. It is generally the “good” color.
|
||||
|
||||
@@ -43,9 +43,9 @@ You can add as many thresholds to a panel as you want. Grafana automatically sor
|
||||
1. Click **Add threshold**.
|
||||
1. Grafana adds a threshold with suggested numerical and color values.
|
||||
1. Accept the recommendations or edit the new threshold.
|
||||
* **Edit color:** Click the color dot you wish to change and then select a new color.
|
||||
* **Edit number:** Click the number you wish to change and then enter a new number.
|
||||
* **Thresholds mode -** Click the mode to change it for all thresholds on this panel.
|
||||
- **Edit color:** Click the color dot you wish to change and then select a new color.
|
||||
- **Edit number:** Click the number you wish to change and then enter a new number.
|
||||
- **Thresholds mode -** Click the mode to change it for all thresholds on this panel.
|
||||
1. Click **Save** to save the changes in the dashboard.
|
||||
|
||||
## Add a threshold to a Graph panel
|
||||
@@ -56,17 +56,17 @@ In the Graph panel visualization, thresholds allow you to add arbitrary lines or
|
||||
1. On the Panel tab, click **Thresholds**.
|
||||
1. Click **Add threshold**.
|
||||
1. Fill in as many fields as you want. Only the **T1** fields are required.
|
||||
* **T1 -** Both values are required to display a threshold.
|
||||
* **lt** or **gt** - Select **lt** for less than or **gt** for greater than to indicate what the threshold applies to.
|
||||
* **Value -** Enter a threshold value. Grafana draws a threshold line along the Y-axis at that value.
|
||||
* **Color -** Choose a condition that corresponds to a color, or define your own color.
|
||||
* **custom -** You define the fill color and line color.
|
||||
* **critical -** Fill and line color are red.
|
||||
* **warning -** Fill and line color are yellow.
|
||||
* **ok -** Fill and line color are green.
|
||||
* **Fill -** Controls whether the threshold fill is displayed.
|
||||
* **Line -** Controls whether the threshold line is displayed.
|
||||
* **Y-Axis -** Choose **left** or **right**.
|
||||
- **T1 -** Both values are required to display a threshold.
|
||||
- **lt** or **gt** - Select **lt** for less than or **gt** for greater than to indicate what the threshold applies to.
|
||||
- **Value -** Enter a threshold value. Grafana draws a threshold line along the Y-axis at that value.
|
||||
- **Color -** Choose a condition that corresponds to a color, or define your own color.
|
||||
- **custom -** You define the fill color and line color.
|
||||
- **critical -** Fill and line color are red.
|
||||
- **warning -** Fill and line color are yellow.
|
||||
- **ok -** Fill and line color are green.
|
||||
- **Fill -** Controls whether the threshold fill is displayed.
|
||||
- **Line -** Controls whether the threshold line is displayed.
|
||||
- **Y-Axis -** Choose **left** or **right**.
|
||||
1. Click **Save** to save the changes in the dashboard.
|
||||
|
||||
## Delete a threshold
|
||||
|
||||
Reference in New Issue
Block a user