PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)

* Format md,mdx files with prettier on lint-staged

* Manually run prettier on docs/sources
This commit is contained in:
Connor Lindsey
2021-08-06 07:52:36 -06:00
committed by GitHub
parent e9c032f10f
commit b78a67cec7
301 changed files with 3216 additions and 2980 deletions
+2
View File
@@ -24,6 +24,7 @@ as info on deprecations, breaking changes and plugin development read the [relea
- [What's new in 7.0]({{< relref "whats-new-in-v7-0" >}})
## Grafana 6
- [What's new in 6.7]({{< relref "whats-new-in-v6-7" >}})
- [What's new in 6.6]({{< relref "whats-new-in-v6-6" >}})
- [What's new in 6.5]({{< relref "whats-new-in-v6-5" >}})
@@ -34,6 +35,7 @@ as info on deprecations, breaking changes and plugin development read the [relea
- [What's new in 6.0]({{< relref "whats-new-in-v6-0" >}})
## Grafana 5
- [What's new in 5.4]({{< relref "whats-new-in-v5-4" >}})
- [What's new in 5.3]({{< relref "whats-new-in-v5-3" >}})
- [What's new in 5.2]({{< relref "whats-new-in-v5-2" >}})
+1 -1
View File
@@ -20,7 +20,7 @@ If you are interested in how to migrate from Grafana V1.x to V2.0, please read o
Grafana now ships with its own required backend server. Also completely open-source, it's written in Go and has a full HTTP API.
In addition to new features, the backend server makes it much easier to set up and enjoy Grafana. Grafana 2.0 now ships as cross platform binaries with no dependencies. Authentication is built in, and Grafana is now capable of proxying connections to Data Sources. There are no longer any CORS (Cross Origin Resource Sharing) issues requiring messy workarounds. Elasticsearch is no longer required just to store dashboards.
In addition to new features, the backend server makes it much easier to set up and enjoy Grafana. Grafana 2.0 now ships as cross platform binaries with no dependencies. Authentication is built in, and Grafana is now capable of proxying connections to Data Sources. There are no longer any CORS (Cross Origin Resource Sharing) issues requiring messy workarounds. Elasticsearch is no longer required just to store dashboards.
## User and Organization permissions
+29 -14
View File
@@ -9,88 +9,99 @@ list = false
+++
# What's new in Grafana v2.1
Grafana 2.1 brings improvements in three core areas: dashboarding, authentication, and data sources.
As with every Grafana release, there is a whole slew of new features, enhancements, and bug fixes.
## More Dynamic Dashboards
The Templating system is one of the most powerful and well-used features of Grafana.
The 2.1 release brings numerous improvements that make dashboards more dynamic than ever before.
### Multi-Value Template Variables
A template variable with Multi-Value enabled allows for the selection of multiple values at the same time.
These variables can then be used in any Panel to make them more dynamic, and to give you the perfect view of your data.
Multi-Value variables are also enabling the new `row repeat` and `panel repeat` feature described below.
![Multi-Value Select](/static/img/docs/v2/multi-select.gif "Multi-Value Select")
![Multi-Value Select](/static/img/docs/v2/multi-select.gif 'Multi-Value Select')
<br/><br/>
### Repeating Rows and Panels
It’s now possible to create a dashboard that automatically adds (or removes) both rows and panels based
on selected variable values. Any row or any panel can be configured to repeat (duplicate itself) based
on a multi-value template variable.</p>
![Repeating Rows and Panels](/static/img/docs/v2/panel-row-repeat.gif "Repeating Rows and Panels")
![Repeating Rows and Panels](/static/img/docs/v2/panel-row-repeat.gif 'Repeating Rows and Panels')
<br/><br/>
### Dashboard Links and Navigation
To support better navigation between dashboards, it's now possible to create custom and dynamic links from individual
panels to appropriate Dashboards. You also have the ability to create flexible top-level links on any
given dashboard thanks to the new dashboard navigation bar feature.
![Dashboard Links](/static/img/docs/v2/dash_links.png "Dashboard Links")
![Dashboard Links](/static/img/docs/v2/dash_links.png 'Dashboard Links')
Dashboard links can be added under dashboard settings. Either defined as static URLs with a custom icon or as dynamic
dashboard links or dropdowns based on custom dashboard search query. These links appear in the same
row under the top menu where template variables appear.
- - -
---
### Better local Dashboard support
Grafana can now index Dashboards saved locally as JSON from a given directory. These file based dashboards
will appear in the regular dashboard search along regular DB dashboards.
> **Note:** Saving local dashboards back the folder is not supported; this feature is meant for statically generated JSON dashboards.
- - -
---
## New Authentication Options
New authentication methods add numerous options to manage users, roles and organizations.
### LDAP support
This highly requested feature now allows your Grafana users to login with their LDAP credentials.
You can also specify mappings between LDAP group memberships and Grafana Organization user roles.
### Basic Auth Support
You can now authenticate against the Grafana API utilizing a simple username and password with basic HTTP authentication.
> **Note:** This can be useful for provisioning and configuring management systems that need
> to utilize the API without having to create an API key.
### Auth Proxy Support
You can now authenticate utilizing a header (eg. X-Authenticated-User, or X-WEBAUTH-USER)
> **Note:** this can be useful in situations with reverse proxies.
### New “Read-only Editor” User Role
There is a new User role available in this version of Grafana: “Read-only Editor”. This role behaves just
like the Viewer role does in Grafana 2.0. That is you can edit graphs and queries but not save dashboards.
like the Viewer role does in Grafana 2.0. That is you can edit graphs and queries but not save dashboards.
The Viewer role has been modified in Grafana 2.1 so that users assigned this role can no longer edit panels.
- - -
---
## Data source Improvements
### InfluxDB 0.9 Support
Grafana 2.1 now comes with full support for InfluxDB 0.9. There is a new query editor designed from scratch
for the new features InfluxDB 0.9 enables.
![InfluxDB Editor](/static/img/docs/v2/influx_09_editor_anim.gif "InfluxDB Editor")
![InfluxDB Editor](/static/img/docs/v2/influx_09_editor_anim.gif 'InfluxDB Editor')
<br/>
### OpenTSDB Improvements
Grafana OpenTSDB data source now supports template variable values queries. This means you can create
template variables that fetches the values from OpenTSDB (for example metric names, tag names, or tag values).
The query editor is also enhanced to limiting tags by metric.
@@ -98,10 +109,11 @@ The query editor is also enhanced to limiting tags by metric.
> **Note:** OpenTSDB config option tsd.core.meta.enable_realtime_ts must enabled for OpenTSDB lookup API)
### New Data Source: KairosDB
The Cassandra backed time series database KairosDB is now supported in Grafana out of the box. Thank you to
<a href="https://github.com/masaori335" target="_blank">masaori335</a> for his hard work in getting it to this point.
- - -
---
## Panel Improvements
@@ -110,24 +122,27 @@ Overriding the colors of specific series using regular expressions, changing how
and allowing string values will help you better understand your data at a glance.
### Graph Panel
Define series color using regex rule. This is useful when you have templated graphs with series names
that change depending selected template variables. Using a regex style override rule you could
for example make all series that contain the word **CPU** `red` and assigned to the second y axis.
![Define series color using regex rule](/static/img/docs/v2/regex_color_override.png "Define series color using regex rule")
![Define series color using regex rule](/static/img/docs/v2/regex_color_override.png 'Define series color using regex rule')
New series style override, negative-y transform and stack groups. Negative y transform is
very useful if you want to plot a series on the negative y scale without affecting the legend values like min or max or
the values shown in the hover tooltip.
![Negative-y Transform](/static/img/docs/v2/negative-y.png "Negative-y Transform")
![Negative-y Transform](/static/img/docs/v2/negative-y.png 'Negative-y Transform')
![Negative-y Transform](/static/img/docs/v2/negative-y-form.png "Negative-y Transform")
![Negative-y Transform](/static/img/docs/v2/negative-y-form.png 'Negative-y Transform')
### Singlestat Panel
Now support string values. Useful for time series database like InfluxDB that supports
string values.
### Changelog
For a detailed list and link to github issues for everything included in the 2.1 release please
view the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) file.
+8 -2
View File
@@ -11,11 +11,13 @@ list = false
# What's new in Grafana v2.5
## Release highlights
This is an exciting release, and we want to share some of the highlights. The release includes many
fixes and enhancements to all areas of Grafana, like new Data Sources, a new and improved timepicker, user invites, panel
resize handles and improved InfluxDB and OpenTSDB support.
### New time range controls
<img src="/static/img/docs/whatsnew_2_5/timepicker.png" alt="New Time picker">
A new timepicker with room for more quick ranges as well as new types of relative ranges, like `Today`,
@@ -60,8 +62,8 @@ metrics directly from Grafana.
Grafana 2.5 ships with a new Prometheus data source that will allow you to query and visualize data
stored in Prometheus.
### Mix different data sources
<img src="/static/img/docs/whatsnew_2_5/mixed_data.png" alt="Mix data sources in the same dashboard or in the same graph!">
In previous releases you have been able to mix different data sources on the same dashboard. In v2.5 you
@@ -71,11 +73,13 @@ to plot metrics from different Graphite servers on the same Graph or plot data f
data from Prometheus. Mixing different data sources on the same graph works for any data source, even custom ones.
### Panel Resize handles
<img src="/static/img/docs/whatsnew_2_5/panel_resize.gif" alt="">
This release adds resize handles to the bottom right corners of panels making it easy to resize both width and height.
### User invites
<img src="/static/img/docs/whatsnew_2_5/org_invite.png" alt="">
This version also brings some new features for user management.
@@ -95,14 +99,16 @@ This version also brings some new features for user management.
- Admin page for all organizations (remove / edit)
### Breaking changes
There have been some changes to the data source plugin API. If you are using a custom plugin check that there is an update for it before you upgrade. Also
the new time picker does not currently support custom quick ranges like the last one did. This will likely be added in a
future release.
### Changelog
For a detailed list and link to github issues for everything included in the 2.5 release please
view the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) file.
- - -
---
### <a href="https://grafana.com/get">Download Grafana 2.5 now</a>
+12 -2
View File
@@ -11,10 +11,12 @@ list = false
# What's new in Grafana v2.6
## Release highlights
The release includes a new Table panel, a new InfluxDB query editor, support for Elasticsearch Pipeline Metrics and
support for multiple Cloudwatch credentials.
## Table Panel
<img src="/assets/img/features/table-panel.png">
The new table panel is very flexible, supporting both multiple modes for time series as well as for
@@ -28,22 +30,26 @@ Where `Metric` is the name of the time series.
<img src="/static/img/docs/v2/table_ts_to_rows.png">
### Table Transform
Above you see the options tab for the **Table Panel**. The most important option is the `To Table Transform`.
This option controls how the result of the metric/data query is turned into a table.
### Column Styles
The column styles allow you control how dates and numbers are formatted.
### Time series to columns
This transform allows you to take multiple time series and group them by time. Which will result in a `Time` column
and a column for each time series.
<img src="/static/img/docs/v2/table_ts_to_columns.png">
In the screenshot above you can see how the same time series query as in the previous example can be transformed into
a different table by changing the `To Table Transform` to `Time series to columns`.
a different table by changing the `To Table Transform` to `Time series to columns`.
### Time series to aggregations
This transform works very similar to the legend values in the Graph panel. Each series gets its own row. In the Options
tab you can select which aggregations you want using the plus button the Columns section.
@@ -78,6 +84,7 @@ The table can also show any annotations you have enabled in the dashboard.
<img src="/static/img/docs/v2/table_annotations.png">
## The New InfluxDB Editor
The new InfluxDB editor is a lot more flexible and powerful. It supports nested functions, like `derivative`.
It also uses the same technique as the Graphite query editor in that it presents nested functions as chain of function
transformations. It tries to simplify and unify the complicated nature of InfluxDB's query language.
@@ -98,10 +105,12 @@ SELECT derivative(mean("value"), 10s) /10 AS "REQ/s" FROM ....
```
### Select multiple fields
Use the plus button and select Field > field to add another SELECT clause. You can also
specify an asterix `*` to select all fields.
### Group By
To group by a tag click the plus icon at the end of the GROUP BY row. Pick a tag from the dropdown that appears.
You can remove the group by by clicking on the `tag` and then click on the x icon.
@@ -119,9 +128,10 @@ to hide metrics from appearing in the graph.
![](/static/img/docs/elasticsearch/pipeline_metrics_editor.png)
## Changelog
For a detailed list and link to github issues for everything included in the 2.6 release please
view the [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md) file.
- - -
---
<a href="http://grafana.org/download">Download Grafana 2.6 now</a>
+9 -5
View File
@@ -36,8 +36,8 @@ two new plugin types:
- **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.
Dashboards, and Grafana **Pages**. Apps are a great way to provide an
entire experience right within Grafana.
## Grafana.com
@@ -183,13 +183,13 @@ now stored without any formatting (glob/regex/etc), this is done on the fly when
variable is interpolated.
- 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.
data source (or panel) they need to be updated as well.
- InfluxDB 0.8: This data source is no longer included in releases,
you can still install manually from [Grafana.com](https://grafana.com)
you can still install manually from [Grafana.com](https://grafana.com)
- KairosDB: This data source has also no longer shipped with Grafana,
you can install it manually from [Grafana.com](https://grafana.com)
you can install it manually from [Grafana.com](https://grafana.com)
## Plugin showcase
@@ -197,20 +197,24 @@ Discovering and installing plugins is very quick and easy with Grafana 3.0 and [
are a couple that I encourage you try!
#### [Clock Panel](https://grafana.com/plugins/grafana-clock-panel)
Support's both current time and count down mode.
<img src="/static/img/docs/v3/clock_panel.png">
#### [Pie Chart Panel](https://grafana.com/plugins/grafana-piechart-panel)
A simple pie chart panel is now available as an external plugin.
<img src="/static/img/docs/v3/pie_chart_panel.png">
#### [WorldPing App](https://grafana.com/plugins/raintank-worldping-app)
This is full blown Grafana App that adds new panels, data sources and pages to give
feature rich global performance monitoring directly from your on-prem Grafana.
<img src="/static/img/docs/v3/wP-Screenshot-dash-web.png">
#### [Zabbix App](https://grafana.com/plugins/alexanderzobnin-zabbix-app)
This app contains the already very pouplar Zabbix data source plugin, 2 dashboards and a triggers panel. It is
created and maintained by [Alexander Zobnin](https://github.com/alexanderzobnin/grafana-zabbix).
@@ -51,6 +51,7 @@ Do you want metrics about viewing metrics? Of course you do! In this release we
Switched logging framework to log15 to enable key value per logging and filtering based on different log levels. It's now possible to configure different log levels for different modules.
### Breaking changes
- **Logging** format have been changed to improve log filtering.
- **Graphite PNG** Graphite PNG support dropped from Graph panel (use Grafana native PNG instead).
- **Migration** No longer possible to migrate dashboards from 1.x (Stored in ES or Influx 0.8).
@@ -109,6 +109,7 @@ We always try to bring some UX/UI refinements and polish in every release.
shortcut or by adding <code>&kiosk</code> to the URL when you load a dashboard.
In kiosk mode the navbar is completely hidden/removed from view.
</p>
</div>
<div class="medium-6 columns">
{{< figure src="/static/img/docs/v4/tvmode.png" caption="TV mode" >}}
@@ -9,6 +9,7 @@ list = false
+++
## What's new in Grafana v4.1
- **Graph**: Support for shared tooltip on all graphs as you hover over one graph. [#1578](https://github.com/grafana/grafana/pull/1578), [#6274](https://github.com/grafana/grafana/pull/6274)
- **Victorops**: Add VictorOps notification integration [#6411](https://github.com/grafana/grafana/issues/6411), thx [@ichekrygin](https://github.com/ichekrygin)
- **Opsgenie**: Add OpsGenie notification integratiion [#6687](https://github.com/grafana/grafana/issues/6687), thx [@kylemcc](https://github.com/kylemcc)
@@ -37,6 +38,7 @@ You can set a help text in the general tab on any panel. The help text is using
{{< figure class="float-right" max-width="60%" src="/static/img/docs/v41/helptext_hover.png" caption="Hovering help text" >}}
Panels with a help text available have a little indicator in the top left corner. You can show the help text by hovering the icon.
<div class="clearfix"></div>
### Easier Cloudwatch configuration
@@ -47,6 +49,7 @@ In Grafana 4.1.0 you can configure your Cloudwatch data source with `access key`
This enables people to use the Cloudwatch data source without having access to the filesystem where Grafana is running.
Once the `access key` and `secret key` have been saved the user will no longer be able to view them.
<div class="clearfix"></div>
## Upgrade and Breaking changes
@@ -63,4 +66,5 @@ of new features, changes, and bug fixes.
Head to [v4.1 download page](/download/4_1_0/) for download links and instructions.
## Thanks
A big thanks to all the Grafana users who contribute by submitting PRs, bug reports and feedback!
+1 -1
View File
@@ -20,7 +20,7 @@ Big thumbs up!
- **Hipchat**: Adds support for sending alert notifications to hipchat [#6451](https://github.com/grafana/grafana/issues/6451), thx [@jregovic](https://github.com/jregovic)
- **Telegram**: Added Telegram alert notifier [#7098](https://github.com/grafana/grafana/pull/7098), thx [@leonoff](https://github.com/leonoff)
- **LINE**: Add LINE as alerting notification channel [#7301](https://github.com/grafana/grafana/pull/7301), thx [@huydx](https://github.com/huydx)
- **Templating**: Make $__interval and $__interval_ms global built in variables that can be used in by any data source (in panel queries), closes [#7190](https://github.com/grafana/grafana/issues/7190), closes [#6582](https://github.com/grafana/grafana/issues/6582)
- **Templating**: Make $**interval and $**interval_ms global built in variables that can be used in by any data source (in panel queries), closes [#7190](https://github.com/grafana/grafana/issues/7190), closes [#6582](https://github.com/grafana/grafana/issues/6582)
- **Alerting**: Adds deduping of alert notifications [#7632](https://github.com/grafana/grafana/pull/7632)
- **Alerting**: Better information about why an alert triggered [#7035](https://github.com/grafana/grafana/issues/7035)
- **Orgs**: Sharing dashboards using Grafana share feature will now redirect to correct org. [#6948](https://github.com/grafana/grafana/issues/6948)
+1 -1
View File
@@ -52,7 +52,7 @@ The Heatmap panel also works with Elasticsearch Histogram Aggregations for more
This release includes a [new core data source for MySQL](http://docs.grafana.org/features/datasources/mysql/). You can write any possible MySQL query and format it as either Time Series or Table Data allowing it be used with the Graph Panel, Table Panel and SingleStat Panel.
We are still working on the MySQL data source. As it's missing some important features, like templating and macros and future changes could be breaking, we are
labeling the state of the data source as Alpha. Instead of holding up the release of v4.3 we are including it in its current shape to get some early feedback. So please try it out and let us know what you think on [twitter](https://twitter.com/intent/tweet?text=.%40grafana&source=4_3_beta_blog&related=blog) or on our [community forum](https://community.grafana.com/c/releases). Is this a feature that you would use? How can we make it better?
labeling the state of the data source as Alpha. Instead of holding up the release of v4.3 we are including it in its current shape to get some early feedback. So please try it out and let us know what you think on [twitter](https://twitter.com/intent/tweet?text=.%40grafana&source=4_3_beta_blog&related=blog) or on our [community forum](https://community.grafana.com/c/releases). Is this a feature that you would use? How can we make it better?
**The query editor can show the generated and interpolated SQL that is sent to the MySQL server.**
@@ -24,6 +24,7 @@ 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)
+3 -1
View File
@@ -23,10 +23,12 @@ The new query editor has full syntax highlighting. As well as auto complete for
{{< figure src="/static/img/docs/v45/elastic_ad_hoc_filters.png" class="docs-image--block" >}}
### Table cell links!
Create column styles that turn cells into links that use the value in the cell (or other row values) to generate a URL to another dashboard or system:
Create column styles that turn cells into links that use the value in the cell (or other row values) to generate a URL to another dashboard or system:
![](/static/img/docs/v45/table_links.jpg)
### Query Inspector
Query Inspector is a new feature that shows query requests and responses. This can be helpful if a graph is not shown or shows something very different than what you expected.
For more information about query inspector, refer to [using grafanas query inspector to troubleshoot issues](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630).
![](/static/img/docs/v45/query_inspector.png)
+2 -1
View File
@@ -51,7 +51,7 @@ This makes exploring and filtering Prometheus data much easier.
- **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**: 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)
@@ -69,4 +69,5 @@ This makes exploring and filtering Prometheus data much easier.
- **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
+2 -2
View File
@@ -115,7 +115,6 @@ in sync with dashboards in Grafana's database. The dashboard provisioner has mul
which makes it possible to star them, use one as the home dashboard, set permissions and other features in Grafana that
expects the dashboards to exist in the database. More info in the [dashboard provisioning docs]({{< relref "../administration/provisioning.md" >}})
## Graphite Tags and Integrated Function Docs
{{< figure src="/static/img/docs/v50/graphite_tags.png" max-width="1000px" class="docs-image--right" >}}
@@ -133,7 +132,7 @@ We are introducing a new unique identifier (`uid`) in the dashboard JSON model.
generated if not provided when creating a dashboard and will have a length of 9-12 characters.
The unique identifier allows having persistent URLs for accessing dashboards, sharing them
between instances and when using [dashboard provisioning]((/administration/provisioning/#reusable-dashboard-urls)). This means that dashboard can
between instances and when using [dashboard provisioning](<(/administration/provisioning/#reusable-dashboard-urls)>). This means that dashboard can
be renamed without breaking any links. We're changing the URL format for dashboards
from `/dashboard/db/:slug` to `/d/:uid/:slug`. We'll keep supporting the old slug-based URLs for dashboards
and redirects to the new one for backward compatibility. Please note that the old slug-based URLs
@@ -144,5 +143,6 @@ This might seem like a small change, but we are incredibly excited about it sinc
much easier to manage, collaborate and navigate between dashboards.
### API changes
New uid-based routes in the dashboard API have been introduced to retrieve and delete dashboards.
The corresponding slug-based routes have been deprecated and will be removed in a future release.
+12 -13
View File
@@ -34,10 +34,10 @@ Grafana v5.1 brings an improved official docker image which should make it easie
We've switched the id of the grafana user running Grafana inside a docker container. Unfortunately this means that files created prior to 5.1 won't have the correct permissions for later versions and thereby this introduces a breaking change.
We made this change so that it would be easier for you to control what user Grafana is executed as (see examples below).
Version | User | User ID
--------|---------|---------
< 5.1 | grafana | 104
>= 5.1 | grafana | 472
| Version | User | User ID |
| ------- | ------- | ------- |
| < 5.1 | grafana | 104 |
| >= 5.1 | grafana | 472 |
Please read the [updated documentation](/installation/docker/#migrate-to-v51-or-later) which includes migration instructions and more information.
@@ -75,7 +75,7 @@ The control for adding new panels to dashboards have got some enhancements and n
you want to add. Further, the control has tabs separating functionality for adding new panels and pasting
copied panels.
By copying a panel in a dashboard it will be displayed in the `Paste` tab in *any* dashboard and allows you to paste the
By copying a panel in a dashboard it will be displayed in the `Paste` tab in _any_ dashboard and allows you to paste the
copied panel into the current dashboard.
{{< figure src="/static/img/docs/v51/dashboard_panel_copy.png" max-width= "300px" >}}
@@ -95,12 +95,12 @@ New enhancements include support for mapping a numeric value/range to text and a
We now support a new option for rendering variables that gives the user full control of how the value(s) should be rendered.
In the table below you can see some examples and you can find all different options in the [Variables documentation](http://docs.grafana.org/variables/templates-and-variables/#advanced-formatting-options).
Filter Option | Example | Raw | Interpolated | Description
------------ | ------------- | ------------- | ------------- | -------------
`glob` | ${servers:glob} | `'test1', 'test2'` | `{test1,test2}` | Formats multi-value variable into a glob
`regex` | ${servers:regex} | `'test.', 'test2'` | <code>(test\.&#124;test2)</code> | Formats multi-value variable into a regex string
`pipe` | ${servers:pipe} | `'test.', 'test2'` | <code>test.&#124;test2</code> | Formats multi-value variable into a pipe-separated string
`csv`| ${servers:csv} | `'test1', 'test2'` | `test1,test2` | Formats multi-value variable as a comma-separated string
| Filter Option | Example | Raw | Interpolated | Description |
| ------------- | ---------------- | ------------------ | -------------------------------- | --------------------------------------------------------- |
| `glob` | ${servers:glob} | `'test1', 'test2'` | `{test1,test2}` | Formats multi-value variable into a glob |
| `regex` | ${servers:regex} | `'test.', 'test2'` | <code>(test\.&#124;test2)</code> | Formats multi-value variable into a regex string |
| `pipe` | ${servers:pipe} | `'test.', 'test2'` | <code>test.&#124;test2</code> | Formats multi-value variable into a pipe-separated string |
| `csv` | ${servers:csv} | `'test1', 'test2'` | `test1,test2` | Formats multi-value variable as a comma-separated string |
## Improved workflow for provisioned dashboards
@@ -109,8 +109,7 @@ 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.
- 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.
More information in the [Provisioning documentation](/administration/provisioning/).
+3 -3
View File
@@ -55,12 +55,12 @@ We hope this encourages users to follow Grafana's best practices and change the
## Prometheus
The Prometheus data source now aligns the start/end of the query sent to Prometheus with the step, which ensures PromQL expressions with *rate*
The Prometheus data source now aligns the start/end of the query sent to Prometheus with the step, which ensures PromQL expressions with _rate_
functions get consistent results, and thus avoids graphs jumping around on reload.
## InfluxDB
The InfluxDB data source now includes support for the *mode* function which returns the most frequent value in a list of field values.
The InfluxDB data source now includes support for the _mode_ function which returns the most frequent value in a list of field values.
## Alerting
@@ -88,7 +88,7 @@ Grafana v5.0 introduced support for dashboard folders and permissions. The impor
and should now make it more clear if a possible import will overwrite an existing dashboard, or not.
This release also adds some improvements for those users only having editor or admin permissions in certain folders. The links to
*Create Dashboard* and *Import Dashboard* are now available in the side navigation, in dashboard search and on the manage dashboards/folder page for a
_Create Dashboard_ and _Import Dashboard_ are now available in the side navigation, in dashboard search and on the manage dashboards/folder page for a
user that has editor role in an organization or the edit permission in at least one folder.
<div class="clearfix"></div>
+2 -2
View File
@@ -18,7 +18,7 @@ The main highlights are:
- [Grafana Loki]({{< relref "#explore-and-grafana-loki" >}}) - Integration with the new open source log aggregation system from Grafana Labs.
- [Gauge Panel]({{< relref "#gauge-panel" >}}) - A new standalone panel for gauges.
- [New Panel Editor UX]({{< relref "#new-panel-editor" >}}) improves panel editing
and enables easy switching between different visualizations.
and enables easy switching between different visualizations.
- [Google Stackdriver data source]({{< relref "#google-stackdriver-data-source" >}}) is out of beta and is officially released.
- [Azure Monitor]({{< relref "#azure-monitor-data-source" >}}) plugin is ported from being an external plugin to be a core data source
- [React Plugin]({{< relref "#react-panels-query-editors" >}}) support enables an easier way to build plugins.
@@ -145,7 +145,7 @@ Besides these changes we have also made security improvements regarding Cross-Si
- Script tags in text panels are per default [disabled](/administration/configuration/#disable-sanitize-html) to protect against XSS attacks
> **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.
> but our goal is to remove this requirement in the near future.
## Named Colors
+8 -7
View File
@@ -69,18 +69,19 @@ the panel and you cannot reference series name or any data field.
While `Data links` are used by the actual visualization and can reference data fields.
Example:
```url
http://my-grafana.com/d/bPCI6VSZz/other-dashboard?var-server=${__series_name}
```
You have access to these variables:
Name | Description
------------ | -------------
*${__series_name}* | The name of the time series (or table)
*${__value_time}* | The time of the point your clicking on (in millisecond epoch)
*${__url_time_range}* | Interpolates as the full time range (i.e. from=21312323412&to=21312312312)
*${__all_variables}* | Adds all current variables (and current values) to the URL
| Name | Description |
| ----------------------- | -------------------------------------------------------------------------- |
| _${\_\_series_name}_ | The name of the time series (or table) |
| _${\_\_value_time}_ | The time of the point your clicking on (in millisecond epoch) |
| _${\_\_url_time_range}_ | Interpolates as the full time range (i.e. from=21312323412&to=21312312312) |
| _${\_\_all_variables}_ | Adds all current variables (and current values) to the URL |
You can then click on point in the Graph.
@@ -107,7 +108,7 @@ Looks really nice in light theme as well.
## Grafana Enterprise
Substantial refactoring and improvements to the external auth systems has gone in to this release making the features
Substantial refactoring and improvements to the external auth systems has gone in to this release making the features
listed below possible as well as laying a foundation for future enhancements.
### LDAP Active Sync
+1 -2
View File
@@ -33,7 +33,6 @@ Some of those new capabilities can already be seen in this release, like sharing
- [**Enterprise**: GitLab OAuth Team Sync support]({{< relref "#gitlab-oauth-team-sync-support" >}})
- [**Enterprise**: Teams and LDAP Improvements]({{< relref "#ldap-teams" >}})
### Go back to dashboard from Explore
To help accelerate workflows that involve regularly switching from Explore to a dashboard and vice-versa, we've added the ability to return to the origin dashboard
@@ -84,7 +83,7 @@ To show a horizontal line through the Y-value of the datapoint across the whole
## Share query results between panels
Grafana 6.4 continues the work started in 6.3 of creating a data model and query execution lifecycle that can support robust analytics and streaming. These changes are mostly structural and lay the foundation for powerful features in future releases.
Grafana 6.4 continues the work started in 6.3 of creating a data model and query execution lifecycle that can support robust analytics and streaming. These changes are mostly structural and lay the foundation for powerful features in future releases.
The first new feature all these changes have enabled is the ability to share query results between panels. So for example if you have an expensive query you can visualize the same results in a graph, table and singlestat panel. To reuse another panel’s query result select the data source named `-- Dashboard --` and then select the panel.
+2 -2
View File
@@ -68,7 +68,7 @@ You can untoggle `Match Exact` to include metrics that have other dimensions def
{{< figure src="/static/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 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.
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 based on math expressions.
@@ -127,7 +127,7 @@ In the Datasource configuration for Graphite, you can change the type to Metrict
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.
- **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.
+13 -13
View File
@@ -42,7 +42,7 @@ Grafana 6.6 comes with a lot of new features and enhancements:
{{< figure src="/static/img/docs/v66/stat_panel_dark2.png" max-width="1024px" caption="Stat panel" >}}
This release adds a new panel named `Stat`. This panel is designed to replace the current `Singlestat` as the primary way to show big single number panels along with a sparkline. This panel is of course building on our new panel infrastructure and option design. So, you can use the new threshold UI and data links. It also supports the same repeating feature as the Gauge and Bar Gauge panels, meaning it will repeat a separate visualization for every series or row
This release adds a new panel named `Stat`. This panel is designed to replace the current `Singlestat` as the primary way to show big single number panels along with a sparkline. This panel is of course building on our new panel infrastructure and option design. So, you can use the new threshold UI and data links. It also supports the same repeating feature as the Gauge and Bar Gauge panels, meaning it will repeat a separate visualization for every series or row
in the query result.
Key features:
@@ -160,21 +160,21 @@ Customize the login page, side menu bar, and footer links.
Now you can install the enterprise edition from the APT and YUM repository. The following table shows the APT repository for each Grafana version (for instructions read the [installation notes]({{< relref "../installation/debian/#install-from-apt-repository" >}})) :
| Grafana Version | Package | Repository |
|-----------------|---------|------------|
| Grafana OSS | grafana | `https://packages.grafana.com/oss/deb stable main` |
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/deb beta main` |
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/deb stable main` |
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/deb beta main` |
| Grafana Version | Package | Repository |
| ------------------------- | ------------------ | --------------------------------------------------------- |
| Grafana OSS | grafana | `https://packages.grafana.com/oss/deb stable main` |
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/deb beta main` |
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/deb stable main` |
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/deb beta main` |
The following table shows the YUM repositories for each Grafana version (for instructions read the [installation notes]({{< relref "../installation/rpm/#install-from-yum-repository" >}})) :
| Grafana Version | Package | Repository |
|----------------------------|--------------------|----------------------------------------------------|
| Grafana OSS | grafana | `https://packages.grafana.com/oss/rpm` |
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/rpm-beta` |
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm` |
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm-beta` |
| Grafana Version | Package | Repository |
| ------------------------- | ------------------ | -------------------------------------------------- |
| Grafana OSS | grafana | `https://packages.grafana.com/oss/rpm` |
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/rpm-beta` |
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm` |
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm-beta` |
We recommend all users to install the Enterprise Edition of Grafana, which can be seamlessly upgraded with a Grafana Enterprise [subscription](https://grafana.com/products/enterprise/?utm_source=grafana-install-page).
+5 -1
View File
@@ -30,15 +30,17 @@ Grafana 6.7 comes with a lot of new features and enhancements:
General features are included in all Grafana editions.
### Query history
> BETA: Query history is a beta feature. It is local to your browser and is not shared with others.
Query history is a new feature that lets you view and interact with the queries that you have previously run in Explore. You can add queries to the Explore query editor, write comments, create and share URL links, star your favorite queries, and much more. Starred queries are displayed in Starred tab, so it is easier to reuse queries that you run often without typing them from scratch.
Query history is a new feature that lets you view and interact with the queries that you have previously run in Explore. You can add queries to the Explore query editor, write comments, create and share URL links, star your favorite queries, and much more. Starred queries are displayed in Starred tab, so it is easier to reuse queries that you run often without typing them from scratch.
Learn more about query history in [Explore]({{< relref "../explore" >}}).
{{< figure src="/static/img/docs/v67/rich-history.gif" max-width="1024px" caption="Query history" >}}
### Azure OAuth
Grafana v6.7 comes with a new OAuth integration for Microsoft Azure Active Directory. You can now assign users and groups to Grafana roles from the Azure Portal. Learn how to enable and configure it in [Azure AD OAuth2 authentication]({{< relref "../auth/azuread/" >}}).
### Enforce minimum dashboard refresh interval
@@ -58,6 +60,7 @@ In Grafana 6.7, the query editor has been enhanced with a project selector that
General features are included in the Grafana Enterprise edition software.
### White labeling customizes application title
This release adds a new white labeling option to customize the application title. Learn how to configure it in [White labeling]({{< relref "../enterprise/white-labeling/" >}}).
```
@@ -90,5 +93,6 @@ You can now use either portrait or landscape mode in your reports. Portrait will
[Reporting]({{< relref "../enterprise/reporting/" >}}) has been updated as a result of this change.
### Azure OAuth Team Sync support
When setting up OAuth with Microsoft Azure AD, you can now sync Azure groups with Teams in Grafana.
Learn more in [Team sync]({{< relref "../enterprise/team-sync/" >}}).
@@ -276,6 +276,7 @@ Support for Singlestat panel has been discontinued. When you upgrade to version
Stat panel is available as plugin.
### Grafana license update
Grafana has updated its license from Apache 2.0 to the GNU Affero General Public License (AGPL). Please see the related [blog post](https://grafana.com/blog/2021/04/20/grafana-loki-tempo-relicensing-to-agplv3/), [Q&A](https://grafana.com/blog/2021/04/20/qa-with-our-ceo-on-relicensing/) and [license](https://github.com/grafana/grafana/blob/main/LICENSE) for more details.
## Enterprise features
+8 -15
View File
@@ -12,18 +12,17 @@ list = false
> **Note:** This topic will be updated frequently between now and the final release.
Grafana 8.1 builds upon our promise of a composable, open observability platform with new panels and extends functionality launched in Grafana 8.0. We’ve got new Geomap and Annotations panels, and some great updates to the Time Series panel. We’ve also got new transformations and updates to data sources. For our enterprise customers, there are additions to fine grained access control, updates to the reporting schedule and query caching, and more. Read on to learn more.
Grafana 8.1 builds upon our promise of a composable, open observability platform with new panels and extends functionality launched in Grafana 8.0. We’ve got new Geomap and Annotations panels, and some great updates to the Time Series panel. We’ve also got new transformations and updates to data sources. For our enterprise customers, there are additions to fine grained access control, updates to the reporting schedule and query caching, and more. Read on to learn more.
In addition to what is summarized here, you might also be interested in our announcement blog post. For all the technical details, check out the complete [CHANGELOG.md](https://github.com/grafana/grafana/blob/master/CHANGELOG.md).
## Grafana OSS features
These features are included in the Grafana open source edition.
## Geomap panel
Grafana 8.1 introduces the foundation for our new map panel. This new panel leverages [OpenLayers](https://openlayers.org/) and gives us a flexible solution for extending the way we use the new Geomap panel moving forward. The new Geomap panel includes multiple base layer styles (map layer options), as well as a more open data layer. The data layer can use coordinates and geo-hashed data in addition to a lookup table.
Grafana 8.1 introduces the foundation for our new map panel. This new panel leverages [OpenLayers](https://openlayers.org/) and gives us a flexible solution for extending the way we use the new Geomap panel moving forward. The new Geomap panel includes multiple base layer styles (map layer options), as well as a more open data layer. The data layer can use coordinates and geo-hashed data in addition to a lookup table.
The Geomap panel is also able to share views across multiple Geomap panels on the same dashboard, making it straightforward to visualize and explore multiple types of geospatial data using the same map zoom and focus settings. For more information, refer to [Geomap panel]({{< relref "../panels/visualizations/geomap.md" >}}).
{{< figure src="/static/img/docs/geomap-panel/geomap_with_heatmap.png" max-width="850px" caption="Geomap panel: Heatmap" >}}
@@ -38,8 +37,7 @@ The new Annotations panel shows a list of available annotations you can use to c
The time series panel has been updated with the ability to color series and line by thresholds or gradient color scales. This allows users to create panels where the line color can change dynamically based on thresholds or using gradient color scales. It adds a layer of visibility to your data, making it easier to view the changes across thresholds at a glance quickly.
Color scheme **From thresholds**:
Color scheme **From thresholds**:
{{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_thresholds_line.png" max-width="1200px" caption="Colors scheme: From thresholds" >}}
Color scheme: **Green-Yellow-Red (by value)**
@@ -47,7 +45,7 @@ Color scheme: **Green-Yellow-Red (by value)**
For more on how to configure Graphs with by value color schemes read [Graph and color schemes]({{< relref "../panels/visualizations/time-series/_index.md" >}}).
You can also create annotations on the new Time series panel]({{< relref "../panels/visualizations/time-series/annotate-time-series.md" >}}), bringing it closer to parity with the legacy Graph Panel. To learn more, refer to the [time series panel]({{< relref "../panels/visualizations/time-series/_index.md" >}}).
You can also create annotations on the new Time series panel]({{< relref "../panels/visualizations/time-series/annotate-time-series.md" >}}), bringing it closer to parity with the legacy Graph Panel. To learn more, refer to the [time series panel]({{< relref "../panels/visualizations/time-series/_index.md" >}}).
### Transformations improvements
@@ -111,7 +109,6 @@ For more on how to prettify JSON logs, refer to [Visualization]({{< relref "../p
We’ve made some changes to the plugins UI to help make it easier to discover and manage your plugins. Enterprise users can now also manage enterprise plugins from within the catalog.
#### Documentation updates
New panel summaries and preview on the top level [Visualizations]({{< relref "../panels/visualizations/_index.md" >}}) page to help users pick or learn about specific visualizations more easily.
@@ -121,11 +118,9 @@ New panel summaries and preview on the top level [Visualizations]({{< relref "..
The `@grafana/ui` exposes a `Select` component, and its variants `MultiSelect`, `AsyncSelect`, and `AsyncMultiSelect`. We have made some internal changes to these components to make the behavior and positioning more consistent in all scenarios.
To test the changes, you can use the `menuShouldPortal` property:
```jsx
<Select
menuShouldPortal
{...otherProps}
/>
<Select menuShouldPortal {...otherProps} />
```
Tests are most likely to be affected. There are some tips for fixing these in the original pull request at [https://github.com/grafana/grafana/pull/36398](https://github.com/grafana/grafana/pull/36398).
@@ -142,7 +137,6 @@ Fine-grained access control remains in beta. You can now grant or revoke permiss
Fine grained access control allows you to customize roles and permissions in Grafana beyond the built-in Viewer, Editor, and Admin roles. As of 8.1, you can modify some of the permissions for any of these built-in roles. This is helpful if you’d like users to have more or fewer access permissions than a given role allows for by default. For an overview of fine-grained access control and a complete list of available permissions, refer to the [Fine grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) documentation.
### New and improved reporting scheduler
We’ve enhanced the scheduler for Reports to be more flexible, so you can send reports at just the right time. When scheduling a report, you can now choose to send a report at custom intervals such as every 4 hours or every 2 weeks. You can also send a report for a limited time period by providing a start and end date, or send a report only on weekdays or on the last day of each month. This change accompanies some other recent improvements to Reporting, like the ability to choose template variables for reports and an improved UX for authoring reports. To learn more, refer to the [reporting]({{< relref "../enterprise/reporting.md" >}}) documentation.
@@ -151,8 +145,7 @@ We’ve enhanced the scheduler for Reports to be more flexible, so you can send
Query caching was released in Grafana 8.0 and allows you to temporarily store the results of data source queries in a cache, so that Grafana reads repeated queries from there instead of from the data source itself. This reduces load on data sources, improves dashboard load times, and can save money for data sources that charge per query. To learn more about query caching see its [overview]({{< relref "../enterprise/query-caching.md" >}}) page. To find out how to turn on encryption, refer to the [caching configuration]({{< relref "../enterprise/enterprise-configuration.md#caching" >}}) documentation.
You can now encrypt the query data cached by Grafana. This improves the security of query data, especially when your cache (like Redis) is shared with other services.
You can now encrypt the query data cached by Grafana. This improves the security of query data, especially when your cache (like Redis) is shared with other services.
### White labeling for the Grafana loading logo
@@ -160,6 +153,6 @@ You can now customize Grafana’s loading logo, which displays while Grafana is
To find out how you can configure it along with other Grafana UI elements, like the corner logo and application footer, refer to the [White labeling]({{< relref "../enterprise/white-labeling.md" >}}) topic of the Grafana Enterprise docs.
### Oauth2 - Team Sync to Group Mapping
### Oauth2 - Team Sync to Group Mapping
With Team Sync you can map your Generic OAuth groups to teams in Grafana so that the users are automatically added to the correct teams.