AWS grafana documentation change
Summary
Added documentation about reserved 'grafana_' label prefix to prevent conflicts
Security assessment
Label prefix reservation is a namespacing convention without explicit security implications mentioned in the change description
Diff
diff --git a/grafana/latest/userguide/version-differences.md b/grafana/latest/userguide/version-differences.md index 42195fdb3..8a50c6477 100644 --- a//grafana/latest/userguide/version-differences.md +++ b//grafana/latest/userguide/version-differences.md @@ -39 +39 @@ The following features were added in Grafana version 10. - * **API key UI deprecation** – [Service accounts](./service-accounts.html) are the recommended way to authenticate calls to the Grafana HTTP APIs. As part of Grafana Labs work toward deprecating API keys, you can no longer create API keys through the workspace user interface. You can only create API keys through the AWS APIs. + * **API key UI discontinued** – [Service accounts](./service-accounts.html) are the recommended way to authenticate calls to the Grafana HTTP APIs. As part of Grafana Labs work toward discontinuing API keys, you can no longer create API keys through the workspace user interface. You can only create API keys through the AWS APIs. @@ -41 +41 @@ The following features were added in Grafana version 10. -For more information about the deprecation of API keys by Grafana Labs, see [APIKeys: Sunsetting of API keys](https://github.com/grafana/grafana/issues/53567) in the Grafana GitHub issues list. +For more information about the discontinuation of API keys by Grafana Labs, see [APIKeys: Sunsetting of API keys](https://github.com/grafana/grafana/issues/53567) in the Grafana GitHub issues list. @@ -52 +52 @@ The following changes might affect some users updating to Grafana version 10. - * **Angular deprecated** – Plugins that use Angular will no longer be supported in future releases of Grafana. In version 10, panels that use angular will show a banner stating that they use a deprecated feature, to give a notice that they won't work in future versions. + * **Angular discontinued** – Plugins that use Angular will no longer be supported in future releases of Grafana. In version 10, panels that use angular will show a banner stating that they use a discontinued feature, to give a notice that they won't work in future versions. @@ -110,0 +111,99 @@ The following features were added in Grafana v9. +**Breaking changes** + +The Grafana version 9.4 release includes a range of new features and improvements, building upon previous versions. This version had some changes that might break functionality in some cases. When updating to a new version, we recommend you test in a non-production environment before updating your production workspaces. + +The following changes might affect some users updating to Grafana version 9.4. For a detailed list of these changes, see the [Grafana 9.4 changelog](https://github.com/grafana/grafana/blob/release-9.4.17/CHANGELOG.md) on _GitHub_. + + * **API discontinued** – The `/api/tsdb/query` API has been removed. + +**Action required:** Use `/api/ds/query` instead. See [Query a data source](https://grafana.com/docs/grafana/latest/http_api/data_source/#query-a-data-source) in the _Grafana public documentation_ and Issue [#49916](https://github.com/grafana/grafana/issues/49916) on _GitHub_. + + * **API endpoint changes** – Several alerting API endpoints now require data source UID instead of numeric ID. + +**Affected endpoints:** `api/v1/rule/test`, `api/prometheus/`, `api/ruler/`, `api/alertmanager/` + +**Action required:** Update API calls to use data source UID as path parameter. See Issues [#48070](https://github.com/grafana/grafana/issues/48070), [#48052](https://github.com/grafana/grafana/issues/48052), [#48046](https://github.com/grafana/grafana/issues/48046), and [#47978](https://github.com/grafana/grafana/issues/47978) on _GitHub_. + + * **Azure Monitor queries removed** – Application Insights and Insight Analytics queries are no longer supported. + +Deprecated in Grafana 8.0, removed in 9.0. Deprecated queries will not execute. + +**Action required:** See [Azure Monitor data source](https://grafana.com/docs/grafana/latest/datasources/azuremonitor/deprecated-application-insights/) in the _Grafana public documentation_ for migration guidance. + + * **Browser access mode removed** – Browser access mode is no longer available for InfluxDB and Prometheus data sources. + +**Action required:** Switch to server access mode in your data source configuration. InfluxDB: Deprecated in 8.0.0, removed in 9.2.0. See Issue [#53529](https://github.com/grafana/grafana/issues/53529) on _GitHub_. Prometheus: Deprecated in 7.4.0, removed in 9.2.0. See Issue [#50162](https://github.com/grafana/grafana/issues/50162) on _GitHub_. + + * **Dashboard settings access restricted** – You can no longer open dashboard settings while editing panels. + +Dashboard settings are locked when panel edit mode is active. Close panel edit mode before accessing dashboard settings. See Issue [#54746](https://github.com/grafana/grafana/issues/54746) on _GitHub_. + + * **Data source password encryption** – Unencrypted passwords are no longer supported. + +**Action required:** Use `secureJsonData.password` and `secureJsonData.basicAuthPassword`. Previously discontinued in v8.1.0. See Issue [#49987](https://github.com/grafana/grafana/issues/49987) on _GitHub_. + + * **Default data source behavior** – Default data source selection no longer affects existing panels. + +Default data source only applies to new panels. Changing the default won't update existing dashboards. Previously saved panels retain their data source configuration. See Issue [#45132](https://github.com/grafana/grafana/issues/45132) on _GitHub_. + + * **Elasticsearch interval property changed** – Query interval specification updated for Elasticsearch 7.x. + +Changed from `interval` to `fixed_interval` property. Provides consistency with Elasticsearch 8.x. Most queries won't show visible changes. See Issue [#50297](https://github.com/grafana/grafana/issues/50297) on _GitHub_. + + * **Elasticsearch Raw document mode discontinued** – Display mode changes in Elasticsearch data source. + +**Action required:** Use **Raw Data** mode instead. See Issue [#62236](https://github.com/grafana/grafana/issues/62236) on _GitHub_. + + * **Elasticsearch version support** – Older Elasticsearch versions are no longer supported. + +**Action required:** Upgrade Elasticsearch to version 7.10.0 or later. Versions below 7.10.0 are past end-of-life. See Issue [#48715](https://github.com/grafana/grafana/issues/48715) on _GitHub_. + + * **Explore URL format discontinued** – Compact Explore URLs will be removed in a future release. + +**Action required:** Update hard coded links to use standard URL format. Compact URLs: `&left=["now-1h","now"...]`. Standard URLs: `&left={"datasource":"test"...}`. See Issue [#50873](https://github.com/grafana/grafana/issues/50873) on _GitHub_. + + * **GitHub OAuth display changes** – GitHub name and login display updated. + +GitHub name appears as Grafana name. GitHub login appears as Grafana login. Improves user identification clarity. See Issue [#45438](https://github.com/grafana/grafana/issues/45438) on _GitHub_. + + * **Heatmap panel implementation updated** – Heatmap panels use a new implementation starting in 9.1.0. + +Significantly improved rendering performance. Buckets are placed on reasonable borders (1m, 5m, 30s). Round cells are no longer supported. + +**Action required:** Test your heatmap panels after upgrade. Disable new implementation by setting `useLegacyHeatmapPanel` feature flag to true if needed. Add `?__feature.useLegacyHeatmapPanel=true` to dashboard URLs for testing. See Issue [#50229](https://github.com/grafana/grafana/issues/50229) on _GitHub_. + + * **InfluxDB backend migration** – InfluxDB data parsing behavior has changed. + +The InfluxDB backend migration feature toggle (`influxdbBackendMigration`) is reintroduced due to backend processing issues. By default, InfluxDB data is parsed in the frontend. If you upgraded to 9.4.4 and added transformations on InfluxDB data, those panels will fail to render. + +**Action required:** Remove affected panels and recreate them, or edit the `time` field as `Time` in `panel.json` or `dashboard.json`. See Issue [#64842](https://github.com/grafana/grafana/issues/64842) on _GitHub_. + + * **Log message format updated** – Log message structure has changed. + +`lvl` is now `level`. `eror` and `dbug` are now `error` and `debug`. Increased timestamp precision. Opt-out available with `oldlog` feature toggle (temporary). See Issue [#47584](https://github.com/grafana/grafana/issues/47584) on _GitHub_. + + * **Loki data format optimization** – Loki logs data uses a more efficient dataframe format. + +Single dataframe with **labels** column instead of separate dataframes. Explore and logs panels work without changes. Other panels or transforms may need adjustment. + +**Action required:** Replace **labels to fields** transformation with **extract fields** transformation. See Issue [#47153](https://github.com/grafana/grafana/issues/47153) on _GitHub_. + + * **NaN value handling** – Consistent `NaN` representation across Prometheus and Loki data sources. + +`NaN` values remain as `NaN` instead of converting to `null`. Change should be mostly invisible to users. Affects both dashboard and alerting paths. See Issues [#49475](https://github.com/grafana/grafana/issues/49475) and [#45389](https://github.com/grafana/grafana/issues/45389) on _GitHub_. + + * **Password reset links invalidated** – Existing password reset links won't work after upgrade. + +Password reset links sent before upgrade are invalid. Users must request new password reset links. Links expire after 2 hours. See Issue [#42334](https://github.com/grafana/grafana/issues/42334) on _GitHub_. + + * **Reserved label prefix** – Labels starting with `grafana_` are reserved. + +Manually configured labels beginning with `grafana_` may be overwritten. Current reserved labels: `grafana_folder` (Title of the folder containing the alert). See Issue [#50262 ](https://github.com/grafana/grafana/issues/50262) on _GitHub_. + + * **Transformation improvements** – **Rename by regex** transformation now supports global patterns. + +Global patterns use the format `/<stringToReplace>/g`. Some transformations may behave differently. Wrap match strings in forward slashes for previous behavior: `(.*)` becomes `/(.*)/`. See Issue [#48179 ](https://github.com/grafana/grafana/issues/48179) on _GitHub_. + + + +