diff --git a/docs/sources/_index.md b/docs/sources/_index.md index bbb23e6a5a9..93f31d24456 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -60,8 +60,8 @@ aliases = ["/v1.1", "/guides/reference/admin", "/v3.1"]

Provisioning

Learn how to automate your Grafana configuration.

- }}" class="nav-cards__item nav-cards__item--guide"> -

What's new in v6.4

+ }}" class="nav-cards__item nav-cards__item--guide"> +

What's new in v6.5

Explore the features and enhancements in the latest release.

 }}" class="nav-cards__item nav-cards__item--guide"> diff --git a/docs/sources/guides/whats-new-in-v6-5.md b/docs/sources/guides/whats-new-in-v6-5.md index 29625e393ed..89064d40275 100644 --- a/docs/sources/guides/whats-new-in-v6-5.md +++ b/docs/sources/guides/whats-new-in-v6-5.md @@ -1,6 +1,6 @@ +++ title = "What's New in Grafana v6.5" -description = "Feature & improvement highlights for Grafana v6.5" +description = "Feature and improvement highlights for Grafana v6.5" keywords = ["grafana", "new", "documentation", "6.5"] type = "docs" [menu.docs] @@ -12,35 +12,37 @@ weight = -16 # What's New in Grafana v6.5 -For all details please read the full [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) +For all details, read the full [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) ## Highlights -Grafana 6.5 comes with a lot of new features and enhancements. +Grafana 6.5 comes with a lot of new features and enhancements: - [**Docker:** Ubuntu-based images and more]({{< relref "#ubuntu-based-docker-images" >}}) - [**CloudWatch:** Major rewrite and lots of enhancements]({{< relref "#cloudwatch-data-source-improvements" >}}) - [**Templating:** Dynamic typeahead queries using $__searchFilter]({{< relref "#dynamic-typeahead-support-in-query-variables" >}}) +- [**Graphite:** Support for additional Metrictank functionality]({{< relref "#graphite-support-for-additional-metrictank-functionality" >}}) - [**Explore:** New log row details view]({{< relref "#explore-logs-log-row-details" >}}) - [**Explore:** Turn parts of log message into a link using derived fields]({{< relref "#loki-explore-derived-fields" >}}) - [**Explore:** Time-sync of split views]({{< relref "#time-sync-of-split-views-in-explore" >}}) -- **Explore**: Tooltip in graphs -- **Azure Monitor**: Alerting support for Azure Application Insights -- **Provisioning**: Allow saving of provisioned dashboards from UI -- **Auth Proxy:** Can now login with auth proxy and get a login token and session cookie -- **OAuth:** Generic OAuth now supports role mapping +- [**Explore**: Hover/tooltip support in graphs]({{< relref "#explore-metrics-graph-hover-tooltip" >}}) +- [**Azure Monitor**: Alerting support for Azure Application Insights]({{< relref "#alerting-support-for-azure-application-insights" >}}) +- [**Provisioning**: Allow saving of provisioned dashboards from UI]({{< relref "#allow-saving-of-provisioned-dashboards-from-ui" >}}) +- [**Auth Proxy:** Mix auth proxy with Grafana login token and session cookie]({{< relref "#mix-auth-proxy-with-grafana-login-token-and-session-cookie" >}}) +- [**OAuth:** Generic OAuth now supports role mapping]({{< relref "#generic-oauth-role-mapping" >}}) +- [**Image Rendering:** Quick update since Grafana 6.4]({{< relref "#image-renderer-plugin" >}}) -More details of above and highlights will be added as we're getting closer to the stable release. +### Ubuntu-based Docker images -### Ubuntu-based docker images +In Grafana [v6.4](/guides/whats-new-in-v6-4/#alpine-based-docker-image), we switched the Grafana Docker image from Ubuntu to Alpine. This change provides a more secure and lightweight Docker image. -In Grafana [v6.4](/guides/whats-new-in-v6-4/#alpine-based-docker-image) we switched the Grafana docker image from Ubuntu to Alpine. The main reason for this change was to be able to provide a more secure and lightweight docker image. +This change has received both negative and positive feedback as well as some bug reports. We learned that switching to an Alpine-based Docker image was a big breaking change for a lot of users. We should have more clearly highlighted this in blog post, release notes, changelog, and the [Docker Hub readme](https://hub.docker.com/r/grafana/grafana). -This change has received both negative and positive feedback as well as some bug reports. Based on this, one of the conclusions and learnings is that switching to an Alpine based docker image was a big breaking change for a lot of users and this change should have been more clearly highlighted in blog post, release notes, changelog and the [Docker Hub readme](https://hub.docker.com/r/grafana/grafana). +We also broke the Docker images for ARM, but this is fixed in Grafana v6.5. -One additional mistake we did was to break the Docker images for ARM. Good news, in Grafana v6.5 this have been fixed. +Grafana Docker images should be as secure as possible by default and that’s why the Alpine-based Docker images will continue to be the Grafana default (`grafana/grafana:`). With that said, it’s good to give users options, and that’s why starting from Grafana v6.5, Ubuntu-based Docker images are also (`grafana/grafana:-ubuntu`) available. -Grafana docker images should be as secure as possible by default and that’s why the Alpine based docker images will continue to be provided as Grafana’s default (`grafana/grafana:`). With that said, it’s good to give users options and that’s why starting from Grafana v6.5 there’re also Ubuntu based docker images (`grafana/grafana:-ubuntu`) available. +Read more about [Installing using Docker](/installation/docker/). ### CloudWatch data source improvements @@ -54,27 +56,27 @@ While GetMetricStatistics qualified for the CloudWatch API free tier, this is no #### Dynamic queries using dimension wildcards -In Grafana 6.5 or higher, you’re able to monitor a dynamic list of metrics by using the asterisk (\*) wildcard for one or more dimension values. +In Grafana 6.5 or higher, you can monitor a dynamic list of metrics by using the asterisk (\*) wildcard for one or more dimension values. {{< docs-imagebox img="/img/docs/v65/cloudwatch-dimension-wildcard.png" max-width="800px" class="docs-image--right" caption="CloudWatch dimension wildcard" >}} -In the example, all metrics in the namespace `AWS/EC2` with a metric name of `CPUUtilization` and ANY value for the `InstanceId` dimension are queried. This can help you monitor metrics for AWS resources, like EC2 instances or containers. For example, when new instances get created as part of an auto scaling event, they will automatically appear in the graph without you having to track the new instance IDs. You can click on `Show Query Preview` to see the search expression that is automatically built to support wildcards. To learn more about search expressions, visit the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html). +The example queries all metrics in the namespace `AWS/EC2` with a metric name of `CPUUtilization` and _any_ value for the `InstanceId` dimension. This can help you monitor metrics for AWS resources, like EC2 instances or containers. For example, when new instances get created as part of an auto scaling event, they automatically appear in the graph without you having to track new instance IDs. You can click `Show Query Preview` to see the search expression that is automatically built to support wildcards. To learn more about search expressions, visit the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html). -By default, the search expression is defined in such a way that the queried metrics must match the defined dimension names exactly. This means that in the example below only metrics with exactly one dimension with name ‘InstanceId’ will be returned. +By default, the search expression is defined in such a way that the queried metrics must match the defined dimension names exactly. This means that in the example it only returns metrics with exactly one dimension with name ‘InstanceId’. -You can untoggle `Match Exact` to include metrics that have other dimensions defined. Disabling ‘Match Exact’ also creates a search expression even if you don’t use wildcards. We simply search for any metric that match at least the namespace, metric name, and all defined dimensions. +You can untoggle `Match Exact` to include metrics that have other dimensions defined. Turning off `Match Exact` also creates a search expression even if you don’t use wildcards. We simply search for any metric that match at least the namespace, metric name, and all defined dimensions. #### Deep linking from Grafana panels to the CloudWatch console {{< docs-imagebox img="/img/docs/v65/cloudwatch-deep-linking.png" max-width="500px" class="docs-image--right" caption="CloudWatch deep linking" >}} -Left clicking a time series in the panel shows a context menu with a link to `View in CloudWatch console`. Clicking that link will open a new tab that will take you to the CloudWatch console and display all the metrics for that query. If you are not currently logged in to the CloudWatch console, the link will forward you to the login page. The provided link is valid for any account but will only display the right metrics if you are logged in to the account that corresponds to the selected data source in Grafana. +Left-clicking a time series in the panel displays a context menu with a link to `View in CloudWatch console`. Clicking that link opens the CloudWatch console and displays all the metrics for that query. If you are not currently logged in to the CloudWatch console, then the link opens the login page. The link is valid for any account, but it only displays the right metrics if you are logged in to the account that corresponds to the selected data source in Grafana. -This feature is not available for metrics that are based on math expressions. +This feature is not available for metrics based on math expressions. #### Improved feedback when throttling occurs -If the [limit of the GetMetricData API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_limits.html) is reached (either the transactions per second limit or the data points per second limit), a throttling error will be returned by the CloudWatch API. Throttling limits are defined per account and region, so the alert modal will indicate which data source got throttled in which region. A link to request a limit increase will be provided for the affected region, but you will have to log in to the correct account. For example, for us-east-1, a limit increase can be requested [here](https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/monitoring/quotas/L-5E141212). +If the [limit of the GetMetricData API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_limits.html) is reached, either the transactions per second limit or the data points per second limit, then a throttling error will be returned by the CloudWatch API. Throttling limits are defined per account and region, so the alert modal indicates which data source got throttled in which region. A link to request a limit increase for the affected region is provided, but you will have to log in to the correct account. For example, for us-east-1, a limit increase can be requested [here](https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/monitoring/quotas/L-5E141212). #### Multi-value template variables now use search expressions @@ -84,6 +86,20 @@ Search expressions are currently limited to 1024 characters, so your query may f The use of multi-valued template variables is only supported for dimension values. Using multi-valued template variables for `Region`, `Namespace`, or `Metric Name` is not supported. +#### Curated Dashboards + +The updated CloudWatch data source is shipped with pre-configured dashboards for five of the most popular AWS services: + +- Amazon Elastic Compute Cloud `Amazon EC2` +- Amazon Elastic Block Store `Amazon EBS` +- AWS Lambda `AWS Lambda` +- Amazon CloudWatch Logs `Amazon CloudWatch Logs` +- Amazon Relational Database Service `Amazon RDS` + +To import the pre-configured dashboards, go to the configuration page of your CloudWatch data source and click on the `Dashboards` tab. Click `Import` for the dashboard you would like to use. To customize the dashboard, we recommend to save the dashboard under a different name, because otherwise the dashboard will be overwritten when a new version of the dashboard is released. + +{{< docs-imagebox img="/img/docs/v65/cloudwatch-dashboard-import.png" max-width="600px" caption="CloudWatch dashboard import" >}} + ### Dynamic typeahead support in query variables If you have a query variable that has many thousands of values it can be quite slow to search for a specific value in the dropdown. This is due to the fact that all that search filtering is happening in the browser. @@ -106,6 +122,34 @@ tag_values(server, server=~${__searchFilter:regex}) This feature is currently only supported by [Graphite](/features/datasources/graphite/#using-searchfilter-to-filter-results-in-query-variable), [MySQL](/features/datasources/mysql/#using-searchfilter-to-filter-results-in-query-variable) and [Postgres](/features/datasources/postgres/#using-searchfilter-to-filter-results-in-query-variable) data sources. +### Graphite: Support for additional Metrictank functionality + +The Graphite data source now has an option to enable extra functionality when using [Metrictank](https://grafana.com/oss/metrictank/) as a Graphite datastore. +In the Datasource configuration for Graphite, you can change the type to Metrictank. +Metrictank returns 2 kinds of additional metadata along its responses: + +- **Performance information:** Time spent querying index, fetching data, running processing functions, the number of series and points fetched, cache hits/misses, etc. This can be useful for optimizing queries or tuning the chunk cache. +- **Lineage information about the returned series:** Which archive was fetched from (raw or rollup), which (if any) runtime consolidation was applied (using which processing function), etc. This is very useful information for anyone trying to understand how their data was generated and why it may not look as expected. + +To see the metadata response from Metrictank you can inspect the response using the Query Inspector found in the panel queries tab. +Grafana 6.5 includes a new `Panel Inspector` in alpha/preview where you also can see the metadata response from Metrictank. +You can try it out by enabling a feature flag in the Grafana configuration file: + +```bash +[feature_toggles] +enable = inspect +``` + +{{< docs-imagebox img="/img/docs/v65/panel-inspector.png" max-width="400px" caption="New Panel Inspector modal" >}} + +In Grafana 6.6, this will have a more user friendly display. In the future, additional Metrictank functionality will become available when the Graphite datasource option is set to the `Metrictank` type. + +### Explore/Metrics: Graph hover/tooltip + +We finally got around to implementing the series hover that shows values of the timeseries you hover over. This has been a requested feature ever since Explore was released. The graph component has been rewritten from scratch, making it more composable for future interactions with the graph data. + +{{< docs-imagebox img="/img/docs/v65/explore_tooltip.png" max-width="500px" caption="Explore graph tooltip/hover" >}} + ### Explore/Logs: Log row details We have massively simplified the way we display both log row labels/fields as well as parsed fields by putting them into an extendable area in each row. @@ -120,18 +164,48 @@ Derived fields allow any part of a log message to be turned into a link. Leaning This allows you to turn an occurrence of e.g., `traceId=624f706351956b81` in your log line, into a link to your distributed tracing system to view that trace. The configuration for the patterns to match can be found in the datasource settings. -This release starts with support for Loki, but we will bring this concept to other datasources soon. +This release starts with support for Loki, but we will bring this concept to other data sources soon. ### Time-sync of split views in Explore -In Explore's split view, the two timepickers can now be linked so that if you change one, the other gets changed as well. This helps with keeping start and end times of the split view queries in sync and will ensure that you're looking at the same time interval in both split panes. +In the Explore split view, you can now link the two timepickers so that if you change one, the other gets changed as well. This helps with keeping start and end times of the split view queries in sync and will ensure that you're looking at the same time interval in both split panes. {{< docs-imagebox img="/img/docs/v65/explore_time_sync.gif" caption="Time-sync of split views in Explore" >}} +### Alerting support for Azure Application Insights + +The [Azure Monitor](/features/datasources/azuremonitor/) data source supports multiple services in the Azure cloud. Before Grafana v6.5, only the Azure Monitor service had support for [Grafana Alerting](/alerting/rules). In Grafana 6.5, alerting support has been implemented for the [Application Insights service](/features/datasources/azuremonitor/#querying-the-application-insights-service). + +### Allow saving of provisioned dashboards from UI + +Historically it has been possible to make changes to a provisioned dashboard in the Grafana UI. However, it hasn't been possible to save the changes without manual intervention. In Grafana 6.5 we introduce a new dashboard provisioning setting named `allowUiUpdates`. If `allowUiUpdates` is set to `true` and you make changes to a provisioned dashboard, you can save the dashboard and the changes will be persisted to the Grafana database. + +Read more about this new feature in [Provisioning Grafana](/administration/provisioning/#making-changes-to-a-provisioned-dashboard). + +### Mix auth proxy with Grafana login token and session cookie + +With the new setting, `enable_login_token`, set to true Grafana will, after successful auth proxy header validation, assign the user a login token and cookie. You only have to configure your auth proxy to provide headers for the /login route. Requests via other routes will be authenticated using the cookie. + +Read more about this new feature in [Auth Proxy Authentication](/auth/auth-proxy/#login-token-and-session-cookie) + +### Generic OAuth role mapping + +Grafana 6.5 makes it possible to configure Generic OAuth to map a certain response from OAuth provider to a certain Grafana organization role, similar to the existing [LDAP Group Mappings](/auth/ldap/#group-mappings) feature. The new setting is named `role_attribute_path` and expects a [JMESPath](http://jmespath.org/) expression. + +Read more about this new feature in [Generic OAuth Authentication](/auth/generic-oauth/) and make sure to check out the [JMESPath examples](/auth/generic-oauth/#jmespath-examples). + +### Image renderer plugin + +Since we announced the deprecation of PhantomJS and the new [Image Renderer Plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) in Grafana [6.4](/guides/whats-new-in-v6-4/#phantomjs-deprecation), we’ve received bug reports and valuable feedback. + +In Grafana 6.5 we’ve updated documentation to make it easier to understand how to install and troubleshoot possible problems. Read more about [Image Rendering](/administration/image_rendering/). + +Please try the [Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) and let us know what you think. + ## Upgrading See [upgrade notes](/installation/upgrading/#upgrading-to-v6-5). ## Changelog -Checkout the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) file for a complete list of new features, changes, and bug fixes. +Check out [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) for a complete list of new features, changes, and bug fixes.