diff --git a/.betterer.results b/.betterer.results index 32a9c19ec5a..4146be12bc7 100644 --- a/.betterer.results +++ b/.betterer.results @@ -5,12 +5,6 @@ // exports[`no enzyme tests`] = { value: `{ - "packages/grafana-ui/src/components/BarGauge/BarGauge.test.tsx:4199795290": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], - "packages/grafana-ui/src/components/Forms/Legacy/Input/Input.test.tsx:3129955645": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], "packages/grafana-ui/src/components/Graph/Graph.test.tsx:1664091255": [ [0, 17, 13, "RegExp match", "2409514259"] ], @@ -23,9 +17,6 @@ exports[`no enzyme tests`] = { "packages/grafana-ui/src/components/QueryField/QueryField.test.tsx:375894800": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "packages/grafana-ui/src/components/Typeahead/PartialHighlighter.test.tsx:1751923376": [ - [0, 31, 13, "RegExp match", "2409514259"] - ], "packages/grafana-ui/src/slate-plugins/braces.test.tsx:1440546721": [ [0, 19, 13, "RegExp match", "2409514259"] ], @@ -59,9 +50,6 @@ exports[`no enzyme tests`] = { "packages/jaeger-ui-components/src/TracePageHeader/TracePageHeader.test.js:3242042907": [ [14, 26, 13, "RegExp match", "2409514259"] ], - "packages/jaeger-ui-components/src/TracePageHeader/TracePageSearchBar.test.js:1062402339": [ - [14, 19, 13, "RegExp match", "2409514259"] - ], "packages/jaeger-ui-components/src/TraceTimelineViewer/ListView/index.test.js:1734982398": [ [14, 26, 13, "RegExp match", "2409514259"] ], @@ -71,7 +59,7 @@ exports[`no enzyme tests`] = { "packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/AccordianLogs.test.js:3960703835": [ [14, 19, 13, "RegExp match", "2409514259"] ], - "packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/AccordianReferences.test.js:2429764318": [ + "packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/AccordianReferences.test.js:2025513694": [ [14, 19, 13, "RegExp match", "2409514259"] ], "packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/KeyValuesTable.test.js:3813002651": [ @@ -86,9 +74,6 @@ exports[`no enzyme tests`] = { "packages/jaeger-ui-components/src/TraceTimelineViewer/SpanTreeOffset.test.js:174536706": [ [14, 19, 13, "RegExp match", "2409514259"] ], - "packages/jaeger-ui-components/src/TraceTimelineViewer/Ticks.test.js:743308415": [ - [14, 19, 13, "RegExp match", "2409514259"] - ], "packages/jaeger-ui-components/src/TraceTimelineViewer/TimelineHeaderRow/TimelineCollapser.test.js:4018342820": [ [14, 19, 13, "RegExp match", "2409514259"] ], @@ -104,31 +89,19 @@ exports[`no enzyme tests`] = { "packages/jaeger-ui-components/src/TraceTimelineViewer/VirtualizedTraceView.test.js:551014442": [ [13, 26, 13, "RegExp match", "2409514259"] ], - "packages/jaeger-ui-components/src/TraceTimelineViewer/index.test.js:381298544": [ + "packages/jaeger-ui-components/src/TraceTimelineViewer/index.test.js:276996587": [ [14, 19, 13, "RegExp match", "2409514259"] ], - "packages/jaeger-ui-components/src/common/NewWindowIcon.test.js:1750458349": [ - [14, 19, 13, "RegExp match", "2409514259"] - ], - "packages/jaeger-ui-components/src/common/UiFindInput.test.js:2207118020": [ - [14, 19, 13, "RegExp match", "2409514259"] - ], - "packages/jaeger-ui-components/src/url/ReferenceLink.test.js:3249503373": [ - [14, 26, 13, "RegExp match", "2409514259"] - ], "public/app/core/components/PageActionBar/PageActionBar.test.tsx:1251504193": [ [0, 19, 13, "RegExp match", "2409514259"] ], "public/app/core/components/QueryOperationRow/QueryOperationAction.test.tsx:3032694716": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx:2026575657": [ + "public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx:3743889097": [ [0, 26, 13, "RegExp match", "2409514259"] ], - "public/app/core/components/Select/FolderPicker.test.tsx:993468764": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], - "public/app/core/components/Select/MetricSelect.test.tsx:3351544014": [ + "public/app/core/components/Select/MetricSelect.test.tsx:1074737147": [ [0, 19, 13, "RegExp match", "2409514259"] ], "public/app/features/alerting/AlertRuleList.test.tsx:2998938420": [ @@ -140,9 +113,6 @@ exports[`no enzyme tests`] = { "public/app/features/api-keys/ApiKeysAddedModal.test.tsx:3246264379": [ [0, 20, 13, "RegExp match", "2409514259"] ], - "public/app/features/dashboard/components/DashboardRow/DashboardRow.test.tsx:1463123173": [ - [0, 17, 13, "RegExp match", "2409514259"] - ], "public/app/features/dashboard/components/ShareModal/ShareLink.test.tsx:2357087833": [ [0, 35, 13, "RegExp match", "2409514259"] ], @@ -152,9 +122,6 @@ exports[`no enzyme tests`] = { "public/app/features/dashboard/dashgrid/PanelHeader/PanelHeaderCorner.test.tsx:2851646279": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "public/app/features/datasources/DashboardsTable.test.tsx:1950355032": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], "public/app/features/datasources/DataSourceDashboards.test.tsx:1369048021": [ [0, 19, 13, "RegExp match", "2409514259"] ], @@ -182,12 +149,6 @@ exports[`no enzyme tests`] = { "public/app/features/org/OrgProfile.test.tsx:623809345": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "public/app/features/teams/TeamMemberRow.test.tsx:1649328210": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], - "public/app/features/teams/TeamMembers.test.tsx:4089428239": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], "public/app/features/teams/TeamPages.test.tsx:3990420214": [ [0, 19, 13, "RegExp match", "2409514259"] ], @@ -197,17 +158,14 @@ exports[`no enzyme tests`] = { "public/app/features/users/UsersListPage.test.tsx:2518052139": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "public/app/features/users/UsersTable.test.tsx:263958312": [ - [0, 19, 13, "RegExp match", "2409514259"] - ], "public/app/plugins/datasource/cloud-monitoring/components/Aggregation.test.tsx:3822406835": [ [1, 19, 13, "RegExp match", "2409514259"] ], - "public/app/plugins/datasource/cloudwatch/components/ConfigEditor.test.tsx:1224072551": [ + "public/app/plugins/datasource/cloudwatch/components/ConfigEditor.test.tsx:227258837": [ [0, 19, 13, "RegExp match", "2409514259"] ], - "public/app/plugins/datasource/cloudwatch/components/LogsQueryField.test.tsx:2097436158": [ - [1, 19, 13, "RegExp match", "2409514259"] + "public/app/plugins/datasource/cloudwatch/components/LogsQueryField.test.tsx:1501504663": [ + [2, 19, 13, "RegExp match", "2409514259"] ], "public/app/plugins/datasource/elasticsearch/configuration/ConfigEditor.test.tsx:3481855642": [ [0, 26, 13, "RegExp match", "2409514259"] @@ -215,7 +173,7 @@ exports[`no enzyme tests`] = { "public/app/plugins/datasource/elasticsearch/configuration/DataLinks.test.tsx:248699332": [ [0, 17, 13, "RegExp match", "2409514259"] ], - "public/app/plugins/datasource/influxdb/components/ConfigEditor.test.tsx:3456478975": [ + "public/app/plugins/datasource/influxdb/components/ConfigEditor.test.tsx:57753101": [ [0, 19, 13, "RegExp match", "2409514259"] ], "public/app/plugins/datasource/loki/components/LokiExploreQueryEditor.test.tsx:1488067923": [ diff --git a/.bingo/.gitignore b/.bingo/.gitignore index 4f2055b6e4c..9efccf683cd 100644 --- a/.bingo/.gitignore +++ b/.bingo/.gitignore @@ -5,6 +5,7 @@ # But not these files: !.gitignore !*.mod +!*.sum !README.md !Variables.mk !variables.env diff --git a/.bingo/Variables.mk b/.bingo/Variables.mk index 33598267643..e142be92b9a 100644 --- a/.bingo/Variables.mk +++ b/.bingo/Variables.mk @@ -1,4 +1,4 @@ -# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.5.1. DO NOT EDIT. +# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.6. DO NOT EDIT. # All tools are designed to be build inside $GOBIN. BINGO_DIR := $(dir $(lastword $(MAKEFILE_LIST))) GOPATH ?= $(shell go env GOPATH) @@ -17,11 +17,11 @@ GO ?= $(shell which go) # @echo "Running drone" # @$(DRONE) # -DRONE := $(GOBIN)/drone-v1.4.0 +DRONE := $(GOBIN)/drone-v1.5.0 $(DRONE): $(BINGO_DIR)/drone.mod @# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies. - @echo "(re)installing $(GOBIN)/drone-v1.4.0" - @cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=drone.mod -o=$(GOBIN)/drone-v1.4.0 "github.com/drone/drone-cli/drone" + @echo "(re)installing $(GOBIN)/drone-v1.5.0" + @cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=drone.mod -o=$(GOBIN)/drone-v1.5.0 "github.com/drone/drone-cli/drone" WIRE := $(GOBIN)/wire-v0.5.0 $(WIRE): $(BINGO_DIR)/wire.mod diff --git a/.bingo/drone.mod b/.bingo/drone.mod index 1c1ff39e1ff..868f0f75869 100644 --- a/.bingo/drone.mod +++ b/.bingo/drone.mod @@ -4,4 +4,4 @@ go 1.17 replace github.com/docker/docker => github.com/docker/engine v17.12.0-ce-rc1.0.20200309214505-aa6a9891b09c+incompatible -require github.com/drone/drone-cli v1.4.0 // drone +require github.com/drone/drone-cli v1.5.0 // drone diff --git a/.bingo/drone.sum b/.bingo/drone.sum new file mode 100644 index 00000000000..ba8cbb0be41 --- /dev/null +++ b/.bingo/drone.sum @@ -0,0 +1,1030 @@ +bazil.org/fuse v0.0.0-20160811212531-371fbbdaa898/go.mod h1:Xbm+BRKSBEpa4q4hTSxohYNQpsxXPbPry4JJWOB3LB8= +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cloud.google.com/go v0.38.0/go.mod h1:990N+gfupTy94rShfmMCWGDn0LpTmnzTp2qbd1dvSRU= +cloud.google.com/go v0.44.1/go.mod h1:iSa0KzasP4Uvy3f1mN/7PiObzGgflwredwwASm/v6AU= +cloud.google.com/go v0.44.2/go.mod h1:60680Gw3Yr4ikxnPRS/oxxkBccT6SA1yMk63TGekxKY= +cloud.google.com/go v0.45.1/go.mod h1:RpBamKRgapWJb87xiFSdk4g1CME7QZg3uwTez+TSTjc= +cloud.google.com/go v0.46.3/go.mod h1:a6bKKbmY7er1mI7TEI4lsAkts/mkhTSZK8w33B4RAg0= +cloud.google.com/go v0.50.0/go.mod h1:r9sluTvynVuxRIOHXQEHMFffphuXHOMZMycpNR5e6To= +cloud.google.com/go v0.52.0/go.mod h1:pXajvRH/6o3+F9jDHZWQ5PbGhn+o8w9qiu/CffaVdO4= +cloud.google.com/go v0.53.0/go.mod h1:fp/UouUEsRkN6ryDKNW/Upv/JBKnv6WDthjR6+vze6M= +cloud.google.com/go v0.54.0/go.mod h1:1rq2OEkV3YMf6n/9ZvGWI3GWw0VoqH/1x2nd8Is/bPc= +cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o= +cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE= +cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvftPBK2Dvzc= +cloud.google.com/go/datastore v1.0.0/go.mod h1:LXYbyblFSglQ5pkeyhO+Qmw7ukd3C+pD7TKLgZqpHYE= +cloud.google.com/go/datastore v1.1.0/go.mod h1:umbIZjpQpHh4hmRpGhH4tLFup+FVzqBi1b3c64qFpCk= +cloud.google.com/go/pubsub v1.0.1/go.mod h1:R0Gpsv3s54REJCy4fxDixWD93lHJMoZTyQ2kNxGRt3I= +cloud.google.com/go/pubsub v1.1.0/go.mod h1:EwwdRX2sKPjnvnqCa270oGRyludottCI76h+R3AArQw= +cloud.google.com/go/pubsub v1.2.0/go.mod h1:jhfEVHT8odbXTkndysNHCcx0awwzvfOlguIAii9o8iA= +cloud.google.com/go/storage v1.0.0/go.mod h1:IhtSnM/ZTZV8YYJWCY8RULGVqBDmpoyjwiyrjsg+URw= +cloud.google.com/go/storage v1.5.0/go.mod h1:tpKbwo567HUNpVclU5sGELwQWBDZ8gh0ZeosJ0Rtdos= +cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohlUTyfDhBk= +dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= +docker.io/go-docker v1.0.0/go.mod h1:7tiAn5a0LFmjbPDbyTPOaTTOuG1ZRNXdPA6RvKY+fpY= +github.com/99designs/httpsignatures-go v0.0.0-20170731043157-88528bf4ca7e h1:rl2Aq4ZODqTDkeSqQBy+fzpZPamacO1Srp8zq7jf2Sc= +github.com/99designs/httpsignatures-go v0.0.0-20170731043157-88528bf4ca7e/go.mod h1:Xa6lInWHNQnuWoF0YPSsx+INFA9qk7/7pTjwb3PInkY= +github.com/Azure/azure-sdk-for-go v16.2.1+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= +github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78/go.mod h1:LmzpDX56iTiv29bbRTIsUNlaFfuhWRQBWjQdVyAevI8= +github.com/Azure/go-autorest v10.8.1+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= +github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= +github.com/Azure/go-autorest/autorest v0.11.1/go.mod h1:JFgpikqFJ/MleTTxwepExTKnFUKKszPS8UavbQYUMuw= +github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= +github.com/Azure/go-autorest/autorest/adal v0.9.5/go.mod h1:B7KF7jKIeC9Mct5spmyCB/A8CG/sEz1vwIRGv/bbw7A= +github.com/Azure/go-autorest/autorest/date v0.3.0/go.mod h1:BI0uouVdmngYNUzGWeSYnokU+TrmwEsOqdt8Y6sso74= +github.com/Azure/go-autorest/autorest/mocks v0.4.0/go.mod h1:LTp+uSrOhSkaKrUy935gNZuuIPPVsHlr9DSOxSayd+k= +github.com/Azure/go-autorest/autorest/mocks v0.4.1/go.mod h1:LTp+uSrOhSkaKrUy935gNZuuIPPVsHlr9DSOxSayd+k= +github.com/Azure/go-autorest/logger v0.2.0/go.mod h1:T9E3cAhj2VqvPOtCYAvby9aBXkZmbF5NWuPV8+WeEW8= +github.com/Azure/go-autorest/tracing v0.6.0/go.mod h1:+vhtPC754Xsa23ID7GlGsrdKBpUA79WCAKPPZVC2DeU= +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= +github.com/Microsoft/go-winio v0.4.11/go.mod h1:VhR8bwka0BXejwEJY73c50VrPtXAaKcyvVC4A4RozmA= +github.com/Microsoft/go-winio v0.4.14/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA= +github.com/Microsoft/go-winio v0.4.15-0.20190919025122-fc70bd9a86b5/go.mod h1:tTuCMEN+UleMWgg9dVx4Hu52b1bJo+59jBh3ajtinzw= +github.com/Microsoft/go-winio v0.4.16-0.20201130162521-d1ffc52c7331/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0= +github.com/Microsoft/go-winio v0.4.16/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0= +github.com/Microsoft/go-winio v0.4.17-0.20210211115548-6eac466e5fa3/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= +github.com/Microsoft/go-winio v0.4.17-0.20210324224401-5516f17a5958/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= +github.com/Microsoft/go-winio v0.4.17/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= +github.com/Microsoft/hcsshim v0.8.6/go.mod h1:Op3hHsoHPAvb6lceZHDtd9OkTew38wNoXnJs8iY7rUg= +github.com/Microsoft/hcsshim v0.8.7-0.20190325164909-8abdbb8205e4/go.mod h1:Op3hHsoHPAvb6lceZHDtd9OkTew38wNoXnJs8iY7rUg= +github.com/Microsoft/hcsshim v0.8.7/go.mod h1:OHd7sQqRFrYd3RmSgbgji+ctCwkbq2wbEYNSzOYtcBQ= +github.com/Microsoft/hcsshim v0.8.9/go.mod h1:5692vkUqntj1idxauYlpoINNKeqCiG6Sg38RRsjT5y8= +github.com/Microsoft/hcsshim v0.8.14/go.mod h1:NtVKoYxQuTLx6gEq0L96c9Ju4JbRJ4nY2ow3VK6a9Lg= +github.com/Microsoft/hcsshim v0.8.15/go.mod h1:x38A4YbHbdxJtc0sF6oIz+RG0npwSCAvn69iY6URG00= +github.com/Microsoft/hcsshim v0.8.16/go.mod h1:o5/SZqmR7x9JNKsW3pu+nqHm0MF8vbA+VxGOoXdC600= +github.com/Microsoft/hcsshim v0.8.23/go.mod h1:4zegtUJth7lAvFyc6cH2gGQ5B3OFQim01nnU2M8jKDg= +github.com/Microsoft/hcsshim/test v0.0.0-20201218223536-d3e5debf77da/go.mod h1:5hlzMzRKMLyo42nCZ9oml8AdTlq/0cvIaBv6tK1RehU= +github.com/Microsoft/hcsshim/test v0.0.0-20210227013316-43a75bb4edd3/go.mod h1:mw7qgWloBUl75W/gVH3cQszUg1+gUITj7D6NY7ywVnY= +github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= +github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= +github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= +github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= +github.com/Shopify/logrus-bugsnag v0.0.0-20171204204709-577dee27f20d/go.mod h1:HI8ITrYtUY+O+ZhtlqUnD8+KwNPOyugEhfP9fdUIaEQ= +github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/alexflint/go-filemutex v0.0.0-20171022225611-72bdc8eae2ae/go.mod h1:CgnQgUtFrFz9mxFNtED3jI5tLDjKlOM+oUF/sTk6ps0= +github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= +github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY= +github.com/aws/aws-sdk-go v1.15.11/go.mod h1:mFuSZ37Z9YOHbQEwBWztmVzqXrEkub65tZoCYDt7FT0= +github.com/beorn7/perks v0.0.0-20160804104726-4c0e84591b9a/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs= +github.com/bitly/go-simplejson v0.5.0/go.mod h1:cXHtHw4XUPsvGaxgjIAn8PhEWG9NfngEKAMDJEczWVA= +github.com/bits-and-blooms/bitset v1.2.0/go.mod h1:gIdJ4wp64HaoK2YrL1Q5/N7Y16edYb8uY+O0FJTyyDA= +github.com/blang/semver v3.1.0+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk= +github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk= +github.com/bmatcuk/doublestar v1.1.1 h1:YroD6BJCZBYx06yYFEWvUuKVWQn3vLLQAVmDmvTSaiQ= +github.com/bmatcuk/doublestar v1.1.1/go.mod h1:UD6OnuiIn0yFxxA2le/rnRU1G4RaI4UvFv1sNto9p6w= +github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869/go.mod h1:Ekp36dRnpXw/yCqJaO+ZrUyxD+3VXMFFr56k5XYrpB4= +github.com/bshuster-repo/logrus-logstash-hook v0.4.1/go.mod h1:zsTqEiSzDgAa/8GZR7E1qaXrhYNDKBYy5/dWPTIflbk= +github.com/buger/jsonparser v0.0.0-20180808090653-f4dd9f5a6b44/go.mod h1:bbYlZJ7hK1yFx9hf58LP0zeX7UjIGs20ufpu3evjr+s= +github.com/bugsnag/bugsnag-go v0.0.0-20141110184014-b1d153021fcd/go.mod h1:2oa8nejYd4cQ/b0hMIopN0lCRxU0bueqREvZLWFrtK8= +github.com/bugsnag/osext v0.0.0-20130617224835-0dd3f918b21b/go.mod h1:obH5gd0BsqsP2LwDJ9aOkm/6J86V6lyAXCoQWGw3K50= +github.com/bugsnag/panicwrap v0.0.0-20151223152923-e2c28503fcd0/go.mod h1:D/8v3kj0zr8ZAKg1AQ6crr+5VwKN5eIywRkfhyM/+dE= +github.com/buildkite/yaml v2.1.0+incompatible h1:xirI+ql5GzfikVNDmt+yeiXpf/v1Gt03qXTtT5WXdr8= +github.com/buildkite/yaml v2.1.0+incompatible/go.mod h1:UoU8vbcwu1+vjZq01+KrpSeLBgQQIjL/H7Y6KwikUrI= +github.com/cenkalti/backoff/v4 v4.1.1/go.mod h1:scbssz8iZGpm3xbr14ovlUdkxfGXNInqkPWOWmG2CLw= +github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= +github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= +github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/checkpoint-restore/go-criu/v4 v4.1.0/go.mod h1:xUQBLp4RLc5zJtWY++yjOoMoB5lihDt7fai+75m+rGw= +github.com/checkpoint-restore/go-criu/v5 v5.0.0/go.mod h1:cfwC0EG7HMUenopBsUf9d89JlCLQIfgVcNsNN0t6T2M= +github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= +github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= +github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= +github.com/cilium/ebpf v0.0.0-20200110133405-4032b1d8aae3/go.mod h1:MA5e5Lr8slmEg9bt0VpxxWqJlO4iwu3FBdHUzV7wQVg= +github.com/cilium/ebpf v0.0.0-20200702112145-1c8d4c9ef775/go.mod h1:7cR51M8ViRLIdUjrmSXlK9pkrsDlLHbO8jiB8X8JnOc= +github.com/cilium/ebpf v0.2.0/go.mod h1:To2CFviqOWL/M0gIMsvSMlqe7em/l1ALkX1PyjrX2Qs= +github.com/cilium/ebpf v0.4.0/go.mod h1:4tRaxcgiL706VnOzHOdBlY8IEAIdxINsQBcU4xJJXRs= +github.com/cilium/ebpf v0.6.2/go.mod h1:4tRaxcgiL706VnOzHOdBlY8IEAIdxINsQBcU4xJJXRs= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= +github.com/cockroachdb/datadriven v0.0.0-20190809214429-80d97fb3cbaa/go.mod h1:zn76sxSg3SzpJ0PPJaLDCu+Bu0Lg3sKTORVIj19EIF8= +github.com/containerd/aufs v0.0.0-20200908144142-dab0cbea06f4/go.mod h1:nukgQABAEopAHvB6j7cnP5zJ+/3aVcE7hCYqvIwAHyE= +github.com/containerd/aufs v0.0.0-20201003224125-76a6863f2989/go.mod h1:AkGGQs9NM2vtYHaUen+NljV0/baGCAPELGm2q9ZXpWU= +github.com/containerd/aufs v0.0.0-20210316121734-20793ff83c97/go.mod h1:kL5kd6KM5TzQjR79jljyi4olc1Vrx6XBlcyj3gNv2PU= +github.com/containerd/aufs v1.0.0/go.mod h1:kL5kd6KM5TzQjR79jljyi4olc1Vrx6XBlcyj3gNv2PU= +github.com/containerd/btrfs v0.0.0-20201111183144-404b9149801e/go.mod h1:jg2QkJcsabfHugurUvvPhS3E08Oxiuh5W/g1ybB4e0E= +github.com/containerd/btrfs v0.0.0-20210316141732-918d888fb676/go.mod h1:zMcX3qkXTAi9GI50+0HOeuV8LU2ryCE/V2vG/ZBiTss= +github.com/containerd/btrfs v1.0.0/go.mod h1:zMcX3qkXTAi9GI50+0HOeuV8LU2ryCE/V2vG/ZBiTss= +github.com/containerd/cgroups v0.0.0-20190717030353-c4b9ac5c7601/go.mod h1:X9rLEHIqSf/wfK8NsPqxJmeZgW4pcfzdXITDrUSJ6uI= +github.com/containerd/cgroups v0.0.0-20190919134610-bf292b21730f/go.mod h1:OApqhQ4XNSNC13gXIwDjhOQxjWa/NxkwZXJ1EvqT0ko= +github.com/containerd/cgroups v0.0.0-20200531161412-0dbf7f05ba59/go.mod h1:pA0z1pT8KYB3TCXK/ocprsh7MAkoW8bZVzPdih9snmM= +github.com/containerd/cgroups v0.0.0-20200710171044-318312a37340/go.mod h1:s5q4SojHctfxANBDvMeIaIovkq29IP48TKAxnhYRxvo= +github.com/containerd/cgroups v0.0.0-20200824123100-0b889c03f102/go.mod h1:s5q4SojHctfxANBDvMeIaIovkq29IP48TKAxnhYRxvo= +github.com/containerd/cgroups v0.0.0-20210114181951-8a68de567b68/go.mod h1:ZJeTFisyysqgcCdecO57Dj79RfL0LNeGiFUqLYQRYLE= +github.com/containerd/cgroups v1.0.1/go.mod h1:0SJrPIenamHDcZhEcJMNBB85rHcUsw4f25ZfBiPYRkU= +github.com/containerd/console v0.0.0-20180822173158-c12b1e7919c1/go.mod h1:Tj/on1eG8kiEhd0+fhSDzsPAFESxzBBvdyEgyryXffw= +github.com/containerd/console v0.0.0-20181022165439-0650fd9eeb50/go.mod h1:Tj/on1eG8kiEhd0+fhSDzsPAFESxzBBvdyEgyryXffw= +github.com/containerd/console v0.0.0-20191206165004-02ecf6a7291e/go.mod h1:8Pf4gM6VEbTNRIT26AyyU7hxdQU3MvAvxVI0sc00XBE= +github.com/containerd/console v1.0.1/go.mod h1:XUsP6YE/mKtz6bxc+I8UiKKTP04qjQL4qcS3XoQ5xkw= +github.com/containerd/console v1.0.2/go.mod h1:ytZPjGgY2oeTkAONYafi2kSj0aYggsf8acV1PGKCbzQ= +github.com/containerd/containerd v1.2.10/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.3.0-beta.2.0.20190828155532-0293cbd26c69/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.3.0/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.3.1-0.20191213020239-082f7e3aed57/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.3.2/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.3.4 h1:3o0smo5SKY7H6AJCmJhsnCjR2/V2T8VmiHt7seN2/kI= +github.com/containerd/containerd v1.3.4/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.4.0-beta.2.0.20200729163537-40b22ef07410/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.4.1/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.4.3/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.4.9/go.mod h1:bC6axHOhabU15QhwfG7w5PipXdVtMXFTttgp+kVtyUA= +github.com/containerd/containerd v1.5.0-beta.1/go.mod h1:5HfvG1V2FsKesEGQ17k5/T7V960Tmcumvqn8Mc+pCYQ= +github.com/containerd/containerd v1.5.0-beta.3/go.mod h1:/wr9AVtEM7x9c+n0+stptlo/uBBoBORwEx6ardVcmKU= +github.com/containerd/containerd v1.5.0-beta.4/go.mod h1:GmdgZd2zA2GYIBZ0w09ZvgqEq8EfBp/m3lcVZIvPHhI= +github.com/containerd/containerd v1.5.0-rc.0/go.mod h1:V/IXoMqNGgBlabz3tHD2TWDoTJseu1FGOKuoA4nNb2s= +github.com/containerd/containerd v1.5.8 h1:NmkCC1/QxyZFBny8JogwLpOy2f+VEbO/f6bV2Mqtwuw= +github.com/containerd/containerd v1.5.8/go.mod h1:YdFSv5bTFLpG2HIYmfqDpSYYTDX+mc5qtSuYx1YUb/s= +github.com/containerd/continuity v0.0.0-20190426062206-aaeac12a7ffc/go.mod h1:GL3xCUCBDV3CZiTSEKksMWbLE66hEyuu9qyDOOqM47Y= +github.com/containerd/continuity v0.0.0-20190815185530-f2a389ac0a02/go.mod h1:GL3xCUCBDV3CZiTSEKksMWbLE66hEyuu9qyDOOqM47Y= +github.com/containerd/continuity v0.0.0-20191127005431-f65d91d395eb/go.mod h1:GL3xCUCBDV3CZiTSEKksMWbLE66hEyuu9qyDOOqM47Y= +github.com/containerd/continuity v0.0.0-20200710164510-efbc4488d8fe/go.mod h1:cECdGN1O8G9bgKTlLhuPJimka6Xb/Gg7vYzCTNVxhvo= +github.com/containerd/continuity v0.0.0-20201208142359-180525291bb7/go.mod h1:kR3BEg7bDFaEddKm54WSmrol1fKWDU1nKYkgrcgZT7Y= +github.com/containerd/continuity v0.0.0-20210208174643-50096c924a4e/go.mod h1:EXlVlkqNba9rJe3j7w3Xa924itAMLgZH4UD/Q4PExuQ= +github.com/containerd/continuity v0.1.0/go.mod h1:ICJu0PwR54nI0yPEnJ6jcS+J7CZAUXrLh8lPo2knzsM= +github.com/containerd/fifo v0.0.0-20180307165137-3d5202aec260/go.mod h1:ODA38xgv3Kuk8dQz2ZQXpnv/UZZUHUCL7pnLehbXgQI= +github.com/containerd/fifo v0.0.0-20190226154929-a9fb20d87448/go.mod h1:ODA38xgv3Kuk8dQz2ZQXpnv/UZZUHUCL7pnLehbXgQI= +github.com/containerd/fifo v0.0.0-20200410184934-f15a3290365b/go.mod h1:jPQ2IAeZRCYxpS/Cm1495vGFww6ecHmMk1YJH2Q5ln0= +github.com/containerd/fifo v0.0.0-20201026212402-0724c46b320c/go.mod h1:jPQ2IAeZRCYxpS/Cm1495vGFww6ecHmMk1YJH2Q5ln0= +github.com/containerd/fifo v0.0.0-20210316144830-115abcc95a1d/go.mod h1:ocF/ME1SX5b1AOlWi9r677YJmCPSwwWnQ9O123vzpE4= +github.com/containerd/fifo v1.0.0/go.mod h1:ocF/ME1SX5b1AOlWi9r677YJmCPSwwWnQ9O123vzpE4= +github.com/containerd/go-cni v1.0.1/go.mod h1:+vUpYxKvAF72G9i1WoDOiPGRtQpqsNW/ZHtSlv++smU= +github.com/containerd/go-cni v1.0.2/go.mod h1:nrNABBHzu0ZwCug9Ije8hL2xBCYh/pjfMb1aZGrrohk= +github.com/containerd/go-runc v0.0.0-20180907222934-5a6d9f37cfa3/go.mod h1:IV7qH3hrUgRmyYrtgEeGWJfWbgcHL9CSRruz2Vqcph0= +github.com/containerd/go-runc v0.0.0-20190911050354-e029b79d8cda/go.mod h1:IV7qH3hrUgRmyYrtgEeGWJfWbgcHL9CSRruz2Vqcph0= +github.com/containerd/go-runc v0.0.0-20200220073739-7016d3ce2328/go.mod h1:PpyHrqVs8FTi9vpyHwPwiNEGaACDxT/N/pLcvMSRA9g= +github.com/containerd/go-runc v0.0.0-20201020171139-16b287bc67d0/go.mod h1:cNU0ZbCgCQVZK4lgG3P+9tn9/PaJNmoDXPpoJhDR+Ok= +github.com/containerd/go-runc v1.0.0/go.mod h1:cNU0ZbCgCQVZK4lgG3P+9tn9/PaJNmoDXPpoJhDR+Ok= +github.com/containerd/imgcrypt v1.0.1/go.mod h1:mdd8cEPW7TPgNG4FpuP3sGBiQ7Yi/zak9TYCG3juvb0= +github.com/containerd/imgcrypt v1.0.4-0.20210301171431-0ae5c75f59ba/go.mod h1:6TNsg0ctmizkrOgXRNQjAPFWpMYRWuiB6dSF4Pfa5SA= +github.com/containerd/imgcrypt v1.1.1-0.20210312161619-7ed62a527887/go.mod h1:5AZJNI6sLHJljKuI9IHnw1pWqo/F0nGDOuR9zgTs7ow= +github.com/containerd/imgcrypt v1.1.1/go.mod h1:xpLnwiQmEUJPvQoAapeb2SNCxz7Xr6PJrXQb0Dpc4ms= +github.com/containerd/nri v0.0.0-20201007170849-eb1350a75164/go.mod h1:+2wGSDGFYfE5+So4M5syatU0N0f0LbWpuqyMi4/BE8c= +github.com/containerd/nri v0.0.0-20210316161719-dbaa18c31c14/go.mod h1:lmxnXF6oMkbqs39FiCt1s0R2HSMhcLel9vNL3m4AaeY= +github.com/containerd/nri v0.1.0/go.mod h1:lmxnXF6oMkbqs39FiCt1s0R2HSMhcLel9vNL3m4AaeY= +github.com/containerd/ttrpc v0.0.0-20190828154514-0e0f228740de/go.mod h1:PvCDdDGpgqzQIzDW1TphrGLssLDZp2GuS+X5DkEJB8o= +github.com/containerd/ttrpc v0.0.0-20190828172938-92c8520ef9f8/go.mod h1:PvCDdDGpgqzQIzDW1TphrGLssLDZp2GuS+X5DkEJB8o= +github.com/containerd/ttrpc v0.0.0-20191028202541-4f1b8fe65a5c/go.mod h1:LPm1u0xBw8r8NOKoOdNMeVHSawSsltak+Ihv+etqsE8= +github.com/containerd/ttrpc v1.0.1/go.mod h1:UAxOpgT9ziI0gJrmKvgcZivgxOp8iFPSk8httJEt98Y= +github.com/containerd/ttrpc v1.0.2/go.mod h1:UAxOpgT9ziI0gJrmKvgcZivgxOp8iFPSk8httJEt98Y= +github.com/containerd/ttrpc v1.1.0/go.mod h1:XX4ZTnoOId4HklF4edwc4DcqskFZuvXB1Evzy5KFQpQ= +github.com/containerd/typeurl v0.0.0-20180627222232-a93fcdb778cd/go.mod h1:Cm3kwCdlkCfMSHURc+r6fwoGH6/F1hH3S4sg0rLFWPc= +github.com/containerd/typeurl v0.0.0-20190911142611-5eb25027c9fd/go.mod h1:GeKYzf2pQcqv7tJ0AoCuuhtnqhva5LNU3U+OyKxxJpk= +github.com/containerd/typeurl v1.0.1/go.mod h1:TB1hUtrpaiO88KEK56ijojHS1+NeF0izUACaJW2mdXg= +github.com/containerd/typeurl v1.0.2/go.mod h1:9trJWW2sRlGub4wZJRTW83VtbOLS6hwcDZXTn6oPz9s= +github.com/containerd/zfs v0.0.0-20200918131355-0a33824f23a2/go.mod h1:8IgZOBdv8fAgXddBT4dBXJPtxyRsejFIpXoklgxgEjw= +github.com/containerd/zfs v0.0.0-20210301145711-11e8f1707f62/go.mod h1:A9zfAbMlQwE+/is6hi0Xw8ktpL+6glmqZYtevJgaB8Y= +github.com/containerd/zfs v0.0.0-20210315114300-dde8f0fda960/go.mod h1:m+m51S1DvAP6r3FcmYCp54bQ34pyOwTieQDNRIRHsFY= +github.com/containerd/zfs v0.0.0-20210324211415-d5c4544f0433/go.mod h1:m+m51S1DvAP6r3FcmYCp54bQ34pyOwTieQDNRIRHsFY= +github.com/containerd/zfs v1.0.0/go.mod h1:m+m51S1DvAP6r3FcmYCp54bQ34pyOwTieQDNRIRHsFY= +github.com/containernetworking/cni v0.7.1/go.mod h1:LGwApLUm2FpoOfxTDEeq8T9ipbpZ61X79hmU3w8FmsY= +github.com/containernetworking/cni v0.8.0/go.mod h1:LGwApLUm2FpoOfxTDEeq8T9ipbpZ61X79hmU3w8FmsY= +github.com/containernetworking/cni v0.8.1/go.mod h1:LGwApLUm2FpoOfxTDEeq8T9ipbpZ61X79hmU3w8FmsY= +github.com/containernetworking/plugins v0.8.6/go.mod h1:qnw5mN19D8fIwkqW7oHHYDHVlzhJpcY6TQxn/fUyDDM= +github.com/containernetworking/plugins v0.9.1/go.mod h1:xP/idU2ldlzN6m4p5LmGiwRDjeJr6FLK6vuiUwoH7P8= +github.com/containers/ocicrypt v1.0.1/go.mod h1:MeJDzk1RJHv89LjsH0Sp5KTY3ZYkjXO/C+bKAeWFIrc= +github.com/containers/ocicrypt v1.1.0/go.mod h1:b8AOe0YR67uU8OqfVNcznfFpAzu3rdgUV4GP9qXPfu4= +github.com/containers/ocicrypt v1.1.1/go.mod h1:Dm55fwWm1YZAjYRaJ94z2mfZikIyIN4B0oB3dj3jFxY= +github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= +github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= +github.com/coreos/go-iptables v0.4.5/go.mod h1:/mVI274lEDI2ns62jHCDnCyBF9Iwsmekav8Dbxlm1MU= +github.com/coreos/go-iptables v0.5.0/go.mod h1:/mVI274lEDI2ns62jHCDnCyBF9Iwsmekav8Dbxlm1MU= +github.com/coreos/go-oidc v2.1.0+incompatible/go.mod h1:CgnwVTmzoESiwO9qyAFEMiHoZ1nMCKZlZ9V6mm3/LKc= +github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= +github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= +github.com/coreos/go-systemd v0.0.0-20161114122254-48702e0da86b/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/go-systemd v0.0.0-20180511133405-39ca1b05acc7/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/go-systemd/v22 v22.0.0/go.mod h1:xO0FLkIi5MaZafQlIrOotqXZ90ih+1atmu1JpKERPPk= +github.com/coreos/go-systemd/v22 v22.1.0/go.mod h1:xO0FLkIi5MaZafQlIrOotqXZ90ih+1atmu1JpKERPPk= +github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/coreos/pkg v0.0.0-20160727233714-3ac0863d7acf/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/cpuguy83/go-md2man/v2 v2.0.0 h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM= +github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= +github.com/cyphar/filepath-securejoin v0.2.2/go.mod h1:FpkQEhXnPnOthhzymB7CGsFk2G9VLXONKD9G7QGMM+4= +github.com/d2g/dhcp4 v0.0.0-20170904100407-a1d1b6c41b1c/go.mod h1:Ct2BUK8SB0YC1SMSibvLzxjeJLnrYEVLULFNiHY9YfQ= +github.com/d2g/dhcp4client v1.0.0/go.mod h1:j0hNfjhrt2SxUOw55nL0ATM/z4Yt3t2Kd1mW34z5W5s= +github.com/d2g/dhcp4server v0.0.0-20181031114812-7d4a0a7f59a5/go.mod h1:Eo87+Kg/IX2hfWJfwxMzLyuSZyxSoAug2nGa1G2QAi8= +github.com/d2g/hardwareaddr v0.0.0-20190221164911-e7d9fbe030e4/go.mod h1:bMl4RjIciD2oAxI7DmWRx6gbeqrkoLqv3MV0vzNad+I= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/denverdino/aliyungo v0.0.0-20190125010748-a747050bb1ba/go.mod h1:dV8lFg6daOBZbT6/BDGIz6Y3WFGn8juu6G+CQ6LHtl0= +github.com/dgrijalva/jwt-go v0.0.0-20170104182250-a601269ab70c/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no= +github.com/dnaeon/go-vcr v1.0.1/go.mod h1:aBB1+wY4s93YsC3HHjMBMrwTj2R9FHDzUr9KyGc8n1E= +github.com/docker/distribution v0.0.0-20170726174610-edc3ab29cdff/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= +github.com/docker/distribution v0.0.0-20190905152932-14b96e55d84c/go.mod h1:0+TTO4EOBfRPhZXAeF1Vu+W3hHZ8eLp8PgKVZlcvtFY= +github.com/docker/distribution v2.7.1-0.20190205005809-0d3efadf0154+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= +github.com/docker/distribution v2.7.1+incompatible h1:a5mlkVzth6W5A4fOsS3D2EO5BUmsJpcB+cRlLU7cSug= +github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= +github.com/docker/engine v17.12.0-ce-rc1.0.20200309214505-aa6a9891b09c+incompatible h1:hx8H7MbcmXUXAmphQuA/XB7CfSzX4DRrNuHFvfK9aIQ= +github.com/docker/engine v17.12.0-ce-rc1.0.20200309214505-aa6a9891b09c+incompatible/go.mod h1:3CPr2caMgTHxxIAZgEMd3uLYPDlRvPqCpyeRf6ncPcY= +github.com/docker/go-connections v0.3.0 h1:3lOnM9cSzgGwx8VfK/NGOW5fLQ0GjIlCkaktF+n1M6o= +github.com/docker/go-connections v0.3.0/go.mod h1:Gbd7IOopHjR8Iph03tsViu4nIes5XhDvyHbTtUxmeec= +github.com/docker/go-events v0.0.0-20170721190031-9461782956ad/go.mod h1:Uw6UezgYA44ePAFQYUehOuCzmy5zmg/+nl2ZfMWGkpA= +github.com/docker/go-events v0.0.0-20190806004212-e31b211e4f1c/go.mod h1:Uw6UezgYA44ePAFQYUehOuCzmy5zmg/+nl2ZfMWGkpA= +github.com/docker/go-metrics v0.0.0-20180209012529-399ea8c73916/go.mod h1:/u0gXw0Gay3ceNrsHubL3BtdOL2fHf93USgMTe0W5dI= +github.com/docker/go-metrics v0.0.1/go.mod h1:cG1hvH2utMXtqgqqYE9plW6lDxS3/5ayHzueweSI3Vw= +github.com/docker/go-units v0.3.3 h1:Xk8S3Xj5sLGlG5g67hJmYMmUgXv5N4PhkjJHHqrwnTk= +github.com/docker/go-units v0.3.3/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= +github.com/docker/go-units v0.4.0 h1:3uh0PgVws3nIA0Q+MwDC8yjEPf9zjRfZZWXZYDct3Tw= +github.com/docker/go-units v0.4.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= +github.com/docker/libtrust v0.0.0-20150114040149-fa567046d9b1/go.mod h1:cyGadeNEkKy96OOhEzfZl+yxihPEzKnqJwvfuSUqbZE= +github.com/docker/spdystream v0.0.0-20160310174837-449fdfce4d96/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM= +github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE= +github.com/drone/drone-cli v1.4.0 h1:DahOHhnr0LMW5UNSkBtB0KgpAfDbvKb+75Ar1r8CikY= +github.com/drone/drone-cli v1.4.0/go.mod h1:Wq7lI3ke2jyTUe6fiJyPElnKzFZWJamqRpYw0mYexEw= +github.com/drone/drone-cli v1.5.0 h1:dAoU2YBs7c0XjuDs2ql0W7x0+dOvJ/KLh5UrxUuaOnk= +github.com/drone/drone-cli v1.5.0/go.mod h1:682hzP+pG/nS7Xu6YJy064tUrbG7jTpB3gdy0kdxIOM= +github.com/drone/drone-go v1.6.2 h1:QT7o6Bfe5UCUea4ZU74JfzgkwFYbBNduuSQZTr1fQJE= +github.com/drone/drone-go v1.6.2/go.mod h1:fxCf9jAnXDZV1yDr0ckTuWd1intvcQwfJmTRpTZ1mXg= +github.com/drone/drone-go v1.7.0 h1:oEFWVcagBmAkVuFBpBq9lImZX1caDM+zRsmC4O1vXgQ= +github.com/drone/drone-go v1.7.0/go.mod h1:fxCf9jAnXDZV1yDr0ckTuWd1intvcQwfJmTRpTZ1mXg= +github.com/drone/drone-runtime v1.0.7-0.20190729070836-38f28a11afe8/go.mod h1:+osgwGADc/nyl40J0fdsf8Z09bgcBZXvXXnLOY48zYs= +github.com/drone/drone-runtime v1.1.1-0.20200623162453-61e33e2cab5d h1:P5HI/Y9hARTZ3F3EKs0kYijhjXZWQRQHYn1neTi0pWM= +github.com/drone/drone-runtime v1.1.1-0.20200623162453-61e33e2cab5d/go.mod h1:4/2QToW5+HGD0y1sTw7X35W1f7YINS14UfDY4isggT8= +github.com/drone/drone-yaml v0.0.0-20190729072335-70fa398b3560 h1:3QL4NnDpGtaXpgI9eNd6N2k5WK8W388CzD67ZTuuZQg= +github.com/drone/drone-yaml v0.0.0-20190729072335-70fa398b3560/go.mod h1:rCLISp/rqZ50s6G4nKsm971tRSzolxzqqXfgjDqPYoE= +github.com/drone/envsubst v1.0.3 h1:PCIBwNDYjs50AsLZPYdfhSATKaRg/FJmDc2D6+C2x8g= +github.com/drone/envsubst v1.0.3/go.mod h1:N2jZmlMufstn1KEqvbHjw40h1KyTmnVzHcSc9bFiJ2g= +github.com/drone/funcmap v0.0.0-20190918184546-d4ef6e88376d h1:/IO7UVVu191Jc0DajV4cDVoO+91cuppvgxg2MZl+AXI= +github.com/drone/funcmap v0.0.0-20190918184546-d4ef6e88376d/go.mod h1:Hph0/pT6ZxbujnE1Z6/08p5I0XXuOsppqF6NQlGOK0E= +github.com/drone/signal v1.0.0 h1:NrnM2M/4yAuU/tXs6RP1a1ZfxnaHwYkd0kJurA1p6uI= +github.com/drone/signal v1.0.0/go.mod h1:S8t92eFT0g4WUgEc/LxG+LCuiskpMNsG0ajAMGnyZpc= +github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= +github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= +github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= +github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs= +github.com/emicklei/go-restful v2.9.5+incompatible/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs= +github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= +github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= +github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= +github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= +github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s= +github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= +github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= +github.com/frankban/quicktest v1.11.3/go.mod h1:wRf/ReqHper53s+kmmSZizM8NamnL3IM0I9ntUbOk+k= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/fullsailor/pkcs7 v0.0.0-20190404230743-d7302db945fa/go.mod h1:KnogPXtdwXqoenmZCw6S+25EAm2MkxbG0deNDu4cbSA= +github.com/garyburd/redigo v0.0.0-20150301180006-535138d7bcd7/go.mod h1:NR3MbYisc3/PwhQ00EMzDiPmrwpPxAn5GI05/YaO1SY= +github.com/ghodss/yaml v0.0.0-20150909031657-73d445a93680/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= +github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +github.com/go-ini/ini v1.25.4/go.mod h1:ByCAeIL28uOIIG0E3PJtZPDL8WnHpFKFOtgjp+3Ies8= +github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= +github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas= +github.com/go-logr/logr v0.2.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= +github.com/go-openapi/jsonpointer v0.19.2/go.mod h1:3akKfEdA7DF1sugOqz1dVQHBcuDBPKZGEoHC/NkiQRg= +github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= +github.com/go-openapi/jsonreference v0.19.2/go.mod h1:jMjeRr2HHw6nAVajTXJ4eiUwohSTlpa0o73RUL1owJc= +github.com/go-openapi/jsonreference v0.19.3/go.mod h1:rjx6GuL8TTa9VaixXglHmQmIL98+wF9xc8zWvFonSJ8= +github.com/go-openapi/spec v0.19.3/go.mod h1:FpwSN1ksY1eteniUU7X0N/BgJ7a4WvBFVA8Lj9mJglo= +github.com/go-openapi/swag v0.19.2/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= +github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/godbus/dbus v0.0.0-20151105175453-c7fdd8b5cd55/go.mod h1:/YcGZj5zSblfDWMMoOzV4fas9FZnQYTkDnsGvmh2Grw= +github.com/godbus/dbus v0.0.0-20180201030542-885f9cc04c9c/go.mod h1:/YcGZj5zSblfDWMMoOzV4fas9FZnQYTkDnsGvmh2Grw= +github.com/godbus/dbus v0.0.0-20190422162347-ade71ed3457e/go.mod h1:bBOAhwG1umN6/6ZUMtDFBMQR8jRg9O75tm9K00oMsK4= +github.com/godbus/dbus/v5 v5.0.3/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/gogo/googleapis v1.2.0/go.mod h1:Njal3psf3qN6dwBtQfUmBZh2ybovJ0tlu3o/AC7HYjU= +github.com/gogo/googleapis v1.4.0/go.mod h1:5YRNX2z1oM5gXdAkurHa942MDgEJyk02w4OecKY87+c= +github.com/gogo/protobuf v0.0.0-20170307180453-100ba4e88506 h1:zDlw+wgyXdfkRuvFCdEDUiPLmZp2cvf/dWHazY0a5VM= +github.com/gogo/protobuf v0.0.0-20170307180453-100ba4e88506/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= +github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= +github.com/gogo/protobuf v1.3.0/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= +github.com/gogo/protobuf v1.3.1/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= +github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= +github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= +github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= +github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.3 h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/golang/protobuf v1.3.4/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= +github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.5.0 h1:LUVKkCeviFUMKqHa4tXIIij/lbhnMbP7Fn5wKdKkRh4= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-jsonnet v0.16.0 h1:Nb4EEOp+rdeGGyB1rQ5eisgSAqrTnhf9ip+X6lzZbY0= +github.com/google/go-jsonnet v0.16.0/go.mod h1:sOcuej3UW1vpPTZOr8L7RQimqai1a57bt5j22LzGZCw= +github.com/google/go-jsonnet v0.17.0 h1:/9NIEfhK1NQRKl3sP2536b2+x5HnZMdql7x3yK/l8JY= +github.com/google/go-jsonnet v0.17.0/go.mod h1:sOcuej3UW1vpPTZOr8L7RQimqai1a57bt5j22LzGZCw= +github.com/google/gofuzz v0.0.0-20170612174753-24818f796faf/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/gofuzz v1.1.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= +github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= +github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc= +github.com/google/pprof v0.0.0-20191218002539-d4f498aebedc/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= +github.com/google/pprof v0.0.0-20200212024743-f11f1df84d12/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= +github.com/google/pprof v0.0.0-20200229191704-1ebb73c60ed3/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM= +github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= +github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= +github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= +github.com/googleapis/gnostic v0.2.0/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY= +github.com/googleapis/gnostic v0.4.1/go.mod h1:LRhVm6pbyptWbWbuZ38d1eyptfvIytN3ir6b65WBswg= +github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gorilla/handlers v0.0.0-20150720190736-60c7bfde3e33/go.mod h1:Qkdc/uu4tH4g6mTK6auzZ766c4CA0Ng8+o/OAirnOIQ= +github.com/gorilla/mux v1.7.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= +github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= +github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= +github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA= +github.com/gregjones/httpcache v0.0.0-20181110185634-c63ab54fda8f/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA= +github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= +github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de4/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= +github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk= +github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY= +github.com/grpc-ecosystem/grpc-gateway v1.9.5/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY= +github.com/hashicorp/errwrap v0.0.0-20141028054710-7554cd9344ce/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/go-multierror v0.0.0-20161216184304-ed905158d874/go.mod h1:JMRHfdO9jKNzS/+BTlxCjKNQHg/jZAft8U7LloJvN7I= +github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk= +github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= +github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= +github.com/imdario/mergo v0.3.5/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= +github.com/imdario/mergo v0.3.6/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= +github.com/imdario/mergo v0.3.8/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= +github.com/imdario/mergo v0.3.10/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= +github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= +github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= +github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= +github.com/j-keck/arping v0.0.0-20160618110441-2cf9dc699c56/go.mod h1:ymszkNOg6tORTn+6F6j+Jc8TOr5osrynvN6ivFWZ2GA= +github.com/jackspirou/syscerts v0.0.0-20160531025014-b68f5469dff1 h1:9Xm8CKtMZIXgcopfdWk/qZ1rt0HjMgfMR9nxxSeK6vk= +github.com/jackspirou/syscerts v0.0.0-20160531025014-b68f5469dff1/go.mod h1:zuHl3Hh+e9P6gmBPvcqR1HjkaWHC/csgyskg6IaFKFo= +github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= +github.com/jmespath/go-jmespath v0.0.0-20160803190731-bd40a432e4c7/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= +github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc= +github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg= +github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= +github.com/json-iterator/go v1.1.5/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= +github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= +github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= +github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= +github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= +github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQLJ+jE2L00= +github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= +github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= +github.com/klauspost/compress v1.11.3/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= +github.com/klauspost/compress v1.11.13/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= +github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.7.0/go.mod h1:KAzv3t3aY1NaHWoQz1+4F1ccyAH66Jk7yos7ldAVICs= +github.com/marstr/guid v1.1.0/go.mod h1:74gB1z2wpxxInTG6yaqA7KrtM0NZ+RbrcqDvYHefzho= +github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU= +github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA= +github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= +github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= +github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM= +github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE= +github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= +github.com/mattn/go-shellwords v1.0.3/go.mod h1:3xCvwCdWdlDJUrvuMn7Wuy9eWs4pE8vqg+NOMyg4B2o= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4= +github.com/miekg/pkcs11 v1.0.3/go.mod h1:XsNlhZGX73bx86s2hdc/FuaLm2CPZJemRLMA+WTFxgs= +github.com/mistifyio/go-zfs v2.1.2-0.20190413222219-f784269be439+incompatible/go.mod h1:8AuVvqP/mXw1px98n46wfvcGfQ4ci2FwoAjKYxuo3Z4= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= +github.com/mitchellh/osext v0.0.0-20151018003038-5e2d6d41470f/go.mod h1:OkQIRizQZAeMln+1tSwduZz7+Af5oFlKirV/MSYes2A= +github.com/moby/locker v1.0.1/go.mod h1:S7SDdo5zpBK84bzzVlKr2V0hz+7x9hWbYC/kq7oQppc= +github.com/moby/sys/mountinfo v0.4.0/go.mod h1:rEr8tzG/lsIZHBtN/JjGG+LMYx9eXgW2JI+6q0qou+A= +github.com/moby/sys/mountinfo v0.4.1/go.mod h1:rEr8tzG/lsIZHBtN/JjGG+LMYx9eXgW2JI+6q0qou+A= +github.com/moby/sys/symlink v0.1.0/go.mod h1:GGDODQmbFOjFsXvfLVn3+ZRxkch54RkSiGqsZeMYowQ= +github.com/moby/term v0.0.0-20200312100748-672ec06f55cd/go.mod h1:DdlQx2hp0Ss5/fLikoLlEeIYiATotOjgB//nb973jeo= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc= +github.com/mrunalp/fileutils v0.5.0/go.mod h1:M1WthSahJixYnrXQl/DFQuteStB1weuxD2QJNHXfbSQ= +github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= +github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= +github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw= +github.com/natessilva/dag v0.0.0-20180124060714-7194b8dcc5c4 h1:dnMxwus89s86tI8rcGVp2HwZzlz7c5o92VOy7dSckBQ= +github.com/natessilva/dag v0.0.0-20180124060714-7194b8dcc5c4/go.mod h1:cojhOHk1gbMeklOyDP2oKKLftefXoJreOQGOrXk+Z38= +github.com/ncw/swift v1.0.47/go.mod h1:23YIA4yWVnGwv2dQlN4bB7egfYX6YLn0Yo/S6zZO/ZM= +github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= +github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= +github.com/olekukonko/tablewriter v0.0.0-20170122224234-a0225b3f23b5/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= +github.com/onsi/ginkgo v0.0.0-20151202141238-7f8ab55aaf3b/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v0.0.0-20170829012221-11459a886d9c/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.10.1/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.10.3/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.11.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk= +github.com/onsi/gomega v0.0.0-20151007035656-2152b45fa28a/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= +github.com/onsi/gomega v0.0.0-20170829124025-dcabb60a477c/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= +github.com/onsi/gomega v1.7.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= +github.com/onsi/gomega v1.10.3/go.mod h1:V9xEwhxec5O8UDM77eCW8vLymOMltsqPVYWrpDsH8xc= +github.com/opencontainers/go-digest v0.0.0-20170106003457-a6d0ee40d420/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s= +github.com/opencontainers/go-digest v0.0.0-20180430190053-c9281466c8b2/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s= +github.com/opencontainers/go-digest v1.0.0-rc1 h1:WzifXhOVOEOuFYOJAW6aQqW0TooG2iki3E3Ii+WN7gQ= +github.com/opencontainers/go-digest v1.0.0-rc1/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s= +github.com/opencontainers/go-digest v1.0.0-rc1.0.20180430190053-c9281466c8b2/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s= +github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= +github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM= +github.com/opencontainers/image-spec v1.0.0/go.mod h1:BtxoFyWECRxE4U/7sNtV5W15zMzWCbyJoFRP3s7yZA0= +github.com/opencontainers/image-spec v1.0.1 h1:JMemWkRwHx4Zj+fVxWoMCFm/8sYGGrUVojFA6h/TRcI= +github.com/opencontainers/image-spec v1.0.1/go.mod h1:BtxoFyWECRxE4U/7sNtV5W15zMzWCbyJoFRP3s7yZA0= +github.com/opencontainers/image-spec v1.0.2 h1:9yCKha/T5XdGtO0q9Q9a6T5NUCsTn/DrBg0D7ufOcFM= +github.com/opencontainers/image-spec v1.0.2/go.mod h1:BtxoFyWECRxE4U/7sNtV5W15zMzWCbyJoFRP3s7yZA0= +github.com/opencontainers/runc v0.0.0-20190115041553-12f6a991201f/go.mod h1:qT5XzbpPznkRYVz/mWwUaVBUv2rmF59PVA73FjuZG0U= +github.com/opencontainers/runc v0.1.1/go.mod h1:qT5XzbpPznkRYVz/mWwUaVBUv2rmF59PVA73FjuZG0U= +github.com/opencontainers/runc v1.0.0-rc8.0.20190926000215-3e425f80a8c9/go.mod h1:qT5XzbpPznkRYVz/mWwUaVBUv2rmF59PVA73FjuZG0U= +github.com/opencontainers/runc v1.0.0-rc9/go.mod h1:qT5XzbpPznkRYVz/mWwUaVBUv2rmF59PVA73FjuZG0U= +github.com/opencontainers/runc v1.0.0-rc93/go.mod h1:3NOsor4w32B2tC0Zbl8Knk4Wg84SM2ImC1fxBuqJ/H0= +github.com/opencontainers/runc v1.0.2/go.mod h1:aTaHFFwQXuA71CiyxOdFFIorAoemI04suvGRQFzWTD0= +github.com/opencontainers/runtime-spec v0.1.2-0.20190507144316-5b71a03e2700/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-spec v1.0.1/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-spec v1.0.2-0.20190207185410-29686dbc5559/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-spec v1.0.2/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-spec v1.0.3-0.20200929063507-e6143ca7d51d/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-spec v1.0.3-0.20210326190908-1c3f411f0417/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= +github.com/opencontainers/runtime-tools v0.0.0-20181011054405-1d69bd0f9c39/go.mod h1:r3f7wjNzSs2extwzU3Y+6pKfobzPh+kKFJ3ofN+3nfs= +github.com/opencontainers/selinux v1.6.0/go.mod h1:VVGKuOLlE7v4PJyT6h7mNWvq1rzqiriPsEqVhc+svHE= +github.com/opencontainers/selinux v1.8.0/go.mod h1:RScLhm78qiWa2gbVCcGkC7tCGdgk3ogry1nUQF8Evvo= +github.com/opencontainers/selinux v1.8.2/go.mod h1:MUIHuUEvKB1wtJjQdOyYRgOnLD2xAPP8dBsCoU0KuF8= +github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= +github.com/pelletier/go-toml v1.8.1/go.mod h1:T2/BmBdy8dvIRq1a/8aqjN41wvWlN4lrapLU/GW4pbc= +github.com/petar/GoLLRB v0.0.0-20130427215148-53be0d36a84c/go.mod h1:HUpKUBZnpzkdx0kD/+Yfuft+uD3zHGtXF/XJB14TUr4= +github.com/peterbourgon/diskv v2.0.1+incompatible/go.mod h1:uqqh8zWWbv1HBMNONnaR/tNboyR3/BZd58JJSHlUSCU= +github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4 h1:49lOXmGaUpV9Fz3gd7TFZY106KVlPVa5jcYD1gaQf98= +github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4/go.mod h1:4OwLy04Bl9Ef3GJJCoec+30X3LQs/0/m4HFRt/2LUSA= +github.com/pkg/errors v0.8.0 h1:WdK/asTD0HN+q6hsWO3/vpuAkAr+tw6aNJNDFFf0+qw= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1-0.20171018195549-f15c970de5b7/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/pquerna/cachecontrol v0.0.0-20171018203845-0dec1b30a021/go.mod h1:prYjPmNq4d1NPVmpShWobRqXY3q7Vp+80DqgxxUrUIA= +github.com/prometheus/client_golang v0.0.0-20180209125602-c332b6f63c06/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso= +github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo= +github.com/prometheus/client_golang v1.1.0/go.mod h1:I1FGZT9+L76gKKOs5djB6ezCbFQP1xR9D75/vuwEF3g= +github.com/prometheus/client_golang v1.7.1/go.mod h1:PY5Wy2awLA44sXw4AOSfFBetzPP4j5+D6mVACh+pe2M= +github.com/prometheus/client_model v0.0.0-20171117100541-99fa1f4be8e5/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.2.0/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/common v0.0.0-20180110214958-89604d197083/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= +github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= +github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.6.0/go.mod h1:eBmuwkDJBwy6iBfxCBob6t6dR6ENT/y+J+Zk0j9GMYc= +github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB80sz/V91rCo= +github.com/prometheus/procfs v0.0.0-20180125133057-cb4147076ac7/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/procfs v0.0.0-20190522114515-bc1a522cf7b1/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/procfs v0.0.3/go.mod h1:4A/X28fw3Fc593LaREMrKMqOKvUAntwMDaekg4FpcdQ= +github.com/prometheus/procfs v0.0.5/go.mod h1:4A/X28fw3Fc593LaREMrKMqOKvUAntwMDaekg4FpcdQ= +github.com/prometheus/procfs v0.0.8/go.mod h1:7Qr8sr6344vo1JqZ6HhLceV9o3AJ1Ff+GxbHq6oeK9A= +github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU= +github.com/prometheus/procfs v0.2.0/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU= +github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA= +github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= +github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= +github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/safchain/ethtool v0.0.0-20190326074333-42ed695e3de8/go.mod h1:Z0q5wiBQGYcxhMZ6gUqHn6pYNLypFAvaL3UvgZLR0U4= +github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= +github.com/seccomp/libseccomp-golang v0.9.1/go.mod h1:GbW5+tmTXfcxTToHLXlScSlAvWlF4P2Ca7zGrPiEpWo= +github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= +github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= +github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= +github.com/sirupsen/logrus v1.0.4-0.20170822132746-89742aefa4b2/go.mod h1:pMByvHTf9Beacp5x1UXfOR9xyW/9antXMhjMPG0dEzc= +github.com/sirupsen/logrus v1.0.6/go.mod h1:pMByvHTf9Beacp5x1UXfOR9xyW/9antXMhjMPG0dEzc= +github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= +github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= +github.com/sirupsen/logrus v1.6.0 h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I= +github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE= +github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= +github.com/smartystreets/goconvey v0.0.0-20190330032615-68dc04aab96a/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= +github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= +github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= +github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= +github.com/spf13/afero v1.2.2/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk= +github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= +github.com/spf13/cobra v0.0.2-0.20171109065643-2da4a54c5cee/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= +github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= +github.com/spf13/cobra v1.0.0/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE= +github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= +github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.1-0.20171106142849-4c012f6dcd95/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.1/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/viper v1.4.0/go.mod h1:PTJ7Z/lr49W6bUbkmS1V3by4uWynFiR9p7+dSq/yZzE= +github.com/stefanberger/go-pkcs11uri v0.0.0-20201008174630-78d3cae3a980/go.mod h1:AO3tvPzVZ/ayst6UlUKUv6rcPQInYe3IknH3jYhAKu8= +github.com/stretchr/objx v0.0.0-20180129172003-8a3f7159479f/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= +github.com/stretchr/testify v0.0.0-20180303142811-b89eecf5ca5d/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/syndtr/gocapability v0.0.0-20170704070218-db04d3cc01c8/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww= +github.com/syndtr/gocapability v0.0.0-20180916011248-d98352740cb2/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww= +github.com/syndtr/gocapability v0.0.0-20200815063812-42c35b437635/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww= +github.com/tchap/go-patricia v2.2.6+incompatible/go.mod h1:bmLyhP68RS6kStMGxByiQ23RP/odRBOTVjwp2cDyi6I= +github.com/tmc/grpc-websocket-proxy v0.0.0-20170815181823-89b8d40f7ca8/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= +github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= +github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= +github.com/urfave/cli v0.0.0-20171014202726-7bc6a0acffa5/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA= +github.com/urfave/cli v1.20.0 h1:fDqGv3UG/4jbVl/QkFwEdddtEDjh/5Ov6X+0B/3bPaw= +github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA= +github.com/urfave/cli v1.22.1/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= +github.com/urfave/cli v1.22.2 h1:gsqYFH8bb9ekPA12kRo0hfjngWQjkJPlN9R0N78BoUo= +github.com/urfave/cli v1.22.2/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= +github.com/vinzenz/yaml v0.0.0-20170920082545-91409cdd725d h1:3wDi6J5APMqaHBVPuVd7RmHD2gRTfqbdcVSpCNoUWtk= +github.com/vinzenz/yaml v0.0.0-20170920082545-91409cdd725d/go.mod h1:mb5taDqMnJiZNRQ3+02W2IFG+oEz1+dTuCXkp4jpkfo= +github.com/vishvananda/netlink v0.0.0-20181108222139-023a6dafdcdf/go.mod h1:+SR5DhBJrl6ZM7CoCKvpw5BKroDKQ+PJqOg65H/2ktk= +github.com/vishvananda/netlink v1.1.0/go.mod h1:cTgwzPIzzgDAYoQrMm0EdrjRUBkTqKYppBueQtXaqoE= +github.com/vishvananda/netlink v1.1.1-0.20201029203352-d40f9887b852/go.mod h1:twkDnbuQxJYemMlGd4JFIcuhgX83tXhKS2B/PRMpOho= +github.com/vishvananda/netns v0.0.0-20180720170159-13995c7128cc/go.mod h1:ZjcWmFBXmLKZu9Nxj3WKYEafiSqer2rnvPr0en9UNpI= +github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df/go.mod h1:JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU= +github.com/vishvananda/netns v0.0.0-20200728191858-db3c7e526aae/go.mod h1:DD4vA1DwXk04H54A1oHXtwZmA0grkVMdPxx/VGLCah0= +github.com/willf/bitset v1.1.11-0.20200630133818-d5bec3311243/go.mod h1:RjeCKbqT1RxIR/KWY6phxZiaY1IyutSBfGjNPySAYV4= +github.com/willf/bitset v1.1.11/go.mod h1:83CECat5yLh5zVOf4P1ErAgKA5UDvKtgyUABdr3+MjI= +github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= +github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ= +github.com/xeipuuv/gojsonschema v0.0.0-20180618132009-1d523034197f/go.mod h1:5yf86TLmAcydyeJq5YvxkGPE2fm/u4myDekKRoLuqhs= +github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= +github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q= +github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yvasiyarov/go-metrics v0.0.0-20140926110328-57bccd1ccd43/go.mod h1:aX5oPXxHm3bOH+xeAttToC8pqch2ScQN/JoXYupl6xs= +github.com/yvasiyarov/gorelic v0.0.0-20141212073537-a9bba5b9ab50/go.mod h1:NUSPSUX/bi6SeDMUh6brw0nXpxHnc96TguQh0+r/ssA= +github.com/yvasiyarov/newrelic_platform_go v0.0.0-20140908184405-b21fdbd4370f/go.mod h1:GlGEuHIJweS1mbCqG+7vt2nvWLzLLnRHbXz5JKd/Qbg= +go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= +go.etcd.io/bbolt v1.3.3/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= +go.etcd.io/bbolt v1.3.5/go.mod h1:G5EMThwa9y8QZGBClrRx5EY+Yw9kAhnjy3bSjsnlVTQ= +go.etcd.io/etcd v0.5.0-alpha.5.0.20200910180754-dd1b699fc489/go.mod h1:yVHk9ub3CSBatqGNg7GRmsnfLWtoW60w4eDYfh7vHDg= +go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1/go.mod h1:SNgMg+EgDFwmvSmLRTNKC5fegJjB7v23qTQ0XLGUNHk= +go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= +go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= +go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= +go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= +go.starlark.net v0.0.0-20201118183435-e55f603d8c79 h1:JPjLPz44y2N9mkzh2N344kTk1Y4/V4yJAjTrXGmzv8I= +go.starlark.net v0.0.0-20201118183435-e55f603d8c79/go.mod h1:5YFcFnRptTN+41758c2bMPiqpGg4zBfYji1IQz8wNFk= +go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= +go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= +go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= +go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= +golang.org/x/crypto v0.0.0-20171113213409-9f005a07e0d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20181009213950-7c1a557ab941/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= +golang.org/x/exp v0.0.0-20190829153037-c13cbed26979/go.mod h1:86+5VVa7VpoJ4kLfm080zCjGlMRFzhUhsZKEZO7MGek= +golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE3MuO9GYsAcnJvJ4vnMwN/5qkY= +golang.org/x/exp v0.0.0-20191129062945-2f5052295587/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= +golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= +golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4= +golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM= +golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU= +golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= +golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f/go.mod h1:5qLYkcX4OjUUV8bRuDixDT3tpyyb+LUpUlRWLxfhWrs= +golang.org/x/lint v0.0.0-20200130185559-910be7a94367/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= +golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= +golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= +golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o= +golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= +golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= +golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.1.1-0.20191107180719-034126e5016b/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181011144130-49bb7cea24b1/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20190603091049-60506f45cf65 h1:+rhAzEzT3f4JtomfC371qB+0Ola2caSKcY69NUBZrRQ= +golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190619014844-b5b0513f8c1b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190813141303-74dc4d7220e7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20191004110552-13f9640d40b9/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= +golang.org/x/net v0.0.0-20201006153459-a7d1128ccaa0/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110 h1:qWPm9rbaAMKs8Bq/9LRpbMqxWRVUAQwMI9fVrssnTfw= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890 h1:uESlIz09WIHT2I+pasSXcpLYqYK8wHcdCetU3VuMBJE= +golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d h1:TzXSXBo42m9gQenoE3b9BGiEpg5IG2JkU5FkPIawgtw= +golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190227155943-e225da77a7e6/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58 h1:8gQV6CLnAEikrhgkHFbMAEhagSSnXWGV915qUMm9mrU= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201207232520-09787c993a3a h1:DcqTD9SDLc+1P/r1EmRBwnVsrOwW+kk2vWf9n+1sGhs= +golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181005133103-4497e2df6f9e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190514135907-3a4b5fb9f71f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190522044717-8097e1b27ff5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190602015325-4c4f7f33c9ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190606203320-7fc4e5ec1444/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190616124812-15dcb6c0061f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190812073006-9eafafc0a87e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190826190057-c7b8b68b1456/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191022100944-742c48ecaeb7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191115151921-52ab43148777/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191210023423-ac6580df4449/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200106162015-b016eb3dc98e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200113162924-86b910548bc1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200120151820-655fe14d7479/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200122134326-e047566fdf82/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200124204421-9fbb57f87de9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200202164722-d101bd2416d5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200212091648-12a6c2dcc1e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200217220822-9197077df867/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200622214017-ed371f2e16b4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200728102440-3e129f6d46b1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200803210538-64077c9b5642 h1:B6caxRw+hozq68X2MY7jEpZh/cr4/aHLv9xU8Kkadrw= +golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200817155316-9781c653f443/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200909081042-eff7692f9009/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200916030750-2334cc1a136f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200922070232-aee5d888a860/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201112073958-5cba982894dd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201117170446-d9b008d0a637/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201201145000-ef89a241ccb3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201202213521-69691e467435/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210324051608-47abb6519492/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210426230700-d19ff857e887 h1:dXfMednGJh/SUUFjTLsWJz3P+TQt9qnR11GgeI3vWKs= +golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20200630173020-3af7569d3a1e/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20181030221726-6c7e314b6563/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190312170243-e65039ee4138/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190614205625-5aca471b1d59/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190624222133-a101b041ded4/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191113191852-77e3bb0ad9e7/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191115202509-3a792d9c32b2/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191125144606-a911d9008d1f/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191216173652-a0e659d51361/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20191227053925-7b8e75db28f4/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200117161641-43d50277825c/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200122220014-bf1340f18c4a/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200204074204-1cc6d1ef6c74/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200212150539-ea181f53ac56/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200224181240-023911ca70b2/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200304193943-95d2e580d8eb/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw= +golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/api v0.0.0-20160322025152-9bf6e6e569ff/go.mod h1:4mhQ8q/RsB7i+udVvVy5NUi08OU8ZlA0gRVgrF7VFY0= +google.golang.org/api v0.4.0/go.mod h1:8k5glujaEP+g9n7WNsDg8QP6cUVNI86fCNMcbazEtwE= +google.golang.org/api v0.7.0/go.mod h1:WtwebWUNSVBH/HAw79HIFXZNqEvBhG+Ra+ax0hx3E3M= +google.golang.org/api v0.8.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= +google.golang.org/api v0.9.0/go.mod h1:o4eAsZoiT+ibD93RtjEohWalFOjRDx6CVaqeizhEnKg= +google.golang.org/api v0.13.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= +google.golang.org/api v0.14.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= +google.golang.org/api v0.15.0/go.mod h1:iLdEw5Ide6rF15KTC1Kkl0iskquN2gFfn9o9XIsbkAI= +google.golang.org/api v0.17.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= +google.golang.org/api v0.18.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= +google.golang.org/api v0.20.0/go.mod h1:BwFmGc8tA3vsd7r/7kR8DY7iEEGSU04BFxCo5jP/sfE= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.3.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/appengine v1.6.1/go.mod h1:i06prIuMbXzDqacNJfV5OdTW448YApPu5ww/cMBSeb0= +google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= +google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= +google.golang.org/cloud v0.0.0-20151119220103-975617b05ea8/go.mod h1:0H1ncTHf11KCFhTc/+EFRbzSCOZx+VUbRMk55Yv5MYk= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190307195333-5fe7a883aa19/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190418145605-e7d98fc518a7/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190425155659-357c62f0e4bb/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190502173448-54afdca5d873/go.mod h1:VzzqZJRnGkLBvHegQrXjBqPurQTc5/KpmUdxsrq26oE= +google.golang.org/genproto v0.0.0-20190522204451-c2c4e71fbf69/go.mod h1:z3L6/3dTEVtUr6QSP8miRzeRqwQOioJ9I66odjN4I7s= +google.golang.org/genproto v0.0.0-20190801165951-fa694d86fc64/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55 h1:gSJIx1SDwno+2ElGhA4+qG2zF97qiUzTM+rQ0klBOcE= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20190911173649-1774047e7e51/go.mod h1:IbNlFCBrqXvoKpeg0TB2l7cyZUmoaFKYIwrEpbDKLA8= +google.golang.org/genproto v0.0.0-20191108220845-16a3f7862a1a/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20191115194625-c23dd37a84c9/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20191216164720-4f79533eabd1/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20191230161307-f3c370f40bfb/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20200115191322-ca5a22157cba/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20200117163144-32f20d992d24/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20200122232147-0452cf42e150/go.mod h1:n3cpQtvxv34hfy77yVDNjmbRyujviMdxYliBSkLhpCc= +google.golang.org/genproto v0.0.0-20200204135345-fa8e72b47b90/go.mod h1:GmwEX6Z4W5gMy59cAlVYjN9JhxgbQH6Gn+gFDQe2lzA= +google.golang.org/genproto v0.0.0-20200212174721-66ed5ce911ce/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= +google.golang.org/genproto v0.0.0-20200224152610-e50cd9704f63/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= +google.golang.org/genproto v0.0.0-20200305110556-506484158171/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= +google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= +google.golang.org/genproto v0.0.0-20201110150050-8816d57aaa9a h1:pOwg4OoaRYScjmR4LlLgdtnyoHYTSAVhhqe5uPdpII8= +google.golang.org/genproto v0.0.0-20201110150050-8816d57aaa9a/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= +google.golang.org/grpc v0.0.0-20160317175043-d3ddb4469d5a/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= +google.golang.org/grpc v1.21.0/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= +google.golang.org/grpc v1.21.1/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= +google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.23.1/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.24.0/go.mod h1:XDChyiUovWa60DnaeDeZmSW86xtLtjtZbwvSiRnRtcA= +google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= +google.golang.org/grpc v1.26.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.27.1/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.30.0 h1:M5a8xTlYTxwMn5ZFkwhRabsygDY5G8TYLyQDBxJNAxE= +google.golang.org/grpc v1.30.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= +google.golang.org/grpc v1.33.2 h1:EQyQC3sa8M+p6Ulc8yy9SWSS2GVwyRc83gAbG8lrl4o= +google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4= +google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= +google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/airbrake/gobrake.v2 v2.0.9/go.mod h1:/h5ZAUhDkGaJfjzjKLSjv6zCL6O0LLBxU4K+aSYdM/U= +gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20141024133853-64131543e789/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/cheggaaa/pb.v1 v1.0.25/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw= +gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= +gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= +gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2/go.mod h1:Xk6kEKp8OKb+X14hQBKWaSkCsqBpgog8nAV2xsGOxlo= +gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw= +gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k= +gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= +gopkg.in/square/go-jose.v2 v2.2.2/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= +gopkg.in/square/go-jose.v2 v2.3.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= +gopkg.in/square/go-jose.v2 v2.5.1/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4 h1:/eiJrUcujPVeJ3xlSWaiNi3uSVmDGBK1pDHUHAnao1I= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw= +gotest.tools/v3 v3.0.2/go.mod h1:3SzNCllyD9/Y+b5r9JIKQ474KzkZyqLqEfYqMsX94Bk= +gotest.tools/v3 v3.0.3/go.mod h1:Z7Lb0S5l+klDB31fvDQX8ss/FlKDxtlFlw3Oa8Ymbl8= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= +honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= +k8s.io/api v0.0.0-20181130031204-d04500c8c3dd/go.mod h1:iuAfoD4hCxJ8Onx9kaTIt30j7jUFS00AXQi6QMi99vA= +k8s.io/api v0.20.1/go.mod h1:KqwcCVogGxQY3nBlRpwt+wpAMF/KjaCc7RpywacvqUo= +k8s.io/api v0.20.4/go.mod h1:++lNL1AJMkDymriNniQsWRkMDzRaX2Y/POTUi8yvqYQ= +k8s.io/api v0.20.6/go.mod h1:X9e8Qag6JV/bL5G6bU8sdVRltWKmdHsFUGS3eVndqE8= +k8s.io/apimachinery v0.0.0-20181201231028-18a5ff3097b4/go.mod h1:ccL7Eh7zubPUSh9A3USN90/OzHNSVN6zxzde07TDCL0= +k8s.io/apimachinery v0.20.1/go.mod h1:WlLqWAHZGg07AeltaI0MV5uk1Omp8xaN0JGLY6gkRpU= +k8s.io/apimachinery v0.20.4/go.mod h1:WlLqWAHZGg07AeltaI0MV5uk1Omp8xaN0JGLY6gkRpU= +k8s.io/apimachinery v0.20.6/go.mod h1:ejZXtW1Ra6V1O5H8xPBGz+T3+4gfkTCeExAHKU57MAc= +k8s.io/apiserver v0.20.1/go.mod h1:ro5QHeQkgMS7ZGpvf4tSMx6bBOgPfE+f52KwvXfScaU= +k8s.io/apiserver v0.20.4/go.mod h1:Mc80thBKOyy7tbvFtB4kJv1kbdD0eIH8k8vianJcbFM= +k8s.io/apiserver v0.20.6/go.mod h1:QIJXNt6i6JB+0YQRNcS0hdRHJlMhflFmsBDeSgT1r8Q= +k8s.io/client-go v0.20.1/go.mod h1:/zcHdt1TeWSd5HoUe6elJmHSQ6uLLgp4bIJHVEuy+/Y= +k8s.io/client-go v0.20.4/go.mod h1:LiMv25ND1gLUdBeYxBIwKpkSC5IsozMMmOOeSJboP+k= +k8s.io/client-go v0.20.6/go.mod h1:nNQMnOvEUEsOzRRFIIkdmYOjAZrC8bgq0ExboWSU1I0= +k8s.io/client-go v9.0.0+incompatible/go.mod h1:7vJpHMYJwNQCWgzmNV+VYUl1zCObLyodBc8nIyt8L5s= +k8s.io/component-base v0.20.1/go.mod h1:guxkoJnNoh8LNrbtiQOlyp2Y2XFCZQmrcg2n/DeYNLk= +k8s.io/component-base v0.20.4/go.mod h1:t4p9EdiagbVCJKrQ1RsA5/V4rFQNDfRlevJajlGwgjI= +k8s.io/component-base v0.20.6/go.mod h1:6f1MPBAeI+mvuts3sIdtpjljHWBQ2cIy38oBIWMYnrM= +k8s.io/cri-api v0.17.3/go.mod h1:X1sbHmuXhwaHs9xxYffLqJogVsnI+f6cPRcgPel7ywM= +k8s.io/cri-api v0.20.1/go.mod h1:2JRbKt+BFLTjtrILYVqQK5jqhI+XNdF6UiGMgczeBCI= +k8s.io/cri-api v0.20.4/go.mod h1:2JRbKt+BFLTjtrILYVqQK5jqhI+XNdF6UiGMgczeBCI= +k8s.io/cri-api v0.20.6/go.mod h1:ew44AjNXwyn1s0U4xCKGodU7J1HzBeZ1MpGrpa5r8Yc= +k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0= +k8s.io/klog v0.1.0/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk= +k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE= +k8s.io/klog/v2 v2.4.0/go.mod h1:Od+F08eJP+W3HUb4pSrPpgp9DGU4GzlpG/TmITuYh/Y= +k8s.io/kube-openapi v0.0.0-20201113171705-d219536bb9fd/go.mod h1:WOJ3KddDSol4tAGcJo0Tvi+dK12EcqSLqcWsryKMpfM= +k8s.io/kubernetes v1.13.0/go.mod h1:ocZa8+6APFNC2tX1DZASIbocyYT5jHzqFVsY5aoB7Jk= +k8s.io/utils v0.0.0-20201110183641-67b214c5f920/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= +rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= +rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= +rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= +sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.14/go.mod h1:LEScyzhFmoF5pso/YSeBstl57mOzx9xlU9n85RGrDQg= +sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.15/go.mod h1:LEScyzhFmoF5pso/YSeBstl57mOzx9xlU9n85RGrDQg= +sigs.k8s.io/structured-merge-diff/v4 v4.0.2/go.mod h1:bJZC9H9iH24zzfZ/41RGcq60oK1F7G282QMXDPYydCw= +sigs.k8s.io/structured-merge-diff/v4 v4.0.3/go.mod h1:bJZC9H9iH24zzfZ/41RGcq60oK1F7G282QMXDPYydCw= +sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o= +sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc= diff --git a/.bingo/variables.env b/.bingo/variables.env index 3ef9658190d..c8c64783f9c 100644 --- a/.bingo/variables.env +++ b/.bingo/variables.env @@ -1,4 +1,4 @@ -# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.5.1. DO NOT EDIT. +# Auto generated binary variables helper managed by https://github.com/bwplotka/bingo v0.6. DO NOT EDIT. # All tools are designed to be build inside $GOBIN. # Those variables will work only until 'bingo get' was invoked, or if tools were installed via Makefile's Variables.mk. GOBIN=${GOBIN:=$(go env GOBIN)} @@ -8,7 +8,7 @@ if [ -z "$GOBIN" ]; then fi -DRONE="${GOBIN}/drone-v1.4.0" +DRONE="${GOBIN}/drone-v1.5.0" WIRE="${GOBIN}/wire-v0.5.0" diff --git a/.bingo/wire.sum b/.bingo/wire.sum new file mode 100644 index 00000000000..6d4b4b38644 --- /dev/null +++ b/.bingo/wire.sum @@ -0,0 +1,13 @@ +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/subcommands v1.0.1 h1:/eqq+otEXm5vhfBrbREPCSVQbvofip6kIz+mX5TUH7k= +github.com/google/subcommands v1.0.1/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk= +github.com/google/wire v0.5.0 h1:I7ELFeVBr3yfPIcc8+MWvrjk+3VjbcSzoXm3JVa+jD8= +github.com/google/wire v0.5.0/go.mod h1:ngWDr9Qvq3yZA10YrxfyGELY/AFWGVpy9c1LTRi1EoU= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/tools v0.0.0-20190422233926-fe54fb35175b h1:NVD8gBK33xpdqCaZVVtd6OFJp+3dxkXuz7+U7KaVN6s= +golang.org/x/tools v0.0.0-20190422233926-fe54fb35175b/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= diff --git a/.drone.yml b/.drone.yml index 40305f9faf0..758076b73af 100644 --- a/.drone.yml +++ b/.drone.yml @@ -15,7 +15,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -23,13 +23,13 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - yarn run prettier:check @@ -40,7 +40,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - yarn run ci:test-frontend @@ -48,16 +48,20 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend trigger: event: - pull_request paths: exclude: - - '*.md' - docs/** - - latest.json + - '*.md' + - pkg/** + - packaging/** + - go.sum + - go.mod + include: [] type: docker volumes: - host: @@ -80,7 +84,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -88,11 +92,11 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - ./bin/grabpl verify-drone @@ -110,13 +114,13 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl shellcheck depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: shellcheck - commands: - ./bin/grabpl lint-backend --edition oss @@ -124,28 +128,34 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - ./bin/grabpl test-backend --edition oss depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - - ./bin/grabpl integration-tests --edition oss + - go test -run Integration -covermode=atomic -timeout=30m ./pkg/... depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration trigger: event: - pull_request paths: exclude: - - '*.md' - docs/** - - latest.json + - '*.md' + include: + - pkg/** + - packaging/** + - .drone.yml + - conf/** + - go.sum + - go.mod type: docker volumes: - host: @@ -168,7 +178,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -176,17 +186,17 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - failure: ignore image: grafana/drone-downstream @@ -207,7 +217,7 @@ steps: depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -216,7 +226,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -225,7 +235,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition oss @@ -233,27 +243,16 @@ steps: - gen-version - yarn-install environment: null - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - . scripts/build/gpg-test-vars.sh && ./bin/grabpl package --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} --variants linux-amd64,linux-amd64-musl,darwin-amd64,windows-amd64,armv6 @@ -263,7 +262,7 @@ steps: - build-frontend - build-frontend-packages environment: null - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ./scripts/grafana-server/start-server @@ -276,7 +275,7 @@ steps: environment: ARCH: linux-amd64 PORT: 3001 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -354,7 +353,7 @@ steps: - build-frontend-packages environment: NODE_OPTIONS: --max_old_space_size=4096 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-storybook - commands: - yarn wait-on http://$HOST:$PORT @@ -374,7 +373,7 @@ steps: - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition oss -archs amd64 @@ -434,7 +433,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -455,7 +454,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -470,7 +469,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests trigger: event: @@ -504,7 +503,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -516,13 +515,13 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - |- @@ -534,7 +533,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - yarn run prettier:checkDocs @@ -542,7 +541,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-docs - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -551,13 +550,13 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./scripts/ci-reference-docs-lint.sh ci depends_on: - build-frontend-packages - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-docs - commands: - mkdir -p /hugo/content/docs/grafana @@ -594,7 +593,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -606,13 +605,13 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - |- @@ -624,7 +623,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - yarn run prettier:checkDocs @@ -632,7 +631,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-docs - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -641,13 +640,13 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./scripts/ci-reference-docs-lint.sh ci depends_on: - build-frontend-packages - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-docs - commands: - mkdir -p /hugo/content/docs/grafana @@ -683,7 +682,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -691,13 +690,13 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - yarn run prettier:check @@ -708,7 +707,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - yarn run ci:test-frontend @@ -716,7 +715,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend trigger: branch: main @@ -744,7 +743,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -752,11 +751,11 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - ./bin/grabpl verify-drone @@ -774,13 +773,13 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl shellcheck depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: shellcheck - commands: - ./bin/grabpl lint-backend --edition oss @@ -788,19 +787,19 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - ./bin/grabpl test-backend --edition oss depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - - ./bin/grabpl integration-tests --edition oss + - go test -run Integration -covermode=atomic -timeout=30m ./pkg/... depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration trigger: branch: main @@ -828,7 +827,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -836,17 +835,17 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - git clone "https://$${GITHUB_TOKEN}@github.com/grafana/grafana-enterprise.git" @@ -867,7 +866,7 @@ steps: from_secret: github_token TEST_TAG: v0.0.0-test failure: ignore - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: trigger-test-release when: paths: @@ -892,7 +891,7 @@ steps: depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -901,7 +900,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -910,7 +909,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition oss --sign --signing-admin @@ -920,27 +919,16 @@ steps: environment: GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - ./bin/grabpl package --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} --sign depends_on: @@ -957,7 +945,7 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ./scripts/grafana-server/start-server @@ -970,7 +958,7 @@ steps: environment: ARCH: linux-amd64 PORT: 3001 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -1048,7 +1036,7 @@ steps: - build-frontend-packages environment: NODE_OPTIONS: --max_old_space_size=4096 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-storybook - commands: - ./bin/grabpl store-storybook --deployment canary --src-bucket grafana-storybook @@ -1089,7 +1077,7 @@ steps: GRAFANA_MISC_STATS_API_KEY: from_secret: grafana_misc_stats_api_key failure: ignore - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: publish-frontend-metrics when: repo: @@ -1099,7 +1087,7 @@ steps: - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition oss @@ -1177,7 +1165,7 @@ steps: environment: NPM_TOKEN: from_secret: npm_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: release-canary-npm-packages when: repo: @@ -1261,7 +1249,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -1282,7 +1270,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -1297,7 +1285,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests trigger: branch: main @@ -1334,7 +1322,7 @@ steps: name: identify-runner - commands: - $$ProgressPreference = "SilentlyContinue" - - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/windows/grabpl.exe + - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/windows/grabpl.exe -OutFile grabpl.exe image: grafana/ci-wix:0.1.1 name: windows-init @@ -1422,7 +1410,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -1507,7 +1495,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -1515,24 +1503,24 @@ steps: - ./bin/grabpl gen-version ${DRONE_TAG} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl build-backend --jobs 8 --edition oss ${DRONE_TAG} depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition oss ${DRONE_TAG} @@ -1541,7 +1529,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss ${DRONE_TAG} @@ -1550,7 +1538,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition oss --sign --signing-admin @@ -1560,27 +1548,16 @@ steps: environment: GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - ./bin/grabpl package --jobs 8 --edition oss --sign ${DRONE_TAG} depends_on: @@ -1597,14 +1574,14 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ls dist/*.tar.gz* - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition oss --shouldSave @@ -1641,7 +1618,7 @@ steps: environment: ARCH: linux-amd64 PORT: 3001 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -1719,7 +1696,7 @@ steps: - build-frontend-packages environment: NODE_OPTIONS: --max_old_space_size=4096 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-storybook - commands: - ./bin/grabpl upload-cdn --edition oss --src-bucket "$${PRERELEASE_BUCKET}" --src-dir @@ -1813,7 +1790,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -1821,23 +1798,23 @@ steps: - ./bin/grabpl gen-version ${DRONE_TAG} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl shellcheck depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: shellcheck - commands: - |- @@ -1849,7 +1826,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl lint-backend --edition oss @@ -1857,7 +1834,7 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - yarn run prettier:check @@ -1868,19 +1845,19 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - ./bin/grabpl test-backend --edition oss depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - - ./bin/grabpl integration-tests --edition oss + - go test -run Integration -covermode=atomic -timeout=30m ./pkg/... depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration - commands: - yarn run ci:test-frontend @@ -1888,7 +1865,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend trigger: event: @@ -1937,7 +1914,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -1958,7 +1935,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -1973,7 +1950,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests trigger: event: @@ -2014,7 +1991,7 @@ steps: name: identify-runner - commands: - $$ProgressPreference = "SilentlyContinue" - - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/windows/grabpl.exe + - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/windows/grabpl.exe -OutFile grabpl.exe image: grafana/ci-wix:0.1.1 name: windows-init @@ -2073,7 +2050,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -2088,7 +2065,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -2104,32 +2081,32 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - make gen-go depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl gen-version ${DRONE_TAG} depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - ./bin/grabpl build-backend --jobs 8 --edition enterprise ${DRONE_TAG} depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition enterprise ${DRONE_TAG} @@ -2138,7 +2115,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition enterprise ${DRONE_TAG} @@ -2147,7 +2124,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition enterprise --sign --signing-admin @@ -2157,33 +2134,22 @@ steps: environment: GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - ./bin/grabpl build-backend --jobs 8 --edition enterprise2 ${DRONE_TAG} depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend-enterprise2 - commands: - ./bin/grabpl package --jobs 8 --edition enterprise --sign ${DRONE_TAG} @@ -2202,14 +2168,14 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ls dist/*.tar.gz* - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition enterprise --shouldSave @@ -2247,7 +2213,7 @@ steps: ARCH: linux-amd64 PORT: 3001 RUNDIR: scripts/grafana-server/tmp-grafana-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -2368,7 +2334,7 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package-enterprise2 - commands: - ./bin/grabpl upload-cdn --edition enterprise2 --src-bucket "$${PRERELEASE_BUCKET}" @@ -2430,7 +2396,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -2445,7 +2411,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -2461,25 +2427,25 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - make gen-go depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl gen-version ${DRONE_TAG} depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - |- @@ -2491,7 +2457,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl lint-backend --edition enterprise @@ -2499,7 +2465,7 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - yarn run prettier:check @@ -2510,19 +2476,19 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - ./bin/grabpl test-backend --edition enterprise depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - ./bin/grabpl integration-tests --edition enterprise depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration - commands: - yarn run ci:test-frontend @@ -2530,7 +2496,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend - commands: - ./bin/grabpl lint-backend --edition enterprise2 @@ -2538,19 +2504,19 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend-enterprise2 - commands: - ./bin/grabpl test-backend --edition enterprise2 depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-enterprise2 - commands: - ./bin/grabpl integration-tests --edition enterprise2 depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration-enterprise2 trigger: event: @@ -2609,7 +2575,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -2624,7 +2590,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -2640,7 +2606,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - apt-get update @@ -2655,7 +2621,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -2670,7 +2636,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests - commands: - dockerize -wait tcp://redis:6379/0 -timeout 120s @@ -2679,7 +2645,7 @@ steps: - init-enterprise environment: REDIS_URL: redis://redis:6379/0 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: redis-integration-tests - commands: - dockerize -wait tcp://memcached:11211 -timeout 120s @@ -2688,7 +2654,7 @@ steps: - init-enterprise environment: MEMCACHED_HOSTS: memcached:11211 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: memcached-integration-tests trigger: event: @@ -2733,7 +2699,7 @@ steps: name: identify-runner - commands: - $$ProgressPreference = "SilentlyContinue" - - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/windows/grabpl.exe + - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/windows/grabpl.exe -OutFile grabpl.exe - git clone "https://$$env:GITHUB_TOKEN@github.com/grafana/grafana-enterprise.git" - cd grafana-enterprise @@ -2808,7 +2774,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -2886,7 +2852,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -2947,7 +2913,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3026,7 +2992,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3088,7 +3054,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3126,7 +3092,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3164,7 +3130,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3172,7 +3138,7 @@ steps: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl artifacts npm retrieve --tag v${TAG} @@ -3192,7 +3158,7 @@ steps: environment: NPM_TOKEN: from_secret: npm_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: release-npm-packages trigger: event: @@ -3220,7 +3186,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3268,7 +3234,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3317,7 +3283,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3325,24 +3291,24 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl build-backend --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -3351,7 +3317,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} @@ -3360,7 +3326,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition oss --sign --signing-admin @@ -3370,27 +3336,16 @@ steps: environment: GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - ./bin/grabpl package --jobs 8 --edition oss --build-id ${DRONE_BUILD_NUMBER} --sign depends_on: @@ -3407,14 +3362,14 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ls dist/*.tar.gz* - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition oss --shouldSave @@ -3451,7 +3406,7 @@ steps: environment: ARCH: linux-amd64 PORT: 3001 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -3529,7 +3484,7 @@ steps: - build-frontend-packages environment: NODE_OPTIONS: --max_old_space_size=4096 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-storybook - commands: - ./bin/grabpl upload-cdn --edition oss --src-bucket "grafana-static-assets" @@ -3593,7 +3548,7 @@ steps: name: identify-runner - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3601,23 +3556,23 @@ steps: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - make gen-go - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl shellcheck depends_on: - grabpl - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: shellcheck - commands: - |- @@ -3629,7 +3584,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl lint-backend --edition oss @@ -3637,7 +3592,7 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - yarn run prettier:check @@ -3648,19 +3603,19 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - ./bin/grabpl test-backend --edition oss depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - - ./bin/grabpl integration-tests --edition oss + - go test -run Integration -covermode=atomic -timeout=30m ./pkg/... depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration - commands: - yarn run ci:test-frontend @@ -3668,7 +3623,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend trigger: ref: @@ -3711,7 +3666,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3732,7 +3687,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -3747,7 +3702,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests trigger: ref: @@ -3782,7 +3737,7 @@ steps: name: identify-runner - commands: - $$ProgressPreference = "SilentlyContinue" - - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/windows/grabpl.exe + - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/windows/grabpl.exe -OutFile grabpl.exe image: grafana/ci-wix:0.1.1 name: windows-init @@ -3830,7 +3785,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -3845,7 +3800,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -3858,32 +3813,32 @@ steps: depends_on: - clone-enterprise environment: {} - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - make gen-go depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - ./bin/grabpl build-backend --jobs 8 --edition enterprise --build-id ${DRONE_BUILD_NUMBER} depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend - commands: - ./bin/grabpl build-frontend --jobs 8 --edition enterprise --build-id ${DRONE_BUILD_NUMBER} @@ -3892,7 +3847,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend - commands: - ./bin/grabpl build-frontend-packages --jobs 8 --edition enterprise --build-id @@ -3902,7 +3857,7 @@ steps: - yarn-install environment: NODE_OPTIONS: --max_old_space_size=8192 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-frontend-packages - commands: - ./bin/grabpl build-plugins --jobs 8 --edition enterprise --sign --signing-admin @@ -3912,34 +3867,23 @@ steps: environment: GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-plugins - commands: - - ./bin/linux-amd64/grafana-cli cue validate-schema --grafana-root . - depends_on: - - build-backend - image: grafana/build-container:1.5.4 - name: validate-scuemata -- commands: - - '# It is required that the generated Typescript be in sync with the input CUE - files.' - - '# To enforce this, the following command will attempt to generate Typescript - from all' - - '# appropriate .cue files, then compare with the corresponding (*.gen.ts) file - the generated' - - '# code would have been written to. It exits 1 if any diffs are found.' - - ./bin/linux-amd64/grafana-cli cue gen-ts --grafana-root . --diff - depends_on: - - validate-scuemata - image: grafana/build-container:1.5.4 - name: ensure-cuetsified + - '# It is required that code generated from Thema/CUE be committed and in sync + with its inputs.' + - '# The following command will fail if running code generators produces any diff + in output.' + - CODEGEN_VERIFY=1 make gen-cue + image: grafana/build-container:1.5.5 + name: verify-gen-cue - commands: - ./bin/grabpl build-backend --jobs 8 --edition enterprise2 --build-id ${DRONE_BUILD_NUMBER} --variants linux-amd64 depends_on: - gen-version - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-backend-enterprise2 - commands: - ./bin/grabpl package --jobs 8 --edition enterprise --build-id ${DRONE_BUILD_NUMBER} @@ -3959,14 +3903,14 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package - commands: - ls dist/*.tar.gz* - cp dist/*.tar.gz* packaging/docker/ depends_on: - package - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: copy-packages-for-docker - commands: - ./bin/grabpl build-docker --edition enterprise --shouldSave @@ -4004,7 +3948,7 @@ steps: ARCH: linux-amd64 PORT: 3001 RUNDIR: scripts/grafana-server/tmp-grafana-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: grafana-server - commands: - apt-get install -y netcat @@ -4082,7 +4026,7 @@ steps: - build-frontend-packages environment: NODE_OPTIONS: --max_old_space_size=4096 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: build-storybook - commands: - ./bin/grabpl upload-cdn --edition enterprise --src-bucket "grafana-static-assets" @@ -4130,7 +4074,7 @@ steps: from_secret: gpg_pub_key GRAFANA_API_KEY: from_secret: grafana_api_key - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: package-enterprise2 - commands: - ./bin/grabpl upload-cdn --edition enterprise2 --src-bucket "grafana-static-assets" @@ -4185,7 +4129,7 @@ services: [] steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -4200,7 +4144,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -4213,25 +4157,25 @@ steps: depends_on: - clone-enterprise environment: {} - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - make gen-go depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: wire-install - commands: - yarn install --immutable depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: yarn-install - commands: - ./bin/grabpl gen-version --build-id ${DRONE_BUILD_NUMBER} depends_on: - init-enterprise - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: gen-version - commands: - |- @@ -4243,7 +4187,7 @@ steps: wan" > words_to_ignore.txt - codespell -I words_to_ignore.txt docs/ - rm words_to_ignore.txt - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: codespell - commands: - ./bin/grabpl lint-backend --edition enterprise @@ -4251,7 +4195,7 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend - commands: - yarn run prettier:check @@ -4262,19 +4206,19 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-frontend - commands: - ./bin/grabpl test-backend --edition enterprise depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend - commands: - ./bin/grabpl integration-tests --edition enterprise depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration - commands: - yarn run ci:test-frontend @@ -4282,7 +4226,7 @@ steps: - yarn-install environment: TEST_MAX_WORKERS: 50% - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-frontend - commands: - ./bin/grabpl lint-backend --edition enterprise2 @@ -4290,19 +4234,19 @@ steps: - wire-install environment: CGO_ENABLED: "1" - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: lint-backend-enterprise2 - commands: - ./bin/grabpl test-backend --edition enterprise2 depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-enterprise2 - commands: - ./bin/grabpl integration-tests --edition enterprise2 depends_on: - wire-install - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: test-backend-integration-enterprise2 trigger: ref: @@ -4355,7 +4299,7 @@ services: steps: - commands: - mkdir -p bin - - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/grabpl + - curl -fL -o bin/grabpl https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/grabpl - chmod +x bin/grabpl image: byrnedo/alpine-curl:0.1.8 name: grabpl @@ -4370,7 +4314,7 @@ steps: environment: GITHUB_TOKEN: from_secret: github_token - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: clone-enterprise - commands: - mv bin/grabpl /tmp/ @@ -4383,7 +4327,7 @@ steps: depends_on: - clone-enterprise environment: {} - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: init-enterprise - commands: - apt-get update @@ -4398,7 +4342,7 @@ steps: GRAFANA_TEST_DB: postgres PGPASSWORD: grafanatest POSTGRES_HOST: postgres - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: postgres-integration-tests - commands: - apt-get update @@ -4413,7 +4357,7 @@ steps: environment: GRAFANA_TEST_DB: mysql MYSQL_HOST: mysql - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: mysql-integration-tests - commands: - dockerize -wait tcp://redis:6379/0 -timeout 120s @@ -4422,7 +4366,7 @@ steps: - init-enterprise environment: REDIS_URL: redis://redis:6379/0 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: redis-integration-tests - commands: - dockerize -wait tcp://memcached:11211 -timeout 120s @@ -4431,7 +4375,7 @@ steps: - init-enterprise environment: MEMCACHED_HOSTS: memcached:11211 - image: grafana/build-container:1.5.4 + image: grafana/build-container:1.5.5 name: memcached-integration-tests trigger: ref: @@ -4470,7 +4414,7 @@ steps: name: identify-runner - commands: - $$ProgressPreference = "SilentlyContinue" - - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.49/windows/grabpl.exe + - Invoke-WebRequest https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.50/windows/grabpl.exe -OutFile grabpl.exe - git clone "https://$$env:GITHUB_TOKEN@github.com/grafana/grafana-enterprise.git" - cd grafana-enterprise @@ -4667,6 +4611,6 @@ kind: secret name: gcp_upload_artifacts_key --- kind: signature -hmac: a697f4b02af2da0fc6c0d751e40e59db542541d6024e5f0c2b062c7060d635ab +hmac: d2e97d6683c33ccb2dba773e3c103105227a74448fa732124e4c38d67eb464d8 ... diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 847176e9c63..cff5d36ef4d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -112,7 +112,7 @@ pkg/tsdb/testdatasource/sims/ @grafana/grafana-edge-squad /public/app/features/explore/ @grafana/observability-experience-squad /public/app/features/plugins @grafana/plugins-platform-frontend /public/app/features/transformers/spatial @grafana/grafana-edge-squad -/public/app/plugins/panel/alertlist @grafana/alerting-squad +/public/app/plugins/panel/alertlist @grafana/alerting-squad-frontend /public/app/plugins/panel/barchart @grafana/grafana-bi-squad /public/app/plugins/panel/heatmap @grafana/grafana-bi-squad /public/app/plugins/panel/histogram @grafana/grafana-bi-squad diff --git a/.github/renovate.json5 b/.github/renovate.json5 index b3909642552..af4bf894380 100644 --- a/.github/renovate.json5 +++ b/.github/renovate.json5 @@ -29,7 +29,16 @@ "systemjs", "copy-webpack-plugin", // try to upgrade with newer yarn release. Not working with 3.1.1 "ts-loader", // we should remove ts-loader and use babel-loader instead - "ora" // we should bump this once we move to esm modules + "ora", // we should bump this once we move to esm modules + + // dep updates blocked by React 18 + "@testing-library/react", + "@types/react", + "@types/react-dom", + "@types/react-test-renderer", + "react", + "react-dom", + "react-test-renderer" ], "ignorePaths": ["packages/grafana-toolkit/package.json", "emails/**", "plugins-bundled/**", "**/mocks/**"], "labels": ["area/frontend", "dependencies"], diff --git a/.github/workflows/detect-breaking-changes-build.yml b/.github/workflows/detect-breaking-changes-build.yml index acab4a16b2b..dd4049e869e 100644 --- a/.github/workflows/detect-breaking-changes-build.yml +++ b/.github/workflows/detect-breaking-changes-build.yml @@ -38,7 +38,7 @@ jobs: run: zip -r ./pr_built_packages.zip ./packages/**/dist - name: Upload build output as artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: buildPr path: './pr/pr_built_packages.zip' @@ -79,7 +79,7 @@ jobs: run: zip -r ./base_built_packages.zip ./packages/**/dist - name: Upload build output as artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: buildBase path: './base/base_built_packages.zip' @@ -131,7 +131,7 @@ jobs: echo "{ \"exit_code\": ${{ steps.breaking-changes.outputs.is_breaking }}, \"message\": \"${{ steps.breaking-changes.outputs.message }}\", \"job_link\": \"${{ steps.job.outputs.link }}#step:${GITHUB_STEP_NUMBER}:1\", \"pr_number\": \"${{ github.event.pull_request.number }}\" }" > ./levitate/result.json - name: Upload check output as artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: levitate path: levitate/ diff --git a/.gitignore b/.gitignore index affabc71b2a..708681a5b34 100644 --- a/.gitignore +++ b/.gitignore @@ -158,6 +158,7 @@ compilation-stats.json # auto generated Go files *_gen.go !pkg/services/featuremgmt/toggles_gen.go +!pkg/coremodel/**/*_gen.go # Auto-generated localisation files public/locales/_build/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 9eb26796bda..f9d33bd3995 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,255 @@ + + +# 9.0.0-beta3 (2022-06-06) + +### Features and enhancements + +- **Alerting:** Add provenance guard to config api. [#50147](https://github.com/grafana/grafana/pull/50147), [@JohnnyQQQQ](https://github.com/JohnnyQQQQ) +- **Alerting:** Make folder filter clearable in Alert list panel. [#50093](https://github.com/grafana/grafana/pull/50093), [@peterholmberg](https://github.com/peterholmberg) +- **Alerting:** Provisioning API - Alert rules. [#47930](https://github.com/grafana/grafana/pull/47930), [@JohnnyQQQQ](https://github.com/JohnnyQQQQ) +- **Alerting:** Remove Image Upload code from Slack notifier. [#50062](https://github.com/grafana/grafana/pull/50062), [@joeblubaugh](https://github.com/joeblubaugh) +- **Alerting:** Remove double quotes from matchers. [#50038](https://github.com/grafana/grafana/pull/50038), [@gotjosh](https://github.com/gotjosh) +- **Cloudwatch:** Dynamic labels autocomplete. [#49794](https://github.com/grafana/grafana/pull/49794), [@sunker](https://github.com/sunker) +- **Datasource:** Remove deprecated max_idle_connections_per_host setting. [#49948](https://github.com/grafana/grafana/pull/49948), [@marefr](https://github.com/marefr) +- **Datasource:** Remove support for unencrypted passwords. [#49987](https://github.com/grafana/grafana/pull/49987), [@marefr](https://github.com/marefr) +- **Dependencies:** Update to Golang version `1.17.11`. [#50253](https://github.com/grafana/grafana/pull/50253), [@dsotirakis](https://github.com/dsotirakis) +- **Loki:** Run query when pressing Enter on line-filters. [#49913](https://github.com/grafana/grafana/pull/49913), [@svennergr](https://github.com/svennergr) +- **Metrics:** Remove support for using summaries instead of histogram for HTTP instrumentation. [#49985](https://github.com/grafana/grafana/pull/49985), [@bergquist](https://github.com/bergquist) +- **Plugins:** Remove deprecated /api/tsdb/query metrics endpoint. [#49916](https://github.com/grafana/grafana/pull/49916), [@wbrowne](https://github.com/wbrowne) +- **Plugins:** Support headers field for check health. [#49930](https://github.com/grafana/grafana/pull/49930), [@marefr](https://github.com/marefr) +- **Prometheus/Loki:** Add raw query and syntax highlight in explain mode. [#50070](https://github.com/grafana/grafana/pull/50070), [@aocenas](https://github.com/aocenas) +- **Prometheus:** Migrate metadata queries to use resource calls. [#49921](https://github.com/grafana/grafana/pull/49921), [@srclosson](https://github.com/srclosson) +- **RBAC:** Make RBAC action names more consistent. [#49730](https://github.com/grafana/grafana/pull/49730), [@IevaVasiljeva](https://github.com/IevaVasiljeva) +- **RBAC:** Make RBAC action names more consistent. (Enterprise) +- **Settings:** Sunset non-duration based login lifetime config. [#49944](https://github.com/grafana/grafana/pull/49944), [@sakjur](https://github.com/sakjur) +- **[9.0.x] Alerting:** Update alert rule diff to not see difference between nil and empty map. [#50198](https://github.com/grafana/grafana/pull/50198), [@yuri-tceretian](https://github.com/yuri-tceretian) + +### Bug fixes + +- **Alerting:** Fix alert list panel showing firing alerts with no instances. [#50069](https://github.com/grafana/grafana/pull/50069), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Fix notification policy "Override grouping" form save. [#50031](https://github.com/grafana/grafana/pull/50031), [@JacobsonMT](https://github.com/JacobsonMT) +- **Alerting:** Remove double quotes from matchers. [#50046](https://github.com/grafana/grafana/pull/50046), [@alexweav](https://github.com/alexweav) +- **Alerting:** Use correct permission scope for external AM updates. [#50159](https://github.com/grafana/grafana/pull/50159), [@gillesdemey](https://github.com/gillesdemey) +- **Datasource:** Fix allowed cookies to be forwarded as header to backend datasources. [#49541](https://github.com/grafana/grafana/pull/49541), [@marefr](https://github.com/marefr) +- **Licensing:** Fix trial expiration warning. (Enterprise) +- **Loki:** Fix uncaught errors if `labelKey` contains special characters. [#49887](https://github.com/grafana/grafana/pull/49887), [@svennergr](https://github.com/svennergr) +- **Prometheus:** Fix aligning of labels of exemplars after backend migration. [#49924](https://github.com/grafana/grafana/pull/49924), [@aocenas](https://github.com/aocenas) +- **SharePDF:** Fix repeated datasource variables in PDF. (Enterprise) +- **State Timeline:** Fix Null Value Filling and Value Transformation. [#50054](https://github.com/grafana/grafana/pull/50054), [@codeincarnate](https://github.com/codeincarnate) +- **Usage stats:** Divide collection into multiple functions to isolate failures. [#49928](https://github.com/grafana/grafana/pull/49928), [@sakjur](https://github.com/sakjur) + +### Breaking changes + +Removes support for storing/using datasource `password` and `basicAuthPassword` unencrypted which was [deprecated in Grafana v8.1.0](https://grafana.com/docs/grafana/latest/installation/upgrading/#use-of-unencrypted-passwords-for-data-sources-no-longer-supported). Please use `secureJsonData.password` and `secureJsonData.basicAuthPassword`. Issue [#49987](https://github.com/grafana/grafana/issues/49987) + +Removes the option to instrument HTTP request in Grafana using summaries instead of histograms. Issue [#49985](https://github.com/grafana/grafana/issues/49985) + +Removes support for deprecated dataproxy.max_idle_connections_per_host setting. Please use max_idle_connections instead. Issue [#49948](https://github.com/grafana/grafana/issues/49948) + +Removes the deprecated `getFormStyles` function from grafana-ui. +Prefer using `GrafanaTheme2` and the `useStyles2` hook. Issue [#49945](https://github.com/grafana/grafana/issues/49945) + +The configuration options `auth.login_maximum_inactive_lifetime_days` and `auth.login_maximum_lifetime_days` were deprecated in Grafana v7.2.0 and have now been removed. Use `login_maximum_inactive_lifetime_duration` and `login_maximum_lifetime_duration` to customize the maximum lifetime of a login session. Issue [#49944](https://github.com/grafana/grafana/issues/49944) + +Removed the deprecated `isFocused` and `isInvalid` props from the `InlineLabel` component. These props haven't done anything for a while, so migration is just a matter of removing the props. Issue [#49929](https://github.com/grafana/grafana/issues/49929) + +Removed the deprecated `onColorChange` prop from `ColorPicker`. Moving forward the `onChange` prop should be used. Issue [#49923](https://github.com/grafana/grafana/issues/49923) + +`/api/tsdb/query` API has been removed. Use [/api/ds/query](https://grafana.com/docs/grafana/latest/http_api/data_source/#query-a-data-source) instead. +Issue [#49916](https://github.com/grafana/grafana/issues/49916) + +`onClipboardCopy` and `onClipboardError` APIs have been changed such that the callback's argument is just the text that's been copied rather than the old `ClipboardEvent` interface. +Migration should just be a matter of going from + +```tsx + { + console.log(`Text "${e.text}" was copied!`); + }} +/> +``` + +to + +````tsx + { + console.log(`Text "${copiedText}" was copied!`); + }} +/> +``` Issue [#49847](https://github.com/grafana/grafana/issues/49847) + + +The following RBAC action renames have been carried out: + +* `users.authtoken:update` -> `users.authtoken:write`; +* `users.password:update` -> `users.password:write`; +* `users.permissions:update` -> `users.permissions:write`; +* `users.quotas:update` -> `users.quotas:write`; +* `org.users.role:update` -> `org.users:write`; +* `alert.instances:update` -> `alert.instances:write`; +* `alert.rules:update` -> `alert.rules:write`; +* `users.authtoken:list` -> `users.authtoken:read`; +* `users.quotas:list` -> `users.quotas:read`; +* `users.teams:read` -> replaced by `users.read` + `teams:read` + +We've added a migration from the old action names to the new names and have updated our documentation. But you will have to update any scripts and provisioning files that are using the old action names. Issue [#49730](https://github.com/grafana/grafana/issues/49730) + + +The following RBAC action renames have been carried out: + +* `reports.admin:write` -> `reports:write`; +* `reports.admin:create` -> `reports:create`; +* `licensing:update` -> `licensing:write`; +* `roles:list` -> `roles:read`; +* `teams.roles:list` -> `teams.roles:read`; +* `users.roles:list` -> `users.roles:read`; +* `users.permissions:list` -> `users.permissions:read` + +We've added a migration from the old action names to the new names and have updated our documentation. But you will have to update any scripts and provisioning files that are using the old action names. Issue [#3372](https://github.com/grafana/grafana/issues/3372) + +### Plugin development fixes & changes + +- **UI:** Remove deprecated getFormStyles function. [#49945](https://github.com/grafana/grafana/pull/49945), [@kaydelaney](https://github.com/kaydelaney) +- **InlineLabel:** Remove deprecated props. [#49929](https://github.com/grafana/grafana/pull/49929), [@kaydelaney](https://github.com/kaydelaney) +- **ColorPicker:** Remove deprecated onColorChange prop. [#49923](https://github.com/grafana/grafana/pull/49923), [@kaydelaney](https://github.com/kaydelaney) +- **ClipboardButton:** Simplify callbacks. [#49847](https://github.com/grafana/grafana/pull/49847), [@kaydelaney](https://github.com/kaydelaney) + + + + +# 9.0.0-beta2 (2022-05-31) + +### Features and enhancements + +- **Alerting:** Add legacy indicator to navbar. [#49511](https://github.com/grafana/grafana/pull/49511), [@peterholmberg](https://github.com/peterholmberg) +- **Alerting:** Add templated subject config to email notifier. [#49742](https://github.com/grafana/grafana/pull/49742), [@JacobsonMT](https://github.com/JacobsonMT) +- **Alerting:** Enable Unified Alerting for open source and enterprise. [#49834](https://github.com/grafana/grafana/pull/49834), [@grobinson-grafana](https://github.com/grobinson-grafana) +- **Alerting:** Make alertmanager datasource stable. [#49485](https://github.com/grafana/grafana/pull/49485), [@gillesdemey](https://github.com/gillesdemey) +- **Angular:** Remove deprecated angular modal support and libs. [#49781](https://github.com/grafana/grafana/pull/49781), [@torkelo](https://github.com/torkelo) +- **AuthProxy:** Remove deprecated ldap_sync_ttl setting. [#49902](https://github.com/grafana/grafana/pull/49902), [@kalleep](https://github.com/kalleep) +- **Build:** Enable long term caching for frontend assets. [#47625](https://github.com/grafana/grafana/pull/47625), [@jackw](https://github.com/jackw) +- **Chore:** Remove deprecated TextDisplayOptions export. [#49705](https://github.com/grafana/grafana/pull/49705), [@kaydelaney](https://github.com/kaydelaney) +- **Chore:** Remove deprecated `surface` prop from IconButton. [#49715](https://github.com/grafana/grafana/pull/49715), [@kaydelaney](https://github.com/kaydelaney) +- **Chore:** Remove usage of deprecated getColorForTheme function. [#49519](https://github.com/grafana/grafana/pull/49519), [@kaydelaney](https://github.com/kaydelaney) +- **DatePicker:** Add minDate prop. [#49503](https://github.com/grafana/grafana/pull/49503), [@alexanderzobnin](https://github.com/alexanderzobnin) +- **Notification history:** Enable by default. [#49502](https://github.com/grafana/grafana/pull/49502), [@ashharrison90](https://github.com/ashharrison90) +- **Prometheus:** Add pluginVersion to query. [#49414](https://github.com/grafana/grafana/pull/49414), [@toddtreece](https://github.com/toddtreece) +- **Prometheus:** Enable prometheusStreamingJSONParser by default. [#49475](https://github.com/grafana/grafana/pull/49475), [@toddtreece](https://github.com/toddtreece) +- **Prometheus:** Predefined scopes for Azure authentication. [#49557](https://github.com/grafana/grafana/pull/49557), [@kostrse](https://github.com/kostrse) +- **Prometheus:** Streaming JSON parser performance improvements. [#48792](https://github.com/grafana/grafana/pull/48792), [@toddtreece](https://github.com/toddtreece) +- **ValueMapping:** Add support for regex replacement over multiple lines. [#49607](https://github.com/grafana/grafana/pull/49607), [@ashharrison90](https://github.com/ashharrison90) + +### Bug fixes + +- **Accessibility:** Pressing escape in a Modal or DashboardSettings correctly closes the overlay. [#49500](https://github.com/grafana/grafana/pull/49500), [@ashharrison90](https://github.com/ashharrison90) +- **Alerting:** Validate alert notification UID length. [#45546](https://github.com/grafana/grafana/pull/45546), [@wbrowne](https://github.com/wbrowne) +- **BackendSrv:** Throw an error when fetching an invalid JSON. [#47493](https://github.com/grafana/grafana/pull/47493), [@leventebalogh](https://github.com/leventebalogh) +- **Fix:** Timeseries migration regex override. [#49629](https://github.com/grafana/grafana/pull/49629), [@zoltanbedi](https://github.com/zoltanbedi) +- **Loki:** Fix unwrap parsing in query builder. [#49732](https://github.com/grafana/grafana/pull/49732), [@ivanahuckova](https://github.com/ivanahuckova) +- **Navigation:** Position hamburger menu correctly in mobile view. [#49603](https://github.com/grafana/grafana/pull/49603), [@ashharrison90](https://github.com/ashharrison90) +- **PanelEditor:** Fixes issue with Table view and multi data frames. [#49854](https://github.com/grafana/grafana/pull/49854), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) +- **Preferences:** Fix updating of preferences for Navbar and Query History. [#49677](https://github.com/grafana/grafana/pull/49677), [@ivanahuckova](https://github.com/ivanahuckova) +- **TimeRange:** Fixes issue when zooming out on a timerange with timespan 0. [#49622](https://github.com/grafana/grafana/pull/49622), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) +- **Variables:** Fixes DS variables not being correctly used in panel queries. [#49323](https://github.com/grafana/grafana/pull/49323), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) + +### Breaking changes + +Drop support for deprecated setting ldap_sync_ttl under [auth.proxy] +Only sync_ttl will work from now on Issue [#49902](https://github.com/grafana/grafana/issues/49902) + +Removes support for deprecated `heading` and `description` props. Moving forward, the `Card.Heading` and `Card.Description` components should be used. Issue [#49885](https://github.com/grafana/grafana/issues/49885) + +Removes the deprecated `link` variant from the `Button` component. +To migrate, replace any usage of `variant="link"` with `fill="text"`. Issue [#49843](https://github.com/grafana/grafana/issues/49843) + +Removes the deprecated `surface` prop from the `IconButton` component. This prop hasn't actually done anything for a while, so it should be safe to just remove any instances of its usage. +Issue [#49715](https://github.com/grafana/grafana/issues/49715) + +Removes the deprecated `TextDisplayOptions` export from `@grafana/data` in favor of `VizTextDisplayOptions` from `@grafana/schema`. To migrate, just replace usage of `TextDisplayOptions` with `VizTextDisplayOptions`. Issue [#49705](https://github.com/grafana/grafana/issues/49705) + +Removed support for the deprecated `getColorForTheme(color: string, theme: GrafanaTheme)` function in favor of the +`theme.visualization.getColorByName(color: string)` method. The output of this method is identical to the removed function, so migration should just be a matter of rewriting calls of `getColorForTheme(myColor, myTheme)` to `myTheme.visualization.getColorByName(myColor)`. +Issue [#49519](https://github.com/grafana/grafana/issues/49519) + +In the Prometheus data source, for consistency and performance reasons, we changed how we represent `NaN` (not a number) values received from Prometheus. In the past versions, we converted these to `null` in the frontend (for dashboard and explore), and kept as `NaN` in the alerting path. Starting with this version, we will always keep it as `NaN`. This change should be mostly invisible for the users. Issue [#49475](https://github.com/grafana/grafana/issues/49475) + +Plugins using custom Webpack configs could potentially break due to the changes between webpack@4 and webpack@5. Please refer to the [official migration guide](https://webpack.js.org/migrate/5/) for assistance. + +Webpack 5 does not include polyfills for node.js core modules by default (e.g. `buffer`, `stream`, `os`). This can result in failed builds for plugins. If polyfills are required it is recommended to create a custom webpack config in the root of the plugin repo and add the required fallbacks: + +```js +// webpack.config.js + +module.exports.getWebpackConfig = (config, options) => ({ + ...config, + resolve: { + ...config.resolve, + fallback: { + os: require.resolve('os-browserify/browser'), + stream: require.resolve('stream-browserify'), + timers: require.resolve('timers-browserify'), + }, + }, +}); +```` + +Please refer to the webpack build error messages or the [official migration guide](https://webpack.js.org/migrate/5/) for assistance with fallbacks. + +**Which issue(s) this PR fixes**: + + + +Fixes # + +**Special notes for your reviewer**: + +It does not bump the following dependencies to the very latest due to the latest versions being ES modules: + +- ora +- globby +- execa +- chalk + Issue [#47826](https://github.com/grafana/grafana/issues/47826) + +We have changed the internals of `backendSrv.fetch()` to throw an error when the response is an incorrect JSON. + +```javascript +// PREVIOUSLY: this was returning with an empty object {} - in case the response is an invalid JSON +return await getBackendSrv().post(`${API_ROOT}/${id}/install`); + +// AFTER THIS CHANGE: the following will throw an error - in case the response is an invalid JSON +return await getBackendSrv().post(`${API_ROOT}/${id}/install`); +``` + +**When is the response handled as JSON?** + +- If the response has the `"Content-Type: application/json"` header, OR +- If the backendSrv options ([`BackendSrvRequest`](https://github.com/grafana/grafana/blob/e237ff20a996c7313632b2e28f38032012f0e340/packages/grafana-runtime/src/services/backendSrv.ts#L8)) specify the response as JSON: `{ responseType: 'json' }` + +**How does it work after this change?** + +- In case it is recognised as a JSON response and the response is empty, it returns an empty object `{}` +- In case it is recognised as a JSON response and it has formatting errors, it throws an error + +**How to migrate?** +Make sure to handle possible errors on the callsite where using `backendSrv.fetch()` (or any other `backendSrv` methods). Issue [#47493](https://github.com/grafana/grafana/issues/47493) + +### Plugin development fixes & changes + +- **UI/Card:** Remove deprecated props. [#49885](https://github.com/grafana/grafana/pull/49885), [@kaydelaney](https://github.com/kaydelaney) +- **UI/Button:** Remove deprecated "link" variant. [#49843](https://github.com/grafana/grafana/pull/49843), [@kaydelaney](https://github.com/kaydelaney) +- **Toolkit:** Bump dependencies. [#47826](https://github.com/grafana/grafana/pull/47826), [@jackw](https://github.com/jackw) + + # 9.0.0-beta1 (2022-05-24) @@ -30,6 +282,85 @@ In the Loki data source, for consistency and performance reasons, we changed how The dependency to [grafana/aws-sdk](https://github.com/grafana/grafana-aws-sdk-react) is moved from [grafana/ui](https://github.com/grafana/grafana/blob/main/packages/grafana-ui/package.json) to the plugin. This means that any plugin that use SIGV4 auth need to pass a SIGV4 editor component as a prop to the `DataSourceHttpSettings` component. Issue [#43559](https://github.com/grafana/grafana/issues/43559) + + +# 8.5.5 (2022-06-06) + +### Features and enhancements + +- **Azure Monitor:** Include datasource ref when interpolating variables. [#49543](https://github.com/grafana/grafana/pull/49543), [@kevinwcyu](https://github.com/kevinwcyu) +- **CloudWatch:** Add multi-value template variable support for log group names in logs query builder. [#49737](https://github.com/grafana/grafana/pull/49737), [@kevinwcyu](https://github.com/kevinwcyu) +- **Cloudwatch:** Add template variable query function for listing log groups. [#50100](https://github.com/grafana/grafana/pull/50100), [@yaelleC](https://github.com/yaelleC) + +### Bug fixes + +- **Alerting:** Do not overwrite existing alert rule condition. [#49920](https://github.com/grafana/grafana/pull/49920), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Remove double quotes from matchers. [#50044](https://github.com/grafana/grafana/pull/50044), [@alexweav](https://github.com/alexweav) + + + + + +# 8.5.4 (2022-05-30) + +### Features and enhancements + +- **Alerting:** Remove disabled flag for data source when migrating alerts. [#48559](https://github.com/grafana/grafana/pull/48559), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Show notification tab of legacy alerting only to editor. [#49624](https://github.com/grafana/grafana/pull/49624), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Update migration to migrate only alerts that belong to existing org\dashboard. [#49192](https://github.com/grafana/grafana/pull/49192), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **AzureMonitor:** Do not quote variables when a custom "All" variable option is used. [#49428](https://github.com/grafana/grafana/pull/49428), [@andresmgot](https://github.com/andresmgot) +- **AzureMonitor:** Update allowed namespaces. [#48468](https://github.com/grafana/grafana/pull/48468), [@jcolladokuri](https://github.com/jcolladokuri) +- **CloudMonitor:** Correctly encode default project response. [#49510](https://github.com/grafana/grafana/pull/49510), [@aangelisc](https://github.com/aangelisc) +- **Cloudwatch:** Add support for new AWS/RDS EBS\* metrics. [#48798](https://github.com/grafana/grafana/pull/48798), [@szymonpk](https://github.com/szymonpk) +- **InfluxDB:** Use backend for influxDB by default via feature toggle. [#48453](https://github.com/grafana/grafana/pull/48453), [@yesoreyeram](https://github.com/yesoreyeram) +- **Legend:** Use correct unit for percent and count calculations. [#49004](https://github.com/grafana/grafana/pull/49004), [@dprokop](https://github.com/dprokop) +- **LokI:** use millisecond steps in Grafana 8.5.x. [#48630](https://github.com/grafana/grafana/pull/48630), [@gabor](https://github.com/gabor) +- **Plugins:** Introduce HTTP 207 Multi Status response to api/ds/query. [#48550](https://github.com/grafana/grafana/pull/48550), [@wbrowne](https://github.com/wbrowne) +- **Reporting:** Improve PDF file size using grid layout. (Enterprise) +- **Transformations:** Add an All Unique Values Reducer. [#48653](https://github.com/grafana/grafana/pull/48653), [@josiahg](https://github.com/josiahg) +- **Transformers:** avoid error when the ExtractFields source field is missing. [#49368](https://github.com/grafana/grafana/pull/49368), [@wardbekker](https://github.com/wardbekker) +- **[v8.5.x] Alerting:** Update migration to migrate only alerts that belong to existing org\dashboard. [#49199](https://github.com/grafana/grafana/pull/49199), [@grafanabot](https://github.com/grafanabot) +- **[v8.5.x] Reporting:** Improve PDF file size using grid layout. (Enterprise) + +### Bug fixes + +- **Alerting:** Allow disabling override timings for notification policies. [#48648](https://github.com/grafana/grafana/pull/48648), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Allow serving images from custom url path. [#49022](https://github.com/grafana/grafana/pull/49022), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Apply Custom Headers to datasource queries. [#47860](https://github.com/grafana/grafana/pull/47860), [@joeblubaugh](https://github.com/joeblubaugh) +- **Alerting:** Fix RBAC actions for notification policies. [#49185](https://github.com/grafana/grafana/pull/49185), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Fix access to alerts for viewer with editor permissions when RBAC is disabled. [#49270](https://github.com/grafana/grafana/pull/49270), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Fix anonymous access to alerting. [#49203](https://github.com/grafana/grafana/pull/49203), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** correctly show all alerts in a folder. [#48684](https://github.com/grafana/grafana/pull/48684), [@gillesdemey](https://github.com/gillesdemey) +- **AzureMonitor:** Fixes metric definition for Azure Storage queue/file/blob/table resources. [#49101](https://github.com/grafana/grafana/pull/49101), [@aangelisc](https://github.com/aangelisc) +- **Dashboard:** Fix dashboard update permission check. [#48746](https://github.com/grafana/grafana/pull/48746), [@IevaVasiljeva](https://github.com/IevaVasiljeva) +- **DashboardExport:** Fix exporting and importing dashboards where query data source ended up as incorrect. [#48410](https://github.com/grafana/grafana/pull/48410), [@torkelo](https://github.com/torkelo) +- **FileUpload:** clicking the `Upload file` button now opens the modal correctly. [#48766](https://github.com/grafana/grafana/pull/48766), [@ashharrison90](https://github.com/ashharrison90) +- **GrafanaUI:** Fix color of links in error Tooltips in light theme. [#49327](https://github.com/grafana/grafana/pull/49327), [@joshhunt](https://github.com/joshhunt) +- **LibraryPanels:** Fix library panels not connecting properly in imported dashboards. [#49161](https://github.com/grafana/grafana/pull/49161), [@joshhunt](https://github.com/joshhunt) +- **Loki:** Improve unpack parser handling. [#49074](https://github.com/grafana/grafana/pull/49074), [@gabor](https://github.com/gabor) +- **RolePicker:** Fix menu position on smaller screens. [#48429](https://github.com/grafana/grafana/pull/48429), [@Clarity-89](https://github.com/Clarity-89) +- **TimeRange:** Fixes updating time range from url and browser history. [#48657](https://github.com/grafana/grafana/pull/48657), [@torkelo](https://github.com/torkelo) +- **TimeSeries:** Fix detection & rendering of sparse datapoints. [#48841](https://github.com/grafana/grafana/pull/48841), [@leeoniya](https://github.com/leeoniya) +- **Timeseries:** Fix outside range stale state. [#49633](https://github.com/grafana/grafana/pull/49633), [@ryantxu](https://github.com/ryantxu) +- **Tooltip:** Fix links not legible in Tooltips when using light theme. [#48748](https://github.com/grafana/grafana/pull/48748), [@joshhunt](https://github.com/joshhunt) +- **Tooltip:** Sort decimals using standard numeric compare. [#49084](https://github.com/grafana/grafana/pull/49084), [@dprokop](https://github.com/dprokop) +- **Transforms:** Labels to fields, fix label picker layout. [#49304](https://github.com/grafana/grafana/pull/49304), [@torkelo](https://github.com/torkelo) +- **Variables:** Fixes issue with data source variables not updating queries with variable. [#49478](https://github.com/grafana/grafana/pull/49478), [@torkelo](https://github.com/torkelo) +- **[v8.5.x] Alerting:** Fix RBAC actions for notification policies (#49185). [#49348](https://github.com/grafana/grafana/pull/49348), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **[v8.5.x] Alerting:** Fix access to alerts for viewer with editor permissions when RBAC is disabled. [#49427](https://github.com/grafana/grafana/pull/49427), [@konrad147](https://github.com/konrad147) +- **[v8.5.x] Alerting:** Fix anonymous access to alerting. [#49268](https://github.com/grafana/grafana/pull/49268), [@yuri-tceretian](https://github.com/yuri-tceretian) + +### Breaking changes + +For a data source query made via /api/ds/query : + +- If the `DatasourceQueryMultiStatus` feature is enabled and + - The data source response has an error set as part of the `DataResponse`, the resulting HTTP status code is now `207 Multi Status` instead of `400 Bad gateway` +- If the `DatasourceQueryMultiStatus` feature is **not** enabled and + - The data source response has an error set as part of the `DataResponse`, the resulting HTTP status code is `400 Bad Request` (no breaking change) + --> Issue [#48550](https://github.com/grafana/grafana/issues/48550) + + diff --git a/Dockerfile b/Dockerfile index 455a24b0774..3bee9879f2c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,7 +20,7 @@ COPY emails emails ENV NODE_ENV production RUN yarn build -FROM golang:1.17.9-alpine3.15 as go-builder +FROM golang:1.17.11-alpine3.15 as go-builder RUN apk add --no-cache gcc g++ make diff --git a/Dockerfile.ubuntu b/Dockerfile.ubuntu index f8ee00a412d..fe72f04a8c2 100644 --- a/Dockerfile.ubuntu +++ b/Dockerfile.ubuntu @@ -21,7 +21,7 @@ COPY emails emails ENV NODE_ENV production RUN yarn build -FROM golang:1.17.9 AS go-builder +FROM golang:1.17.11 AS go-builder WORKDIR /src/grafana diff --git a/LICENSING.md b/LICENSING.md index 7506fcdc946..510ff42a32b 100644 --- a/LICENSING.md +++ b/LICENSING.md @@ -17,6 +17,8 @@ packages/grafana-toolkit/ packages/grafana-ui/ packages/jaeger-ui-components/ packaging/ +pkg/coremodel/ +pkg/framework/coremodel/ grafana-mixin/ cue/ ``` diff --git a/Makefile b/Makefile index e4881487e56..b1cc517b409 100644 --- a/Makefile +++ b/Makefile @@ -43,6 +43,7 @@ $(SPEC_TARGET): $(API_DEFINITION_FILES) ## Generate API spec -e SWAGGER_GENERATE_EXTENSION=false \ -v ${HOME}/go:/go \ -v $$(pwd):/grafana \ + -v $$(pwd)/../grafana-enterprise:$$(pwd)/../grafana-enterprise \ -w $$(pwd)/pkg/api/docs quay.io/goswagger/swagger:$(SWAGGER_TAG) \ generate spec -m -o /grafana/public/api-spec.json \ -w /grafana/pkg/server \ @@ -50,7 +51,7 @@ $(SPEC_TARGET): $(API_DEFINITION_FILES) ## Generate API spec -x "github.com/prometheus/alertmanager" \ -i /grafana/pkg/api/docs/tags.json -swagger-api-spec: gen-go $(SPEC_TARGET) $(MERGED_SPEC_TARGET) +swagger-api-spec: gen-go $(SPEC_TARGET) $(MERGED_SPEC_TARGET) validate-api-spec $(NGALERT_SPEC_TARGET): +$(MAKE) -C pkg/services/ngalert/api/tooling api.json @@ -62,12 +63,12 @@ ensure_go-swagger_mac: @hash swagger &>/dev/null || (brew tap go-swagger/go-swagger && brew install go-swagger) --swagger-api-spec-mac: ensure_go-swagger_mac $(API_DEFINITION_FILES) ## Generate API spec (for M1 Mac) - swagger generate spec -m -w pkg/server -o public/api-spec.json \ + SWAGGER_GENERATE_EXTENSION=false swagger generate spec -m -w pkg/server -o public/api-spec.json \ -x "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" \ -x "github.com/prometheus/alertmanager" \ -i pkg/api/docs/tags.json -swagger-api-spec-mac: gen-go --swagger-api-spec-mac $(MERGED_SPEC_TARGET) +swagger-api-spec-mac: gen-go --swagger-api-spec-mac $(MERGED_SPEC_TARGET) validate-api-spec validate-api-spec: $(MERGED_SPEC_TARGET) ## Validate API spec docker run --rm -it \ @@ -83,6 +84,11 @@ clean-api-spec: ##@ Building +gen-cue: ## Do all CUE/Thema code generation + @echo "generate code from .cue files" + go generate ./pkg/framework/coremodel + go generate ./public/app/plugins + gen-go: $(WIRE) @echo "generate go files" $(WIRE) gen -tags $(WIRE_TAGS) ./pkg/server ./pkg/cmd/grafana-cli/runner diff --git a/conf/defaults.ini b/conf/defaults.ini index 3b4edffb543..370bf1ff46f 100644 --- a/conf/defaults.ini +++ b/conf/defaults.ini @@ -477,6 +477,8 @@ token_url = https://gitlab.com/oauth/token api_url = https://gitlab.com/api/v4 allowed_domains = allowed_groups = +role_attribute_path = +role_attribute_strict = false #################################### Google Auth ######################### [auth.google] @@ -582,8 +584,6 @@ enabled = false header_name = X-WEBAUTH-USER header_property = username auto_sign_up = true -# Deprecated, use sync_ttl instead -ldap_sync_ttl = 60 sync_ttl = 60 whitelist = headers = @@ -972,6 +972,7 @@ url = https://grafana.com url = https://grafana.com #################################### Distributed tracing ############ +# Opentracing is deprecated use opentelemetry instead [tracing.jaeger] # jaeger destination (ex localhost:6831) address = diff --git a/conf/provisioning/datasources/sample.yaml b/conf/provisioning/datasources/sample.yaml index 7bef8618a31..2d9bae8ee56 100644 --- a/conf/provisioning/datasources/sample.yaml +++ b/conf/provisioning/datasources/sample.yaml @@ -19,8 +19,6 @@ apiVersion: 1 # orgId: 1 # # url # url: http://localhost:8080 -# # database password, if used -# password: # # database user, if used # user: # # database name, if used @@ -29,8 +27,6 @@ apiVersion: 1 # basicAuth: # # basic auth username # basicAuthUser: -# # basic auth password -# basicAuthPassword: # # enable/disable with credentials headers # withCredentials: # # mark as default datasource. Max one per org diff --git a/conf/sample.ini b/conf/sample.ini index 8d8fd35ae33..b5c2e2eae2f 100644 --- a/conf/sample.ini +++ b/conf/sample.ini @@ -937,6 +937,7 @@ ;url = https://grafana.com #################################### Distributed tracing ############ +# Opentracing is deprecated use opentelemetry instead [tracing.jaeger] # Enable by setting the address sending traces to jaeger (ex localhost:6831) ;address = localhost:6831 diff --git a/contribute/architecture/backend/services.md b/contribute/architecture/backend/services.md index 4a4142089fd..35d23ace041 100644 --- a/contribute/architecture/backend/services.md +++ b/contribute/architecture/backend/services.md @@ -8,7 +8,7 @@ Even though the services in Grafana do different things, they share a number of Before a service can start communicating with the rest of Grafana, it needs to be registered with Wire, see `ProvideService` factory function/method in the service example below and how it's being referenced in the wire.go example below. -When Wire is run it will inspect the parameters of `ProvideService` and make sure that all it's dependencies has been wired up and initialized properly. +When Wire is run, it inspects the parameters of `ProvideService` and makes sure that all its dependencies have been wired up and initialized properly. **Service example:** @@ -107,31 +107,31 @@ func InitializeForTest(cla setting.CommandLineArgs, opts Options, apiOpts api.Se ## Background services -A background service is a service that runs in the background of the lifecycle between Grafana starts up and shutdown. If you want a service to be run in the background your Service should satisfy the `registry.BackgroundService` interface and add it as argument to the [ProvideBackgroundServiceRegistry](/pkg/server/backgroundsvcs/background_services.go) function and add it as argument to `NewBackgroundServiceRegistry` to register it as a background service. +A background service runs in the background of the lifecycle between Grafana startup and shutdown. To run your service in the background, it must satisfy the `registry.BackgroundService` interface. Pass it through to the `NewBackgroundServiceRegistry` call in the [ProvideBackgroundServiceRegistry](/pkg/server/backgroundsvcs/background_services.go) function to register it. You can see an example implementation above of the Run method. ## Disabled services -If you want to guarantee that a background service is not run by Grafana when certain criteria is met/service is disabled your service should satisfy the `registry.CanBeDisabled` interface. When the service.IsDisabled method return false Grafana would not call the service.Run method. +If you want to guarantee that a background service is not run by Grafana when certain criteria are met/service is disabled, your service must satisfy the `registry.CanBeDisabled` interface. When the `service.IsDisabled` method returns true, Grafana will not call the `service.Run` method. -If you want to run certain initialization code if service is disabled or not, you need to handle this in the service factory method. +If you want to run certain initialization code whether service is disabled or not, you need to handle this in the service factory method. -You can see an example implementation above of the IsDisabled method and custom initialization code when service is disabled. +You can see an example implementation above of the `IsDisabled` method and custom initialization code when the service is disabled. ## Run Wire / generate code -When running `make run` it will call `make gen-go` on the first run. `gen-go` in turn will call the wire binary and generate the code in [wire_gen.go](/pkg/server/wire_gen.go) and [wire_gen.go](/pkg/cmd/grafana-cli/runner/wire_gen.go). The wire binary is installed using [bingo](https://github.com/bwplotka/bingo) which will make sure to download and install all the tools needed, including the Wire binary at using a specific version. +Running `make run` calls `make gen-go` on the first run. `gen-go` in turn calls the wire binary and generates the code in [wire_gen.go](/pkg/server/wire_gen.go) and [wire_gen.go](/pkg/cmd/grafana-cli/runner/wire_gen.go). The wire binary is installed using [bingo](https://github.com/bwplotka/bingo) which downloads and installs all the tools needed, including the Wire binary at the specified version. ## OSS vs Enterprise -Grafana OSS and Grafana Enterprise shares code and dependencies. Grafana Enterprise might need to override/extend certain OSS services. +Grafana OSS and Grafana Enterprise share code and dependencies. Grafana Enterprise overrides or extends certain OSS services. There's a [wireexts_oss.go](/pkg/server/wireexts_oss.go) that has the `wireinject` and `oss` build tags as requirements. Here services that might have other implementations, e.g. Grafana Enterprise, can be registered. Similarly, there's a wireexts_enterprise.go file in the Enterprise source code repository where other service implementations can be overridden/be registered. -To extend oss background service create a specific background interface for that type and inject that type to [ProvideBackgroundServiceRegistry](/pkg/server/backgroundsvcs/background_services.go) instead of the concrete type. Then add a wire binding for that interface in [wireexts_oss.go](/pkg/server/wireexts_oss.go) and in the enterprise wireexts file. +To extend an OSS background service, create a specific background interface for that type and inject that type to [ProvideBackgroundServiceRegistry](/pkg/server/backgroundsvcs/background_services.go) instead of the concrete type. Then add a wire binding for that interface in [wireexts_oss.go](/pkg/server/wireexts_oss.go) and in the enterprise wireexts file. ## Methods diff --git a/contribute/architecture/frontend-data-requests.md b/contribute/architecture/frontend-data-requests.md index f14f22c4749..81e611fae5f 100644 --- a/contribute/architecture/frontend-data-requests.md +++ b/contribute/architecture/frontend-data-requests.md @@ -10,7 +10,7 @@ A data request can take a long time to finish. During the time between when a re If we wait for canceled requests to complete, it might create unnecessary load on data sources. -Grafana uses a concept called _request cancelation_ to cancel any ongoing request that Grafana doesn't need. +Grafana uses a concept called _request cancellation_ to cancel any ongoing request that Grafana doesn't need. #### Before Grafana 7.2 @@ -29,11 +29,9 @@ Migrating the core data sources to the new `fetch` function [is an ongoing proce ## Request queue -Depending on how the web browser implements the protocol for HTTP 1.1, it will limit the number of parallel requests, lets call this limit _max_parallel_browser_request_. +If Grafana isn't configured to support HTTP/2, browsers connecting with HTTP 1.1 enforce a limit of 4 - 8 parallel requests (the specific limit varies). Because of this limit, if some requests take a long time, they will block later requests and make interacting with Grafana very slow. -Unless you have configured Grafana to use HTTP2, the browser limits parallel data requests according to the browser's implementation. For more information on how to enable HTTP2, refer to [Configuration](https://grafana.com/docs/grafana/latest/administration/configuration/#protocol). - -Because there is a _max_parallel_browser_request_ limit, if some of the requests take a long time, they will block later requests and make interacting with Grafana very slow. +[Enabling HTTP/2 support in Grafana](https://grafana.com/docs/grafana/latest/administration/configuration/#protocol) allows far more parallel requests. #### Before Grafana 7.2 @@ -45,4 +43,4 @@ Grafana uses a _request queue_ to process all incoming data requests in order wh Since the first implementation of the request queue doesn't take into account what browser the user uses, the _request queue_ limit for parallel data source requests is hard-coded to 5. -> **Note:** Grafana instances [configured with HTTP2 ](https://grafana.com/docs/grafana/latest/administration/configuration/#protocol) will have a hard coded limit of 1000. +> **Note:** Grafana instances [configured with HTTP2](https://grafana.com/docs/grafana/latest/administration/configuration/#protocol) will have a hard coded limit of 1000. diff --git a/contribute/create-pull-request.md b/contribute/create-pull-request.md index 34b2c2f0793..b2041e44455 100644 --- a/contribute/create-pull-request.md +++ b/contribute/create-pull-request.md @@ -117,11 +117,14 @@ If you're unsure, see the existing [changelog](https://github.com/grafana/grafan ### Pull request titles +The pull request title should be formatted according to `: ` (Both "Area" and "Summary" should start with a capital letter). + The Grafana team _squashes_ all commits into one when we accept a pull request. The title of the pull request becomes the subject line of the squashed commit message. We still encourage contributors to write informative commit messages, as they becomes a part of the Git commit body. We use the pull request title when we generate change logs for releases. As such, we strive to make the title as informative as possible. -Make sure that the title for your pull request uses the same format as the subject line in the commit message. +**Example:** +`Docs: Change url to URL in all documentation files` ## Configuration changes diff --git a/contribute/developer-guide.md b/contribute/developer-guide.md index 9eb31be1f00..35a91894bf3 100644 --- a/contribute/developer-guide.md +++ b/contribute/developer-guide.md @@ -2,8 +2,6 @@ This guide helps you get started developing Grafana. -Before you begin, you might want to read [How to contribute to Grafana as a junior dev](https://medium.com/@ivanahuckova/how-to-contribute-to-grafana-as-junior-dev-c01fe3064502) by [Ivana Huckova](https://medium.com/@ivanahuckova). - ## Dependencies Make sure you have the following dependencies installed before setting up your developer environment: @@ -59,6 +57,8 @@ Before we can build the frontend assets, we need to install the dependencies: yarn install --immutable ``` +> Troubleshooting: if you get the error `The remote archive doesn't match the expected checksum` for a dependency pulled from a link (e.g. `"tether-drop": "https://github.com/torkelo/drop"`): this is a temporary mismatch. To work around it (while someone corrects the issue), you can prefix your `yarn install --immutable` command with [`YARN_CHECKSUM_BEHAVIOR=update`](https://yarnpkg.com/advanced/error-codes#yn0018---cache_checksum_mismatch) + After the command has finished, we can start building our source code: ``` @@ -67,7 +67,9 @@ yarn start Once `yarn start` has built the assets, it will continue to do so whenever any of the files change. This means you don't have to manually build the assets every time you change the code. -Next, we'll build the web server that will serve the frontend assets we just built. +> Troubleshooting: if your first build works, but after pulling updates you see unexpected errors in the "Type-checking in progress..." stage, these can be caused by the [tsbuildinfo cache supporting incremental builds](https://www.typescriptlang.org/tsconfig#incremental). You can `rm tsconfig.tsbuildinfo` and re-try. + +Next, we'll build & run the web server that will serve the frontend assets we just built. ### Backend @@ -95,7 +97,7 @@ You can build the back-end as follows: 2. Generate code using Wire: ``` -# Normally Wire tool installed at $GOPATH/bin/wire.exe +# Default Wire tool install path: $GOPATH/bin/wire.exe gen -tags oss ./pkg/server ./pkg/cmd/grafana-cli/runner ``` @@ -136,17 +138,23 @@ Running the backend tests on Windows currently needs some tweaking, so use the b go run build.go test ``` -### Run PostgreSQL and MySQL integration tests +### Run SQLLite, PostgreSQL and MySQL integration tests + +By default grafana runs SQLite, to run test with SQLite + +```bash +go test -covermode=atomic -tags=integration ./pkg/... +``` To run PostgreSQL and MySQL integration tests locally, you need to start the docker blocks for MySQL and/or PostgreSQL test data sources by running `make devenv sources=mysql_tests,postgres_tests`. When your test data sources are running, you can execute integration tests by running: -``` +```bash GRAFANA_TEST_DB=mysql go test -covermode=atomic -tags=integration ./pkg/... ``` and/or -``` +```bash GRAFANA_TEST_DB=postgres go test -covermode=atomic -tags=integration ./pkg/... ``` @@ -160,19 +168,19 @@ To run the tests: yarn e2e ``` -By default, the end-to-end tests starts a Grafana instance listening on `localhost:3001`. To use a specific URL, set the `BASE_URL` environment variable: +By default, the end-to-end tests start a Grafana instance listening on `localhost:3001`. To use a different URL, set the `BASE_URL` environment variable: ``` BASE_URL=http://localhost:3333 yarn e2e ``` -To follow the tests in the browser while they're running, use the `yarn e2e:debug`. +To follow all tests in the browser while they're running, use `yarn e2e:debug` ``` yarn e2e:debug ``` -If you want to pick a test first, use the `yarn e2e:dev`, to pick a test and follow the test in the browser while it runs. +To choose a single test to follow in the browser as it runs, use `yarn e2e:dev` ``` yarn e2e:dev @@ -192,7 +200,7 @@ app_mode = development ### Add data sources -By now, you should be able to build and test a change you've made to the Grafana source code. In most cases, you need to add at least one data source to verify the change. +By now, you should be able to build and test a change you've made to the Grafana source code. In most cases, you'll need to add at least one data source to verify the change. To set up data sources for your development environment, go to the [devenv](/devenv) directory in the Grafana repository: @@ -281,5 +289,4 @@ If that happens to you, chances are you've already set a lower limit and your sh - Read our [style guides](/contribute/style-guides). - Learn how to [Create a pull request](/contribute/create-pull-request.md). -- Read [How to contribute to Grafana as a junior dev](https://medium.com/@ivanahuckova/how-to-contribute-to-grafana-as-junior-dev-c01fe3064502) by [Ivana Huckova](https://medium.com/@ivanahuckova). - Read about the [architecture](architecture). diff --git a/contribute/merge-pull-request.md b/contribute/merge-pull-request.md index b6e403ad597..365f77d3661 100644 --- a/contribute/merge-pull-request.md +++ b/contribute/merge-pull-request.md @@ -27,10 +27,15 @@ Before you can merge a pull request, it must have a review approval, and all the ### Format the pull request title -The pull request title should be formatted according to `: `. Keep the summary short and understandable for the community as a whole. +The pull request title should be formatted according to `: ` (Both "Area" and "Summary" should start with a capital letter). + +Keep the summary short and understandable for the community as a whole. All commits in a pull request are squashed when merged and the pull request title will be the default subject line of the squashed commit message. It's also used for [changelog/release notes](#include-in-changelog-and-release-notes). +**Example:** +`Docs: Change url to URL in all documentation files` + See [formatting guidelines](create-pull-request.md#formatting-guidelines) for more information. ### Assign a milestone diff --git a/cue/scuemata/panel-plugin.cue b/cue/scuemata/panel-plugin.cue deleted file mode 100644 index acd02e8a3d5..00000000000 --- a/cue/scuemata/panel-plugin.cue +++ /dev/null @@ -1,27 +0,0 @@ -package scuemata - -// Definition of the shape of a panel plugin's schema declarations in its -// schema.cue file. -// -// Note that these keys do not appear directly in any real JSON artifact; -// rather, they are composed into panel structures as they are defined within -// the larger Dashboard schema. -#PanelSchema: { - // Defines plugin specific options for a panel - PanelOptions: {...} @cuetsy(kind="interface") - - // Define the custom properties that exist within standard field config - PanelFieldConfig?: {...} @cuetsy(kind="interface") - - // Panels may define their own types - ... -} - -// A lineage of panel schema -#PanelLineage: [#PanelSchema, ...#PanelSchema] - -// Panel plugin-specific Family -#PanelFamily: { - lineages: [#PanelLineage, ...#PanelLineage] - migrations: [...#Migration] -} diff --git a/cue/scuemata/scuemata.cue b/cue/scuemata/scuemata.cue deleted file mode 100644 index cccf607bc30..00000000000 --- a/cue/scuemata/scuemata.cue +++ /dev/null @@ -1,61 +0,0 @@ -package scuemata - -// A family is a collection of schemas that specify a single kind of object, -// allowing evolution of the canonical schema for that kind of object over time. -// -// The schemas are organized into a list of Lineages, which are themselves ordered -// lists of schemas where each schema with its predecessor in the lineage. -// -// If it is desired to define a schema with a breaking schema relative to its -// predecessors, a new Lineage must be created, as well as a Migration that defines -// a mapping to the new schema from the latest schema in prior Lineage. -// -// The version number of a schema is not controlled by the schema itself, but by -// its position in the list of lineages - e.g., 0.0 corresponds to the first -// schema in the first lineage. -#Family: { - compose?: {...} - lineages: [#Lineage, ...#Lineage] - migrations: [...#Migration] - let lseq = lineages[len(lineages)-1] - latest: #LastSchema & {_p: lseq} -} - -// A Lineage is a non-empty list containing an ordered series of schemas that -// all describe a single kind of object, where each schema is backwards -// compatible with its predecessor. -#Lineage: [{...}, ...{...}] - -#LastSchema: { - _p: #Lineage - _p[len(_p)-1] -} - -// A Migration defines a relation between two schemas, "_from" and "_to". The -// relation expresses any complex mappings that must be performed to -// transform an input artifact valid with respect to the _from schema, into -// an artifact valid with respect to the _to schema. This is accomplished -// in two stages: -// 1. A Migration is initially defined by passing in schemas for _from and _to, -// and mappings that translate _from to _to are defined in _rel. -// 2. A concrete object may then be unified with _to, resulting in its values -// being mapped onto "result" by way of _rel. -// -// This is the absolute simplest possible definition of a Migration. It's -// incumbent on the implementor to manually ensure the correctness and -// completeness of the mapping. The primary value in defining such a generic -// structure is to allow comparably generic logic for migrating concrete -// artifacts through schema changes. -// -// If _to isn't backwards compatible (accretion-only) with _from, then _rel must -// explicitly enumerate every field in _from and map it to a field in _to, even -// if they're identical. This is laborious for anything outside trivially tiny -// schema. We'll want to eventually add helpers for whitelisting or blacklisting -// of paths in _from, so that migrations of larger schema can focus narrowly on -// the points of actual change. -#Migration: { - from: {...} - to: {...} - rel: {...} - result: to & rel -} diff --git a/devenv/dev-dashboards/e2e-repeats/Repeating-a-panel-horizontally.json b/devenv/dev-dashboards/e2e-repeats/Repeating-a-panel-horizontally.json index a1847c7e93a..8922eee5213 100644 --- a/devenv/dev-dashboards/e2e-repeats/Repeating-a-panel-horizontally.json +++ b/devenv/dev-dashboards/e2e-repeats/Repeating-a-panel-horizontally.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -21,7 +24,8 @@ "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, - "iteration": 1640181116069, + "id": 95, + "iteration": 1652465568602, "links": [], "liveNow": false, "panels": [ @@ -102,7 +106,7 @@ "type": "timeseries" } ], - "schemaVersion": 34, + "schemaVersion": 36, "style": "dark", "tags": [], "templating": { @@ -199,6 +203,6 @@ "timezone": "utc", "title": "Repeating a panel horizontally", "uid": "WVpf2jp7z", - "version": 3, + "version": 1, "weekStart": "" } diff --git a/devenv/dev-dashboards/e2e-repeats/Repeating-a-row-with-a-non-repeating-panel-and-horizontal-repeating-panel.json b/devenv/dev-dashboards/e2e-repeats/Repeating-a-row-with-a-non-repeating-panel-and-horizontal-repeating-panel.json index ff27b5edcc6..3a2e6bb18b5 100644 --- a/devenv/dev-dashboards/e2e-repeats/Repeating-a-row-with-a-non-repeating-panel-and-horizontal-repeating-panel.json +++ b/devenv/dev-dashboards/e2e-repeats/Repeating-a-row-with-a-non-repeating-panel-and-horizontal-repeating-panel.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -21,12 +24,17 @@ "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, - "iteration": 1640181157128, + "id": 85, + "iteration": 1652465607869, "links": [], "liveNow": false, "panels": [ { "collapsed": false, + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 1, "w": 24, @@ -192,7 +200,7 @@ "type": "timeseries" } ], - "schemaVersion": 34, + "schemaVersion": 36, "style": "dark", "tags": [], "templating": { @@ -330,6 +338,6 @@ "timezone": "utc", "title": "Repeating a row with a non-repeating panel and horizontal repeating panel", "uid": "k3PEoCpnk", - "version": 3, + "version": 1, "weekStart": "" } diff --git a/devenv/dev-dashboards/home.json b/devenv/dev-dashboards/home.json index c59210f5874..c8a2b649d6a 100644 --- a/devenv/dev-dashboards/home.json +++ b/devenv/dev-dashboards/home.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -19,10 +22,17 @@ ] }, "editable": true, + "fiscalYearStartMonth": 0, "graphTooltip": 0, + "id": 28, "links": [], + "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 26, "w": 6, @@ -40,12 +50,16 @@ "showStarred": true, "tags": [] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [], "title": "Starred", "type": "dashlist" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 13, "w": 6, @@ -65,7 +79,7 @@ "panel-tests" ] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [ "panel-tests" ], @@ -73,6 +87,10 @@ "type": "dashlist" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 13, "w": 6, @@ -93,7 +111,7 @@ "demo" ] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [ "gdev", "demo" @@ -102,6 +120,10 @@ "type": "dashlist" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 26, "w": 6, @@ -122,7 +144,7 @@ "datasource-test" ] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [ "gdev", "datasource-test" @@ -131,6 +153,10 @@ "type": "dashlist" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 13, "w": 6, @@ -151,7 +177,7 @@ "gdev" ] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [ "templating", "gdev" @@ -160,6 +186,10 @@ "type": "dashlist" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "gridPos": { "h": 13, "w": 6, @@ -180,7 +210,7 @@ "transform" ] }, - "pluginVersion": "8.1.0-pre", + "pluginVersion": "9.0.0-pre", "tags": [ "gdev", "demo" @@ -189,7 +219,7 @@ "type": "dashlist" } ], - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [], "templating": { @@ -227,5 +257,6 @@ "timezone": "", "title": "Grafana Dev Overview & Home", "uid": "j6T00KRZz", - "version": 2 + "version": 3, + "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-barchart/barchart-autosizing.json b/devenv/dev-dashboards/panel-barchart/barchart-autosizing.json index 785ad11d5d7..189f651828b 100644 --- a/devenv/dev-dashboards/panel-barchart/barchart-autosizing.json +++ b/devenv/dev-dashboards/panel-barchart/barchart-autosizing.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -19,10 +22,17 @@ ] }, "editable": true, + "fiscalYearStartMonth": 0, "graphTooltip": 0, + "id": 75, "links": [], + "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -39,7 +49,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "mappings": [], "thresholds": { @@ -65,6 +78,7 @@ }, "id": 9, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.82, "legend": { @@ -81,7 +95,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -94,6 +110,10 @@ "type": "barchart" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "description": "Should be smaller given the longer value", "fieldConfig": { "defaults": { @@ -111,7 +131,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "decimals": 2, "mappings": [], @@ -138,6 +161,7 @@ }, "id": 15, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.82, "legend": { @@ -154,7 +178,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -167,6 +193,10 @@ "type": "barchart" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -183,7 +213,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "mappings": [], "thresholds": { @@ -209,6 +242,7 @@ }, "id": 16, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.89, "legend": { @@ -225,7 +259,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -238,6 +274,10 @@ "type": "barchart" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -254,7 +294,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "mappings": [], "thresholds": { @@ -280,6 +323,7 @@ }, "id": 17, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.89, "legend": { @@ -296,7 +340,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -329,7 +375,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "mappings": [], "thresholds": { @@ -355,6 +404,7 @@ }, "id": 10, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 1, "legend": { @@ -372,7 +422,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -384,6 +436,10 @@ "type": "barchart" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -400,7 +456,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "decimals": 7, "mappings": [], @@ -427,6 +486,7 @@ }, "id": 18, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.82, "legend": { @@ -443,7 +503,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -456,6 +518,10 @@ "type": "barchart" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "description": "", "fieldConfig": { "defaults": { @@ -473,7 +539,10 @@ "tooltip": false, "viz": false }, - "lineWidth": 0 + "lineWidth": 0, + "scaleDistribution": { + "type": "linear" + } }, "mappings": [], "thresholds": { @@ -499,6 +568,7 @@ }, "id": 19, "options": { + "barRadius": 0, "barWidth": 1, "groupWidth": 0.89, "legend": { @@ -515,7 +585,9 @@ "tooltip": { "mode": "single", "sort": "none" - } + }, + "xTickLabelRotation": 0, + "xTickLabelSpacing": 0 }, "targets": [ { @@ -529,7 +601,7 @@ } ], "refresh": "", - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -548,5 +620,6 @@ "timezone": "", "title": "BarChart - Panel Tests - Value sizing", "uid": "WFlOM-jM1", - "version": 9 + "version": 6, + "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-candlestick/candlestick.json b/devenv/dev-dashboards/panel-candlestick/candlestick.json index 6cfaf6d95e3..7f25fb65afd 100644 --- a/devenv/dev-dashboards/panel-candlestick/candlestick.json +++ b/devenv/dev-dashboards/panel-candlestick/candlestick.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -21,10 +24,15 @@ "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 2, + "id": 93, "links": [], "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -169,6 +177,10 @@ "type": "candlestick" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -254,6 +266,10 @@ "type": "candlestick" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -339,6 +355,10 @@ "type": "candlestick" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -458,7 +478,7 @@ } ], "refresh": false, - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -476,6 +496,6 @@ "timezone": "", "title": "Candlestick", "uid": "MP-Di9F7k", - "version": 2, + "version": 1, "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-geomap/geomap_multi-layers.json b/devenv/dev-dashboards/panel-geomap/geomap_multi-layers.json index 7da66da3c17..0bc2677412c 100644 --- a/devenv/dev-dashboards/panel-geomap/geomap_multi-layers.json +++ b/devenv/dev-dashboards/panel-geomap/geomap_multi-layers.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -21,23 +24,33 @@ "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, - "id": 157, + "id": 88, "links": [], "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { - "color": "green", - "value": 20 + "color": "green" }, { "color": "red", @@ -297,7 +310,7 @@ "zoom": 3.58 } }, - "pluginVersion": "8.3.0-pre", + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -309,18 +322,28 @@ "type": "geomap" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", "steps": [ { - "color": "green", - "value": 20 + "color": "green" }, { "color": "red", @@ -401,7 +424,7 @@ "zoom": 3.58 } }, - "pluginVersion": "8.3.0-pre", + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -413,7 +436,7 @@ "type": "geomap" } ], - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -431,6 +454,6 @@ "timezone": "", "title": "Panel Tests - Geomap Multi Layers", "uid": "2jFpEvp7z", - "version": 8, + "version": 1, "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-geomap/panel-geomap.json b/devenv/dev-dashboards/panel-geomap/panel-geomap.json index 5fb9d880e15..cbeb86e8fe8 100644 --- a/devenv/dev-dashboards/panel-geomap/panel-geomap.json +++ b/devenv/dev-dashboards/panel-geomap/panel-geomap.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -19,16 +22,29 @@ ] }, "editable": true, + "fiscalYearStartMonth": 0, "graphTooltip": 0, + "id": 83, "links": [], "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "continuous-GrYlRd" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", @@ -55,6 +71,7 @@ "options": { "basemap": { "config": {}, + "name": "Layer 0", "type": "default" }, "controls": { @@ -86,6 +103,7 @@ "lookup": "State", "mode": "auto" }, + "name": "Layer 1", "type": "markers" } ], @@ -97,6 +115,7 @@ "zoom": 3.98 } }, + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -108,11 +127,22 @@ "type": "geomap" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "thresholds" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", @@ -143,6 +173,7 @@ "options": { "basemap": { "config": {}, + "name": "Layer 0", "type": "default" }, "controls": { @@ -174,6 +205,7 @@ "lookup": "State", "mode": "auto" }, + "name": "Layer 1", "type": "markers" } ], @@ -185,6 +217,7 @@ "zoom": 3.98 } }, + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -196,11 +229,22 @@ "type": "geomap" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "continuous-BlYlRd" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", @@ -227,6 +271,7 @@ "options": { "basemap": { "config": {}, + "name": "Layer 0", "type": "default" }, "controls": { @@ -253,6 +298,7 @@ "lookup": "State", "mode": "auto" }, + "name": "Layer 1", "type": "heatmap" } ], @@ -264,6 +310,7 @@ "zoom": 4.15 } }, + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -276,11 +323,22 @@ "type": "geomap" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { "mode": "continuous-GrYlRd" }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, "mappings": [], "thresholds": { "mode": "absolute", @@ -309,6 +367,7 @@ "config": { "server": "world-imagery" }, + "name": "Layer 0", "type": "esri-xyz" }, "controls": { @@ -339,6 +398,7 @@ "lookup": "State", "mode": "auto" }, + "name": "Layer 1", "type": "markers" } ], @@ -350,6 +410,7 @@ "zoom": 3.83 } }, + "pluginVersion": "9.0.0-pre", "targets": [ { "csvFileName": "flight_info_by_state.csv", @@ -362,7 +423,7 @@ } ], "refresh": "", - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -391,5 +452,6 @@ "timezone": "", "title": "Panel Tests - Geomap", "uid": "2xuwrgV7z", - "version": 5 + "version": 2, + "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-graph/graph-ng-nulls.json b/devenv/dev-dashboards/panel-graph/graph-ng-nulls.json index cf92486354c..2d36cdd2f4f 100644 --- a/devenv/dev-dashboards/panel-graph/graph-ng-nulls.json +++ b/devenv/dev-dashboards/panel-graph/graph-ng-nulls.json @@ -24,6 +24,7 @@ "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 0, + "id": 61, "links": [ { "asDropdown": true, @@ -1326,7 +1327,7 @@ "type": "timeseries" } ], - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", diff --git a/devenv/dev-dashboards/panel-heatmap/heatmap-calculate-log.json b/devenv/dev-dashboards/panel-heatmap/heatmap-calculate-log.json new file mode 100644 index 00000000000..5481b136d9d --- /dev/null +++ b/devenv/dev-dashboards/panel-heatmap/heatmap-calculate-log.json @@ -0,0 +1,553 @@ +{ + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": { + "type": "grafana", + "uid": "-- Grafana --" + }, + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "target": { + "limit": 100, + "matchAny": false, + "tags": [], + "type": "dashboard" + }, + "type": "dashboard" + } + ] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 1, + "links": [], + "liveNow": false, + "panels": [ + { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "points", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 2, + "scaleDistribution": { + "log": 2, + "type": "log" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green" + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 0, + "y": 0 + }, + "id": 3, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom" + }, + "tooltip": { + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, + "max": 500000, + "min": 0.01, + "refId": "A", + "scenarioId": "random_walk", + "seriesCount": 2, + "spread": 1000, + "startValue": 0.01 + } + ], + "title": "Time series", + "type": "timeseries" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 8, + "y": 0 + }, + "id": 6, + "options": { + "bucket": { + "layout": "auto" + }, + "calculate": true, + "calculation": { + "yBuckets": { + "scale": { + "log": 2, + "type": "log" + } + } + }, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "scale": "exponential", + "scheme": "Spectral", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "mode": "calculate", + "tooltip": { + "show": true, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + }, + "yAxisLabels": "auto", + "yAxisReverse": false + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "panelId": 3, + "refId": "A" + } + ], + "title": "log2", + "type": "heatmap-new" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 16, + "y": 0 + }, + "id": 7, + "options": { + "bucket": { + "layout": "auto" + }, + "calculate": true, + "calculation": { + "yBuckets": { + "scale": { + "log": 2, + "type": "log" + }, + "value": "2" + } + }, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "scale": "exponential", + "scheme": "Spectral", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "mode": "calculate", + "tooltip": { + "show": true, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + }, + "yAxisLabels": "auto", + "yAxisReverse": false + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "panelId": 3, + "refId": "A" + } + ], + "title": "log2 split 2", + "type": "heatmap-new" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 0, + "y": 14 + }, + "id": 4, + "options": { + "bucket": { + "layout": "auto" + }, + "calculate": true, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "scale": "exponential", + "scheme": "Spectral", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "mode": "calculate", + "tooltip": { + "show": true, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + }, + "yAxisLabels": "auto", + "yAxisReverse": false + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "panelId": 3, + "refId": "A" + } + ], + "title": "linear", + "type": "heatmap-new" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 8, + "y": 14 + }, + "id": 5, + "options": { + "bucket": { + "layout": "auto" + }, + "calculate": true, + "calculation": { + "yBuckets": { + "scale": { + "log": 10, + "type": "log" + } + } + }, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "scale": "exponential", + "scheme": "Spectral", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "mode": "calculate", + "tooltip": { + "show": true, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + }, + "yAxisLabels": "auto", + "yAxisReverse": false + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "panelId": 3, + "refId": "A" + } + ], + "title": "log10", + "type": "heatmap-new" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "fieldConfig": { + "defaults": { + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "scaleDistribution": { + "type": "linear" + } + } + }, + "overrides": [] + }, + "gridPos": { + "h": 14, + "w": 8, + "x": 16, + "y": 14 + }, + "id": 8, + "options": { + "bucket": { + "layout": "auto" + }, + "calculate": true, + "calculation": { + "yBuckets": { + "scale": { + "log": 10, + "type": "log" + }, + "value": "2" + } + }, + "cellGap": 1, + "color": { + "exponent": 0.5, + "fill": "dark-orange", + "mode": "scheme", + "scale": "exponential", + "scheme": "Spectral", + "steps": 64 + }, + "exemplars": { + "color": "rgba(255,0,255,0.7)" + }, + "filterValues": { + "le": 1e-9 + }, + "legend": { + "show": true + }, + "mode": "calculate", + "tooltip": { + "show": true, + "yHistogram": false + }, + "yAxis": { + "axisPlacement": "left", + "reverse": false + }, + "yAxisLabels": "auto", + "yAxisReverse": false + }, + "pluginVersion": "9.0.0-pre", + "targets": [ + { + "datasource": { + "type": "datasource", + "uid": "-- Dashboard --" + }, + "panelId": 3, + "refId": "A" + } + ], + "title": "log10 split 2", + "type": "heatmap-new" + } + ], + "schemaVersion": 36, + "style": "dark", + "tags": ["gdev", "panel-tests", "graph-ng"], + "templating": { + "list": [] + }, + "time": { + "from": "now-6h", + "to": "now" + }, + "timepicker": {}, + "timezone": "", + "title": "Heatmap calculate (log)", + "uid": "ZXYQTA97ZZ", + "version": 1, + "weekStart": "" +} diff --git a/devenv/dev-dashboards/panel-timeline/timeline-demo.json b/devenv/dev-dashboards/panel-timeline/timeline-demo.json index 6dec37ab297..fbee94b84aa 100644 --- a/devenv/dev-dashboards/panel-timeline/timeline-demo.json +++ b/devenv/dev-dashboards/panel-timeline/timeline-demo.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -19,10 +22,17 @@ ] }, "editable": true, + "fiscalYearStartMonth": 0, "graphTooltip": 0, + "id": 79, "links": [], + "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -30,7 +40,8 @@ }, "custom": { "fillOpacity": 80, - "lineWidth": 1 + "lineWidth": 1, + "spanNulls": false }, "mappings": [ { @@ -120,6 +131,10 @@ "type": "state-timeline" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -127,7 +142,8 @@ }, "custom": { "fillOpacity": 70, - "lineWidth": 1 + "lineWidth": 1, + "spanNulls": false }, "mappings": [ { @@ -221,6 +237,10 @@ "type": "state-timeline" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "description": "Should show gaps", "fieldConfig": { "defaults": { @@ -229,7 +249,8 @@ }, "custom": { "fillOpacity": 80, - "lineWidth": 1 + "lineWidth": 1, + "spanNulls": false }, "mappings": [ { @@ -322,6 +343,10 @@ "type": "state-timeline" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -414,7 +439,7 @@ } ], "refresh": false, - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -433,5 +458,6 @@ "timezone": "utc", "title": "Timeline Demo", "uid": "mIJjFy8Kz", - "version": 3 + "version": 7, + "weekStart": "" } diff --git a/devenv/dev-dashboards/panel-timeline/timeline-modes.json b/devenv/dev-dashboards/panel-timeline/timeline-modes.json index d1895390fbd..aa614819397 100644 --- a/devenv/dev-dashboards/panel-timeline/timeline-modes.json +++ b/devenv/dev-dashboards/panel-timeline/timeline-modes.json @@ -3,7 +3,10 @@ "list": [ { "builtIn": 1, - "datasource": "-- Grafana --", + "datasource": { + "type": "datasource", + "uid": "grafana" + }, "enable": true, "hide": true, "iconColor": "rgba(0, 211, 255, 1)", @@ -19,11 +22,17 @@ ] }, "editable": true, + "fiscalYearStartMonth": 0, "graphTooltip": 0, - "id": 329, + "id": 78, "links": [], + "liveNow": false, "panels": [ { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -31,7 +40,8 @@ }, "custom": { "fillOpacity": 70, - "lineWidth": 1 + "lineWidth": 1, + "spanNulls": false }, "mappings": [], "thresholds": { @@ -201,6 +211,10 @@ "type": "state-timeline" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -208,7 +222,8 @@ }, "custom": { "fillOpacity": 70, - "lineWidth": 1 + "lineWidth": 1, + "spanNulls": false }, "mappings": [], "thresholds": { @@ -273,6 +288,10 @@ "type": "state-timeline" }, { + "datasource": { + "type": "testdata", + "uid": "PD8C576611E62080A" + }, "fieldConfig": { "defaults": { "color": { @@ -361,7 +380,7 @@ } ], "refresh": false, - "schemaVersion": 33, + "schemaVersion": 36, "style": "dark", "tags": [ "gdev", @@ -379,5 +398,6 @@ "timezone": "utc", "title": "Timeline Modes", "uid": "mIJjFy8Gz", - "version": 13 + "version": 6, + "weekStart": "" } diff --git a/devenv/docker/blocks/elastic/docker-compose.yaml b/devenv/docker/blocks/elastic/docker-compose.yaml index aee8b0eae5c..0cb707edf33 100644 --- a/devenv/docker/blocks/elastic/docker-compose.yaml +++ b/devenv/docker/blocks/elastic/docker-compose.yaml @@ -17,8 +17,4 @@ - elasticsearch # elastic starts slowly, the first couple start of data.js # might fail, so we auto-restart it on failure. - deploy: - restart_policy: - condition: on-failure - delay: 5s - max_attempts: 20 # should be enough \ No newline at end of file + restart: "on-failure" \ No newline at end of file diff --git a/devenv/docker/blocks/loki/data/data.js b/devenv/docker/blocks/loki/data/data.js index 38f0d9c2525..07572a18efd 100644 --- a/devenv/docker/blocks/loki/data/data.js +++ b/devenv/docker/blocks/loki/data/data.js @@ -66,16 +66,51 @@ async function lokiSendLogLine(timestampMs, line, tags) { await jsonRequest(data, 'POST', url, 204); } -function getRandomLogLine(counter) { +function getRandomLogItem(counter) { const randomText = `${Math.trunc(Math.random() * 1000 * 1000 * 1000)}`; const maybeAnsiText = Math.random() < 0.5 ? 'with ANSI \u001b[31mpart of the text\u001b[0m' : ''; - return JSON.stringify({ + return { _entry: `log text ${maybeAnsiText} [${randomText}]`, counter: counter.toString(), - float: Math.random() > 0.2 ? (100 * Math.random()).toString() : 'NaN', + float: Math.random() > 0.2 ? (Math.trunc(100000 * Math.random())/1000).toString() : 'NaN', label: chooseRandomElement(['val1', 'val2', 'val3']), - level: chooseRandomElement(['info', 'info', 'error']), + level: chooseRandomElement(['debug','info', 'info', 'info', 'info', 'warning', 'error', 'error']), + }; +} + +function getRandomJSONLogLine(counter) { + const item = getRandomLogItem(counter) + return JSON.stringify(item) +} + +const logFmtProblemRe = /[="\n]/; + +// we are not really escaping things, we just check +// that we don't need to escape :-) +function escapeLogFmtKey(key) { + if (logFmtProblemRe.test(key)) { + throw new Error(`invalid logfmt-key: ${key}`) + } + return key; +} + +function escapeLogFmtValue(value) { + if (logFmtProblemRe.test(value)) { + throw new Error(`invalid logfmt-value: ${key}`) + } + + // we must handle the space-character because we have values with spaces :-( + return value.indexOf(' ') === -1 ? value : `"${value}"` +} + +function logFmtLine(item) { + const parts = Object.entries(item).map(([k,v]) => { + const key = escapeLogFmtKey(k.toString()); + const value = escapeLogFmtValue(v.toString()); + return `${key}=${value}`; }); + + return parts.join(' '); } const SLEEP_ANGLE_STEP = Math.PI / 200; @@ -86,15 +121,12 @@ function getNextSineWaveSleepDuration() { } async function main() { - const tags = { - place: 'moon', - }; - for (let step = 0; step < 300; step++) { await sleep(getNextSineWaveSleepDuration()); const timestampMs = new Date().getTime(); - const line = getRandomLogLine(step + 1); - lokiSendLogLine(timestampMs, line, tags); + const item = getRandomLogItem(step + 1) + lokiSendLogLine(timestampMs, JSON.stringify(item), {place:'moon', source: 'data'}); + lokiSendLogLine(timestampMs, logFmtLine(item), {place:'luna', source: 'data'}); } } diff --git a/devenv/docker/loadtest/annotations_by_tag_test.js b/devenv/docker/loadtest/annotations_by_tag_test.js index 7f722757caa..39d376b85f7 100644 --- a/devenv/docker/loadtest/annotations_by_tag_test.js +++ b/devenv/docker/loadtest/annotations_by_tag_test.js @@ -57,7 +57,7 @@ export default (data) => { requests.push({ method: 'GET', url: '/api/annotations?from=1580825186534&to=1580846786535' }); for (let n = 0; n < batchCount; n++) { - requests.push({ method: 'POST', url: '/api/tsdb/query', body: payload }); + requests.push({ method: 'POST', url: '/api/ds/query', body: payload }); } let responses = client.batch(requests); diff --git a/devenv/docker/loadtest/auth_key_test.js b/devenv/docker/loadtest/auth_key_test.js index b13b97dd17c..a3029226a64 100644 --- a/devenv/docker/loadtest/auth_key_test.js +++ b/devenv/docker/loadtest/auth_key_test.js @@ -62,7 +62,7 @@ export default (data) => { requests.push({ method: 'GET', url: '/api/annotations?dashboardId=2074&from=1548078832772&to=1548082432772' }); for (let n = 0; n < batchCount; n++) { - requests.push({ method: 'POST', url: '/api/tsdb/query', body: payload }); + requests.push({ method: 'POST', url: '/api/ds/query', body: payload }); } let responses = client.batch(requests); diff --git a/devenv/docker/loadtest/auth_token_slow_test.js b/devenv/docker/loadtest/auth_token_slow_test.js index 7e80b1017c2..38a3a6d8171 100644 --- a/devenv/docker/loadtest/auth_token_slow_test.js +++ b/devenv/docker/loadtest/auth_token_slow_test.js @@ -59,7 +59,7 @@ export default (data) => { requests.push({ method: 'GET', url: '/api/annotations?dashboardId=2074&from=1548078832772&to=1548082432772' }); for (let n = 0; n < batchCount; n++) { - requests.push({ method: 'POST', url: '/api/tsdb/query', body: payload }); + requests.push({ method: 'POST', url: '/api/ds/query', body: payload }); } let responses = client.batch(requests); diff --git a/devenv/docker/loadtest/auth_token_test.js b/devenv/docker/loadtest/auth_token_test.js index 40570fdef57..0626377a29a 100644 --- a/devenv/docker/loadtest/auth_token_test.js +++ b/devenv/docker/loadtest/auth_token_test.js @@ -58,7 +58,7 @@ export default (data) => { requests.push({ method: 'GET', url: '/api/annotations?dashboardId=2074&from=1548078832772&to=1548082432772' }); for (let n = 0; n < batchCount; n++) { - requests.push({ method: 'POST', url: '/api/tsdb/query', body: payload }); + requests.push({ method: 'POST', url: '/api/ds/query', body: payload }); } let responses = client.batch(requests); diff --git a/docs/sources/_index.md b/docs/sources/_index.md index d75758579b5..156adb351d4 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -1,31 +1,38 @@ -+++ -aliases = ["/docs/grafana/latest/", "/docs/grafana/latest/guides/reference/admin/", "/docs/grafana/v1.1/", "/docs/grafana/v3.1/"] -description = "Guides, Installation and Feature Documentation" -keywords = ["grafana", "installation", "documentation"] -title = "Grafana documentation" -+++ +--- +aliases: + - /docs/grafana/latest/ + - /docs/grafana/latest/guides/reference/admin/ + - /docs/grafana/v1.1/ + - /docs/grafana/v3.1/ +description: Guides, Installation and Feature Documentation +keywords: + - grafana + - installation + - documentation +title: Grafana documentation +--- # Grafana documentation ## Installing Grafana
- }}" class="nav-cards__item nav-cards__item--install"> + }}" class="nav-cards__item nav-cards__item--install">
Install on Linux
 - }}" class="nav-cards__item nav-cards__item--install"> + }}" class="nav-cards__item nav-cards__item--install">
Install on macOS
 - }}" class="nav-cards__item nav-cards__item--install"> + }}" class="nav-cards__item nav-cards__item--install">
Install on Windows
 - }}" class="nav-cards__item nav-cards__item--install"> + }}" class="nav-cards__item nav-cards__item--install">
Run Docker image
 @@ -44,27 +51,27 @@ title = "Grafana documentation" ## Guides
- }}" class="nav-cards__item nav-cards__item--guide"> + }}" class="nav-cards__item nav-cards__item--guide">

Getting started

Learn the basics of using Grafana.

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

Grafana basics

Learn basic observability.

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

Configure Grafana

Review the configuration and setup options.

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

Intro to time series

Learn about time series data.

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

Provisioning

Learn how to automate your Grafana configuration.

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

What's new in v8.0

Explore the features and enhancements in the latest release.

 @@ -74,51 +81,51 @@ title = "Grafana documentation" ## Data source guides
- }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Graphite
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Elasticsearch
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
InfluxDB
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Prometheus
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Google Cloud Monitoring
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
AWS CloudWatch
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Azure Monitor
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Loki
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
MySQL
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Postgres
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
Microsoft SQL Server
 - }}" class="nav-cards__item nav-cards__item--ds"> + }}" class="nav-cards__item nav-cards__item--ds">
OpenTSDB
 diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md index a9798e2b693..a2926d4ee09 100644 --- a/docs/sources/administration/_index.md +++ b/docs/sources/administration/_index.md @@ -1,17 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/administration/"] -description = "Administration" -title = "Administration" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/administration/ +description: Administration +title: Administration +weight: 40 +--- # Administration This section includes information for Grafana administrators, team administrators, and users performing administrative tasks: -- [Change Preferences]({{< relref "preferences" >}}) -- [Configuration]({{< relref "configuration" >}}) -- [Configure Docker image]({{< relref "configure-docker" >}}) -- [Security]({{< relref "security" >}}) -- [Database encryption]({{< relref "database-encryption" >}}) -- [Service accounts]({{< relref "service-accounts" >}}) +- [Change Preferences]({{< relref "preferences/" >}}) +- [Configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) +- [Configure Docker image]({{< relref "configure-docker/" >}}) +- [Security]({{< relref "../setup-grafana/configure-security/" >}}) +- [Database encryption]({{< relref "../setup-grafana/configure-security/configure-database-encryption/" >}}) +- [Service accounts]({{< relref "service-accounts/" >}}) diff --git a/docs/sources/administration/api-keys/_index.md b/docs/sources/administration/api-keys/_index.md index edffa026f3b..2ec44f4ead6 100644 --- a/docs/sources/administration/api-keys/_index.md +++ b/docs/sources/administration/api-keys/_index.md @@ -14,6 +14,6 @@ weight: 300 API Keys can be used to interact with Grafana HTTP APIs. -We recommend using service accounts instead of API keys if you are on Grafana 8.5+, for more information refer to [About service accounts]({{< relref "../service-accounts/about-service-accounts.md#" >}}). +We recommend using service accounts instead of API keys if you are on Grafana 8.5+, for more information refer to [About service accounts]({{< relref "../service-accounts/about-service-accounts/#" >}}). {{< section >}} diff --git a/docs/sources/administration/api-keys/about-api-keys.md b/docs/sources/administration/api-keys/about-api-keys.md index 901e8dcb1f5..cbd339de8d3 100644 --- a/docs/sources/administration/api-keys/about-api-keys.md +++ b/docs/sources/administration/api-keys/about-api-keys.md @@ -11,4 +11,4 @@ weight: 30 An API key is a randomly generated string that external systems use to interact with Grafana HTTP APIs. -When you create an API key, you specify a **Role** that determines the permissions associated with the API key. Role permissions control that actions the API key can perform on Grafana resources. For more information about creating API keys, refer to [Create an API key]({{< relref "./create-api-key.md#" >}}). +When you create an API key, you specify a **Role** that determines the permissions associated with the API key. Role permissions control that actions the API key can perform on Grafana resources. For more information about creating API keys, refer to [Create an API key]({{< relref "create-api-key/#" >}}). diff --git a/docs/sources/administration/api-keys/create-api-key.md b/docs/sources/administration/api-keys/create-api-key.md index d200bc05536..a8ad53f9374 100644 --- a/docs/sources/administration/api-keys/create-api-key.md +++ b/docs/sources/administration/api-keys/create-api-key.md @@ -14,13 +14,13 @@ weight: 50 Create an API key when you want to manage your computed workload with a user. -For more information about API keys, refer to [About API keys in Grafana]({{< relref "./about-api-keys.md" >}}). +For more information about API keys, refer to [About API keys in Grafana]({{< relref "about-api-keys/" >}}). -This topic shows you how to create an API key using the Grafana UI. You can also create an API key using the Grafana HTTP API. For more information about creating API keys via the API, refer to [Create API key via API]({{< relref "../../developers/http_api/create-api-tokens-for-org.md#how-to-create-a-new-organization-and-an-api-token" >}}). +This topic shows you how to create an API key using the Grafana UI. You can also create an API key using the Grafana HTTP API. For more information about creating API keys via the API, refer to [Create API key via API]({{< relref "../../developers/http_api/create-api-tokens-for-org/#how-to-create-a-new-organization-and-an-api-token" >}}). ## Before you begin: -- Ensure you have permission to create and edit API keys. For more information about permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#" >}}). +- Ensure you have permission to create and edit API keys. For more information about permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#" >}}). **To create an API key:** diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md index 3056312c725..3c67dc18616 100644 --- a/docs/sources/administration/cli.md +++ b/docs/sources/administration/cli.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/administration/cli/"] -description = "Guide to using grafana-cli" -keywords = ["grafana", "cli", "grafana-cli", "command line interface"] -title = "Grafana CLI" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/administration/cli/ +description: Guide to using grafana-cli +keywords: + - grafana + - cli + - grafana-cli + - command line interface +title: Grafana CLI +weight: 400 +--- # Grafana CLI @@ -132,7 +137,7 @@ grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password }}) for more information about configuring Grafana and default configuration file locations. +`--config value` overrides the default location where Grafana expects the configuration file. Refer to [Configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) for more information about configuring Grafana and default configuration file locations. **Example:** @@ -142,7 +147,7 @@ grafana-cli --config "/etc/configuration/" admin reset-admin-password mynewpassw ## Plugins commands -Grafana CLI allows you to install, upgrade, and manage your Grafana plugins. For more information about installing plugins, refer to [plugins page]({{< relref "../plugins/installation.md" >}}). +Grafana CLI allows you to install, upgrade, and manage your Grafana plugins. For more information about installing plugins, refer to [plugins page]({{< relref "../plugins/installation/" >}}). All listed commands apply to the Grafana default repositories and directories. You can override the defaults with [Global Options](#global-options). @@ -214,7 +219,7 @@ grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password User tab. -If you need to set the password in a script, then you can use the [Grafana User API]({{< relref "../developers/http_api/user.md#change-password" >}}). +If you need to set the password in a script, then you can use the [Grafana User API]({{< relref "../developers/http_api/user/#change-password" >}}). ### Migrate data and encrypt passwords diff --git a/docs/sources/administration/configure-docker.md b/docs/sources/administration/configure-docker.md index 217fa558821..ff8978f18ec 100644 --- a/docs/sources/administration/configure-docker.md +++ b/docs/sources/administration/configure-docker.md @@ -1,14 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/administration/configure-docker/", "/docs/grafana/latest/installation/configure-docker/"] -description = "Guide for configuring the Grafana Docker image" -keywords = ["grafana", "configuration", "documentation", "docker"] -title = "Configure Grafana Docker image" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/administration/configure-docker/ + - /docs/grafana/latest/installation/configure-docker/ +description: Guide for configuring the Grafana Docker image +keywords: + - grafana + - configuration + - documentation + - docker +title: Configure Grafana Docker image +weight: 200 +--- # Configure a Grafana Docker image -If you are running Grafana in a Docker image, then you configure Grafana using [environment variables]({{< relref "../administration/configuration.md#configure-with-environment-variables" >}}) rather than directly editing the configuration file. If you want to save your data, then you also need to designate persistent storage or bind mounts for the Grafana container. +If you are running Grafana in a Docker image, then you configure Grafana using [environment variables]({{< relref "../setup-grafana/configure-grafana/#configure-with-environment-variables" >}}) rather than directly editing the configuration file. If you want to save your data, then you also need to designate persistent storage or bind mounts for the Grafana container. > **Note:** These examples use the Grafana Enterprise docker image. You can use the Grafana Open Source edition by changing the docker image to `grafana/grafana-oss`. @@ -53,7 +59,7 @@ The following settings are hard-coded when launching the Grafana Docker containe ## Logging -Logs in the Docker container go to standard out by default, as is common in the Docker world. Change this by setting a different [log mode]({{< relref "../administration/configuration.md#mode" >}}). +Logs in the Docker container go to standard out by default, as is common in the Docker world. Change this by setting a different [log mode]({{< relref "../setup-grafana/configure-grafana/#mode" >}}). Example: diff --git a/docs/sources/administration/jaeger-instrumentation.md b/docs/sources/administration/jaeger-instrumentation.md deleted file mode 100644 index 01981377c52..00000000000 --- a/docs/sources/administration/jaeger-instrumentation.md +++ /dev/null @@ -1,17 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/administration/jaeger-instrumentation/"] -description = "Jaeger traces emitted and propagation by Grafana" -keywords = ["grafana", "jaeger", "tracing"] -title = "Jaeger instrumentation" -weight = 900 -+++ - -# Jaeger instrumentation - -Grafana supports [Jaeger tracing](https://www.jaegertracing.io/). - -Grafana can emit Jaeger traces for its HTTP API endpoints and propagate Jaeger trace information to data sources. -All HTTP endpoints are logged evenly (annotations, dashboard, tags, and so on). -When a trace ID is propagated, it is reported with operation 'HTTP /datasources/proxy/:id/\*'. - -Refer to [Configuration]({{< relref "configuration.md#tracing-jaeger" >}}) for information about enabling Jaeger tracing. diff --git a/docs/sources/administration/manage-organizations/_index.md b/docs/sources/administration/manage-organizations/_index.md index e321e2f3924..97ba0d9666e 100644 --- a/docs/sources/administration/manage-organizations/_index.md +++ b/docs/sources/administration/manage-organizations/_index.md @@ -42,7 +42,7 @@ The following table summarizes the resources you can share and/or isolate using The member of one organization cannot view dashboards assigned to another organization. However, a user can belong to multiple organizations. -Grafana Server Administrators are responsible for creating organizations. For more information about the Grafana Server Administrator role, refer to [Grafana server administrators]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#Grafana server administrators" >}}). +Grafana Server Administrators are responsible for creating organizations. For more information about the Grafana Server Administrator role, refer to [Grafana server administrators]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#Grafana server administrators" >}}). ## View a list of organizations @@ -80,9 +80,9 @@ Create an organization when you want to isolate dashboards and other resources f 1. On the **Preferences** tab, select a home dashboard, time zone, and week start. - For more information about preferences, refer to [Preferences]({{< relref "../preferences/_index.md" >}}). + For more information about preferences, refer to [Preferences]({{< relref "../preferences/" >}}). -For more information about adding users to an organization, refer to [Add a user to an organization]({{< relref "../manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md" >}}). +For more information about adding users to an organization, refer to [Add a user to an organization]({{< relref "../manage-users-and-permissions/manage-server-users/add-remove-user-to-org/" >}}). ## Delete an organization diff --git a/docs/sources/administration/manage-user-preferences/_index.md b/docs/sources/administration/manage-user-preferences/_index.md index 123f29f7363..e6a07ada381 100644 --- a/docs/sources/administration/manage-user-preferences/_index.md +++ b/docs/sources/administration/manage-user-preferences/_index.md @@ -1,10 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/administration/change-your-password/", "/docs/grafana/latest/administration/manage-user-preferences/"] -description = "Learn how to update your user preferences and switch organizations" -keywords = ["password", "change", "organization", "change"] -title = "Manage user preferences" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/administration/change-your-password/ + - /docs/grafana/latest/administration/manage-user-preferences/ +description: Learn how to update your user preferences and switch organizations +keywords: + - password + - change + - organization + - change +title: Manage user preferences +weight: 400 +--- # Manage user preferences @@ -16,7 +22,7 @@ You can also view important information about your account, such as the organiza You can change your Grafana password at any time. -> **Note**: If your Grafana instance uses an external authentication provider, then you might not be able to change your password in Grafana. Contact your Grafana administrator for more information. +> **Note**: If your Grafana instance uses an external authentication provider, then you might not be able to change your password in Grafana. Contact your Grafana administrator for more information. **To change your password**: @@ -41,7 +47,7 @@ Your profile includes your name, user name, and email address, which you can upd ## Edit your preferences -You can choose the way you would like data to appear in Grafana, including the UI theme, home dashboard, timezone, and first day of the week. You can set these preferences for your own account, for a team, for an organization, or Grafana-wide using configuration settings. Your user preferences take precedence over team, organization, and Grafana default preferences. For more information, see [Grafana preferences]({{< relref "../../administration/preferences/_index.md" >}}). +You can choose the way you would like data to appear in Grafana, including the UI theme, home dashboard, timezone, and first day of the week. You can set these preferences for your own account, for a team, for an organization, or Grafana-wide using configuration settings. Your user preferences take precedence over team, organization, and Grafana default preferences. For more information, see [Grafana preferences]({{< relref "../preferences/" >}}). - **UI theme** determines whether Grafana appears in light mode or dark mode. By default, UI theme is set to dark mode. - **Home dashboard** refers to the dashboard you see when you sign in to Grafana. By default, this is set to the Home dashboard. @@ -75,7 +81,7 @@ Every user is a member of at least one organization. You can have different role 1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**. 1. Scroll down to the **Organizations** section and review the following information: - **Name**: The name of the organizations of which you are a member. - - **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}). + - **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#organization-users-and-permissions" >}}). - **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization. ## View your Grafana sessions diff --git a/docs/sources/administration/manage-users-and-permissions/_index.md b/docs/sources/administration/manage-users-and-permissions/_index.md index 1e3e48e4bcc..4a0ae999e3b 100644 --- a/docs/sources/administration/manage-users-and-permissions/_index.md +++ b/docs/sources/administration/manage-users-and-permissions/_index.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/"] -title = "Manage users and permissions" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/ +title: Manage users and permissions +weight: 200 +--- # Manage users and permissions diff --git a/docs/sources/administration/manage-users-and-permissions/about-users-and-permissions.md b/docs/sources/administration/manage-users-and-permissions/about-users-and-permissions.md index b471fa27df7..d18d5227705 100644 --- a/docs/sources/administration/manage-users-and-permissions/about-users-and-permissions.md +++ b/docs/sources/administration/manage-users-and-permissions/about-users-and-permissions.md @@ -1,8 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/about-users-and-permissions/", "/docs/grafana/latest/manage-users/", "/docs/grafana/latest/permissions/", "/docs/grafana/latest/permissions/organization_roles/", "/docs/grafana/latest/permissions/overview/"] -title = "About users and permissions" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/about-users-and-permissions/ + - /docs/grafana/latest/manage-users/ + - /docs/grafana/latest/permissions/ + - /docs/grafana/latest/permissions/organization_roles/ + - /docs/grafana/latest/permissions/overview/ +title: About users and permissions +weight: 100 +--- # About users and permissions @@ -26,7 +31,7 @@ A server administrator can perform the following tasks: - Manage users and permissions - Create, edit, and delete organizations -- View server-wide settings defined in the [Configuration]({{< relref "../../administration/configuration.md" >}}) file +- View server-wide settings defined in the [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) file - View Grafana server statistics, including total users and active sessions - Upgrade the server to Grafana Enterprise. @@ -52,7 +57,7 @@ Permissions assigned to a user within an organization control the extent to whic ### Organization roles -Organization role-based permissions are global, which means that each permission level applies to all Grafana resources within an given organization. For example, an editor can see and update _all_ dashboards in an organization, unless those dashboards have been specifically restricted using [dashboard permissions]({{< relref "manage-dashboard-permissions/_index.md" >}}). +Organization role-based permissions are global, which means that each permission level applies to all Grafana resources within an given organization. For example, an editor can see and update _all_ dashboards in an organization, unless those dashboards have been specifically restricted using [dashboard permissions]({{< relref "manage-dashboard-permissions/" >}}). Grafana uses the following roles to control user access: @@ -92,9 +97,9 @@ You can specify the following permissions to dashboards and folders. - **Edit**: Can create and edit dashboards. Editors _cannot_ change folder or dashboard permissions, or add, edit, or delete folders. - **View**: Can only view dashboards and folders. -For more information about assigning dashboard folder permissions, refer to [Grant dashboard folder permissions]({{< relref "./manage-dashboard-permissions/_index.md#grant-dashboard-folder-permissions" >}}). +For more information about assigning dashboard folder permissions, refer to [Grant dashboard folder permissions]({{< relref "manage-dashboard-permissions/#grant-dashboard-folder-permissions" >}}). -For more information about assigning dashboard permissions, refer to [Grant dashboard permissions]({{< relref "./manage-dashboard-permissions/_index.md#grant-dashboard-permissions" >}}). +For more information about assigning dashboard permissions, refer to [Grant dashboard permissions]({{< relref "manage-dashboard-permissions/#grant-dashboard-permissions" >}}). ## Editors with administrator permissions @@ -104,18 +109,18 @@ If you have access to the Grafana server, you can modify the default editor role This setting can be used to enable self-organizing teams to administer their own dashboards. -For more information about assigning administrator permissions to editors, refer to [Grant editors administrator permissions]({{< relref "./manage-server-users/grant-editor-admin-permissions.md" >}}). +For more information about assigning administrator permissions to editors, refer to [Grant editors administrator permissions]({{< relref "manage-server-users/grant-editor-admin-permissions/" >}}). ## Viewers with dashboard preview and Explore permissions If you have access to the Grafana server, you can modify the default viewer role so that viewers can: - Edit and preview dashboards, but cannot save their changes or create new dashboards. -- Access and use [Explore]({{< relref "../../explore/_index.md" >}}). +- Access and use [Explore]({{< relref "../../explore/" >}}). Extending the viewer role is useful for public Grafana installations where you want anonymous users to be able to edit panels and queries, but not be able to save or create new dashboards. -For more information about assigning dashboard preview permissions to viewers, refer to [Enable viewers to preview dashboards and use Explore]({{< relref "./manage-dashboard-permissions/_index.md#enable-viewers-to-preview-dashboards-and-use-explore" >}}). +For more information about assigning dashboard preview permissions to viewers, refer to [Enable viewers to preview dashboards and use Explore]({{< relref "manage-dashboard-permissions/#enable-viewers-to-preview-dashboards-and-use-explore" >}}). ## Teams and permissions @@ -126,7 +131,7 @@ You can assign a team member one of the following permissions: - **Member**: Includes the user as a member of the team. Members do not have team administrator privileges. - **Admin**: Administrators have permission to manage various aspects of the team, including team membership, permissions, and settings. -Because teams exist inside an organization, the organization administrator can manage all teams. When the `editors_can_admin` setting is enabled, editors can create teams and manage teams that they create. For more information about the `editors_can_admin` setting, refer to [Grant editors administrator permissions]({{< relref "./manage-server-users/grant-editor-admin-permissions.md" >}}). +Because teams exist inside an organization, the organization administrator can manage all teams. When the `editors_can_admin` setting is enabled, editors can create teams and manage teams that they create. For more information about the `editors_can_admin` setting, refer to [Grant editors administrator permissions]({{< relref "manage-server-users/grant-editor-admin-permissions/" >}}). ## Grafana Enterprise user permissions features @@ -141,13 +146,13 @@ Grafana Enterprise provides the following permissions-related features: By default, a user can query any data source in an organization, even if the data source is not linked to the user's dashboards. -Data source permissions enable you to restrict data source query permissions to specific **Users** and **Teams**. For more information about assigning data source permissions, refer to [Data source permissions]({{< relref "../../enterprise/datasource_permissions.md" >}}). +Data source permissions enable you to restrict data source query permissions to specific **Users** and **Teams**. For more information about assigning data source permissions, refer to [Data source permissions]({{< relref "../../enterprise/datasource_permissions/" >}}). ### Role-based access control RBAC provides you a way of granting, changing, and revoking user read and write access to Grafana resources, such as users, reports, and authentication. -For more information about RBAC, refer to [Role-based access control]({{< relref "../../enterprise/access-control" >}}). +For more information about RBAC, refer to [Role-based access control]({{< relref "../../enterprise/access-control/" >}}). ### Learn more diff --git a/docs/sources/administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md b/docs/sources/administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md index d8b8bf76645..852b780e839 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-dashboard-permissions/", "/docs/grafana/latest/permissions/dashboard_folder_permissions/"] -title = "Manage dashboard permissions" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-dashboard-permissions/ + - /docs/grafana/latest/permissions/dashboard_folder_permissions/ +title: Manage dashboard permissions +weight: 500 +--- # Manage dashboard permissions @@ -74,7 +76,7 @@ This modification is useful for public Grafana installations where you want anon 1. Open the Grafana configuration file. - For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../administration/configuration" >}}). + For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../setup-grafana/configure-grafana/" >}}). 1. Locate the `viewers_can_edit` parameter. 1. Set the `viewers_can_edit` value to `true`. @@ -142,4 +144,4 @@ Dashboard permissions settings: Result: You receive an error message that cannot override a higher permission with a lower permission in the same dashboard. User1 has administrator permissions. -> Refer to [Role-based access Control]({{< relref "../../../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how to use RBAC permissions to restrict access to dashboards, folders, administrative functions, and other resources. +> Refer to [Role-based access Control]({{< relref "../../../enterprise/access-control/" >}}) in Grafana Enterprise to understand how to use RBAC permissions to restrict access to dashboards, folders, administrative functions, and other resources. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/_index.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/_index.md index 7b8b0454d27..a2c8622894a 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/_index.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/", "/docs/grafana/latest/manage-users/org-admin/"] -title = "Manage users in an organization" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/ + - /docs/grafana/latest/manage-users/org-admin/ +title: Manage users in an organization +weight: 400 +--- # Manage users in an organization diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions.md index 70bee3ae264..ab16398e009 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions/"] -title = "Change a user's organization permissions" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/change-user-org-permissions/ +title: Change a user's organization permissions +weight: 30 +--- # Change a user's organization permissions @@ -24,4 +25,4 @@ Update user permissions when you want to enhance or restrict a user's access to 1. Select the role that you want to assign. 1. Click **Update**. -> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can also [change a user's organization permissions]({{< relref "../../manage-users-and-permissions/manage-server-users/change-user-org-permissions.md" >}}) in the Server Admin section. +> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [change a user's organization permissions]({{< relref "../manage-server-users/change-user-org-permissions/" >}}) in the Server Admin section. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org.md index 7ae875e82c7..5581c8152e7 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org/"] -title = "Invite a user to join an organization" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/invite-user-join-org/ +title: Invite a user to join an organization +weight: 10 +--- # Invite a user to join an organization @@ -11,7 +12,7 @@ When you invite users to join an organization, you assign the **Admin**, **Edito - If you know that the user already has access Grafana and you know their user name, then you issue an invitation by entering their user name. - If the user is new to Grafana, then use their email address to issue an invitation. The system automatically creates the user account on first sign in. -> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can also manually [add a user to an organization]({{< relref "../../manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md" >}}). +> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can also manually [add a user to an organization]({{< relref "../manage-server-users/add-remove-user-to-org/" >}}). ## Before you begin @@ -34,7 +35,7 @@ When you invite users to join an organization, you assign the **Admin**, **Edito | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Email or username | Either the email or username that the user will use to sign in to Grafana. | | Name | The user's name. | - | Role | Click the organization role to assign this user. For more information about organization roles, refer to [Organization roles]({{< relref "../about-users-and-permissions#organization-roles" >}}).. | + | Role | Click the organization role to assign this user. For more information about organization roles, refer to [Organization roles]({{< relref "../about-users-and-permissions/#organization-roles" >}}).. | | Send invite email | Switch to on if your organization has configured. The system sends an email to the user inviting them to sign in to Grafana and join the organization. Switch to off if you are not using email. The user can sign in to Grafana with the email or username you entered. | 1. Click **Submit**. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites.md index a48079703b9..92a2a5a1809 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites/"] -title = "Manage a pending invitation" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/manage-pending-invites/ +title: Manage a pending invitation +weight: 20 +--- # Manage a pending invitation diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org.md index cdc8348e9d7..b93d188c98b 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org/"] -title = "Remove a user from an organization" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/remove-user-from-org/ +title: Remove a user from an organization +weight: 40 +--- # Remove a user from an organization @@ -24,4 +25,4 @@ This action does not remove the user account from the Grafana server. 1. Click the red **X** to remove the user from the organization. -> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can also [remove a user from an organization]({{< relref "../../manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md#remove-a-user-from-an-organization" >}}) on the Users page of the Server Admin section. +> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [remove a user from an organization]({{< relref "../manage-server-users/add-remove-user-to-org/#remove-a-user-from-an-organization" >}}) on the Users page of the Server Admin section. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-org-users/view-list-org-users.md b/docs/sources/administration/manage-users-and-permissions/manage-org-users/view-list-org-users.md index cf03ec5db9a..9f66c0cedda 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-org-users/view-list-org-users.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-org-users/view-list-org-users.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/view-list-org-users/"] -title = "View a list of organization users" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-org-users/view-list-org-users/ +title: View a list of organization users +weight: 50 +--- # View a list of organization users @@ -19,4 +20,4 @@ You can see a list of users with accounts in your Grafana organization. If neces ![Org Admin user list](/static/img/docs/manage-users/org-user-list-7-3.png) -> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can also [view a global list of users]({{< relref "../../manage-users-and-permissions/manage-server-users/view-list-users.md" >}}) in the Server Admin section of Grafana. +> **Note:** If you have [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [view a global list of users]({{< relref "../manage-server-users/view-list-users/" >}}) in the Server Admin section of Grafana. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/_index.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/_index.md index 867789bcf12..49e0c59fe1f 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/_index.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/_index.md @@ -1,17 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/", "/docs/grafana/latest/manage-users/server-admin/", "/docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/"] -title = "Manage users globally" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/ + - /docs/grafana/latest/manage-users/server-admin/ + - /docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/ +title: Manage users globally +weight: 300 +--- # Manage users globally A _user_ is defined as any individual who can log in to Grafana. Each user is associated with a _role_ that includes _permissions_. Permissions determine the tasks a user can perform in the system. -If you have [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions in Grafana, you can manage all users for a Grafana instance in the Server Admin section: +If you have [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions in Grafana, you can manage all users for a Grafana instance in the Server Admin section: {{< section >}} -If you have [organization administrator]({{< relref "../about-users-and-permissions.md#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, refer to [Manage users in a organization]({{< relref "../../manage-users-and-permissions/manage-org-users/_index.md" >}}). +If you have [organization administrator]({{< relref "../about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, refer to [Manage users in a organization]({{< relref "../manage-org-users/" >}}). -For more information about users and permissions, refer to [About users and permissions]({{< relref "../about-users-and-permissions" >}}). +For more information about users and permissions, refer to [About users and permissions]({{< relref "../about-users-and-permissions/" >}}). diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md index 31767666dbd..874bc39dae9 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org/", "/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user-to-org/"] -title = "Add or remove a user from an organization" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org/ + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user-to-org/ +title: Add or remove a user from an organization +weight: 30 +--- # Add a user to an organization @@ -12,8 +14,8 @@ You are required to specify an Admin role for each organization. The first user ## Before you begin -- [Create an organization]({{< relref "../../manage-organizations/_index.md" >}}) -- [Add a user]({{< relref "./add-user.md" >}}) to Grafana +- [Create an organization]({{< relref "../../manage-organizations/" >}}) +- [Add a user]({{< relref "add-user/" >}}) to Grafana - Ensure you have Grafana server administrator privileges **To add a user to an organization**: @@ -30,7 +32,7 @@ You are required to specify an Admin role for each organization. The first user The next time the user signs in, they will be able to navigate to their new organization using the Switch Organizations option in the user profile menu. -> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions.md#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can still [invite a user to join an organization]({{< relref "../../manage-users-and-permissions/manage-org-users/invite-user-join-org.md" >}}). +> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [invite a user to join an organization]({{< relref "../manage-org-users/invite-user-join-org/" >}}). # Remove a user from an organization @@ -48,4 +50,4 @@ Remove a user from an organization when they no longer require access to the das 1. In the **Organization** section, click **Remove from organization** next to the organization from which you want to remove the user. 1. Click **Confirm removal**. -> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions.md#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can still [remove a user from an organization]({{< relref "../../manage-users-and-permissions/manage-org-users/remove-user-from-org.md" >}}) in the Users section of organization configuration. +> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [remove a user from an organization]({{< relref "../manage-org-users/remove-user-from-org/" >}}) in the Users section of organization configuration. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-user.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-user.md index 7033dce3749..87f626f037c 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-user.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/add-user.md @@ -1,14 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user/"] -title = "Add a user" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user/ +title: Add a user +weight: 10 +--- # Add a user Add users when you want to manually provide individuals with access to Grafana. -When you create a user using this method, you must create their password. The user does not receive a notification by email. To invite a user to Grafana and allow them to create their own password, [invite a user to join an organization]({{< relref "../manage-org-users/invite-user-join-org.md" >}}). +When you create a user using this method, you must create their password. The user does not receive a notification by email. To invite a user to Grafana and allow them to create their own password, [invite a user to join an organization]({{< relref "../manage-org-users/invite-user-join-org/" >}}). When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth proxy, users are created automatically. @@ -23,6 +24,6 @@ When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth 1. Click **New user**. 1. Complete the fields and click **Create user**. -When you create a user, the system assigns the user viewer permissions in a default organization, which you can change. You can now [add a user to a second organization]({{< relref "./add-remove-user-to-org.md" >}}). +When you create a user, the system assigns the user viewer permissions in a default organization, which you can change. You can now [add a user to a second organization]({{< relref "add-remove-user-to-org/" >}}). -> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions.md#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can still add users by [inviting a user to join an organization]({{< relref "../../manage-users-and-permissions/manage-org-users/invite-user-join-org.md" >}}). +> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still add users by [inviting a user to join an organization]({{< relref "../manage-org-users/invite-user-join-org/" >}}). diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges.md index 219d390aea2..3c569ba851e 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges/"] -title = "Assign or remove Grafana server administrator privileges" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges/ +title: Assign or remove Grafana server administrator privileges +weight: 20 +--- # Assign or remove Grafana server administrator privileges @@ -12,7 +13,7 @@ Grafana server administrators are responsible for creating users, organizations, ## Before you begin -- [Add a user]({{< relref "./add-user.md" >}}) +- [Add a user]({{< relref "add-user/" >}}) - Ensure you have Grafana server administrator privileges **To assign or remove Grafana administrator privileges**: diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions.md index 1ca6cee6dbc..970c3de590f 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions/"] -title = "Change a user's organization permissions" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions/ +title: Change a user's organization permissions +weight: 50 +--- # Change a user's organization permissions @@ -10,7 +11,7 @@ Update organization permissions when you want to enhance or restrict a user's ac ## Before you begin -- [Add a user to an organization]({{< relref "./add-remove-user-to-org.md" >}}) +- [Add a user to an organization]({{< relref "add-remove-user-to-org/" >}}) - Ensure you have Grafana server administrator privileges **To change a user's organization permissions**: diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/force-user-logout.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/force-user-logout.md index 3c9199bf881..0cf4c9d87f9 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/force-user-logout.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/force-user-logout.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/force-user-logout/"] -title = "Force a user to logout from Grafana" -weight = 90 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/force-user-logout/ +title: Force a user to logout from Grafana +weight: 90 +--- # Force a user to log out of Grafana diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions.md index 1664e9c1fea..99f6bfa3166 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions/"] -title = "Grant editors administrator permissions" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions/ +title: Grant editors administrator permissions +weight: 60 +--- # Grant editors administrator permissions @@ -12,8 +13,8 @@ This setting can be used to enable self-organizing teams to administer their own When `editors_can_admin` is enabled: -- Users with the Editor role in an organization are Administrators for new dashboards and folders they create, meaning they can edit dashboard permissions. To learn more about dashboard permissions, refer to [Manage dashboard permissions]({{< relref "../manage-dashboard-permissions/_index.md" >}}). -- Users with the Editor role in an organization can create teams, and they are Administrators of the teams they create. To learn more about team permissions, refer to [Manage teams]({{< relref "../manage-teams/_index.md" >}}) +- Users with the Editor role in an organization are Administrators for new dashboards and folders they create, meaning they can edit dashboard permissions. To learn more about dashboard permissions, refer to [Manage dashboard permissions]({{< relref "../manage-dashboard-permissions/" >}}). +- Users with the Editor role in an organization can create teams, and they are Administrators of the teams they create. To learn more about team permissions, refer to [Manage teams]({{< relref "../manage-teams/" >}}) > **Note**: If you use Grafana Enterprise and customize users' permissions using RBAC, the RBAC permissions override the functionality enabled by the `editors_can_admin` flag. @@ -25,7 +26,7 @@ When `editors_can_admin` is enabled: 1. Log in to the Grafana server and open the Grafana configuration file. - For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../administration/configuration" >}}). + For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../setup-grafana/configure-grafana/" >}}). 1. Locate the `editors_can_admin` parameter. 1. Set the `editors_can_admin` value to `true`. diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account.md index 03fce48d967..84859121220 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account/", "/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-user-account-details/"] -title = "View and edit a user account" -weight = 110 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account/ + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-user-account-details/ +title: View and edit a user account +weight: 110 +--- # View user details diff --git a/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-list-users.md b/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-list-users.md index a0e2eed8de2..949cf581957 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-list-users.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-server-users/view-list-users.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-list-users/"] -title = "View a list of users" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-list-users/ +title: View a list of users +weight: 100 +--- # View a list of users @@ -19,4 +20,4 @@ You can see a list of users with accounts on your Grafana server. This action mi ![Server Admin user list](/static/img/docs/manage-users/server-user-list-7-3.png) -> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions.md#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions.md#grafana-server-administrators" >}}) permissions, you can still [view of list of users in a given organization]({{< relref "../../manage-users-and-permissions/manage-org-users/view-list-org-users.md" >}}). +> **Note:** If you have [organization administrator]({{< relref "../about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [view of list of users in a given organization]({{< relref "../manage-org-users/view-list-org-users/" >}}). diff --git a/docs/sources/administration/manage-users-and-permissions/manage-teams/_index.md b/docs/sources/administration/manage-users-and-permissions/manage-teams/_index.md index b6a631a5afe..ad7b15c71e2 100644 --- a/docs/sources/administration/manage-users-and-permissions/manage-teams/_index.md +++ b/docs/sources/administration/manage-users-and-permissions/manage-teams/_index.md @@ -1,8 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/administration/manage-users-and-permissions/manage-teams/", "/docs/grafana/latest/manage-users/add-or-remove-user-from-team/", "/docs/grafana/latest/manage-users/create-or-remove-team/", "/docs/grafana/latest/manage-users/manage-teams/"] -title = "Manage teams" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/administration/manage-users-and-permissions/manage-teams/ + - /docs/grafana/latest/manage-users/add-or-remove-user-from-team/ + - /docs/grafana/latest/manage-users/create-or-remove-team/ + - /docs/grafana/latest/manage-users/manage-teams/ +title: Manage teams +weight: 600 +--- # Manage teams diff --git a/docs/sources/administration/preferences/_index.md b/docs/sources/administration/preferences/_index.md index c93e126d798..4125ac3d532 100644 --- a/docs/sources/administration/preferences/_index.md +++ b/docs/sources/administration/preferences/_index.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/preferences/"] -title = "Preferences" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/administration/preferences/ +title: Preferences +weight: 50 +--- # Grafana preferences @@ -10,9 +11,9 @@ Grafana preferences are basic settings. They control the Grafana UI theme, home Preferences are sometimes confusing because they can be set at four different levels, listed from highest level to lowest: -- **Server -** Affects all users on the Grafana server. Set by a [Grafana server admin]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#grafana-server-administrators" >}}). -- **Organization -** Affects all users in an organization. Set by an [Organization admin]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#organization-roles" >}}). -- **Team -** Affects all users assigned to a team. Set by an Organization Admin or Team Admin. To learn more about these roles, refer to [Teams and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#teams-and-permissions" >}}). +- **Server -** Affects all users on the Grafana server. Set by a [Grafana server admin]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#grafana-server-administrators" >}}). +- **Organization -** Affects all users in an organization. Set by an [Organization admin]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#organization-roles" >}}). +- **Team -** Affects all users assigned to a team. Set by an Organization Admin or Team Admin. To learn more about these roles, refer to [Teams and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#teams-and-permissions" >}}). - **User account -** Affects the individual user. Set by the user on their own account. The lowest level always takes precedence. For example, if a user sets their theme to **Light**, then their visualization of Grafana displays the light theme. Nothing at any higher level can override that. diff --git a/docs/sources/administration/preferences/change-grafana-name.md b/docs/sources/administration/preferences/change-grafana-name.md index 9c043c90d3e..a5ffc60e2ff 100644 --- a/docs/sources/administration/preferences/change-grafana-name.md +++ b/docs/sources/administration/preferences/change-grafana-name.md @@ -1,9 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/administration/preferences/change-grafana-name/"] -keywords = ["grafana", "configuration", "documentation", "home"] -title = "Change name and email" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/administration/preferences/change-grafana-name/ +keywords: + - grafana + - configuration + - documentation + - home +title: Change name and email +weight: 100 +--- # Change Grafana name and email @@ -54,4 +59,4 @@ To change the team name or email, follow these steps: ## Change user name or email -To learn how to edit your user information, refer to [Edit your profile]({{< relref "../manage-user-preferences/_index.md#edit-your-profile" >}}). +To learn how to edit your user information, refer to [Edit your profile]({{< relref "../manage-user-preferences/#edit-your-profile" >}}). diff --git a/docs/sources/administration/preferences/change-grafana-theme.md b/docs/sources/administration/preferences/change-grafana-theme.md index 27de9025370..742ab5ed0d7 100644 --- a/docs/sources/administration/preferences/change-grafana-theme.md +++ b/docs/sources/administration/preferences/change-grafana-theme.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/administration/preferences/change-grafana-theme/"] -description = "How to set the Grafana UI theme" -keywords = ["grafana", "configuration", "documentation", "home"] -title = "Change UI theme" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/administration/preferences/change-grafana-theme/ +description: How to set the Grafana UI theme +keywords: + - grafana + - configuration + - documentation + - home +title: Change UI theme +weight: 200 +--- # Change Grafana UI theme @@ -34,9 +39,9 @@ Here is an example of the light theme. ## Change server UI theme -Grafana server administrators can change the Grafana UI theme for all users on the server by setting the [default_theme]({{< relref "../configuration.md#default-theme" >}}) option in the Grafana configuration file. +Grafana server administrators can change the Grafana UI theme for all users on the server by setting the [default_theme]({{< relref "../../setup-grafana/configure-grafana/#default-theme" >}}) option in the Grafana configuration file. -To see what the current settings are, refer to [View server settings]({{< relref "../view-server/view-server-settings.md" >}}). +To see what the current settings are, refer to [View server settings]({{< relref "../view-server/view-server-settings/" >}}). ## Change organization UI theme diff --git a/docs/sources/administration/preferences/change-grafana-timezone.md b/docs/sources/administration/preferences/change-grafana-timezone.md index 95f832743d2..ea2e917932f 100644 --- a/docs/sources/administration/preferences/change-grafana-timezone.md +++ b/docs/sources/administration/preferences/change-grafana-timezone.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/administration/preferences/change-grafana-timezone/"] -description = "How to change your Grafana timezone" -keywords = ["grafana", "configuration", "documentation", "home"] -title = "Change default timezone" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/administration/preferences/change-grafana-timezone/ +description: How to change your Grafana timezone +keywords: + - grafana + - configuration + - documentation + - home +title: Change default timezone +weight: 400 +--- # Change the Grafana default timezone @@ -14,7 +19,7 @@ By default, Grafana uses the timezone in your web browser. However, you can over ## Set server timezone -Grafana server administrators can choose a default timezone for all users on the server by setting the [default_timezone]({{< relref "../configuration.md#default-timezone" >}}) option in the Grafana configuration file. +Grafana server administrators can choose a default timezone for all users on the server by setting the [default_timezone]({{< relref "../../setup-grafana/configure-grafana/#default-timezone" >}}) option in the Grafana configuration file. ## Set organization timezone diff --git a/docs/sources/administration/preferences/change-home-dashboard.md b/docs/sources/administration/preferences/change-home-dashboard.md index 2f5bbce5ad2..af02a8d6fb1 100644 --- a/docs/sources/administration/preferences/change-home-dashboard.md +++ b/docs/sources/administration/preferences/change-home-dashboard.md @@ -1,10 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/administration/change-home-dashboard/", "/docs/grafana/latest/administration/preferences/change-home-dashboard/"] -description = "How to replace the default home dashboard" -keywords = ["grafana", "configuration", "documentation", "home"] -title = "Change home dashboard" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/administration/change-home-dashboard/ + - /docs/grafana/latest/administration/preferences/change-home-dashboard/ +description: How to replace the default home dashboard +keywords: + - grafana + - configuration + - documentation + - home +title: Change home dashboard +weight: 300 +--- # Change the default home dashboard @@ -32,7 +38,7 @@ Users with the Grafana Server Admin flag on their account or access to the confi ### Use a JSON file as the home dashboard 1. Save your JSON file somewhere that Grafana can access it. For example, in the Grafana `data` folder of Grafana. -1. Update your configuration file to set the path to the JSON file. Refer to [default_home_dashboard_path]({{< relref "../configuration.md#default_home_dashboard_path" >}}) for more information about modifying the Grafana configuration files. +1. Update your configuration file to set the path to the JSON file. Refer to [default_home_dashboard_path]({{< relref "../../setup-grafana/configure-grafana/#default_home_dashboard_path" >}}) for more information about modifying the Grafana configuration files. ```ini [dashboards] diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md index 239122405f9..eda7e20eeb0 100644 --- a/docs/sources/administration/provisioning.md +++ b/docs/sources/administration/provisioning.md @@ -1,10 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/administration/provisioning/", "/docs/grafana/latest/installation/provisioning/"] -description = "" -keywords = ["grafana", "provisioning"] -title = "Provisioning" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/administration/provisioning/ + - /docs/grafana/latest/installation/provisioning/ +description: '' +keywords: + - grafana + - provisioning +title: Provisioning +weight: 800 +--- # Provisioning Grafana @@ -12,7 +16,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat ## Config File -Check out the [configuration]({{< relref "configuration.md" >}}) page for more information on what you can configure in `grafana.ini` +Check out the [configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) page for more information on what you can configure in `grafana.ini` ### Config File Locations @@ -94,8 +98,6 @@ datasources: uid: my_unique_uid # url url: http://localhost:8080 - # Deprecated, use secureJsonData.password - password: # database user, if used user: # database name, if used @@ -104,8 +106,6 @@ datasources: basicAuth: # basic auth username basicAuthUser: - # Deprecated, use secureJsonData.basicAuthPassword - basicAuthPassword: # enable/disable with credentials headers withCredentials: # mark as default datasource. Max one per org @@ -194,7 +194,7 @@ Since not all datasources have the same configuration settings we only have the `{"authType":"keys","defaultRegion":"us-west-2","timeField":"@timestamp"}` -Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "configuration.md#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. +Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "../setup-grafana/configure-grafana/#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. > **Note:** Datasources tagged with _HTTP\*_ below denotes any data source which communicates using the HTTP protocol, e.g. all core data source plugins except MySQL, PostgreSQL and MSSQL. @@ -233,7 +233,7 @@ datasources: > This feature is available from v7.1 -You can manage plugins in Grafana by adding one or more YAML config files in the [`provisioning/plugins`]({{< relref "configuration.md#provisioning" >}}) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file. +You can manage plugins in Grafana by adding one or more YAML config files in the [`provisioning/plugins`]({{< relref "../setup-grafana/configure-grafana/#provisioning" >}}) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file. ### Example plugin configuration file @@ -261,7 +261,7 @@ apps: ## Dashboards -You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`]({{< relref "configuration.md" >}}) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. +You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`]({{< relref "../setup-grafana/configure-grafana/" >}}) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. The dashboard provider config file looks somewhat like this: @@ -316,7 +316,7 @@ Note: The JSON definition in the input field when using `Copy JSON to Clipboard` ### Reusable Dashboard URLs -If the dashboard in the JSON file contains an [UID]({{< relref "../dashboards/json-model.md" >}}), Grafana forces insert/update on that UID. This allows you to migrate dashboards between Grafana instances and provisioning Grafana from configuration without breaking the URLs given because the new dashboard URL uses the UID as identifier. +If the dashboard in the JSON file contains an [UID]({{< relref "../dashboards/json-model/" >}}), Grafana forces insert/update on that UID. This allows you to migrate dashboards between Grafana instances and provisioning Grafana from configuration without breaking the URLs given because the new dashboard URL uses the UID as identifier. When Grafana starts, it updates/inserts all dashboards available in the configured folders. If you modify the file, then the dashboard is also updated. By default, Grafana deletes dashboards in the database if the file is removed. You can disable this behavior using the `disableDeletion` setting. @@ -601,4 +601,4 @@ The following sections detail the supported settings and secure settings for eac Grafana Enterprise supports provisioning for the following resources: -- [Role-based access control provisioning]({{< relref "../enterprise/access-control/rbac-provisioning.md" >}}) +- [Role-based access control provisioning]({{< relref "../enterprise/access-control/rbac-provisioning/" >}}) diff --git a/docs/sources/administration/service-accounts/about-service-accounts.md b/docs/sources/administration/service-accounts/about-service-accounts.md index 8d0737ed0f0..042a29dd063 100644 --- a/docs/sources/administration/service-accounts/about-service-accounts.md +++ b/docs/sources/administration/service-accounts/about-service-accounts.md @@ -11,7 +11,7 @@ weight: 30 A service account can be used to run automated workloads in Grafana, like dashboard provisioning, configuration, or report generation. Create service accounts and tokens to authenticate applications like Terraform with the Grafana API. -> **Note:** Service accounts are available in Grafana 8.5+ as a beta feature. To enable service accounts, refer to [Enable service accounts]({{< relref "./enable-service-accounts.md#" >}}) section. Service accounts will eventually replace [API keys]({{< relref "../api-keys/_index.md" >}}) as the primary way to authenticate applications that interact with Grafana. +> **Note:** Service accounts are available in Grafana 8.5+ as a beta feature. To enable service accounts, refer to [Enable service accounts]({{< relref "enable-service-accounts/#" >}}) section. Service accounts will eventually replace [API keys]({{< relref "../api-keys/" >}}) as the primary way to authenticate applications that interact with Grafana. A common use case for creating a service account is to perform operations on automated or triggered tasks. You can use service accounts to: @@ -20,7 +20,7 @@ A common use case for creating a service account is to perform operations on aut - Set up an external SAML authentication provider - Interact with Grafana without signing in as a user -In [Grafana Enterprise]({{< relref "../../enterprise/_index.md" >}}), you can also use service accounts in combination with [role-based access control]({{< relref "../../enterprise/access-control/about-rbac.md" >}}) to grant very specific permissions to applications that interact with Grafana. +In [Grafana Enterprise]({{< relref "../../enterprise/" >}}), you can also use service accounts in combination with [role-based access control]({{< relref "../../enterprise/access-control/about-rbac/" >}}) to grant very specific permissions to applications that interact with Grafana. > **Note:** Service accounts can only act in the organization they are created for. If you have the same task that is needed for multiple organizations, we recommend creating service accounts in each organization. @@ -46,4 +46,4 @@ The added benefits of service accounts to API keys include: - Service accounts resemble Grafana users and can be enabled/disabled, granted specific permissions, and remain active until they are deleted or disabled. API keys are only valid until their expiry date. - Service accounts can be associated with multiple tokens. - Unlike API keys, service account tokens are not associated with a specific user, which means that applications can be authenticated even if a Grafana user is deleted. -- You can grant granular permissions to service accounts by leveraging [fine-grained access control]({{< relref "../../enterprise/access-control" >}}). For more information about permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#" >}}). +- You can grant granular permissions to service accounts by leveraging [fine-grained access control]({{< relref "../../enterprise/access-control/" >}}). For more information about permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#" >}}). diff --git a/docs/sources/administration/service-accounts/add-service-account-token.md b/docs/sources/administration/service-accounts/add-service-account-token.md index a038c33ad2c..ad11a5408c9 100644 --- a/docs/sources/administration/service-accounts/add-service-account-token.md +++ b/docs/sources/administration/service-accounts/add-service-account-token.md @@ -9,14 +9,14 @@ weight: 60 # Add a token to a service account in Grafana -A service account token is a generated random string that acts as an alternative to a password when authenticating with Grafana’s HTTP API. For more information about service accounts, refer to [About service accounts in Grafana]({{< relref "./about-service-accounts.md" >}}). +A service account token is a generated random string that acts as an alternative to a password when authenticating with Grafana’s HTTP API. For more information about service accounts, refer to [About service accounts in Grafana]({{< relref "about-service-accounts/" >}}). -You can create a service account token using the Grafana UI or via the API. For more information about creating a service account token via the API, refer to [Create service account tokens using the HTTP API]({{< relref "../../developers/http_api/serviceaccount.md#create-service-account-tokens" >}}). +You can create a service account token using the Grafana UI or via the API. For more information about creating a service account token via the API, refer to [Create service account tokens using the HTTP API]({{< relref "../../developers/http_api/serviceaccount/#create-service-account-tokens" >}}). ## Before you begin -- Ensure you have added the `serviceAccounts` feature toggle to Grafana. For more information about adding the feature toggle, refer to [Enable service accounts]({{< relref "./enable-service-accounts.md#" >}}). -- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#" >}}). +- Ensure you have added the `serviceAccounts` feature toggle to Grafana. For more information about adding the feature toggle, refer to [Enable service accounts]({{< relref "enable-service-accounts/#" >}}). +- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#" >}}). ## To add a token to a service account diff --git a/docs/sources/administration/service-accounts/create-service-account.md b/docs/sources/administration/service-accounts/create-service-account.md index 2e107a74bd7..bdf9b8141bc 100644 --- a/docs/sources/administration/service-accounts/create-service-account.md +++ b/docs/sources/administration/service-accounts/create-service-account.md @@ -11,14 +11,14 @@ weight: 50 # Create a service account in Grafana -A service account can be used to run automated workloads in Grafana, like dashboard provisioning, configuration, or report generation. For more information about how you can use service accounts, refer to [About service accounts]({{< relref "../service-accounts/about-service-accounts.md#" >}}). +A service account can be used to run automated workloads in Grafana, like dashboard provisioning, configuration, or report generation. For more information about how you can use service accounts, refer to [About service accounts]({{< relref "about-service-accounts/#" >}}). -For more information about creating service accounts via the API, refer to [Create a service account in the HTTP API]({{< relref "../../developers/http_api/serviceaccount.md#create-service-account" >}}). +For more information about creating service accounts via the API, refer to [Create a service account in the HTTP API]({{< relref "../../developers/http_api/serviceaccount/#create-service-account" >}}). ## Before you begin -- Ensure you have added the feature toggle for service accounts `serviceAccounts`. For more information about adding the feature toggle, refer to [Enable service accounts]({{< relref "./enable-service-accounts.md#" >}}). -- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md#" >}}). +- Ensure you have added the feature toggle for service accounts `serviceAccounts`. For more information about adding the feature toggle, refer to [Enable service accounts]({{< relref "enable-service-accounts/#" >}}). +- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/#" >}}). ## To create a service account diff --git a/docs/sources/administration/service-accounts/enable-service-accounts.md b/docs/sources/administration/service-accounts/enable-service-accounts.md index e6b5325ca27..64f2853364c 100644 --- a/docs/sources/administration/service-accounts/enable-service-accounts.md +++ b/docs/sources/administration/service-accounts/enable-service-accounts.md @@ -25,7 +25,7 @@ You can enable service accounts by: This topic shows you how to enable service accounts by modifying the Grafana configuration file. 1. Sign in to the Grafana server and locate the configuration file. For more information about finding the configuration file, refer to LINK. -2. Open the configuration file and locate the [feature toggles section]({{< relref "../../administration/configuration.md#feature_toggles" >}}). Add `serviceAccounts` as a [feature_toggle]({{< relref "../../administration/configuration.md#feature_toggle" >}}). +2. Open the configuration file and locate the [feature toggles section]({{< relref "../../setup-grafana/configure-grafana/#feature_toggles" >}}). Add `serviceAccounts` as a [feature_toggle]({{< relref "../../setup-grafana/configure-grafana/#feature_toggle" >}}). ``` [feature_toggles] @@ -39,6 +39,6 @@ enable = serviceAccounts This topic shows you how to enable service accounts by setting environment variables before starting Grafana. -Follow the instructions to [override configuration with environment variables]({{< relref "../../administration/configuration.md#override-configuration-with-environment-variables" >}}). Set the following environment variable: `GF_FEATURE_TOGGLES_ENABLE = serviceAccounts`. +Follow the instructions to [override configuration with environment variables]({{< relref "../../setup-grafana/configure-grafana/#override-configuration-with-environment-variables" >}}). Set the following environment variable: `GF_FEATURE_TOGGLES_ENABLE = serviceAccounts`. > **Note:** Environment variables override configuration file settings. diff --git a/docs/sources/administration/view-server/_index.md b/docs/sources/administration/view-server/_index.md index 0052604e072..b726bf96b37 100644 --- a/docs/sources/administration/view-server/_index.md +++ b/docs/sources/administration/view-server/_index.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/administration/view-server/"] -title = "View server" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/administration/view-server/ +title: View server +weight: 100 +--- # View server information diff --git a/docs/sources/administration/view-server/view-server-settings.md b/docs/sources/administration/view-server/view-server-settings.md index dbbcd22162e..4c662109c58 100644 --- a/docs/sources/administration/view-server/view-server-settings.md +++ b/docs/sources/administration/view-server/view-server-settings.md @@ -1,18 +1,24 @@ -+++ -aliases = ["/docs/grafana/latest/admin/view-server-settings/", "/docs/grafana/latest/administration/view-server/view-server-settings/"] -description = "How to view server settings in the Grafana UI" -keywords = ["grafana", "configuration", "server", "settings"] -title = "View server settings" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/admin/view-server-settings/ + - /docs/grafana/latest/administration/view-server/view-server-settings/ +description: How to view server settings in the Grafana UI +keywords: + - grafana + - configuration + - server + - settings +title: View server settings +weight: 300 +--- # View Grafana server settings -> Refer to [Role-based access control]({{< relref "../../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. +> Refer to [Role-based access control]({{< relref "../../enterprise/access-control/" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. -If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration]({{< relref "../configuration.md#config-file-locations" >}}) file and any environmental variables. +If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration]({{< relref "../../setup-grafana/configure-grafana/#config-file-locations" >}}) file and any environmental variables. -> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md" >}}). +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/" >}}). ## View server settings @@ -21,4 +27,4 @@ If you are a Grafana server administrator, use the Settings tab to view the sett ## Available settings -For a full list of server settings, refer to [Configuration]({{< relref "../configuration.md" >}}). +For a full list of server settings, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}). diff --git a/docs/sources/administration/view-server/view-server-stats.md b/docs/sources/administration/view-server/view-server-stats.md index 3a8f1f33104..4cd6c623a78 100644 --- a/docs/sources/administration/view-server/view-server-stats.md +++ b/docs/sources/administration/view-server/view-server-stats.md @@ -1,17 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/admin/view-server-stats/", "/docs/grafana/latest/administration/view-server/view-server-stats/"] -keywords = ["grafana", "server", "statistics"] -title = "View server stats" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/admin/view-server-stats/ + - /docs/grafana/latest/administration/view-server/view-server-stats/ +keywords: + - grafana + - server + - statistics +title: View server stats +weight: 400 +--- # View Grafana server stats -> Refer to [Role-based access control]({{< relref "../../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. +> Refer to [Role-based access control]({{< relref "../../enterprise/access-control/" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. If you are a Grafana server admin, then you can view useful statistics about your Grafana server in the Stats & Licensing tab. -> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions.md" >}}). +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [About users and permissions]({{< relref "../manage-users-and-permissions/about-users-and-permissions/" >}}). ## View server stats diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index 72206e75b36..51a173c4b41 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/", "/docs/grafana/latest/alerting/unified-alerting/difference-old-new/"] -title = "Alerting" -weight = 114 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/ + - /docs/grafana/latest/alerting/unified-alerting/alerting/ +title: Alerting +weight: 114 +--- # Grafana alerting @@ -18,18 +20,19 @@ For new installations or existing installs without alerting configured, Grafana | ----------- | ------------- | ------------- | ------------- | | Grafana 9.0 | On by default | On by default | On by default | -- For existing OSS installations with legacy dashboard alerting, you can [opt-in]({{< relref "./opt-in.md" >}}) to Grafana alerting. -- For Grafana Cloud instances using legacy cloud alerting, contact customer support to migrate to Grafana alerting. +Existing installations that upgrade to v9.0 will have Grafana alerting enabled by default. For more information on migrating from legacy or the cloud alerting plugin, see [Migrating to Grafana alerting]({{< relref "migrating-alerts/" >}}). -Before you begin, we recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "./fundamentals/_index.md" >}}) of Grafana alerting. Refer to [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to learn more about controlling access to alerts using role-based permissions. +Before you begin, we recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "fundamentals/" >}}) of Grafana alerting. Refer to [Role-based access control]({{< relref "../enterprise/access-control/" >}}) in Grafana Enterprise to learn more about controlling access to alerts using role-based permissions. -- [Enable Grafana alerting in OSS]({{< relref "./opt-in.md" >}}) -- [Migrating legacy alerts]({{< relref "./migrating-legacy-alerts.md" >}}) -- [Create Grafana managed alerting rules]({{< relref "alerting-rules/create-grafana-managed-rule.md" >}}) -- [Create Grafana Mimir or Loki managed alerting rules]({{< relref "alerting-rules/create-mimir-loki-managed-rule.md" >}}) -- [View existing alerting rules and manage their current state]({{< relref "alerting-rules/rule-list.md" >}}) -- [View the state and health of alerting rules]({{< relref "./fundamentals/state-and-health.md" >}}) -- [View alert groupings]({{< relref "./alert-groups/_index.md" >}}) -- [Add or edit an alert contact point]({{< relref "./contact-points/_index.md" >}}) -- [Add or edit notification policies]({{< relref "./notifications/_index.md" >}}) -- [Add or edit silences]({{< relref "./silences/_index.md" >}}) +- [About alert rules]({{< relref "fundamentals/alert-rules/" >}}) +- [Migrating legacy alerts]({{< relref "migrating-alerts/" >}}) +- [Disable Grafana alerting in OSS]({{< relref "migrating-alerts/opt-out/" >}}) +- [Create Grafana managed alerting rules]({{< relref "alerting-rules/create-grafana-managed-rule/" >}}) +- [Create Grafana Mimir or Loki managed alerting rules]({{< relref "alerting-rules/create-mimir-loki-managed-rule/" >}}) +- [View existing alerting rules and manage their current state]({{< relref "alerting-rules/rule-list/" >}}) +- [View the state and health of alerting rules]({{< relref "fundamentals/state-and-health/" >}}) +- [View alert groupings]({{< relref "alert-groups/" >}}) +- [Add or edit an alert contact point]({{< relref "contact-points/" >}}) +- [Add or edit notification policies]({{< relref "notifications/" >}}) +- [Add or edit silences]({{< relref "silences/" >}}) +- [Performance considerations for alerting]({{< relref "performance/" >}}) diff --git a/docs/sources/alerting/about-alerting.md b/docs/sources/alerting/about-alerting.md index f96eaccedd2..c4d35a80402 100644 --- a/docs/sources/alerting/about-alerting.md +++ b/docs/sources/alerting/about-alerting.md @@ -1,26 +1,33 @@ -+++ -title = "About Grafana alerting" -description = "A quick overview of Grafana alerting" -keywords = ["grafana", "alerting", "overview", "concepts", "basics"] -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/about-alerting/ +description: A quick overview of Grafana alerting +keywords: + - grafana + - alerting + - overview + - concepts + - basics +title: About Grafana alerting +weight: 100 +--- # About Grafana alerting Grafana Alerting consists of several individual concepts that are at the core of a flexible and powerful alerting engine. -This topic explains how to create [alert rules]({{< relref "./about-alert-rules/_index.md" >}}), their relationship with [alert instances]({{< relref "./about-alert-rules/alert-instances.md" >}}) and the various alert rule [states and transitions]({{< relref "./fundamentals/state-and-health.md" >}}), [notification policies]({{< relref "./notifications/_index.md" >}}) and [contact points]({{< relref "./contact-points/_index.md" >}}). +This topic explains how to create [alert rules]({{< relref "fundamentals/alert-rules/" >}}), their relationship with [alert instances]({{< relref "fundamentals/alert-rules/alert-instances/" >}}) and the various alert rule [states and transitions]({{< relref "fundamentals/state-and-health/" >}}), [notification policies]({{< relref "notifications/" >}}) and [contact points]({{< relref "contact-points/" >}}). These three individual concepts are the minimum necessities to successfully create alerts and receive notifications. -We will also touch on various other concepts such as [silences]({{< relref "./silences/_index.md" >}}) and [mute timings]({{< relref "./notifications/mute-timings.md" >}}) to more granularly manage alert notifications, [role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) to limit access and manage permissions and additional advanced topics such as [external alertmanagers]({{< relref "./fundamentals/alertmanager.md#add-a-new-external-alertmanager" >}}) and [high availability]({{< relref "./high-availability/_index.md" >}}). +We will also touch on various other concepts such as [silences]({{< relref "silences/" >}}) and [mute timings]({{< relref "notifications/mute-timings/" >}}) to more granularly manage alert notifications, [role-based access control]({{< relref "../enterprise/access-control/" >}}) to limit access and manage permissions and additional advanced topics such as [external alertmanagers]({{< relref "fundamentals/alertmanager/#add-a-new-external-alertmanager" >}}) and [high availability]({{< relref "high-availability/" >}}). ## Overview {{< figure src="/static/img/docs/alerting/unified/about-alerting-flow-diagram.jpg" caption="Grafana alerting overview" >}} -As shown in the diagram above, Grafana alerting uses [labels]({{< relref "./fundamentals/annotation-label/how-to-use-labels.md" >}}) to match an alert rule and its instances to a specific notification policy. This concept of labels and label matching is important and is also used in [silences]({{< relref "./silences/_index.md" >}}). +As shown in the diagram above, Grafana alerting uses [labels]({{< relref "fundamentals/annotation-label/how-to-use-labels/" >}}) to match an alert rule and its instances to a specific notification policy. This concept of labels and label matching is important and is also used in [silences]({{< relref "silences/" >}}). -Each notification policy specifies a set of [label matchers]({{< relref "./fundamentals/annotation-label/labels-and-label-matchers.md" >}}) to indicate what alerts they are responsible for. +Each notification policy specifies a set of [label matchers]({{< relref "fundamentals/annotation-label/labels-and-label-matchers/" >}}) to indicate what alerts they are responsible for. -A notification policy has a [contact point]({{< relref "./contact-points/_index.md" >}}) assigned to it that consists of one or more [notifiers]({{< relref "./contact-points/_index.md#list-of-notifiers-supported-by-grafana" >}}). +A notification policy has a [contact point]({{< relref "contact-points/" >}}) assigned to it that consists of one or more [notifiers]({{< relref "contact-points/#list-of-notifiers-supported-by-grafana" >}}). diff --git a/docs/sources/alerting/alert-groups/_index.md b/docs/sources/alerting/alert-groups/_index.md index 0951ad5eb4a..a0de79245a3 100644 --- a/docs/sources/alerting/alert-groups/_index.md +++ b/docs/sources/alerting/alert-groups/_index.md @@ -1,16 +1,22 @@ -+++ -title = "Alert groups" -description = "Alert groups" -keywords = ["grafana", "alerting", "alerts", "groups"] -weight = 445 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/alert-groups/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alert-groups/ + - /docs/grafana/latest/alerting/unified-alerting/alert-groups/ +description: Alert groups +keywords: + - grafana + - alerting + - alerts + - groups +title: Alert groups +weight: 445 +--- # Alert groups -Alert groups show grouped alerts from an Alertmanager instance. By default, the alerts are grouped by the label keys for the root policy in [notification policies]({{< relref "../notifications/_index.md" >}}). Grouping common alerts into a single alert group prevents duplicate alerts from being fired. +Alert groups show grouped alerts from an Alertmanager instance. By default, the alerts are grouped by the label keys for the root policy in [notification policies]({{< relref "../notifications/" >}}). Grouping common alerts into a single alert group prevents duplicate alerts from being fired. For more information, see: -- [View alert groupings]({{< relref "./view-alert-grouping.md" >}}) -- [Filter alerts by group]({{< relref "./filter-alerts.md" >}}) +- [View alert groupings]({{< relref "view-alert-grouping/" >}}) +- [Filter alerts by group]({{< relref "filter-alerts/" >}}) diff --git a/docs/sources/alerting/alert-groups/filter-alerts.md b/docs/sources/alerting/alert-groups/filter-alerts.md index 778721bb8cc..b946db6c479 100644 --- a/docs/sources/alerting/alert-groups/filter-alerts.md +++ b/docs/sources/alerting/alert-groups/filter-alerts.md @@ -1,10 +1,16 @@ -+++ -title = "Filter alerts" -description = "Alert groups" -keywords = ["grafana", "alerting", "alerts", "groups"] -weight = 445 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/alert-groups/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alert-groups/filter-alerts/ + - /docs/grafana/latest/alerting/unified-alerting/alert-groups/ +description: Alert groups +keywords: + - grafana + - alerting + - alerts + - groups +title: Filter alerts +weight: 445 +--- # Filter alerts by group diff --git a/docs/sources/alerting/alert-groups/view-alert-grouping.md b/docs/sources/alerting/alert-groups/view-alert-grouping.md index ea911b291c2..f92a90087ca 100644 --- a/docs/sources/alerting/alert-groups/view-alert-grouping.md +++ b/docs/sources/alerting/alert-groups/view-alert-grouping.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alert-groups/", "/docs/grafana/latest/alerting/unified-alerting/alert-groups/"] -description = "Alert groups" -keywords = ["grafana", "alerting", "alerts", "groups"] -title = "View alert groupings" -weight = 445 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alert-groups/ + - /docs/grafana/latest/alerting/alert-groups/view-alert-grouping/ + - /docs/grafana/latest/alerting/unified-alerting/alert-groups/ +description: Alert groups +keywords: + - grafana + - alerting + - alerts + - groups +title: View alert groupings +weight: 445 +--- # View alert groupings diff --git a/docs/sources/alerting/alerting-limitations.md b/docs/sources/alerting/alerting-limitations.md index 82094f19cde..1efc1fffeea 100644 --- a/docs/sources/alerting/alerting-limitations.md +++ b/docs/sources/alerting/alerting-limitations.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-limitations/"] -title = "Limitations" -weight = 552 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-limitations/ +title: Limitations +weight: 552 +--- # Limitations diff --git a/docs/sources/alerting/alerting-rules/_index.md b/docs/sources/alerting/alerting-rules/_index.md index c7c038200e7..e121804910a 100644 --- a/docs/sources/alerting/alerting-rules/_index.md +++ b/docs/sources/alerting/alerting-rules/_index.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/", "/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/"] -title = "Create and manage rules" -weight = 130 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/ + - /docs/grafana/latest/alerting/rules/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/ +title: Create and manage rules +weight: 130 +--- # Create and manage Grafana alerting rules @@ -12,9 +15,9 @@ While queries and expressions select the data set to evaluate, a condition sets You can: -- [Create Grafana Mimir or Loki managed alert rule]({{< relref "./create-mimir-loki-managed-rule.md" >}}) -- [Create Grafana Mimir or Loki managed recording rule]({{< relref "./create-mimir-loki-managed-recording-rule.md" >}}) -- [Edit Grafana Mimir or Loki rule groups and namespaces]({{< relref "./edit-mimir-loki-namespace-group.md" >}}) -- [Create Grafana managed alert rule]({{< relref "./create-grafana-managed-rule.md" >}}) -- [State and health of alerting rules]({{< relref "../fundamentals/state-and-health.md" >}}) -- [Manage alerting rules]({{< relref "./rule-list.md" >}}) +- [Create Grafana Mimir or Loki managed alert rule]({{< relref "create-mimir-loki-managed-rule/" >}}) +- [Create Grafana Mimir or Loki managed recording rule]({{< relref "create-mimir-loki-managed-recording-rule/" >}}) +- [Edit Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}) +- [Create Grafana managed alert rule]({{< relref "create-grafana-managed-rule/" >}}) +- [State and health of alerting rules]({{< relref "../fundamentals/state-and-health/" >}}) +- [Manage alerting rules]({{< relref "rule-list/" >}}) diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 6c577300a35..3d2b68d2b0f 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -1,41 +1,48 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule/"] -description = "Create Grafana managed alert rule" -keywords = ["grafana", "alerting", "guide", "rules", "create"] -title = "Create Grafana managed alert rule" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule/ +description: Create Grafana managed alert rule +keywords: + - grafana + - alerting + - guide + - rules + - create +title: Create Grafana managed alert rule +weight: 400 +--- # Create a Grafana managed alerting rule -Grafana allows you to create alerting rules that query one or more data sources, reduce or transform the results and compare them to each other or to fix thresholds. When these are executed, Grafana sends notifications to the contact point. +Grafana allows you to create alerting rules that query one or more data sources, reduce or transform the results and compare them to each other or to fix thresholds. When these are executed, Grafana sends notifications to the contact point. For information on Grafana alerting, see [About Grafana alerting]({{< relref "../about-alerting/" >}}) which explains the various components of Grafana alerting. We also recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "../fundamentals/" >}}) of Grafana alerting. ## Add Grafana managed rule 1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. -1. Click **New alert rule**. -1. In Step 1, add the rule name, type, and storage location. - - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule. - - From the **Rule type** drop-down, select **Grafana managed alert**. - - From the **Folder** drop-down, select the folder where you want to store the rule. If you do not select a folder, the rule is stored in the General folder. To create a new folder, click the drop-down and enter the new folder name. -1. In Step 2, add queries and expressions to evaluate. - - Keep the default name or hover over and click the edit icon to change the name. +1. Click **New alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default. +1. In Step 1, add queries and expressions to evaluate, and then select the alert condition. - For queries, select a data source from the drop-down. - - Add one or more [queries]({{< relref "../../panels/query-a-data-source/add-a-query.md" >}}) or [expressions]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). + - Add one or more [queries]({{< relref "../../panels/query-a-data-source/add-a-query/" >}}) or [expressions]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/" >}}). - For each expression, select either **Classic condition** to create a single alert rule, or choose from **Math**, **Reduce**, **Resample** options to generate separate alert for each series. For details on these options, see [Single and multi dimensional rule](#single-and-multi-dimensional-rule). - Click **Run queries** to verify that the query is successful. -1. In Step 3, add conditions. + - Next, select the query or expression for your alert condition. +1. In Step 2, specify the alert evaluation interval. - From the **Condition** drop-down, select the query or expression to trigger the alert rule. - For **Evaluate every**, specify the frequency of evaluation. Must be a multiple of 10 seconds. For examples, `1m`, `30s`. - For **Evaluate for**, specify the duration for which the condition must be true before an alert fires. - > **Note:** Once a condition is breached, the alert goes into the Pending state. If the condition remains breached for the duration specified, the alert transitions to the Firing state, else it reverts back to the Normal state. + > **Note:** Once a condition is breached, the alert goes into the Pending state. If the condition remains breached for the duration specified, the alert transitions to the `Firing` state, otherwise it reverts back to the `Normal` state. - In **Configure no data and error handling**, configure alerting behavior in the absence of data. Use the guidelines in [No data and error handling](#no-data-and-error-handling). - Click **Preview alerts** to check the result of running the query at this moment. Preview excludes no data and error handling. -1. In Step 4, add additional metadata associated with the rule. - - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/_index.md" >}}). +1. In Step 3, add the rule name, storage location, rule group, as well as additional metadata associated with the rule. + - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule. + - From the **Folder** drop-down, select the folder where you want to store the rule. + - For **Group**, specify a pre-defined group. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time. + - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}). - Add Runbook URL, panel, dashboard, and alert IDs. - Add custom labels. 1. Click **Save** to save the rule or **Save and exit** to save the rule and go back to the Alerting page. +1. Next, create a [notification]({{< relref "../notifications/" >}}) for the rule. ### Single and multi dimensional rule @@ -49,7 +56,7 @@ Use the classic condition expression to create a rule that triggers a single ale To generate a separate alert for each series, create a multi-dimensional rule. Use `Math`, `Reduce`, or `Resample` expressions to create a multi-dimensional rule. For example: -- Add a `Reduce` expression for each query to aggregate values in the selected time range into a single value. (Not needed for [rules using numeric data]({{< relref "../fundamentals/evaluate-grafana-alerts.md#alerting-on-numeric-data-1" >}})). +- Add a `Reduce` expression for each query to aggregate values in the selected time range into a single value. (Not needed for [rules using numeric data]({{< relref "../fundamentals/evaluate-grafana-alerts/#alerting-on-numeric-data-1" >}})). - Add a `Math` expression with the condition for the rule. Not needed in case a query or a reduce expression already returns 0 if rule should not fire, or a positive number if it should fire. Some examples: `$B > 70` if it should fire in case value of B query/expression is more than 70. `$B < $C * 100` in case it should fire if value of B is less than value of C multiplied by 100. If queries being compared have multiple series in their results, series from different queries are matched if they have the same labels or one is a subset of the other. ![Query section multi dimensional](/static/img/docs/alerting/unified/rule-edit-multi-8-0.png 'Query section multi dimensional screenshot') @@ -58,7 +65,7 @@ To generate a separate alert for each series, create a multi-dimensional rule. U #### Rule with classic condition -For more information, see [expressions documentation]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). +For more information, see [expressions documentation]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/" >}}). ### No data and error handling diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md index 95e11990f97..e63649e90b3 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md @@ -1,10 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-recording-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/"] -description = "Create Grafana Mimir or Loki managed recording rule" -keywords = ["grafana", "alerting", "guide", "rules", "recording rules", "create"] -title = "Create Grafana Mimir or Loki managed recording rule" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-recording-rule/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/ +description: Create Grafana Mimir or Loki managed recording rule +keywords: + - grafana + - alerting + - guide + - rules + - recording rules + - create +title: Create Grafana Mimir or Loki managed recording rule +weight: 400 +--- # Create a Grafana Mimir or Loki managed recording rule @@ -12,16 +21,35 @@ You can create and manage recording rules for an external Grafana Mimir or Loki ## Before you begin -For Grafana Mimir and Loki data sources to work with Grafana 8.0 alerting, enable the ruler API by configuring their respective services. +- Verify that you have write permission to the Prometheus or Loki data source. Otherwise, you will not be able to create or update Grafana Mimir managed alerting rules. -**Loki** - The `local` rule storage type, default for the Loki data source, supports only viewing of rules. To edit rules, configure one of the other rule storage types. +- For Grafana Mimir and Loki data sources, enable the ruler API by configuring their respective services. -**Grafana Mimir** - When configuring a Grafana Prometheus data source to point to Grafana Mimir, use the legacy `/api/prom` prefix, not `/prometheus`. Currently, we support only single-binary mode and you cannot provide a separate URL for the ruler API. + - **Loki** - The `local` rule storage type, default for the Loki data source, supports only viewing of rules. To edit rules, configure one of the other rule storage types. -> **Note:** If you do not want to manage alerting rules for a particular Loki or Prometheus data source, go to its settings page and clear the **Manage alerts via Alerting UI** checkbox. + - **Grafana Mimir** - use the [legacy `/api/prom` prefix](https://grafana.com/docs/mimir/latest/operators-guide/reference-http-api/#path-prefixes), not `/prometheus`. The Prometheus data source supports both Grafana Mimir and Prometheus, and Grafana expects that both the [Query API](https://grafana.com/docs/mimir/latest/operators-guide/reference-http-api/#querier--query-frontend) and [Ruler API](https://grafana.com/docs/mimir/latest/operators-guide/reference-http-api/#ruler) are under the same URL. You cannot provide a separate URL for the Ruler API. + +> **Note:** If you do not want to manage alerting rules for a particular Loki or Prometheus data source, go to its settings and clear the **Manage alerts via Alerting UI** checkbox. ## Add a Grafana Mimir or Loki managed recording rule +To create a Grafana Mimir or Loki managed recording rule + +1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. +1. Click **New alert rule**. The new alerting rule page opens where the **Grafana managed alert** option is selected by default. +1. In Step 1, select **Mimir or Loki recording rule** option. + - Select your Loki or Prometheus data source, add the query to evaluate, and then select the alert condition. + - Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series. +1. In Step 2, add the rule name, namespace, rule group, as well as additional metadata associated with the rule. + - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule. + - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click Add new and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}). + - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time. + - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}). + - Add Runbook URL, panel, dashboard, and alert IDs. + - Add custom labels. +1. Click **Save** to save the rule or **Save and exit** to save the rule and go back to the Alerting page. +1. Next, create a [notification]({{< relref "../notifications/" >}}) for the rule. + 1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. 1. Click **New alert rule**. 1. In Step 1, add the rule name, type, and storage location. @@ -35,7 +63,7 @@ For Grafana Mimir and Loki data sources to work with Grafana 8.0 alerting, enabl - Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series. {{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-query-8-0.png" max-width="550px" caption="Alert details" >}} 1. In Step 3, add additional metadata associated with the rule. - - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/_index.md" >}}). + - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}). - Add Runbook URL, panel, dashboard, and alert IDs. - Add custom labels. 1. Click **Save** to save the rule or **Save and exit** to save the rule and go back to the Alerting page. diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md index ff0baf0e66e..f2ad158fa5c 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md @@ -1,18 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/"] -description = "Create Grafana Mimir or Loki managed alerting rule" -keywords = ["grafana", "alerting", "guide", "rules", "create"] -title = "Create Grafana Mimir or Loki managed alert rule" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/create-mimir-loki-managed-rule/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/ +description: Create Grafana Mimir or Loki managed alerting rule +keywords: + - grafana + - alerting + - guide + - rules + - create +title: Create Grafana Mimir or Loki managed alert rule +weight: 400 +--- # Create a Grafana Mimir or Loki managed alerting rule -Grafana allows you to create alerting rules for an external Grafana Mimir or Loki instance. +Grafana allows you to create alerting rules for an external Grafana Mimir or Loki instance that has ruler API enabled. For information on Grafana alerting, see [About Grafana alerting]({{< relref "../about-alerting/" >}}) which explains the various components of Grafana alerting. We also recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "../fundamentals/" >}}) of Grafana alerting. ## Before you begin -- Verify that you have write permission to the Prometheus data source. Otherwise, you will not be able to create or update Grafana Mimir managed alerting rules. +- Verify that you have write permission to the Prometheus or Loki data source. Otherwise, you will not be able to create or update Grafana Mimir managed alerting rules. - For Grafana Mimir and Loki data sources, enable the ruler API by configuring their respective services. @@ -25,23 +33,19 @@ Grafana allows you to create alerting rules for an external Grafana Mimir or Lok ## Add a Grafana Mimir or Loki managed alerting rule 1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. -1. Click **New alert rule**. -1. In Step 1, add the rule name, type, and storage location. - - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule. - - From the **Rule type** drop-down, select **Mimir / Loki managed alert**. - - From the **Select data source** drop-down, select an external Prometheus, an external Loki, or a Grafana Cloud data source. - - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "./edit-mimir-loki-namespace-group.md" >}}). - - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time. - {{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-alert-type-8-0.png" max-width="550px" caption="Alert details" >}} -1. In Step 2, add the query to evaluate. - - Enter a PromQL or LogQL expression. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series. - {{< figure src="/static/img/docs/alerting/unified/rule-edit-mimir-query-8-0.png" max-width="550px" caption="Alert details" >}} -1. In Step 3, add conditions. +1. Click **New alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default. +1. In Step 1, select **Mimir or Loki alert** option. + - Next, select your Loki or Prometheus data source and add the query to evaluate. + - Enter a PromQL or LogQL expression to query. The rule fires if the evaluation result has at least one series with a value that is greater than 0. An alert is created for each series. +1. In Step 2, specify the alert evaluation interval. - In the **For** text box, specify the duration for which the condition must be true before an alert fires. If you specify `5m`, the condition must be true for 5 minutes before the alert fires. > **Note:** Once a condition is met, the alert goes into the `Pending` state. If the condition remains active for the duration specified, the alert transitions to the `Firing` state, else it reverts to the `Normal` state. -1. In Step 4, add additional metadata associated with the rule. - - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/_index.md" >}}). +1. In Step 3, add the rule name, namespace, rule group, as well as additional metadata associated with the rule. + - In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule. + - From the **Namespace** drop-down, select an existing rule namespace. Otherwise, click **Add new** and enter a name to create a new one. Namespaces can contain one or more rule groups and only have an organizational purpose. For more information, see [Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}}). + - From the **Group** drop-down, select an existing group within the selected namespace. Otherwise, click **Add new** and enter a name to create a new one. Newly created rules are appended to the end of the group. Rules within a group are run sequentially at a regular interval, with the same evaluation time. + - Add a description and summary to customize alert messages. Use the guidelines in [Annotations and labels for alerting]({{< relref "../fundamentals/annotation-label/" >}}). - Add Runbook URL, panel, dashboard, and alert IDs. - Add custom labels. -1. To evaluate the rule and see what alerts it would produce, click **Preview alerts**. It will display a list of alerts with state and value of for each one. 1. Click **Save** to save the rule or **Save and exit** to save the rule and go back to the Alerting page. +1. Next, create a [notification]({{< relref "../notifications/" >}}) for the rule. diff --git a/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md index a1bd8428ee4..696ca97e9a3 100644 --- a/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md +++ b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md @@ -1,10 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/edit-mimir-loki-namespace-group/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group/"] -description = "Edit Grafana Mimir or Loki rule groups and namespaces" -keywords = ["grafana", "alerting", "guide", "group", "namespace", "grafana mimir", "loki"] -title = "Grafana Mimir or Loki rule groups and namespaces" -weight = 405 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/edit-mimir-loki-namespace-group/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group/ +description: Edit Grafana Mimir or Loki rule groups and namespaces +keywords: + - grafana + - alerting + - guide + - group + - namespace + - grafana mimir + - loki +title: Grafana Mimir or Loki rule groups and namespaces +weight: 405 +--- # Grafana Mimir or Loki rule groups and namespaces diff --git a/docs/sources/alerting/alerting-rules/rule-list.md b/docs/sources/alerting/alerting-rules/rule-list.md index 986c9973ed8..7e6bfeb043f 100644 --- a/docs/sources/alerting/alerting-rules/rule-list.md +++ b/docs/sources/alerting/alerting-rules/rule-list.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/rule-list/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/rule-list/"] -description = "Manage alerting rules" -keywords = ["grafana", "alerting", "guide", "rules", "view"] -title = "Manage alerting rules" -weight = 402 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/rule-list/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/rule-list/ +description: Manage alerting rules +keywords: + - grafana + - alerting + - guide + - rules + - view +title: Manage alerting rules +weight: 402 +--- # Manage alerting rules @@ -55,5 +62,5 @@ Grafana managed alerting rules can only be edited or deleted by users with Edit To edit or delete a rule: 1. Expand a rule row until you can see the rule controls of **View**, **Edit**, and **Delete**. -1. Click **Edit** to open the create rule page. Make updates following instructions in [Create a Grafana managed alerting rule]({{< relref "./create-grafana-managed-rule.md" >}}) or [Create a Grafana Mimir or Loki managed alerting rule]({{< relref "./create-mimir-loki-managed-rule.md" >}}). +1. Click **Edit** to open the create rule page. Make updates following instructions in [Create a Grafana managed alerting rule]({{< relref "create-grafana-managed-rule/" >}}) or [Create a Grafana Mimir or Loki managed alerting rule]({{< relref "create-mimir-loki-managed-rule/" >}}). 1. Click **Delete** to delete a rule. diff --git a/docs/sources/alerting/contact-points/_index.md b/docs/sources/alerting/contact-points/_index.md index c010672c679..6d1c31d63e8 100644 --- a/docs/sources/alerting/contact-points/_index.md +++ b/docs/sources/alerting/contact-points/_index.md @@ -1,210 +1,30 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/contact-points/", "/docs/grafana/latest/alerting/unified-alerting/contact-points/"] -description = "Create or edit contact point" -keywords = ["grafana", "alerting", "guide", "contact point", "notification channel", "create"] -title = "Contact points" -weight = 430 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/ + - /docs/grafana/latest/alerting/unified-alerting/contact-points/ +description: Create or edit contact point +keywords: + - grafana + - alerting + - guide + - contact point + - notification channel + - create +title: Contact points +weight: 430 +--- # Contact points -Use contact points to define how your contacts are notified when an alert fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert fires, a notification is sent to all contact point types listed for a contact point. Optionally, use [message templates]({{< relref "./message-templating/_index.md" >}}) to customize notification messages for the contact point types. +Use contact points to define how your contacts are notified when an alert fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert fires, a notification is sent to all contact point types listed for a contact point. Optionally, use [message templates]({{< relref "message-templating/" >}}) to customize notification messages for the contact point types. -You can configure Grafana managed contact points as well as contact points for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed contact points as well as contact points for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager/" >}}). -## Add a contact point +Before you begin, see [About Grafana alerting]({{< relref "../about-alerting/" >}}) which explains the various components of Grafana alerting. We also recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "../fundamentals/" >}}) of Grafana alerting. -1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. -1. Click **Contact points** to open the page listing existing contact points. -1. Click **New contact point**. -1. From the **Alertmanager** dropdown, select an Alertmanager. By default, Grafana Alertmanager is selected. -1. In **Name**, enter a descriptive name for the contact point. -1. From **Contact point type**, select a type and fill out mandatory fields. For example, if you choose email, enter the email addresses. Or if you choose Slack, enter the Slack channel(s) and users who should be contacted. -1. Some contact point types, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point type. -1. In Notification settings, optionally select **Disable resolved message** if you do not want to be notified when an alert resolves. -1. To add another contact point type, click **New contact point type** and repeat steps 6 through 8. -1. Click **Save contact point** to save your changes. - -## Edit a contact point - -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. Find the contact point to edit, then click **Edit** (pen icon). -1. Make any changes and click **Save contact point**. - -## Test a contact point - -For Grafana managed contact points, you can send a test notification which helps verify a contact point is configured correctly. - -To send a test notification: - -1. In the Grafana side bar, hover your cursor over the **Alerting** (bell) icon and then click **Contact** points. -1. Find the contact point to test, then click **Edit** (pen icon). You can also create a new contact point if needed. -1. Click **Test** (paper airplane icon) to open the contact point testing modal. -1. Choose whether to send a predefined test notification or choose custom to add your own custom annotations and labels to include in the notification. -1. Click **Send test notification** to fire the alert. - -## Delete a contact point - -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. Find the contact point to delete, then click **Delete** (trash icon). -1. In the confirmation dialog, click **Yes, delete**. - -> **Note:** You cannot delete contact points that are in use by a notification policy. You will have to either delete the [notification policy]({{< relref "../notifications/_index.md" >}}) or update it to use another contact point. - -## Edit Alertmanager global config - -To edit global configuration options for an external Alertmanager, like SMTP server, that is used by default for all email contact types: - -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. From the **Alertmanager** drop-down, select an external Alertmanager data source. -1. Click the **Edit global config** option. -1. Add global configuration settings. -1. Click **Save global config** to save your changes. - -> **Note** This option is available only for external Alertmanagers. You can configure some global options for Grafana contact types, like email settings, via [Grafana configuration]({{< relref "../../administration/configuration.md" >}}). - -## List of notifiers supported by Grafana - -| Name | Type | Grafana Alertmanager | Other Alertmanagers | -| --------------------------------------------- | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- | -| [DingDing](#dingdingdingtalk) | `dingding` | Supported | N/A | -| [Discord](#discord) | `discord` | Supported | N/A | -| [Email](#email) | `email` | Supported | Supported | -| [Google Hangouts Chat](#google-hangouts-chat) | `googlechat` | Supported | N/A | -| [Kafka](#kafka) | `kafka` | Supported | N/A | -| Line | `line` | Supported | N/A | -| Microsoft Teams | `teams` | Supported | N/A | -| [Opsgenie](#opsgenie) | `opsgenie` | Supported | Supported | -| [Pagerduty](#pagerduty) | `pagerduty` | Supported | Supported | -| Prometheus Alertmanager | `prometheus-alertmanager` | Supported | N/A | -| [Pushover](#pushover) | `pushover` | Supported | Supported | -| Sensu | `sensu` | Supported | N/A | -| [Sensu Go](#sensu-go) | `sensugo` | Supported | N/A | -| [Slack](#slack) | `slack` | Supported | Supported | -| Telegram | `telegram` | Supported | N/A | -| Threema | `threema` | Supported | N/A | -| VictorOps | `victorops` | Supported | Supported | -| [Webhook](#webhook) | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) | -| [WeCom](#wecom) | `wecom` | Supported | N/A | -| [Zenduty](#zenduty) | `webhook` | Supported | N/A | - -### Webhook - -Example JSON body: - -```json -{ - "receiver": "My Super Webhook", - "status": "firing", - "orgId": 1, - "alerts": [ - { - "status": "firing", - "labels": { - "alertname": "High memory usage", - "team": "blue", - "zone": "us-1" - }, - "annotations": { - "description": "The system has high memory usage", - "runbook_url": "https://myrunbook.com/runbook/1234", - "summary": "This alert was triggered for zone us-1" - }, - "startsAt": "2021-10-12T09:51:03.157076+02:00", - "endsAt": "0001-01-01T00:00:00Z", - "generatorURL": "https://play.grafana.org/alerting/1afz29v7z/edit", - "fingerprint": "c6eadffa33fcdf37", - "silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1", - "dashboardURL": "", - "panelURL": "", - "valueString": "[ metric='' labels={} value=14151.331895396988 ]" - }, - { - "status": "firing", - "labels": { - "alertname": "High CPU usage", - "team": "blue", - "zone": "eu-1" - }, - "annotations": { - "description": "The system has high CPU usage", - "runbook_url": "https://myrunbook.com/runbook/1234", - "summary": "This alert was triggered for zone eu-1" - }, - "startsAt": "2021-10-12T09:56:03.157076+02:00", - "endsAt": "0001-01-01T00:00:00Z", - "generatorURL": "https://play.grafana.org/alerting/d1rdpdv7k/edit", - "fingerprint": "bc97ff14869b13e3", - "silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1", - "dashboardURL": "", - "panelURL": "", - "valueString": "[ metric='' labels={} value=47043.702386305304 ]" - } - ], - "groupLabels": {}, - "commonLabels": { - "team": "blue" - }, - "commonAnnotations": {}, - "externalURL": "https://play.grafana.org/", - "version": "1", - "groupKey": "{}:{}", - "truncatedAlerts": 0, - "title": "[FIRING:2] (blue)", - "state": "alerting", - "message": "**Firing**\n\nLabels:\n - alertname = T2\n - team = blue\n - zone = us-1\nAnnotations:\n - description = This is the alert rule checking the second system\n - runbook_url = https://myrunbook.com\n - summary = This is my summary\nSource: https://play.grafana.org/alerting/1afz29v7z/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1\n\nLabels:\n - alertname = T1\n - team = blue\n - zone = eu-1\nAnnotations:\nSource: https://play.grafana.org/alerting/d1rdpdv7k/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1\n" -} -``` - -### Webhook fields - -#### Body - -| Key | Type | Description | -| ----------------- | ------------------------- | ------------------------------------------------------------------------------- | -| receiver | string | Name of the webhook | -| status | string | Current status of the alert, `firing` or `resolved` | -| orgId | number | ID of the organization related to the payload | -| alerts | array of [alerts](#alert) | Alerts that are triggering | -| groupLabels | object | Labels that are used for grouping, map of string keys to string values | -| commonLabels | object | Labels that all alarms have in common, map of string keys to string values | -| commonAnnotations | object | Annotations that all alarms have in common, map of string keys to string values | -| externalURL | string | External URL to the Grafana instance sending this webhook | -| version | string | Version of the payload | -| groupKey | string | Key that is used for grouping | -| truncatedAlerts | number | Number of alerts that were truncated | -| title | string | **Will be deprecated soon** | -| state | string | **Will be deprecated soon** | -| message | string | **Will be deprecated soon** | - -#### Alert - -| Key | Type | Description | -| ------------ | ------ | ---------------------------------------------------------------------------------- | -| status | string | Current status of the alert, `firing` or `resolved` | -| labels | object | Labels that are part of this alert, map of string keys to string values | -| annotations | object | Annotations that are part of this alert, map of string keys to string values | -| startsAt | string | Start time of the alert | -| endsAt | string | End time of the alert, default value when not resolved is `0001-01-01T00:00:00Z` | -| valueString | string | Values that triggered the current status | -| generatorURL | string | URL of the alert rule in the Grafana UI | -| fingerprint | string | The labels fingerprint, alarms with the same labels will have the same fingerprint | -| silenceURL | string | URL to silence the alert rule in the Grafana UI | -| dashboardURL | string | **Will be deprecated soon** | -| panelURL | string | **Will be deprecated soon** | - -#### Removed fields related to dashboards - -Alerts are not coupled to dashboards anymore therefore the fields related to dashboards `dashboardId` and `panelId` have been removed. - -### WeCom - -WeCom contact points need a Webhook URL. These are obtained by setting up a WeCom robot on the corresponding group chat. To obtain a Webhook URL using the WeCom desktop Client please follow these steps: - -1. Click the "..." in the top right corner of a group chat that you want your alerts to be delivered to -2. Click "Add Group Robot", select "New Robot" and give your robot a name. Click "Add Robot" -3. There should be a Webhook URL in the panel. - -| Setting | Description | -| ------- | ------------------ | -| Url | WeCom webhook URL. | +- [Create contact point]({{< relref "create-contact-point/" >}}) +- [Edit contact point]({{< relref "edit-contact-point/" >}}) +- [Test contact point]({{< relref "test-contact-point/" >}}) +- [Delete contact point]({{< relref "delete-contact-point/" >}}) +- [List of notifiers]({{< relref "notifiers/" >}}) +- [Message templating]({{< relref "message-templating/" >}}) diff --git a/docs/sources/alerting/contact-points/create-contact-point.md b/docs/sources/alerting/contact-points/create-contact-point.md new file mode 100644 index 00000000000..5c72362af57 --- /dev/null +++ b/docs/sources/alerting/contact-points/create-contact-point.md @@ -0,0 +1,32 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/create-contact-point/ + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Add contact point +weight: 100 +--- + +# Add a contact point + +Use contact points to define how your contacts are notified when an alert fires. + +To add a contact point + +1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. +1. Click **Contact points** to open the page listing existing contact points. +1. Click **New contact point**. +1. From the **Alertmanager** dropdown, select an Alertmanager. By default, Grafana Alertmanager is selected. +1. In **Name**, enter a descriptive name for the contact point. +1. From **Contact point type**, select a type and fill out mandatory fields. For example, if you choose email, enter the email addresses. Or if you choose Slack, enter the Slack channel(s) and users who should be contacted. +1. Some contact point types, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point type. +1. In Notification settings, optionally select **Disable resolved message** if you do not want to be notified when an alert resolves. +1. To add another contact point type, click **New contact point type** and repeat steps 6 through 8. +1. Click **Save contact point** to save your changes. diff --git a/docs/sources/alerting/contact-points/delete-contact-point.md b/docs/sources/alerting/contact-points/delete-contact-point.md new file mode 100644 index 00000000000..ef428bfe19c --- /dev/null +++ b/docs/sources/alerting/contact-points/delete-contact-point.md @@ -0,0 +1,27 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/delete-contact-point/ + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Delete a contact point +weight: 115 +--- + +## Delete a contact point + +For Grafana managed contact points, you can send a test notification which helps verify a contact point is configured correctly. + +To delete a contact point + +1. In the Alerting page, click **Contact points** to open the page listing existing contact points. +1. Find the contact point to delete, then click **Delete** (trash icon). +1. In the confirmation dialog, click **Yes, delete**. + +> **Note:** You cannot delete contact points that are in use by a notification policy. You will have to either delete the [notification policy]({{< relref "../notifications/" >}}) or update it to use another contact point. diff --git a/docs/sources/alerting/contact-points/edit-alertmanager-config.md b/docs/sources/alerting/contact-points/edit-alertmanager-config.md new file mode 100644 index 00000000000..5b7ebd975c1 --- /dev/null +++ b/docs/sources/alerting/contact-points/edit-alertmanager-config.md @@ -0,0 +1,27 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/edit-alertmanager-config/ + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Edit contact point +weight: 120 +--- + +# Edit Alertmanager global config + +To edit global configuration options for an external Alertmanager, like SMTP server, that is used by default for all email contact types: + +1. In the Alerting page, click **Contact points** to open the page listing existing contact points. +1. From the **Alertmanager** drop-down, select an external Alertmanager data source. +1. Click the **Edit global config** option. +1. Add global configuration settings. +1. Click **Save global config** to save your changes. + +> **Note** This option is available only for external Alertmanagers. You can configure some global options for Grafana contact types, like email settings, via [Grafana configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) diff --git a/docs/sources/alerting/contact-points/edit-contact-point.md b/docs/sources/alerting/contact-points/edit-contact-point.md new file mode 100644 index 00000000000..6af63def98c --- /dev/null +++ b/docs/sources/alerting/contact-points/edit-contact-point.md @@ -0,0 +1,25 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/edit-contact-point/ + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Edit contact point +weight: 105 +--- + +# Edit a contact point + +Use contact points to define how your contacts are notified when an alert fires. + +To edit a contact point + +1. In the Alerting page, click **Contact points** to open the page listing existing contact points. +1. Find the contact point to edit, then click **Edit** (pen icon). +1. Make any changes and click **Save contact point**. diff --git a/docs/sources/alerting/contact-points/message-templating/_index.md b/docs/sources/alerting/contact-points/message-templating/_index.md index 7cf66dbbee0..d65d3ae5e0c 100644 --- a/docs/sources/alerting/contact-points/message-templating/_index.md +++ b/docs/sources/alerting/contact-points/message-templating/_index.md @@ -1,56 +1,34 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/message-templating/", "/docs/grafana/latest/alerting/unified-alerting/message-templating/"] -description = "Message templating" -keywords = ["grafana", "alerting", "guide", "contact point", "templating"] -title = "Message templating" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +description: Message templating +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Message templating +weight: 400 +--- # Message templating -Notifications sent via [contact points]({{< relref "../../contact-points/_index.md" >}}) are built using messaging templates. Grafana's default templates are based on the [Go templating system](https://golang.org/pkg/text/template) where some fields are evaluated as text, while others are evaluated as HTML (which can affect escaping). The default template, defined in [default_template.go](https://github.com/grafana/grafana/blob/main/pkg/services/ngalert/notifier/channels/default_template.go), is a useful reference for custom templates. +Notifications sent via [contact points]({{< relref "../" >}}) are built using messaging templates. Grafana's default templates are based on the [Go templating system](https://golang.org/pkg/text/template) where some fields are evaluated as text, while others are evaluated as HTML (which can affect escaping). The default template, defined in [default_template.go](https://github.com/grafana/grafana/blob/main/pkg/services/ngalert/notifier/channels/default_template.go), is a useful reference for custom templates. -Since most of the contact point fields can be templated, you can create reusable custom templates and use them in multiple contact points. The [template data]({{< relref "./template-data.md" >}}) topic lists variables that are available for templating. The default template is defined in [default_template.go](https://github.com/grafana/grafana/blob/main/pkg/services/ngalert/notifier/channels/default_template.go) which can serve as a useful reference or starting point for custom templates. +Since most of the contact point fields can be templated, you can create reusable custom templates and use them in multiple contact points. The [template data]({{< relref "template-data/" >}}) topic lists variables that are available for templating. The default template is defined in [default_template.go](https://github.com/grafana/grafana/blob/main/pkg/services/ngalert/notifier/channels/default_template.go) which can serve as a useful reference or starting point for custom templates. ### Using templates The following example shows how to use default templates to render an alert message in Slack. The message title contains a count of alerts that are firing or were resolved. The message body lists the alerts and their status. - +{{< figure src="/static/img/docs/alerting/unified/contact-points-template-fields-8-0.png" class="docs-image--no-shadow" max-width= "550px" caption="Default template" >}} The following example shows the use of a custom template within one of the contact point fields. - - -### Create a message template - -> **Note:** Before Grafana v8.2, the configuration of the embedded Alertmanager was shared across organisations. Users of Grafana 8.0 and 8.1 are advised to use the new Grafana 8 alerts only if they have one organisation. Otherwise, silences for the Grafana managed alerts will be visible by all organizations. - -1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. From Alertmanager drop-down, select an external Alertmanager to create and manage templates for the external data source. Otherwise, keep the default option of Grafana. - {{< figure max-width="250px" src="/static/img/docs/alerting/unified/contact-points-select-am-8-0.gif" caption="Select Alertmanager" >}} -1. Click **Add template**. -1. In **Name**, add a descriptive name. -1. In **Content**, add the content of the template. -1. Click **Save template** button at the bottom of the page. - - -The `define` tag in the Content section assigns the template name. This tag is optional, and when omitted, the template name is derived from the **Name** field. When both are specified, it is a best practice to ensure that they are the same. - -### Edit a message template - -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. In the Template table, find the template you want to edit, then click the **Edit** (pen icon). -1. Make your changes, then click **Save template**. - -### Delete a message template - -1. In the Alerting page, click **Contact points** to open the page listing existing contact points. -1. In the Template table, find the template you want to delete, then click the **Delete** (trash icon). -1. In the confirmation dialog, click **Yes, delete** to delete the template. - -Use caution when deleting a template since Grafana does not prevent you from deleting templates that are in use. +{{< figure src="/static/img/docs/alerting/unified/contact-points-use-template-8-0.png" class="docs-image--no-shadow" max-width= "550px" caption="Default template" >}} ### Nested templates @@ -79,59 +57,6 @@ You can use any of the following built-in template options to embed custom templ | `default.message` | Provides a formatted summary of firing and resolved alerts. | | `teams.default.message` | Similar to `default.messsage`, formatted for Microsoft Teams. | -### Example of a custom template - -Here's an example of how to use a custom template. You can also use the default template included in the setup. - -Step 1: Configure a template to render a single alert. - -``` -{{ define "myalert" }} - [{{.Status}}] {{ .Labels.alertname }} - - Labels: - {{ range .Labels.SortedPairs }} - {{ .Name }}: {{ .Value }} - {{ end }} - - {{ if gt (len .Annotations) 0 }} - Annotations: - {{ range .Annotations.SortedPairs }} - {{ .Name }}: {{ .Value }} - {{ end }} - {{ end }} - - {{ if gt (len .SilenceURL ) 0 }} - Silence alert: {{ .SilenceURL }} - {{ end }} - {{ if gt (len .DashboardURL ) 0 }} - Go to dashboard: {{ .DashboardURL }} - {{ end }} -{{ end }} -``` - -Step 2: Configure a template to render entire notification message. - -``` -{{ define "mymessage" }} - {{ if gt (len .Alerts.Firing) 0 }} - {{ len .Alerts.Firing }} firing: - {{ range .Alerts.Firing }} {{ template "myalert" .}} {{ end }} - {{ end }} - {{ if gt (len .Alerts.Resolved) 0 }} - {{ len .Alerts.Resolved }} resolved: - {{ range .Alerts.Resolved }} {{ template "myalert" .}} {{ end }} - {{ end }} -{{ end }} -``` - -Step 3: Add `mymessage` in the notification message field. - -``` -Alert summary: -{{ template "mymessage" . }} -``` - ### HTML in message templates HTML in alerting message templates is escaped. We do not support rendering of HTML in the resulting notification. diff --git a/docs/sources/alerting/contact-points/message-templating/create-message-template.md b/docs/sources/alerting/contact-points/message-templating/create-message-template.md new file mode 100644 index 00000000000..35722596f5c --- /dev/null +++ b/docs/sources/alerting/contact-points/message-templating/create-message-template.md @@ -0,0 +1,33 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/message-templating/create-message-template/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Create message template +weight: 100 +--- + +# Create a message template + +You can use message templates to customize notification messages for the contact point types. + +To create a message tempplate: + +1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. +2. In the Alerting page, click **Contact points** to open the page listing existing contact points. +3. From Alertmanager drop-down, select an external Alertmanager to create and manage templates for the external data source. Otherwise, keep the default option of Grafana. + {{< figure max-width="250px" src="/static/img/docs/alerting/unified/contact-points-select-am-8-0.gif" caption="Select Alertmanager" >}} +4. Click **Add template**. +5. In **Name**, add a descriptive name. +6. In **Content**, add the content of the template. +7. Click **Save template** button at the bottom of the page. + + +The `define` tag in the Content section assigns the template name. This tag is optional, and when omitted, the template name is derived from the **Name** field. When both are specified, it is a best practice to ensure that they are the same. diff --git a/docs/sources/alerting/contact-points/message-templating/delete-message-template.md b/docs/sources/alerting/contact-points/message-templating/delete-message-template.md new file mode 100644 index 00000000000..710acd4692c --- /dev/null +++ b/docs/sources/alerting/contact-points/message-templating/delete-message-template.md @@ -0,0 +1,25 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/message-templating/delete-message-template/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Delete message template +weight: 110 +--- + +# Edit a message template + +Message templates customize notification messages for the contact point types. + +1. In the Alerting page, click **Contact points** to open the page listing existing contact points. +1. In the Template table, find the template you want to delete, then click the **Delete** (trash icon). +1. In the confirmation dialog, click **Yes, delete** to delete the template. + +Use caution when deleting a template since Grafana does not prevent you from deleting templates that are in use. diff --git a/docs/sources/alerting/contact-points/message-templating/edit-message-template.md b/docs/sources/alerting/contact-points/message-templating/edit-message-template.md new file mode 100644 index 00000000000..59fea5b03bb --- /dev/null +++ b/docs/sources/alerting/contact-points/message-templating/edit-message-template.md @@ -0,0 +1,25 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/message-templating/edit-message-template/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Edit message template +weight: 100 +--- + +# Edit a message template + +Message templates customize notification messages for the contact point types. + +To edit a message template + +1. In the Alerting page, click **Contact points** to open the page listing existing contact points. +1. In the Template table, find the template you want to edit, then click the **Edit** (pen icon). +1. Make your changes, then click **Save template**. diff --git a/docs/sources/alerting/contact-points/message-templating/example-template-functions.md b/docs/sources/alerting/contact-points/message-templating/example-template-functions.md new file mode 100644 index 00000000000..76693eda54d --- /dev/null +++ b/docs/sources/alerting/contact-points/message-templating/example-template-functions.md @@ -0,0 +1,127 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/example-template-functions/ + - /docs/grafana/latest/alerting/contact-points/message-templating/template-functions/ + - /docs/grafana/latest/alerting/message-templating/template-functions/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/template-functions/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Examples of template functions +weight: 130 +--- + +# Examples of template functions + +## humanize + +**Template string** `{ humanize $value }` + +**Input** `1234567.0` + +**Expected** `1.235M` + +## humanize1024 + +**TemplateString** `{ humanize1024 $value } ` + +**Input** `1048576.0` + +**Expected** `1Mi` + +## humanizeDuration + +**TemplateString** `{ humanizeDuration $value }` + +**Input** `899.99` + +**Expected** `14m 59s` + +### humanizePercentage + +**TemplateString** `{ humanizePercentage $value }` + +**Input** `0.1234567` + +**Expected** `12.35%` + +## humanizeTimestamp + +**TemplateString** `{ $value | humanizeTimestamp }` + +**Input** `1435065584.128` + +**Expected** `2015-06-23 13:19:44.128 +0000 UTC` + +## title + +**TemplateString** `{ $value | title }` + +**Input** `aa bb CC` + +**Expected** `Aa Bb Cc` + +### toUpper + +**TemplateString** `{ $value | toUpper }` + +**Input** `aa bb CC` + +**Expected** `AA BB CC` + +### toLower + +**TemplateString** `{ $value | toLower }` + +**Input** `aA bB CC` + +**Expected** `aa bb cc` + +## match + +**TemplateString** `{ match "a+" $labels.instance }` + +**Input** `aa` + +**Expected** `true` + +## reReplaceAll + +**TemplateString** `{{ reReplaceAll "localhost:(.*)" "my.domain:$1" $labels.instance }}` + +**Input** `localhost:3000` + +**Expected** `my.domain:3000` + +### graphLink + +**TemplateString** `{{ graphLink "{\"expr\": \"up\", \"datasource\": \"gdev-prometheus\"}" }}` + +**Expected** `/explore?left=["now-1h","now","gdev-prometheus",{"datasource":"gdev-prometheus","expr":"up","instant":false,"range":true}]` + +### tableLink + +**TemplateString** `{{ tableLink "{\"expr\": \"up\", \"datasource\": \"gdev-prometheus\"}" }}` + +**Expected** `/explore?left=["now-1h","now","gdev-prometheus",{"datasource":"gdev-prometheus","expr":"up","instant":true,"range":false}]` + +## args + +**TemplateString** `{{define "x"}}{{.arg0}} {{.arg1}}{{end}}{{template "x" (args 1 "2")}}` + +**Expected** `1 2` + +## externalURL + +**TemplateString** `{ externalURL }` + +**Expected** `http://localhost/path/prefix` + +## pathPrefix + +**TemplateString** `{ pathPrefix }` + +**Expected** `/path/prefix` diff --git a/docs/sources/alerting/contact-points/message-templating/example-template.md b/docs/sources/alerting/contact-points/message-templating/example-template.md new file mode 100644 index 00000000000..1b90d154b38 --- /dev/null +++ b/docs/sources/alerting/contact-points/message-templating/example-template.md @@ -0,0 +1,68 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/message-templating/example-template/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Example message template +weight: 115 +--- + +# Example of a custom template + +Here's an example of how to use a custom template. You can also use the default template included in the setup. + +Step 1: Configure a template to render a single alert. + +``` +{{ define "myalert" }} + [{{.Status}}] {{ .Labels.alertname }} + + Labels: + {{ range .Labels.SortedPairs }} + {{ .Name }}: {{ .Value }} + {{ end }} + + {{ if gt (len .Annotations) 0 }} + Annotations: + {{ range .Annotations.SortedPairs }} + {{ .Name }}: {{ .Value }} + {{ end }} + {{ end }} + + {{ if gt (len .SilenceURL ) 0 }} + Silence alert: {{ .SilenceURL }} + {{ end }} + {{ if gt (len .DashboardURL ) 0 }} + Go to dashboard: {{ .DashboardURL }} + {{ end }} +{{ end }} +``` + +Step 2: Configure a template to render entire notification message. + +``` +{{ define "mymessage" }} + {{ if gt (len .Alerts.Firing) 0 }} + {{ len .Alerts.Firing }} firing: + {{ range .Alerts.Firing }} {{ template "myalert" .}} {{ end }} + {{ end }} + {{ if gt (len .Alerts.Resolved) 0 }} + {{ len .Alerts.Resolved }} resolved: + {{ range .Alerts.Resolved }} {{ template "myalert" .}} {{ end }} + {{ end }} +{{ end }} +``` + +Step 3: Add `mymessage` in the notification message field. + +``` +Alert summary: +{{ template "mymessage" . }} +``` diff --git a/docs/sources/alerting/contact-points/message-templating/template-data.md b/docs/sources/alerting/contact-points/message-templating/template-data.md index 71d71b82c07..ef8d73af0e1 100644 --- a/docs/sources/alerting/contact-points/message-templating/template-data.md +++ b/docs/sources/alerting/contact-points/message-templating/template-data.md @@ -1,12 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/message-templating/template-data/", "/docs/grafana/latest/alerting/unified-alerting/message-templating/template-data/"] -keywords = ["grafana", "alerting", "guide", "contact point", "templating"] -title = "Template data" -+++ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/template-data/ + - /docs/grafana/latest/alerting/message-templating/template-data/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/template-data/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Template data +weight: 120 +--- # Template data -Template data is passed on to [message templates]({{< relref "./_index.md" >}}) as well as sent as payload to webhook pushes. +Template data is passed on to [message templates]({{< relref "_index.md" >}}) as well as sent as payload to webhook pushes. | Name | Type | Notes | | ----------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sources/alerting/contact-points/message-templating/template-functions.md b/docs/sources/alerting/contact-points/message-templating/template-functions.md index 500dde75a00..567f0452703 100644 --- a/docs/sources/alerting/contact-points/message-templating/template-functions.md +++ b/docs/sources/alerting/contact-points/message-templating/template-functions.md @@ -1,8 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/message-templating/template-functions/", "/docs/grafana/latest/alerting/unified-alerting/message-templating/template-functions/"] -keywords = ["grafana", "alerting", "guide", "contact point", "templating"] -title = "Template functions" -+++ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/template-functions/ + - /docs/grafana/latest/alerting/message-templating/template-functions/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/template-functions/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Template functions +weight: 125 +--- # Template Functions diff --git a/docs/sources/alerting/contact-points/notifiers/_index.md b/docs/sources/alerting/contact-points/notifiers/_index.md new file mode 100644 index 00000000000..164a74e93a3 --- /dev/null +++ b/docs/sources/alerting/contact-points/notifiers/_index.md @@ -0,0 +1,42 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/notifiers/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: List of notifiers +weight: 130 +--- + +# List of supported notifiers + +The following table lists the notifiers (contact point types) supported by Grafana. + +| Name | Type | Grafana Alertmanager | Other Alertmanagers | +| --------------------------------------------- | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- | +| [DingDing](#dingdingdingtalk) | `dingding` | Supported | N/A | +| [Discord](#discord) | `discord` | Supported | N/A | +| [Email](#email) | `email` | Supported | Supported | +| [Google Hangouts Chat](#google-hangouts-chat) | `googlechat` | Supported | N/A | +| [Kafka](#kafka) | `kafka` | Supported | N/A | +| Line | `line` | Supported | N/A | +| Microsoft Teams | `teams` | Supported | N/A | +| [Opsgenie](#opsgenie) | `opsgenie` | Supported | Supported | +| [Pagerduty](#pagerduty) | `pagerduty` | Supported | Supported | +| Prometheus Alertmanager | `prometheus-alertmanager` | Supported | N/A | +| [Pushover](#pushover) | `pushover` | Supported | Supported | +| Sensu | `sensu` | Supported | N/A | +| [Sensu Go](#sensu-go) | `sensugo` | Supported | N/A | +| [Slack](#slack) | `slack` | Supported | Supported | +| Telegram | `telegram` | Supported | N/A | +| Threema | `threema` | Supported | N/A | +| VictorOps | `victorops` | Supported | Supported | +| [Webhook](#webhook) | `webhook` | Supported | Supported ([different format](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config)) | +| [WeCom](#wecom) | `wecom` | Supported | N/A | +| [Zenduty](#zenduty) | `webhook` | Supported | N/A | diff --git a/docs/sources/alerting/contact-points/notifiers/webhook-notifier.md b/docs/sources/alerting/contact-points/notifiers/webhook-notifier.md new file mode 100644 index 00000000000..354b63bce2d --- /dev/null +++ b/docs/sources/alerting/contact-points/notifiers/webhook-notifier.md @@ -0,0 +1,138 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/notifiers/webhook-notifier/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Webhook notifier +weight: 105 +--- + +### Webhook + +This topic helps you configure the Webhook notifier. It also discusses that [WeCom]({{< relref "./webhook-notifier/#wecom" >}}) contact points need a Webhook URL. + +Example JSON body: + +```json +{ + "receiver": "My Super Webhook", + "status": "firing", + "orgId": 1, + "alerts": [ + { + "status": "firing", + "labels": { + "alertname": "High memory usage", + "team": "blue", + "zone": "us-1" + }, + "annotations": { + "description": "The system has high memory usage", + "runbook_url": "https://myrunbook.com/runbook/1234", + "summary": "This alert was triggered for zone us-1" + }, + "startsAt": "2021-10-12T09:51:03.157076+02:00", + "endsAt": "0001-01-01T00:00:00Z", + "generatorURL": "https://play.grafana.org/alerting/1afz29v7z/edit", + "fingerprint": "c6eadffa33fcdf37", + "silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1", + "dashboardURL": "", + "panelURL": "", + "valueString": "[ metric='' labels={} value=14151.331895396988 ]" + }, + { + "status": "firing", + "labels": { + "alertname": "High CPU usage", + "team": "blue", + "zone": "eu-1" + }, + "annotations": { + "description": "The system has high CPU usage", + "runbook_url": "https://myrunbook.com/runbook/1234", + "summary": "This alert was triggered for zone eu-1" + }, + "startsAt": "2021-10-12T09:56:03.157076+02:00", + "endsAt": "0001-01-01T00:00:00Z", + "generatorURL": "https://play.grafana.org/alerting/d1rdpdv7k/edit", + "fingerprint": "bc97ff14869b13e3", + "silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1", + "dashboardURL": "", + "panelURL": "", + "valueString": "[ metric='' labels={} value=47043.702386305304 ]" + } + ], + "groupLabels": {}, + "commonLabels": { + "team": "blue" + }, + "commonAnnotations": {}, + "externalURL": "https://play.grafana.org/", + "version": "1", + "groupKey": "{}:{}", + "truncatedAlerts": 0, + "title": "[FIRING:2] (blue)", + "state": "alerting", + "message": "**Firing**\n\nLabels:\n - alertname = T2\n - team = blue\n - zone = us-1\nAnnotations:\n - description = This is the alert rule checking the second system\n - runbook_url = https://myrunbook.com\n - summary = This is my summary\nSource: https://play.grafana.org/alerting/1afz29v7z/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1\n\nLabels:\n - alertname = T1\n - team = blue\n - zone = eu-1\nAnnotations:\nSource: https://play.grafana.org/alerting/d1rdpdv7k/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1\n" +} +``` + +### Webhook fields + +## Body + +| Key | Type | Description | +| ----------------- | ------------------------- | ------------------------------------------------------------------------------- | +| receiver | string | Name of the webhook | +| status | string | Current status of the alert, `firing` or `resolved` | +| orgId | number | ID of the organization related to the payload | +| alerts | array of [alerts](#alert) | Alerts that are triggering | +| groupLabels | object | Labels that are used for grouping, map of string keys to string values | +| commonLabels | object | Labels that all alarms have in common, map of string keys to string values | +| commonAnnotations | object | Annotations that all alarms have in common, map of string keys to string values | +| externalURL | string | External URL to the Grafana instance sending this webhook | +| version | string | Version of the payload | +| groupKey | string | Key that is used for grouping | +| truncatedAlerts | number | Number of alerts that were truncated | +| title | string | **Will be deprecated soon** | +| state | string | **Will be deprecated soon** | +| message | string | **Will be deprecated soon** | + +### Alert + +| Key | Type | Description | +| ------------ | ------ | ---------------------------------------------------------------------------------- | +| status | string | Current status of the alert, `firing` or `resolved` | +| labels | object | Labels that are part of this alert, map of string keys to string values | +| annotations | object | Annotations that are part of this alert, map of string keys to string values | +| startsAt | string | Start time of the alert | +| endsAt | string | End time of the alert, default value when not resolved is `0001-01-01T00:00:00Z` | +| valueString | string | Values that triggered the current status | +| generatorURL | string | URL of the alert rule in the Grafana UI | +| fingerprint | string | The labels fingerprint, alarms with the same labels will have the same fingerprint | +| silenceURL | string | URL to silence the alert rule in the Grafana UI | +| dashboardURL | string | **Will be deprecated soon** | +| panelURL | string | **Will be deprecated soon** | + +### Removed fields related to dashboards + +Alerts are not coupled to dashboards anymore therefore the fields related to dashboards `dashboardId` and `panelId` have been removed. + +## WeCom + +WeCom contact points need a Webhook URL. These are obtained by setting up a WeCom robot on the corresponding group chat. To obtain a Webhook URL using the WeCom desktop Client please follow these steps: + +1. Click the "..." in the top right corner of a group chat that you want your alerts to be delivered to +2. Click "Add Group Robot", select "New Robot" and give your robot a name. Click "Add Robot" +3. There should be a Webhook URL in the panel. + +| Setting | Description | +| ------- | ------------------ | +| Url | WeCom webhook URL. | diff --git a/docs/sources/alerting/contact-points/test-contact-point.md b/docs/sources/alerting/contact-points/test-contact-point.md new file mode 100644 index 00000000000..1bc52163c9a --- /dev/null +++ b/docs/sources/alerting/contact-points/test-contact-point.md @@ -0,0 +1,27 @@ +--- +aliases: + - /docs/grafana/latest/alerting/contact-points/message-templating/ + - /docs/grafana/latest/alerting/contact-points/test-contact-point/ + - /docs/grafana/latest/alerting/message-templating/ + - /docs/grafana/latest/alerting/unified-alerting/message-templating/ +keywords: + - grafana + - alerting + - guide + - contact point + - templating +title: Test a contact point +weight: 110 +--- + +# Test a contact point + +For Grafana managed contact points, you can send a test notification which helps verify a contact point is configured correctly. + +To send a test notification: + +1. In the Grafana side bar, hover your cursor over the **Alerting** (bell) icon and then click **Contact** points. +1. Find the contact point to test, then click **Edit** (pen icon). You can also create a new contact point if needed. +1. Click **Test** (paper airplane icon) to open the contact point testing modal. +1. Choose whether to send a predefined test notification or choose custom to add your own custom annotations and labels to include in the notification. +1. Click **Send test notification** to fire the alert. diff --git a/docs/sources/alerting/difference-old-new.md b/docs/sources/alerting/difference-old-new.md index 29af5b50597..bb32cd3228f 100644 --- a/docs/sources/alerting/difference-old-new.md +++ b/docs/sources/alerting/difference-old-new.md @@ -1,11 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/difference-old-new/", "/docs/grafana/latest/alerting/unified-alerting/difference-old-new/"] -description = "What's New with Grafana alerts" -draft = true -keywords = ["grafana", "alerting", "guide"] -title = "What's new in Grafana alerting" -weight = 108 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/difference-old-new/ + - /docs/grafana/latest/alerting/unified-alerting/difference-old-new/ +description: What's New with Grafana alerts +draft: true +keywords: + - grafana + - alerting + - guide +title: What's new in Grafana alerting +weight: 108 +--- # What's new in Grafana alerting diff --git a/docs/sources/alerting/fundamentals/_index.md b/docs/sources/alerting/fundamentals/_index.md index 8826764c5ca..5315b7899f7 100644 --- a/docs/sources/alerting/fundamentals/_index.md +++ b/docs/sources/alerting/fundamentals/_index.md @@ -1,14 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/fundamentals/", "/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/"] -title = "Alerting fundamentals" -weight = 110 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/ + - /docs/grafana/latest/alerting/metrics/ + - /docs/grafana/latest/alerting/unified-alerting/fundamentals/ +title: Alerting fundamentals +weight: 110 +--- # Alerting fundamentals This section includes the following fundamental concepts of Grafana alerting: -- [Annotations and labels for alerting rules]({{< relref "./annotation-label/_index.md" >}}) -- [Alertmanager]({{< relref "./alertmanager.md" >}}) -- [State and health of alerting rules]({{< relref "./state-and-health.md" >}}) -- [Evaluating Grafana managed alerts]({{< relref "./evaluate-grafana-alerts.md" >}}) +- [Annotations and labels for alerting rules]({{< relref "annotation-label/" >}}) +- [Alertmanager]({{< relref "alertmanager/" >}}) +- [State and health of alerting rules]({{< relref "state-and-health/" >}}) +- [Evaluating Grafana managed alerts]({{< relref "evaluate-grafana-alerts/" >}}) diff --git a/docs/sources/alerting/about-alert-rules/_index.md b/docs/sources/alerting/fundamentals/alert-rules/_index.md similarity index 60% rename from docs/sources/alerting/about-alert-rules/_index.md rename to docs/sources/alerting/fundamentals/alert-rules/_index.md index 33db80be0bc..8d200af8265 100644 --- a/docs/sources/alerting/about-alert-rules/_index.md +++ b/docs/sources/alerting/fundamentals/alert-rules/_index.md @@ -1,9 +1,14 @@ -+++ -title = "About alert rules" -description = "Learn about Grafana alert rules" -keywords = ["grafana", "alerting", "rules"] -weight = 101 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/alert-rules/ +description: About Grafana alert rules +keywords: + - grafana + - alerting + - rules +title: Alert rules +weight: 101 +--- # About alert rules @@ -13,7 +18,7 @@ While queries and expressions select the data set to evaluate, a condition sets An interval specifies how frequently an alerting rule is evaluated. Duration, when configured, indicates how long a condition must be met. The alert rules can also define alerting behavior in the absence of data. -- [Alert rule types]({{< relref "./alert-rule-types.md" >}}) -- [Alert instances]({{< relref "./alert-instances.md" >}}) -- [Organising alert rules]({{< relref "./organising-alerts.md" >}}) -- [Annotation and labels]({{< relref "../fundamentals/annotation-label/_index.md" >}}) +- [Alert rule types]({{< relref "alert-rule-types/" >}}) +- [Alert instances]({{< relref "alert-instances/" >}}) +- [Organising alert rules]({{< relref "organising-alerts/" >}}) +- [Annotation and labels]({{< relref "../annotation-label/" >}}) diff --git a/docs/sources/alerting/about-alert-rules/alert-instances.md b/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md similarity index 75% rename from docs/sources/alerting/about-alert-rules/alert-instances.md rename to docs/sources/alerting/fundamentals/alert-rules/alert-instances.md index 485c0170b0f..86049cd6c69 100644 --- a/docs/sources/alerting/about-alert-rules/alert-instances.md +++ b/docs/sources/alerting/fundamentals/alert-rules/alert-instances.md @@ -1,9 +1,14 @@ -+++ -title = "Alert instances" -description = "Learn about Grafana alert instances" -keywords = ["grafana", "alerting", "instances"] -weight = 103 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/alert-rules/alert-instances/ +description: Learn about Grafana alert instances +keywords: + - grafana + - alerting + - instances +title: Alert instances +weight: 103 +--- # Alert instances diff --git a/docs/sources/alerting/about-alert-rules/alert-rule-types.md b/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md similarity index 76% rename from docs/sources/alerting/about-alert-rules/alert-rule-types.md rename to docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md index 18b9553f0f8..912dcb11e06 100644 --- a/docs/sources/alerting/about-alert-rules/alert-rule-types.md +++ b/docs/sources/alerting/fundamentals/alert-rules/alert-rule-types.md @@ -1,9 +1,14 @@ -+++ -title = "Alert rule types" -description = "Learn about the different alert rule types" -keywords = ["grafana", "alerting", "rule types"] -weight = 102 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/alert-rules/alert-rule-types/ +description: Learn about the different alert rule types +keywords: + - grafana + - alerting + - rule types +title: Alert rule types +weight: 102 +--- # Alert rule types @@ -13,7 +18,7 @@ Grafana supports several alert rule types, the following sections will explain t Grafana-managed rules are the most flexible alert rule type. They allow you to create alerts that can act on data from any of your existing data sources. -In additional to supporting any datasource you can also add additional [expressions]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/_index.md" >}}) to transform your data and express alert conditions. +In additional to supporting any datasource you can also add additional [expressions]({{< relref "../../../panels/query-a-data-source/use-expressions-to-manipulate-data/" >}}) to transform your data and express alert conditions. ## Mimir, Loki and Cortex rules diff --git a/docs/sources/alerting/about-alert-rules/organising-alerts.md b/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md similarity index 74% rename from docs/sources/alerting/about-alert-rules/organising-alerts.md rename to docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md index 6a6a0cc50fe..4674c876f5e 100644 --- a/docs/sources/alerting/about-alert-rules/organising-alerts.md +++ b/docs/sources/alerting/fundamentals/alert-rules/organising-alerts.md @@ -1,9 +1,14 @@ -+++ -title = "Organising alert rules" -description = "Learn how to organize alert rules" -keywords = ["grafana", "alerting", "organization"] -weight = 104 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/alert-rules/organising-alerts/ +description: Learn how to organize alert rules +keywords: + - grafana + - alerting + - organization +title: Organising alert rules +weight: 104 +--- ## Namespaces and groups diff --git a/docs/sources/alerting/fundamentals/alertmanager.md b/docs/sources/alerting/fundamentals/alertmanager.md index 7a849bf7928..7e72361e4eb 100644 --- a/docs/sources/alerting/fundamentals/alertmanager.md +++ b/docs/sources/alerting/fundamentals/alertmanager.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/fundamentals/alertmanager/", "/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/alertmanager/"] -title = "Alertmanager" -weight = 116 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/alertmanager/ + - /docs/grafana/latest/alerting/metrics/ + - /docs/grafana/latest/alerting/unified-alerting/fundamentals/alertmanager/ +title: Alertmanager +weight: 116 +--- # Alertmanager @@ -12,7 +15,7 @@ Grafana includes built-in support for Prometheus Alertmanager. By default, notif > **Note:** Before v8.2, the configuration of the embedded Alertmanager was shared across organizations. If you are on an older Grafana version, we recommend that you use Grafana alerts only if you have one organization. Otherwise, your contact points are visible to all organizations. -Grafana alerting added support for external Alertmanager configuration. When you add an [Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}), the Alertmanager drop-down shows a list of available external Alertmanager data sources. Select a data source to create and manage alerting for standalone Grafana Mimir or Loki data sources. +Grafana alerting added support for external Alertmanager configuration. When you add an [Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}), the Alertmanager drop-down shows a list of available external Alertmanager data sources. Select a data source to create and manage alerting for standalone Grafana Mimir or Loki data sources. {{< figure max-width="40%" src="/static/img/docs/alerting/unified/contact-points-select-am-8-0.gif" max-width="250px" caption="Select Alertmanager" >}} diff --git a/docs/sources/alerting/fundamentals/annotation-label/_index.md b/docs/sources/alerting/fundamentals/annotation-label/_index.md index f91a411b87e..9627f373571 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/_index.md +++ b/docs/sources/alerting/fundamentals/annotation-label/_index.md @@ -1,14 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/alerting-rules/alert-annotation-label/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/alert-annotation-label/"] -description = "Annotations and labels for alerting" -keywords = ["grafana", "alerting", "guide", "rules", "create"] -title = "Annotations and labels for alerting rules" -weight = 401 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/alerting-rules/alert-annotation-label/ + - /docs/grafana/latest/alerting/fundamentals/annotation-label/ + - /docs/grafana/latest/alerting/unified-alerting/alerting-rules/alert-annotation-label/ +description: Annotations and labels for alerting +keywords: + - grafana + - alerting + - guide + - rules + - create +title: Annotations and labels for alerting rules +weight: 401 +--- # Annotations and labels for alerting rules -Annotations and labels are key value pairs associated with alerts originating from the alerting rule, datasource response, and as a result of alerting rule evaluation. They can be used in alert notifications directly or in [templates]({{< relref "../../contact-points/message-templating/_index.md" >}}) and [template functions]({{< relref "../../contact-points/message-templating/template-functions" >}}) to create notification contact dynamically. +Annotations and labels are key value pairs associated with alerts originating from the alerting rule, datasource response, and as a result of alerting rule evaluation. They can be used in alert notifications directly or in [templates]({{< relref "../../contact-points/message-templating/" >}}) and [template functions]({{< relref "../../contact-points/message-templating/template-functions/" >}}) to create notification contact dynamically. ## Annotations @@ -20,6 +28,6 @@ Labels are key-value pairs that contain information about, and are used to uniqu Before you begin using annotations and labels, familiarize yourself with: -- [Labels in Grafana alerting]({{< relref "./how-to-use-labels.md" >}}) -- [How label matching works]({{< relref "./how-to-use-labels.md" >}}) -- [Template variables for alerting rule labels and annotations]({{< relref "./variables-label-annotation.md" >}}) +- [Labels in Grafana alerting]({{< relref "how-to-use-labels/" >}}) +- [How label matching works]({{< relref "how-to-use-labels/" >}}) +- [Template variables for alerting rule labels and annotations]({{< relref "variables-label-annotation/" >}}) diff --git a/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md b/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md index 2eab1aa0859..f5932693bbb 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md +++ b/docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md @@ -1,18 +1,24 @@ -+++ -title = "Labels in Grafana alerting" -description = "Learn about labels and label matchers in alerting" -keywords = ["grafana", "alerting", "guide", "fundamentals"] -weight = 117 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/annotation-label/how-to-use-labels/ +description: Learn about labels and label matchers in alerting +keywords: + - grafana + - alerting + - guide + - fundamentals +title: Labels in Grafana alerting +weight: 117 +--- # Labels in Grafana alerting This topic explains why labels are a fundamental component of alerting. - The complete set of labels for an alert is what uniquely identifies an alert within Grafana alerts. -- The Alertmanager uses labels to match alerts for [silences]({{< relref "../../silences/_index.md" >}}) and [alert groups]({{< relref "../../alert-groups/_index.md" >}}) in [notification policies]({{< relref "../../notifications/_index.md" >}}). +- The Alertmanager uses labels to match alerts for [silences]({{< relref "../../silences/" >}}) and [alert groups]({{< relref "../../alert-groups/" >}}) in [notification policies]({{< relref "../../notifications/" >}}). - The alerting UI shows labels for every alert instance generated during evaluation of that rule. - Contact points can access labels to dynamically generate notifications that contain information specific to the alert that is resulting in a notification. -- Labels can be added to an [alerting rule]({{< relref "../../alerting-rules/_index.md" >}}). These manually configured labels are able to use template functions and reference other labels. Labels added to an alerting rule take precedence in the event of a collision between labels. +- Labels can be added to an [alerting rule]({{< relref "../../alerting-rules/" >}}). These manually configured labels are able to use template functions and reference other labels. Labels added to an alerting rule take precedence in the event of a collision between labels. {{< figure src="/static/img/docs/alerting/unified/rule-edit-details-8-0.png" max-width="550px" caption="Alert details" >}} diff --git a/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md b/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md index 07768d26b36..53f79c4ac61 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md +++ b/docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md @@ -1,13 +1,19 @@ -+++ -title = "Label matchers" -description = "Learn about labels and label matchers in alerting" -keywords = ["grafana", "alerting", "guide", "fundamentals"] -weight = 117 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/annotation-label/labels-and-label-matchers/ +description: Learn about labels and label matchers in alerting +keywords: + - grafana + - alerting + - guide + - fundamentals +title: Label matchers +weight: 117 +--- # How label matching works -Use labels and label matchers to link alert rules to [notification policies]({{< relref "../../notifications/_index.md" >}}) and [silences]({{< relref "../../silences/_index.md" >}}). This allows for a very flexible way to manage your alert instances, specify which policy should handle them, and which alerts to silence. +Use labels and label matchers to link alert rules to [notification policies]({{< relref "../../notifications/" >}}) and [silences]({{< relref "../../silences/" >}}). This allows for a very flexible way to manage your alert instances, specify which policy should handle them, and which alerts to silence. A label matchers consists of 3 distinct parts, the **label**, the **value** and the **operator**. diff --git a/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md b/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md index 362943b8af0..ad8895e4de7 100644 --- a/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md +++ b/docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md @@ -1,9 +1,15 @@ -+++ -title = "Template variables for alerting rule labels and annotations" -description = "Learn about labels and label matchers in alerting" -keywords = ["grafana", "alerting", "guide", "fundamentals"] -weight = 117 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/annotation-label/variables-label-annotation/ +description: Learn about labels and label matchers in alerting +keywords: + - grafana + - alerting + - guide + - fundamentals +title: Template variables for alerting rule labels and annotations +weight: 117 +--- # Template variables for alerting rule labels and annotations diff --git a/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md index f55944766dd..d687261b00e 100644 --- a/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md +++ b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/fundamentals/evaluate-grafana-alerts/", "/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts/"] -title = "Alerting on numeric data" -weight = 116 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/evaluate-grafana-alerts/ + - /docs/grafana/latest/alerting/metrics/ + - /docs/grafana/latest/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts/ +title: Alerting on numeric data +weight: 116 +--- # Alerting on numeric data @@ -21,11 +24,11 @@ Grafana managed alerts query the following backend data sources that have alerti - built-in data sources or those developed and maintained by Grafana: `Graphite`, `Prometheus`, `Loki`, `InfluxDB`, `Elasticsearch`, `Google Cloud Monitoring`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Monitor` -- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../developers/plugins/metadata.md" >}})) +- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../developers/plugins/metadata/" >}})) ### Metrics from the alerting engine -The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../administration/view-server/internal-metrics.md" >}}). See also, [View alert rules and their current state]({{< relref "../alerting-rules/rule-list.md" >}}). +The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../setup-grafana/set-up-grafana-monitoring/" >}}). See also, [View alert rules and their current state]({{< relref "../alerting-rules/rule-list/" >}}). | Metric Name | Type | Description | | ------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------- | diff --git a/docs/sources/alerting/fundamentals/state-and-health.md b/docs/sources/alerting/fundamentals/state-and-health.md index a9e4c92f4b8..dc2ff746fd4 100644 --- a/docs/sources/alerting/fundamentals/state-and-health.md +++ b/docs/sources/alerting/fundamentals/state-and-health.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/fundamentals/state-and-health/", "/docs/grafana/llatest/alerting/unified-alerting/alerting-rules/state-and-health/"] -description = "State and Health of alerting rules" -keywords = ["grafana", "alerting", "guide", "state"] -title = "State and health of alerting rules" -+++ +--- +aliases: + - /docs/grafana/latest/alerting/fundamentals/state-and-health/ + - /docs/grafana/llatest/alerting/unified-alerting/alerting-rules/state-and-health/ +description: State and Health of alerting rules +keywords: + - grafana + - alerting + - guide + - state +title: State and health of alerting rules +--- # State and health of alerting rules diff --git a/docs/sources/alerting/high-availability/_index.md b/docs/sources/alerting/high-availability/_index.md index 766ac32f545..ce631cc2b7b 100644 --- a/docs/sources/alerting/high-availability/_index.md +++ b/docs/sources/alerting/high-availability/_index.md @@ -1,14 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/high-availability/", "/docs/grafana/latest/alerting/unified-alerting/high-availability/"] -description = "High availability" -keywords = ["grafana", "alerting", "tutorials", "ha", "high availability"] -title = " Alerting high availability" -weight = 450 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/high-availability/ + - /docs/grafana/latest/alerting/unified-alerting/high-availability/ +description: High availability +keywords: + - grafana + - alerting + - tutorials + - ha + - high availability +title: ' Alerting high availability' +weight: 450 +--- # About alerting high availability -The Grafana alerting system has two main components: a `Scheduler` and an internal `Alertmanager`. The `Scheduler` evaluates your [alert rules]({{< relref "../fundamentals/evaluate-grafana-alerts.md" >}}), while the internal Alertmanager manages **routing** and **grouping**. +The Grafana alerting system has two main components: a `Scheduler` and an internal `Alertmanager`. The `Scheduler` evaluates your [alert rules]({{< relref "../fundamentals/evaluate-grafana-alerts/" >}}), while the internal Alertmanager manages **routing** and **grouping**. When running Grafana alerting in high availability, the operational mode of the scheduler remains unaffected, and each Grafana instance evaluates all alerts. The operational change happens in the Alertmanager when it deduplicates alert notifications across Grafana instances. @@ -23,4 +30,4 @@ The two types of messages gossiped between Grafana instances are: The notification logs and silences are persisted in the database periodically and during a graceful Grafana shut down. -For configuration instructions, refer to [enable alerting high availability]({{< relref "./enable-alerting-ha.md" >}}). +For configuration instructions, refer to [enable alerting high availability]({{< relref "enable-alerting-ha/" >}}). diff --git a/docs/sources/alerting/high-availability/enable-alerting-ha.md b/docs/sources/alerting/high-availability/enable-alerting-ha.md index 2b2c48d245c..c040be3cf00 100644 --- a/docs/sources/alerting/high-availability/enable-alerting-ha.md +++ b/docs/sources/alerting/high-availability/enable-alerting-ha.md @@ -1,14 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/high-availability/enable-alerting-ha/", "/docs/grafana/latest/alerting/unified-alerting/high-availability/"] -description = "Enable alerting high availability" -keywords = ["grafana", "alerting", "tutorials", "ha", "high availability"] -title = "Enable alerting high availability" -weight = 450 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/high-availability/enable-alerting-ha/ + - /docs/grafana/latest/alerting/unified-alerting/high-availability/ +description: Enable alerting high availability +keywords: + - grafana + - alerting + - tutorials + - ha + - high availability +title: Enable alerting high availability +weight: 450 +--- # Enable alerting high availability -You can enable [alerting high availability]({{< relref "./_index.md" >}}) support by updating the Grafana configuration file. On Kubernetes, you can enable alerting high availability by updating the Kubernetes container definition. +You can enable [alerting high availability]({{< relref "_index.md" >}}) support by updating the Grafana configuration file. On Kubernetes, you can enable alerting high availability by updating the Kubernetes container definition. ## Update Grafana configuration file diff --git a/docs/sources/alerting/migrating-alerts/_index.md b/docs/sources/alerting/migrating-alerts/_index.md new file mode 100644 index 00000000000..3824cd50f1d --- /dev/null +++ b/docs/sources/alerting/migrating-alerts/_index.md @@ -0,0 +1,27 @@ +--- +aliases: + - /docs/grafana/latest/alerting/migrating-alerts/ +description: Migrate Grafana alerts +title: Migrate to Grafana alerting +weight: 113 +--- + +# Migrate to Grafana alerting + +Grafana alerting is the default for new Cloud, Enterprise, and OSS installations. The new installations will only show the Grafana alerting icon in the left navigation panel. + +Existing installations that upgrade to v9.0 will have Grafana alerting enabled by default. + +| Grafana instance upgraded to v 90 | | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Cloud | Existing Cloud installations with legacy dashboard alerting will have two alerting icons in the left navigation panel - the old alerting plugin icon and the new Grafana alerting icon. During upgrade, existing alerts from the Cloud alerting plugin are migrated to Grafana alerting. Once migration is complete, you can access aman manage the older alerts from the new alerting Grafana alerting icon in the navigation panel. The (older) Cloud alerting plugin is uninstalled from your cloud instance. Contact customer support if you **do not wish** to migrate to Grafana alerting for your Cloud stack. If you choose to use legacy alerting, use the You will see the new Grafana alerting icon as well as the old Cloud alerting plugin in the left navigation panel. | +| Enterprise | Existing Enterprise instances using legacy alerting will have both the old (marked as legacy) and the new alerting icons in the navigation panel. During upgrade, existing legacy alerts are migrated to Grafana alerting. If you wish, you can [opt-out]({{< relref "opt-out/" >}}) of Grafana alerting and roll back to legacy alerting. In that case, you can manage your legacy alerts from the alerting icon marked as legacy. | +| OSS | Existing OSS installations with legacy dashboard alerting will have two alerting icons in the left navigation panel - the old alerting icon (marked as legacy) and the new Grafana alerting icon. During upgrade, existing legacy alerts are migrated to Grafana alerting. If you wish, you can [opt-out]({{< relref "opt-out/" >}}) of Grafana alerting and roll back to legacy alerting. In that case, you can manage your legacy alerts from the alerting icon marked as legacy. | + +During migration from legacy alerting to unified alerting, the legacy alerts are updated to the new alerts type, as a result, the user does not lose alerts or alerting data. However, if a user rolls back to legacy alerting after having migrated to unified alerting, they will only get the legacy alerts they had right before migration. + +## Roll back to legacy alerting + +Although we encourage you to use Grafana alerting, roll back to legacy alerting is supported in Grafana 9. Rolling back can result in data loss (you will loose all alerts that you created using Grafana alerting). This is applicable to the fresh installation as well as upgraded setups. + +> **Note:** Legacy alerting will be deprecated in a future release (v10). diff --git a/docs/sources/alerting/migrating-legacy-alerts.md b/docs/sources/alerting/migrating-alerts/migrating-legacy-alerts.md similarity index 55% rename from docs/sources/alerting/migrating-legacy-alerts.md rename to docs/sources/alerting/migrating-alerts/migrating-legacy-alerts.md index 51dfd5ffac7..c9fd8e5409a 100644 --- a/docs/sources/alerting/migrating-legacy-alerts.md +++ b/docs/sources/alerting/migrating-alerts/migrating-legacy-alerts.md @@ -1,13 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/migrating-legacy-alerts/", "/docs/grafana/latest/alerting/unified-alerting/opt-in/"] -description = "Migrate legacy dashboard alerts" -title = "Migrating legacy dashboard alerts" -weight = 114 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/migrating-alerts/migrating-legacy-alerts/ + - /docs/grafana/latest/alerting/migrating-legacy-alerts/ + - /docs/grafana/latest/alerting/unified-alerting/opt-in/ +description: Migrate legacy dashboard alerts +title: Migrating legacy dashboard alerts +weight: 114 +--- # Migrating legacy dashboard alerts -When Grafana alerting is enabled or Grafana is upgraded to the latest version, existing legacy dashboard alerts migrate in a format compatible with the Grafana alerting. In the Alerting page of your Grafana instance, you can view the migrated alerts alongside new alerts. +When Grafana alerting is enabled or Grafana is upgraded to the latest version, existing legacy dashboard alerts migrate in a format compatible with the Grafana alerting. In the Alerting page of your Grafana instance, you can view the migrated alerts alongside any new alerts. This topic explains how legacy dashboard alerts are migrated and some limitations. + +> **Note:** This topic is only relevant for OSS and Enterprise customers. Contact customer support to enable or disable Grafana alerting for your Cloud stack. Read and write access to legacy dashboard alerts and Grafana alerts are governed by the permissions of the folders storing them. During migration, legacy dashboard alert permissions are matched to the new rules permissions as follows: @@ -15,20 +20,9 @@ Read and write access to legacy dashboard alerts and Grafana alerts are governed - If there are no dashboard permissions and the dashboard is under a folder, then the rule is linked to this folder and inherits its permissions. - If there are no dashboard permissions and the dashboard is under the General folder, then the rule is linked to the `General Alerting` folder, and the rule inherits the default permissions. -> **Note:** Since there is no `Keep Last State` option for [`No Data`]({{< relref "./alerting-rules/create-grafana-managed-rule/#no-data--error-handling" >}}) in Grafana alerting, this option becomes `NoData` during the legacy rules migration. Option "Keep Last State" for [`Error handling`]({{< relref "./alerting-rules/create-grafana-managed-rule/#no-data--error-handling" >}}) is migrated to a new option `Error`. To match the behavior of the `Keep Last State`, in both cases, during the migration Grafana automatically creates a [silence]({{< relref "./silences/_index.md" >}}) for each alert rule with a duration of 1 year. +> **Note:** Since there is no `Keep Last State` option for [`No Data`]({{< relref "../alerting-rules/create-grafana-managed-rule/#no-data--error-handling" >}}) in Grafana alerting, this option becomes `NoData` during the legacy rules migration. Option "Keep Last State" for [`Error handling`]({{< relref "../alerting-rules/create-grafana-managed-rule/#no-data--error-handling" >}}) is migrated to a new option `Error`. To match the behavior of the `Keep Last State`, in both cases, during the migration Grafana automatically creates a [silence]({{< relref "../silences/" >}}) for each alert rule with a duration of 1 year. Notification channels are migrated to an Alertmanager configuration with the appropriate routes and receivers. Default notification channels are added as contact points to the default route. Notification channels not associated with any Dashboard alert go to the `autogen-unlinked-channel-recv` route. Since `Hipchat` and `Sensu` notification channels are no longer supported, legacy alerts associated with these channels are not automatically migrated to Grafana alerting. Assign the legacy alerts to a supported notification channel so that you continue to receive notifications for those alerts. Silences (expiring after one year) are created for all paused dashboard alerts. - -## Disable Grafana alerts - -To disable Grafana alerts and enable legacy dashboard alerts: - -1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. -1. Set the `enabled` property to `false`. -1. For [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `true`. -1. Restart Grafana for the configuration changes to take effect. - -> **Note:** Switching from one flavor of alerting to another can result in data loss. This is applicable to the fresh installation as well as upgraded setups. diff --git a/docs/sources/alerting/migrating-alerts/opt-out.md b/docs/sources/alerting/migrating-alerts/opt-out.md new file mode 100644 index 00000000000..b270a532461 --- /dev/null +++ b/docs/sources/alerting/migrating-alerts/opt-out.md @@ -0,0 +1,43 @@ +--- +aliases: + - /docs/grafana/latest/alerting/migrating-alerts/opt-out/ + - /docs/grafana/latest/alerting/opt-in/ + - /docs/grafana/latest/alerting/unified-alerting/opt-in/ +description: Disable Grafana alerts +title: Opt-out of Grafana alerting +weight: 113 +--- + +# Opt-out to Grafana alerting in OSS + +This topic discusses how to disable Grafana alerting and migrate to legacy dashboard alerting. It also provides guidance on how to enable Grafana alerting once you are ready to migrate to Grafana alerting. + +> **Note:** This topic is only relevant for OSS and Enterprise customers. Contact customer support to enable or disable Grafana alerting for your Grafana Cloud stack. + +## Before you begin + +We recommend that you backup Grafana's database. If you are using PostgreSQL as the backend database, then the minimum required version is 9.5. + +## Opt-out of Grafana alerts + +To opt-out of Grafana alerts and roll back to legacy dashboard alerting: + +1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../../setup-grafana/configure-grafana/#unified_alerting" >}}) section. +1. Set the `enabled` property to `false`. +1. For [legacy dashboard alerting]({{< relref "../../setup-grafana/configure-grafana/#alerting" >}}), set the `enabled` flag to `true`. +1. Restart Grafana for the configuration changes to take effect. + +> **Note:** Rolling back from Grafana to legacy alerting can result in data loss. This is applicable to the fresh installation as well as upgraded setups. + +## Opt-in to Grafana alerting + +When you are ready to make the switch, the following procedure will help you migrate to Grafana alerting. + +To opt-in to Grafana alerts: + +1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [unified alerts]({{< relref "../../setup-grafana/configure-grafana/#unified_alerting" >}}) section. +1. Set the `enabled` property to `true`. +1. Next, for [legacy dashboard alerting]({{< relref "../../setup-grafana/configure-grafana/#alerting" >}}), set the `enabled` flag to `false`. +1. Restart Grafana for the configuration changes to take effect. + +> **Note:** The `ngalert` toggle previously used to enable or disable Grafana alerting is no longer available. diff --git a/docs/sources/alerting/notifications/_index.md b/docs/sources/alerting/notifications/_index.md index 01fef50d0a2..1a168328410 100644 --- a/docs/sources/alerting/notifications/_index.md +++ b/docs/sources/alerting/notifications/_index.md @@ -1,16 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/notifications/", "/docs/grafana/latest/alerting/unified-alerting/notifications/"] -description = "Notification policies" -keywords = ["grafana", "alerting", "guide", "notification policies", "routes"] -title = "Notification policies" -weight = 440 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/notifications/ + - /docs/grafana/latest/alerting/unified-alerting/notifications/ +description: Notification policies +keywords: + - grafana + - alerting + - guide + - notification policies + - routes +title: Notification policies +weight: 440 +--- # Notification policies Notification policies determine how alerts are routed to contact points. Policies have a tree structure, where each policy can have one or more child policies. Each policy, except for the root policy, can also match specific alert labels. Each alert is evaluated by the root policy and subsequently by each child policy. If you enable the `Continue matching subsequent sibling nodes` option is enabled for a specific policy, then evaluation continues even after one or more matches. A parent policy’s configuration settings and contact point information govern the behavior of an alert that does not match any of the child policies. A root policy governs any alert that does not match a specific policy. -You can configure Grafana managed notification policies as well as notification policies for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed notification policies as well as notification policies for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager/" >}}). ## Grouping @@ -34,7 +41,7 @@ You can configure grouping to be `group_by: [alertname]` (take note that the `en 1. Click **Notification policies**. 1. From the **Alertmanager** dropdown, select an external Alertmanager. By default, the Grafana Alertmanager is selected. 1. In the Root policy section, click **Edit** (pen icon). -1. In **Default contact point**, update the [contact point]({{< relref "../contact-points/_index.md" >}}) to whom notifications should be sent for rules when alert rules do not match any specific policy. +1. In **Default contact point**, update the [contact point]({{< relref "../contact-points/" >}}) to whom notifications should be sent for rules when alert rules do not match any specific policy. 1. In **Group by**, choose labels to group alerts by. If multiple alerts are matched for this policy, then they are grouped by these labels. A notification is sent per group. If the field is empty (default), then all notifications are sent in a single group. Use a special label `...` to group alerts by all labels (which effectively disables grouping). 1. In **Timing options**, select from the following options: - **Group wait** Time to wait to buffer alerts of the same group before sending an initial notification. Default is 30 seconds. @@ -48,8 +55,8 @@ You can configure grouping to be `group_by: [alertname]` (take note that the `en 1. Click **Notification policies**. 1. From the **Alertmanager** dropdown, select an Alertmanager. By default, the Grafana Alertmanager is selected. 1. To add a top level specific policy, go to the **Specific routing** section and click **New specific policy**. -1. In **Matching labels** section, add one or more rules for matching alert labels. For more information, see ["Labels and label matchers"]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers.md" >}}). -1. In **Contact point**, add the [contact point]({{< relref "../contact-points/_index.md" >}}) to send notification to if alert matches only this specific policy and not any of the nested policies. +1. In **Matching labels** section, add one or more rules for matching alert labels. For more information, see ["Labels and label matchers"]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers/" >}}). +1. In **Contact point**, add the [contact point]({{< relref "../contact-points/" >}}) to send notification to if alert matches only this specific policy and not any of the nested policies. 1. Optionally, enable **Continue matching subsequent sibling nodes** to continue matching nested policies even after the alert matched the parent policy. When this option is enabled, you can get more than one notification. Use it to send notification to a catch-all contact point as well as to one of more specific contact points handled by nested policies. 1. Optionally, enable **Override grouping** to specify the same grouping as the root policy. If this option is not enabled, the root policy grouping is used. 1. Optionally, enable **Override general timings** to override the timing options configured in the group notification policy. diff --git a/docs/sources/alerting/notifications/mute-timings.md b/docs/sources/alerting/notifications/mute-timings.md index 4fbab31dd21..d8d7dc8db32 100644 --- a/docs/sources/alerting/notifications/mute-timings.md +++ b/docs/sources/alerting/notifications/mute-timings.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/notifications/mute-timings/", "/docs/grafana/latest/alerting/unified-alerting/notifications/mute-timings/"] -description = "Mute timings" -keywords = ["grafana", "alerting", "guide", "mute", "mute timings", "mute time interval"] -title = "Mute timings" -weight = 450 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/notifications/mute-timings/ + - /docs/grafana/latest/alerting/unified-alerting/notifications/mute-timings/ +description: Mute timings +keywords: + - grafana + - alerting + - guide + - mute + - mute timings + - mute time interval +title: Mute timings +weight: 450 +--- # Mute timings @@ -12,7 +20,7 @@ A mute timing is a recurring interval of time when no new notifications for a po Similar to silences, mute timings do not prevent alert rules from being evaluated, nor do they stop alert instances from being shown in the user interface. They only prevent notifications from being created. -You can configure Grafana managed mute timings as well as mute timings for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager documentation]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed mute timings as well as mute timings for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}). For more information, see [Alertmanager documentation]({{< relref "../fundamentals/alertmanager/" >}}). ## Mute timings vs silences diff --git a/docs/sources/alerting/opt-in.md b/docs/sources/alerting/opt-in.md deleted file mode 100644 index ca31f27b927..00000000000 --- a/docs/sources/alerting/opt-in.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/opt-in/", "/docs/grafana/latest/alerting/unified-alerting/opt-in/"] -description = "Enable Grafana alerts" -title = "Opt-in to Grafana alerting" -weight = 113 -+++ - -# Opt-in to Grafana alerting in OSS - -Grafana alerting is enabled by default for new Cloud and OSS installations. - -- For existing OSS installations that use legacy dashboard alerts, unified alerting is still an opt-in feature. -- For existing Grafana Cloud users, contact customer support to enable Grafana alerting for your Cloud stack. - -## Before you begin - -We recommend that you backup Grafana's database. If you are using PostgreSQL as the backend database, then the minimum required version is 9.5. - -## Enable Grafana alerting - -To enable Grafana alerts: - -1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [unified alerts]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. -2. Set the `enabled` property to `true`. -3. Next, for [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `false`. -4. Restart Grafana for the configuration changes to take effect. - -> **Note:** The `ngalert` toggle previously used to enable or disable Grafana alerting is no longer available. - -Before v8.2, notification logs and silences were stored on a disk. If you did not use persistent disks, you would have lost any configured silences and logs on a restart, resulting in unwanted or duplicate notifications. We no longer require the use of a persistent disk. Instead, the notification logs and silences are stored regularly (every 15 minutes). If you used the file-based approach, Grafana reads the existing file and persists it eventually. - -## Disable Grafana alerts - -To disable Grafana alerts and roll back to legacy dashboard alerting: - -1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. -1. Set the `enabled` property to `false`. -1. For [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `true`. -1. Restart Grafana for the configuration changes to take effect. - -> **Note:** Switching from one flavor of alerting to another can result in data loss. This is applicable to the fresh installation as well as upgraded setups. diff --git a/docs/sources/alerting/performance.md b/docs/sources/alerting/performance.md new file mode 100644 index 00000000000..a24fa0bb661 --- /dev/null +++ b/docs/sources/alerting/performance.md @@ -0,0 +1,24 @@ ++++ +title = "Performance considerations" +description = "Understanding alerting performance" +keywords = ["grafana", "alerting", "performance"] +weight = 100 ++++ + +# Alerting performance considerations + +Grafana alerting supports multi-dimensional alerting, where one alert rule can generate many alerts. For example, you can configure an alert rule to fire an alert every time the CPU of individual VMs max out. This topic discusses performance considerations resulting from multi-dimensional alerting. + +Evaluating alerting rules consumes RAM and CPU to compute the output of an alerting query, and network resources to send alert notifications and write the results to the Grafana SQL database. The configuration of individual alert rules affects the resource consumption and, therefore, the maximum number of rules a given configuration can support. + +The following section provides a list of alerting performance considerations. + +- Frequency of rule evaluation consideration. The "Evaluate Every" property of an alert rule controls the frequency of rule evaluation. We recommend using the lowest acceptable evaluation frequency to support more concurrent rules. +- Cardinality of the rule's result set. For example, suppose you are monitoring API response errors for every API path, on every VM in your fleet. This set has a cardinality of _n_ number of paths multiplied by _v_ number of VMs. You can reduce the cardinality of a result set - perhaps by monitoring errors-per-VM instead of for each path per VM. +- Complexity of the alerting query consideration. Queries that data sources can process and respond to quickly consume fewer resources. Although this consideration is less important than the other considerations listed above, if you have reduced those as much as possible, looking at individual query performance could make a difference. + +Each evaluation of an alert rule generates a set of alert instances; one for each member of the result set. The state of all the instances is written to the `alert_instance` table in Grafana's SQL database. + +Grafana alerting exposes a metric, `grafana_alerting_rule_evaluations_total` that counts the number of alert rule evaluations. To get a feel for the influence of rule evaluations on your Grafana instance, you can observe the rate of evaluations and compare it with resource consumption. In a Prometheus-compatible database, you can use the query `rate(grafana_alerting_rule_evaluations_total[5m])` to compute the rate over 5 minute windows of time. It's important to remember that this isn't the full picture of rule evaluation. For example, the load will be unevenly distributed if you have some rules that evaluate every 10 seconds, and others every 30 minutes. + +These factors all affect the load on the Grafana instance, but you should also be aware of the performance impact that evaluating these rules has on your data sources. Alerting queries are often the vast majority of queries handled by monitoring databases, so the same load factors that affect the Grafana instance affect them as well. diff --git a/docs/sources/alerting/silences/_index.md b/docs/sources/alerting/silences/_index.md index 1374ade3259..a2516e6101d 100644 --- a/docs/sources/alerting/silences/_index.md +++ b/docs/sources/alerting/silences/_index.md @@ -1,10 +1,16 @@ -+++ -title = "Silences" -description = "Silences" -keywords = ["grafana", "alerting", "silence", "mute"] -weight = 450 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/silences/ + - /docs/grafana/latest/alerting/unified-alerting/silences/ +description: Silences +keywords: + - grafana + - alerting + - silence + - mute +title: Silences +weight: 450 +--- # About alerting silences @@ -12,12 +18,12 @@ Use silences to stop notifications from one or more alerting rules. Silences do Silences do not prevent alert rules from being evaluated. They also do not stop alert instances from being shown in the user interface. Silences only prevent notifications from being created. -You can configure Grafana managed silences as well as silences for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed silences as well as silences for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager/" >}}). See also: -- [How label matching works]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers.md" >}}) -- [Create a silence]({{< relref "./create-silence.md" >}}) -- [Create a URL to link to a silence form]({{< relref "./linking-to-silence-form.md" >}}) -- [Edit silences]({{< relref "./edit-silence.md" >}}) -- [Remove a silences]({{< relref "./remove-silence.md" >}}) +- [How label matching works]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers/" >}}) +- [Create a silence]({{< relref "create-silence/" >}}) +- [Create a URL to link to a silence form]({{< relref "linking-to-silence-form/" >}}) +- [Edit silences]({{< relref "edit-silence/" >}}) +- [Remove silences]({{< relref "remove-silence/" >}}) diff --git a/docs/sources/alerting/silences/create-silence.md b/docs/sources/alerting/silences/create-silence.md index 10e38417ddd..893fca76ed2 100644 --- a/docs/sources/alerting/silences/create-silence.md +++ b/docs/sources/alerting/silences/create-silence.md @@ -1,10 +1,16 @@ -+++ -title = "Create a silence" -description = "Add silence alert notification" -keywords = ["grafana", "alerting", "silence", "mute"] -weight = 450 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/silences/create-silence/ + - /docs/grafana/latest/alerting/unified-alerting/silences/ +description: Add silence alert notification +keywords: + - grafana + - alerting + - silence + - mute +title: Create a silence +weight: 450 +--- # Create a silence @@ -18,7 +24,7 @@ To add a silence: 4. Click **New Silence** to open the Create silence page. 5. In **Silence start and end**, select the start and end date to indicate when the silence should go into effect and expire. 6. Optionally, in **Duration**, specify how long the silence is enforced. This automatically updates the end time in the **Silence start and end** field. -7. In the **Name** and **Value** fields, enter one or more _Matching Labels_. Matchers determine which rules the silence will apply to. For more information, see [how label matching works]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers.md" >}}). +7. In the **Name** and **Value** fields, enter one or more _Matching Labels_. Matchers determine which rules the silence will apply to. For more information, see [how label matching works]({{< relref "../fundamentals/annotation-label/labels-and-label-matchers/" >}}). 8. In **Comment**, add details about the silence. 9. In **Creator**, enter the name of the silence owner or keep the default owner. 10. Click **Create**. diff --git a/docs/sources/alerting/silences/edit-silence.md b/docs/sources/alerting/silences/edit-silence.md index d2460b70e4b..ba182836cdd 100644 --- a/docs/sources/alerting/silences/edit-silence.md +++ b/docs/sources/alerting/silences/edit-silence.md @@ -1,10 +1,16 @@ -+++ -title = "Edit silences" -description = "Edit alerting silences" -keywords = ["grafana", "alerting", "silence", "mute"] -weight = 450 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/silences/edit-silence/ + - /docs/grafana/latest/alerting/unified-alerting/silences/ +description: Edit alerting silences +keywords: + - grafana + - alerting + - silence + - mute +title: Edit silences +weight: 450 +--- # Edit silences diff --git a/docs/sources/alerting/silences/linking-to-silence-form.md b/docs/sources/alerting/silences/linking-to-silence-form.md index 8bb4e5a2be9..84111b88294 100644 --- a/docs/sources/alerting/silences/linking-to-silence-form.md +++ b/docs/sources/alerting/silences/linking-to-silence-form.md @@ -1,10 +1,16 @@ -+++ -title = "Create URL to link to silence form" -description = "Linking to a silence form" -keywords = ["grafana", "alerting", "silence", "mute"] -weight = 451 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/silences/linking-to-silence-form/ + - /docs/grafana/latest/alerting/unified-alerting/silences/ +description: Linking to a silence form +keywords: + - grafana + - alerting + - silence + - mute +title: Create URL to link to silence form +weight: 451 +--- # Create a URL to link to a silence form @@ -12,4 +18,4 @@ When linking to a silence form, provide the default matching labels and comment For example, to link to silence form with matching labels `severity=critical` & `cluster!~europe-.*` and comment `Silence critical EU alerts`, create a URL `https://mygrafana/alerting/silence/new?matchers=severity%3Dcritical%2Ccluster!~europe-*&comment=Silence%20critical%20EU%20alert`. -To link to a new silence page for an [external Alertmanager]({{< relref "../../datasources/alertmanager.md" >}}), add a `alertmanager` query parameter with the Alertmanager data source name. +To link to a new silence page for an [external Alertmanager]({{< relref "../../datasources/alertmanager/" >}}), add a `alertmanager` query parameter with the Alertmanager data source name. diff --git a/docs/sources/alerting/silences/remove-silence.md b/docs/sources/alerting/silences/remove-silence.md index 32f03a32f67..f3a4c3daa82 100644 --- a/docs/sources/alerting/silences/remove-silence.md +++ b/docs/sources/alerting/silences/remove-silence.md @@ -1,10 +1,16 @@ -+++ -title = "Remove silences" -description = "Remove alerting silences" -keywords = ["grafana", "alerting", "silence", "mute"] -weight = 451 -aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] -+++ +--- +aliases: + - /docs/grafana/latest/alerting/silences/remove-silence/ + - /docs/grafana/latest/alerting/unified-alerting/silences/ +description: Remove alerting silences +keywords: + - grafana + - alerting + - silence + - mute +title: Remove silences +weight: 451 +--- # Remove silences diff --git a/docs/sources/auth/_index.md b/docs/sources/auth/_index.md deleted file mode 100644 index 502c7f3e8e6..00000000000 --- a/docs/sources/auth/_index.md +++ /dev/null @@ -1,26 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/auth/"] -description = "Authentication" -title = "Authentication" -weight = 30 -+++ - -# User Authentication Overview - -Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user permissions and org memberships. - -Here is a table showing all supported authentication providers and the features available for them. [Team sync]({{< relref "../enterprise/team-sync.md" >}}) and [active sync]({{< relref "../enterprise/enhanced_ldap.md#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. - -See also, [Grafana Authentication]({{< relref "grafana.md" >}}). - -| Provider | Support | Role mapping | Team sync
_(Enterprise only)_ | Active sync
_(Enterprise only)_ | -| -------------------------------------------------------------- | :-----: | :----------: | :-------------------------------: | :---------------------------------: | -| [Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - | -| [Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - | -| [Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - | -| [GitHub OAuth]({{< relref "github.md" >}}) | v2.0+ | - | v6.3+ | - | -| [GitLab OAuth]({{< relref "gitlab.md" >}}) | v5.3+ | - | v6.4+ | - | -| [Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - | -| [LDAP]({{< relref "ldap.md" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ | -| [Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - | -| [SAML]({{< relref "../enterprise/saml/" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - | diff --git a/docs/sources/auth/enhanced_ldap.md b/docs/sources/auth/enhanced_ldap.md deleted file mode 100644 index eb8f0750eec..00000000000 --- a/docs/sources/auth/enhanced_ldap.md +++ /dev/null @@ -1,13 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/auth/enhanced_ldap/"] -description = "Grafana Enhanced LDAP Integration Guide " -keywords = ["grafana", "configuration", "documentation", "ldap", "active directory", "enterprise"] -title = "Enhanced LDAP Integration" -weight = 400 -+++ - -# Enhanced LDAP integration - -The enhanced LDAP integration adds additional functionality on top of the existing [LDAP integration]({{< relref "ldap.md" >}}). - -> Enhanced LDAP integration is only available in Grafana Enterprise. For more information, refer to [Enhanced LDAP integration]({{< relref "../enterprise/enhanced_ldap.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). diff --git a/docs/sources/auth/saml.md b/docs/sources/auth/saml.md deleted file mode 100644 index 98e921da278..00000000000 --- a/docs/sources/auth/saml.md +++ /dev/null @@ -1,13 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/auth/saml/"] -description = "Grafana SAML Authentication" -keywords = ["grafana", "saml", "documentation", "saml-auth"] -title = "SAML Authentication" -weight = 1100 -+++ - -# SAML authentication - -The SAML authentication integration allows your Grafana users to log in by using an external SAML Identity Provider (IdP). To enable this, Grafana becomes a Service Provider (SP) in the authentication flow, interacting with the IdP to exchange user information. - -> SAML authentication integration is available in Grafana Cloud Pro and Advanced and in Grafana Enterprise. For more information, refer to [SAML authentication]({{< relref "../enterprise/saml/" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). diff --git a/docs/sources/auth/team-sync.md b/docs/sources/auth/team-sync.md deleted file mode 100644 index 9bebec819fc..00000000000 --- a/docs/sources/auth/team-sync.md +++ /dev/null @@ -1,22 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/auth/saml/", "/docs/grafana/latest/auth/team-sync/"] -description = "Grafana Team Sync" -keywords = ["grafana", "auth", "documentation"] -title = "Team Sync" -weight = 1200 -+++ - -# Team sync - -With Team Sync, you can set up synchronization between your auth provider's teams and teams in Grafana. This enables LDAP or GitHub OAuth users which are members -of certain teams/groups to automatically be added/removed as members to certain teams in Grafana. Currently the synchronization will only happen every -time a user logs in, unless LDAP is used together with active background synchronization that was added in Grafana 6.3. - -{{< figure src="/static/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}} - -Grafana keeps track of all synchronized users in teams and you can see which users have been synchronized in the team members list, see `LDAP` label in screenshot. -This mechanism allows Grafana to remove an existing synchronized user from a team when its LDAP group membership (for example) changes. This mechanism also enables you to manually add a user as member of a team and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships. - -
- -> Team Sync is available in both Grafana Enterprise and Grafana Cloud Advanced. For more information, refer to [Team sync]({{< relref "../enterprise/team-sync.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). diff --git a/docs/sources/basics/_index.md b/docs/sources/basics/_index.md index f26094e6311..2c67abb9305 100644 --- a/docs/sources/basics/_index.md +++ b/docs/sources/basics/_index.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/basics/"] -title = "Grafana basics" -weight = 15 -+++ +--- +aliases: + - /docs/grafana/latest/basics/ +title: Grafana basics +weight: 15 +--- # Grafana basics diff --git a/docs/sources/basics/exemplars/_index.md b/docs/sources/basics/exemplars/_index.md index 4696922e319..d11ae5ca917 100644 --- a/docs/sources/basics/exemplars/_index.md +++ b/docs/sources/basics/exemplars/_index.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/basics/exemplars/"] -description = "Exemplars" -keywords = ["grafana", "concepts", "exemplars", "prometheus"] -title = "Exemplars" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/basics/exemplars/ +description: Exemplars +keywords: + - grafana + - concepts + - exemplars + - prometheus +title: Exemplars +weight: 400 +--- # Introduction to exemplars @@ -16,10 +21,10 @@ To identify the factors that are contributing to the latency, you must compare a Use exemplars to help isolate problems within your data distribution by pinpointing query traces exhibiting high latency within a time interval. Once you localize the latency problem to a few exemplar traces, you can combine it with additional system based information or location properties to perform a root cause analysis faster, leading to quick resolutions to performance issues. -Support for exemplars is available for the Prometheus data source only. Once you enable the functionality, exemplars data is available by default. For more information on exemplar configuration and how to enable exemplars, refer to [configuring exemplars in Prometheus data source]({{< relref "../../datasources/prometheus.md#configuring-exemplars" >}}). +Support for exemplars is available for the Prometheus data source only. Once you enable the functionality, exemplars data is available by default. For more information on exemplar configuration and how to enable exemplars, refer to [configuring exemplars in Prometheus data source]({{< relref "../../datasources/prometheus/#configuring-exemplars" >}}). Grafana shows exemplars alongside a metric in the Explore view and in dashboards. Each exemplar displays as a highlighted star. You can hover your cursor over an exemplar to view the unique traceID, which is a combination of a key value pair. To investigate further, click the blue button next to the `traceID` property. {{< figure src="/static/img/docs/v74/exemplars.png" class="docs-image--no-shadow" max-width= "750px" caption="Screenshot showing the detail window of an Exemplar" >}} -Refer to [View exemplar data]({{< relref "./view-exemplars.md" >}}) for instructions on how to drill down and view exemplar trace details from metrics and logs. To know more about exemplars, refer to the blogpost [Intro to exemplars, which enable Grafana Tempo’s distributed tracing at massive scale](https://grafana.com/blog/2021/03/31/intro-to-exemplars-which-enable-grafana-tempos-distributed-tracing-at-massive-scale/). +Refer to [View exemplar data]({{< relref "view-exemplars/" >}}) for instructions on how to drill down and view exemplar trace details from metrics and logs. To know more about exemplars, refer to the blogpost [Intro to exemplars, which enable Grafana Tempo’s distributed tracing at massive scale](https://grafana.com/blog/2021/03/31/intro-to-exemplars-which-enable-grafana-tempos-distributed-tracing-at-massive-scale/). diff --git a/docs/sources/basics/exemplars/view-exemplars.md b/docs/sources/basics/exemplars/view-exemplars.md index 4453ebf91ad..0aa4ba68816 100644 --- a/docs/sources/basics/exemplars/view-exemplars.md +++ b/docs/sources/basics/exemplars/view-exemplars.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/basics/exemplars/view-exemplars/"] -description = "Exemplars" -keywords = ["grafana", "concepts", "exemplars", "prometheus"] -title = "View exemplar data" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/basics/exemplars/view-exemplars/ +description: Exemplars +keywords: + - grafana + - concepts + - exemplars + - prometheus +title: View exemplar data +weight: 400 +--- # View exemplar data @@ -12,7 +17,7 @@ When support for exemplar support is enabled for a Prometheus data source, you c ## In Explore -Explore visualizes exemplar traces as highlighted stars alongside metrics data. For more information on how Explore visualizes trace data, refer to [Tracing in Explore]({{< relref "../../explore/trace-integration.md" >}}). +Explore visualizes exemplar traces as highlighted stars alongside metrics data. For more information on how Explore visualizes trace data, refer to [Tracing in Explore]({{< relref "../../explore/trace-integration/" >}}). To examine the details of an exemplar trace: @@ -28,7 +33,7 @@ For more information on how to drill down and analyze the trace and span details ## In logs -You can also view exemplar trace details from the Loki logs in Explore. Use regex within the Derived fields links for Loki to extract the `traceID` information. Now when you expand Loki logs, you can see a `traceID` property under the **Detected fields** section. To learn more about how to extract a part of a log message into an internal or external link, refer to [using derived fields in Loki]({{< relref "../../explore/logs-integration.md" >}}). +You can also view exemplar trace details from the Loki logs in Explore. Use regex within the Derived fields links for Loki to extract the `traceID` information. Now when you expand Loki logs, you can see a `traceID` property under the **Detected fields** section. To learn more about how to extract a part of a log message into an internal or external link, refer to [using derived fields in Loki]({{< relref "../../explore/logs-integration/" >}}). To view the details of an exemplar trace: diff --git a/docs/sources/basics/glossary.md b/docs/sources/basics/glossary.md index 04380473f02..1fd9828ed8a 100644 --- a/docs/sources/basics/glossary.md +++ b/docs/sources/basics/glossary.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/basics/glossary/", "/docs/grafana/latest/getting-started/glossary/", "/docs/grafana/latest/guides/glossary/"] -description = "Grafana glossary" -keywords = ["grafana", "intro", "glossary", "dictionary"] -title = "Glossary" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/basics/glossary/ + - /docs/grafana/latest/getting-started/glossary/ + - /docs/grafana/latest/guides/glossary/ +description: Grafana glossary +keywords: + - grafana + - intro + - glossary + - dictionary +title: Glossary +weight: 800 +--- # Glossary diff --git a/docs/sources/basics/intro-histograms.md b/docs/sources/basics/intro-histograms.md index a3c00e80a0f..5d1138eb770 100644 --- a/docs/sources/basics/intro-histograms.md +++ b/docs/sources/basics/intro-histograms.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/basics/intro-histograms/", "/docs/grafana/latest/getting-started/intro-histograms/"] -description = "An introduction to histograms and heatmaps" -keywords = ["grafana", "heatmap", "panel", "documentation", "histogram"] -title = "Histograms and heatmaps" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/basics/intro-histograms/ + - /docs/grafana/latest/getting-started/intro-histograms/ +description: An introduction to histograms and heatmaps +keywords: + - grafana + - heatmap + - panel + - documentation + - histogram +title: Histograms and heatmaps +weight: 700 +--- # Introduction to histograms and heatmaps @@ -25,7 +32,7 @@ Here is an example showing height distribution of people. {{< figure src="/static/img/docs/histogram-panel/histogram-example-v8-0.png" max-width="625px" caption="Bar chart example" >}} -For more information about histogram visualization options, refer to [Histogram]({{< relref "../visualizations/histogram.md" >}}). +For more information about histogram visualization options, refer to [Histogram]({{< relref "../visualizations/histogram/" >}}). Histograms only look at _value distributions_ over a specific time range. The problem with histograms is that you cannot see any trends or changes in the distribution over time. This is where heatmaps become useful. @@ -37,7 +44,7 @@ In this example, you can clearly see what values are more common and how they tr ![](/static/img/docs/v43/heatmap_histogram_over_time.png) -For more information about heatmap visualization options, refer to [Heatmap]({{< relref "../visualizations/heatmap.md" >}}). +For more information about heatmap visualization options, refer to [Heatmap]({{< relref "../visualizations/heatmap/" >}}). ## Pre-bucketed data diff --git a/docs/sources/basics/timeseries-dimensions.md b/docs/sources/basics/timeseries-dimensions.md index 88a0fb5cb0a..af607ae0456 100644 --- a/docs/sources/basics/timeseries-dimensions.md +++ b/docs/sources/basics/timeseries-dimensions.md @@ -1,14 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/basics/timeseries-dimensions/", "/docs/grafana/latest/getting-started/timeseries-dimensions/", "/docs/grafana/latest/guides/timeseries-dimensions/"] -description = "time series dimensions" -keywords = ["grafana", "intro", "guide", "concepts", "timeseries", "labels"] -title = "Time series dimensions" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/basics/timeseries-dimensions/ + - /docs/grafana/latest/getting-started/timeseries-dimensions/ + - /docs/grafana/latest/guides/timeseries-dimensions/ +description: time series dimensions +keywords: + - grafana + - intro + - guide + - concepts + - timeseries + - labels +title: Time series dimensions +weight: 600 +--- # Time series dimensions -In [Introduction to time series]({{< relref "timeseries.md#time-series-databases" >}}), the concept of _labels_, also called _tags_, is introduced: +In [Introduction to time series]({{< relref "timeseries/#time-series-databases" >}}), the concept of _labels_, also called _tags_, is introduced: > Another feature of a TSDB is the ability to filter measurements using _tags_. Each data point is labeled with a tag that adds context information, such as where the measurement was taken. @@ -76,10 +85,10 @@ In this case the labels that represent the dimensions will have two keys based o > **Note:** More than one dimension is currently only supported in the Logs queries within the Azure Monitor service as of version 7.1. -> **Note:** Multiple dimensions are not supported in a way that maps to multiple alerts in Grafana, but rather they are treated as multiple conditions to a single alert. For more information, see See the documentation on [creating alerts with multiple series]({{< relref "../alerting/alerting-rules/create-grafana-managed-rule.md#single-and-multi-dimensional-rule" >}}). +> **Note:** Multiple dimensions are not supported in a way that maps to multiple alerts in Grafana, but rather they are treated as multiple conditions to a single alert. For more information, see See the documentation on [creating alerts with multiple series]({{< relref "../alerting/alerting-rules/create-grafana-managed-rule/#single-and-multi-dimensional-rule" >}}). ### Multiple values In the case of SQL-like data sources, more than one numeric column can be selected, with or without additional string columns to be used as dimensions. For example, `AVG(Temperature) AS AvgTemp, MAX(Temperature) AS MaxTemp`. This, if combined with multiple dimensions, can result in a lot of series. Selecting multiple values is currently only designed to be used with visualization. -Additional technical information on tabular time series formats and how dimensions are extracted can be found in [the developer documentation on data frames as time series]({{< relref "../developers/plugins/data-frames.md#data-frames-as-time-series" >}}). +Additional technical information on tabular time series formats and how dimensions are extracted can be found in [the developer documentation on data frames as time series]({{< relref "../developers/plugins/data-frames/#data-frames-as-time-series" >}}). diff --git a/docs/sources/basics/timeseries.md b/docs/sources/basics/timeseries.md index 6197aa2b5dd..a9f61abe6a6 100644 --- a/docs/sources/basics/timeseries.md +++ b/docs/sources/basics/timeseries.md @@ -1,10 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/basics/timeseries/"] -description = "Introduction to time series" -keywords = ["grafana", "intro", "guide", "concepts", "timeseries"] -title = "Intro to time series" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/basics/timeseries/ +description: Introduction to time series +keywords: + - grafana + - intro + - guide + - concepts + - timeseries +title: Intro to time series +weight: 400 +--- # Introduction to time series diff --git a/docs/sources/best-practices/_index.md b/docs/sources/best-practices/_index.md index 70e443ed08b..0410112f78f 100644 --- a/docs/sources/best-practices/_index.md +++ b/docs/sources/best-practices/_index.md @@ -1,15 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/best-practices/"] -description = "Best practices for working with Grafana" -title = "Best practices" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/best-practices/ +description: Best practices for working with Grafana +title: Best practices +weight: 20 +--- # Best practices This section provides information about best practices for intermediate Grafana administrators and users. Click on each of the links before for more information. -- [Best practices for creating dashboards]({{< relref "best-practices-for-creating-dashboards" >}}) -- [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards" >}}) -- [Common observability strategies]({{< relref "common-observability-strategies" >}}) -- [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels" >}}) +- [Best practices for creating dashboards]({{< relref "best-practices-for-creating-dashboards/" >}}) +- [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards/" >}}) +- [Common observability strategies]({{< relref "common-observability-strategies/" >}}) +- [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels/" >}}) diff --git a/docs/sources/best-practices/best-practices-for-creating-dashboards.md b/docs/sources/best-practices/best-practices-for-creating-dashboards.md index 4133dbb1816..932946faa84 100644 --- a/docs/sources/best-practices/best-practices-for-creating-dashboards.md +++ b/docs/sources/best-practices/best-practices-for-creating-dashboards.md @@ -1,9 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/best-practices/best-practices-for-creating-dashboards/"] -description = "Best practices for creating dashboards in Grafana" -title = "Best practices for creating dashboards" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/best-practices/best-practices-for-creating-dashboards/ +description: Best practices for creating dashboards in Grafana +title: Best practices for creating dashboards +weight: 100 +--- # Best practices for creating dashboards @@ -32,7 +33,7 @@ Ask yourself: It's easy to make new dashboards. It's harder to optimize dashboard creation and adhere to a plan, but it's worth it. This strategy should govern both your overall dashboard scheme and enforce consistency in individual dashboard design. -Refer to [Common observability strategies]({{< relref "common-observability-strategies.md" >}}) and [Dashboard management maturity levels]({{< relref "dashboard-management-maturity-levels.md" >}}) for more information. +Refer to [Common observability strategies]({{< relref "common-observability-strategies/" >}}) and [Dashboard management maturity levels]({{< relref "dashboard-management-maturity-levels/" >}}) for more information. ### Write it down @@ -44,12 +45,12 @@ Once you have a strategy or design guidelines, write them down to help maintain - If you are creating a dashboard to play or experiment, then put the word `TEST` or `TMP` in the name. - Consider including your name or initials in the dashboard name or as a tag so that people know who owns the dashboard. - Remove temporary experiment dashboards when you are done with them. -- If you create many related dashboards, think about how to cross-reference them for easy navigation. Refer to [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards.md" >}}) for more information. -- Grafana retrieves data from a data source. A basic understanding of [data sources]({{< relref "../datasources/_index.md" >}}) in general and your specific is important. +- If you create many related dashboards, think about how to cross-reference them for easy navigation. Refer to [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards/" >}}) for more information. +- Grafana retrieves data from a data source. A basic understanding of [data sources]({{< relref "../datasources/" >}}) in general and your specific is important. - Avoid unnecessary dashboard refreshing to reduce the load on the network or backend. For example, if your data changes every hour, then you don't need to set the dashboard refresh rate to 30 seconds. - Use the left and right Y-axes when displaying time series with different units or ranges. - Add documentation to dashboards and panels. - - To add documentation to a dashboard, add a [Text panel visualization]({{< relref "../visualizations/text-panel.md" >}}) to the dashboard. Record things like the purpose of the dashboard, useful resource links, and any instructions users might need to interact with the dashboard. Check out this [Wikimedia example](https://grafana.wikimedia.org/d/000000066/resourceloader?orgId=1). - - To add documentation to a panel, [edit the panel settings]({{< relref "../panels/working-with-panels/add-panel.md" >}}) and add a description. Any text you add will appear if you hover your cursor over the small `i` in the top left corner of the panel. -- Reuse your dashboards and enforce consistency by using [templates and variables]({{< relref "../variables/_index.md" >}}). + - To add documentation to a dashboard, add a [Text panel visualization]({{< relref "../visualizations/text-panel/" >}}) to the dashboard. Record things like the purpose of the dashboard, useful resource links, and any instructions users might need to interact with the dashboard. Check out this [Wikimedia example](https://grafana.wikimedia.org/d/000000066/resourceloader?orgId=1). + - To add documentation to a panel, [edit the panel settings]({{< relref "../panels/working-with-panels/add-panel/" >}}) and add a description. Any text you add will appear if you hover your cursor over the small `i` in the top left corner of the panel. +- Reuse your dashboards and enforce consistency by using [templates and variables]({{< relref "../variables/" >}}). - Be careful with stacking graph data. The visualizations can be misleading, and hide important data. We recommend turning it off in most cases. diff --git a/docs/sources/best-practices/best-practices-for-managing-dashboards.md b/docs/sources/best-practices/best-practices-for-managing-dashboards.md index 17ad57f5f38..cc7c3e29881 100644 --- a/docs/sources/best-practices/best-practices-for-managing-dashboards.md +++ b/docs/sources/best-practices/best-practices-for-managing-dashboards.md @@ -1,9 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/best-practices/best-practices-for-managing-dashboards/"] -description = "Best practices for managing dashboards in Grafana" -title = "Best practices for managing dashboards" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/best-practices/best-practices-for-managing-dashboards/ +description: Best practices for managing dashboards in Grafana +title: Best practices for managing dashboards +weight: 200 +--- # Best practices for managing dashboards @@ -15,13 +16,13 @@ Here are some principles to consider before you start managing dashboards. ### Strategic observability -There are several [common observability strategies]({{< relref "common-observability-strategies.md" >}}). You should research them and decide whether one of them works for you or if you want to come up with your own. Either way, have a plan, write it down, and stick to it. +There are several [common observability strategies]({{< relref "common-observability-strategies/" >}}). You should research them and decide whether one of them works for you or if you want to come up with your own. Either way, have a plan, write it down, and stick to it. Adapt your strategy to changing needs as necessary. ### Maturity level -What is your dashboard maturity level? Analyze your current dashboard setup and compare it to the [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels.md" >}}). Understanding where you are can help you decide how to get to where you want to be. +What is your dashboard maturity level? Analyze your current dashboard setup and compare it to the [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels/" >}}). Understanding where you are can help you decide how to get to where you want to be. ## Best practices to follow @@ -30,9 +31,9 @@ What is your dashboard maturity level? Analyze your current dashboard setup and - If you create a temporary dashboard, perhaps to test something, prefix the name with `TEST: `. Delete the dashboard when you are finished. - Copying dashboards with no significant changes is not a good idea. - You miss out on updates to the original dashboard, such as documentation changes, bug fixes, or additions to metrics. - - In many cases copies are being made to simply customize the view by setting template parameters. This should instead be done by maintaining a link to the master dashboard and customizing the view with [URL parameters]({{< relref "../linking/data-link-variables.md" >}}). + - In many cases copies are being made to simply customize the view by setting template parameters. This should instead be done by maintaining a link to the master dashboard and customizing the view with [URL parameters]({{< relref "../linking/data-link-variables/" >}}). - When you must copy a dashboard, clearly rename it and _do not_ copy the dashboard tags. Tags are important metadata for dashboards that are used during search. Copying tags can result in false matches. - Maintain a dashboard of dashboards or cross-reference dashboards. This can be done in several ways: - - Create dashboard links, panel, or data links. Links can go to other dashboards or to external systems. For more information, refer to [Linking]({{< relref "../linking/_index.md" >}}). - - Add a [Dashboard list panel]({{< relref "../visualizations/dashboard-list-panel.md" >}}). You can then customize what you see by doing tag or folder searches. - - Add a [Text panel]({{< relref "../visualizations/text-panel.md" >}}) and use markdown to customize the display. + - Create dashboard links, panel, or data links. Links can go to other dashboards or to external systems. For more information, refer to [Linking]({{< relref "../linking/" >}}). + - Add a [Dashboard list panel]({{< relref "../visualizations/dashboard-list-panel/" >}}). You can then customize what you see by doing tag or folder searches. + - Add a [Text panel]({{< relref "../visualizations/text-panel/" >}}) and use markdown to customize the display. diff --git a/docs/sources/best-practices/common-observability-strategies.md b/docs/sources/best-practices/common-observability-strategies.md index ff66f5bb82b..3d42f617aa0 100644 --- a/docs/sources/best-practices/common-observability-strategies.md +++ b/docs/sources/best-practices/common-observability-strategies.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/best-practices/common-observability-strategies/", "/docs/grafana/latest/getting-started/strategies/"] -description = "Common observability strategies" -keywords = ["grafana", "intro", "guide", "concepts", "methods"] -title = "Common observability strategies" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/best-practices/common-observability-strategies/ + - /docs/grafana/latest/getting-started/strategies/ +description: Common observability strategies +keywords: + - grafana + - intro + - guide + - concepts + - methods +title: Common observability strategies +weight: 300 +--- # Common observability strategies diff --git a/docs/sources/best-practices/dashboard-management-maturity-levels.md b/docs/sources/best-practices/dashboard-management-maturity-levels.md index 9832750b087..4f9c59b4288 100644 --- a/docs/sources/best-practices/dashboard-management-maturity-levels.md +++ b/docs/sources/best-practices/dashboard-management-maturity-levels.md @@ -1,9 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/best-practices/dashboard-management-maturity-levels/"] -description = "Explanation of dashboard management maturity model" -title = "Dashboard management maturity model" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/best-practices/dashboard-management-maturity-levels/ +description: Explanation of dashboard management maturity model +title: Dashboard management maturity model +weight: 400 +--- # Dashboard management maturity model @@ -34,9 +35,9 @@ How can you tell you are here? - Prevent sprawl by using template variables. For example, you don't need a separate dashboard for each node, you can use query variables. Even better, you can make the data source a template variable too, so you can reuse the same dashboard across different clusters and monitoring backends. - Refer to the list of [Variable examples]({{< relref "../variables/variable-examples.md" >}}) if you want some ideas. + Refer to the list of [Variable examples]({{< relref "../variables/variable-examples/" >}}) if you want some ideas. -- Methodical dashboards according to an [observability strategy]({{< relref "common-observability-strategies.md" >}}). +- Methodical dashboards according to an [observability strategy]({{< relref "common-observability-strategies/" >}}). - Hierarchical dashboards with drill-downs to the next level. {{< figure class="float-right" max-width="100%" src="/static/img/docs/best-practices/drill-down-example.png" caption="Example of using drill-down" >}} @@ -47,12 +48,12 @@ How can you tell you are here? - Compare like to like: split service dashboards when the magnitude differs. Make sure aggregated metrics don't drown out important information. - Expressive charts with meaningful use of color and normalizing axes where you can. - - Example of meaningful color: Blue means it's good, red means it's bad. [Thresholds]({{< relref "../panels/configure-thresholds" >}}) can help with that. + - Example of meaningful color: Blue means it's good, red means it's bad. [Thresholds]({{< relref "../panels/configure-thresholds/" >}}) can help with that. - Example of normalizing axes: When comparing CPU usage, measure by percentage rather than raw number, because machines can have a different number of cores. Normalizing CPU usage by the number of cores reduces cognitive load because the viewer can trust that at 100% all cores are being used, without having to know the number of CPUs. - Directed browsing cuts down on "guessing." - Template variables make it harder to “just browse” randomly or aimlessly. - Most dashboards should be linked to by alerts. - - Browsing is directed with links. For more information, refer to [Linking]({{< relref "../linking/_index.md" >}}). + - Browsing is directed with links. For more information, refer to [Linking]({{< relref "../linking/" >}}). - Version-controlled dashboard JSON. ## High - optimized use @@ -62,7 +63,7 @@ At this stage, you have optimized your dashboard management use with a consisten - Actively reducing sprawl. - Regularly review existing dashboards to make sure they are still relevant. - Only approved dashboards added to master dashboard list. - - Tracking dashboard use. If you're an Enterprise user, you can take advantage of [Usage insights]({{< relref "../enterprise/usage-insights/_index.md" >}}). + - Tracking dashboard use. If you're an Enterprise user, you can take advantage of [Usage insights]({{< relref "../enterprise/usage-insights/" >}}). - Consistency by design. - Use scripting libraries to generate dashboards, ensure consistency in pattern and style. - grafonnet (Jsonnet) diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 9363d730c81..4df43ef823e 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -1,28 +1,30 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = "Dashboards" -weight = 80 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: Dashboards +weight: 80 +--- # About Grafana dashboards -A dashboard is a set of one or more [panels]({{< relref "../panels/_index.md" >}}) organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source]({{< relref "../datasources/_index.md" >}}). +A dashboard is a set of one or more [panels]({{< relref "../panels/" >}}) organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source]({{< relref "../datasources/" >}}). Dashboard snapshots are static . Queries and expressions cannot be re-executed from snapshots. As a result, if you update any variables in your query or expression, it will not change your dashboard data. Before you begin, ensure that you have configured a data source. See also: -- [Working with Grafana dashboard UI]({{< relref "./dashboard-ui/_index.md" >}}) -- [Dashboard folders]({{< relref "./dashboard-folders.md" >}}) -- [Create dashboard]({{< relref "./dashboard-create" >}}) -- [Manage dashboards]({{< relref "./dashboard-manage.md" >}}) -- [Annotations]({{< relref "./annotations.md" >}}) -- [Playlist]({{< relref "./playlist.md" >}}) -- [Search]({{< relref "./search.md" >}}) -- [Keyboard shortcuts]({{< relref "./shortcuts.md" >}}) -- [Reporting]({{< relref "./reporting.md" >}}) -- [Time range controls]({{< relref "./time-range-controls.md" >}}) -- [Dashboard version history]({{< relref "./dashboard-history.md" >}}) -- [Dashboard export and import]({{< relref "./export-import.md" >}}) -- [Dashboard JSON model]({{< relref "./json-model.md" >}}) -- [Scripted dashboards]({{< relref "./scripted-dashboards.md" >}}) +- [Working with Grafana dashboard UI]({{< relref "dashboard-ui/" >}}) +- [Dashboard folders]({{< relref "dashboard-folders/" >}}) +- [Create dashboard]({{< relref "dashboard-create/" >}}) +- [Manage dashboards]({{< relref "dashboard-manage/" >}}) +- [Annotations]({{< relref "annotations/" >}}) +- [Playlist]({{< relref "playlist/" >}}) +- [Search]({{< relref "search/" >}}) +- [Keyboard shortcuts]({{< relref "shortcuts/" >}}) +- [Reporting]({{< relref "reporting/" >}}) +- [Time range controls]({{< relref "time-range-controls/" >}}) +- [Dashboard version history]({{< relref "dashboard-history/" >}}) +- [Dashboard export and import]({{< relref "export-import/" >}}) +- [Dashboard JSON model]({{< relref "json-model/" >}}) +- [Scripted dashboards]({{< relref "scripted-dashboards/" >}}) diff --git a/docs/sources/dashboards/annotations.md b/docs/sources/dashboards/annotations.md index d81e9d965f8..5f975ab414f 100644 --- a/docs/sources/dashboards/annotations.md +++ b/docs/sources/dashboards/annotations.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/annotations/", "/docs/grafana/latest/reference/annotations/"] -keywords = ["grafana", "annotations", "documentation", "guide"] -title = "Annotations" -weight = 9 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/annotations/ + - /docs/grafana/latest/reference/annotations/ +keywords: + - grafana + - annotations + - documentation + - guide +title: Annotations +weight: 9 +--- # Annotations @@ -14,7 +20,7 @@ you can get event description and event tags. The text field can include links t ## Native annotations -Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "../developers/http_api/annotations.md" >}}). +Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "../developers/http_api/annotations/" >}}). ## Adding annotations @@ -70,4 +76,4 @@ to show. ### Annotation query details -The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../datasources/_index.md" >}}) topic. +The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../datasources/" >}}) topic. diff --git a/docs/sources/dashboards/dashboard-create.md b/docs/sources/dashboards/dashboard-create.md index 3017af23e4e..6380a4c97b2 100644 --- a/docs/sources/dashboards/dashboard-create.md +++ b/docs/sources/dashboards/dashboard-create.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-create/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = "Create dashboards" -weight = 7 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-create/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: Create dashboards +weight: 7 +--- ## Create dashboard diff --git a/docs/sources/dashboards/dashboard-folders.md b/docs/sources/dashboards/dashboard-folders.md index b54d257e689..0d7d3a265df 100644 --- a/docs/sources/dashboards/dashboard-folders.md +++ b/docs/sources/dashboards/dashboard-folders.md @@ -1,15 +1,24 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-folders/", "/docs/grafana/latest/reference/dashboard_folders/"] -keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"] -title = "Dashboard Folders" -weight = 6 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-folders/ + - /docs/grafana/latest/reference/dashboard_folders/ +keywords: + - grafana + - dashboard + - dashboard folders + - folder + - folders + - documentation + - guide +title: Dashboard Folders +weight: 6 +--- # Dashboard Folders Folders are a way to organize and group dashboards - very useful if you have a lot of dashboards or multiple teams using the same Grafana instance. -> **Note:** Only Grafana Admins and Super Admins can create, edit, or delete folders. Refer to [Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md#dashboard-permissions" >}}) for more information. +> **Note:** Only Grafana Admins and Super Admins can create, edit, or delete folders. Refer to [Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/#dashboard-permissions" >}}) for more information. ## How To Create A Folder @@ -46,5 +55,5 @@ The Dashboard Folder Page is similar to the Manage Dashboards page and is where Permissions can be assigned to a folder and inherited by the containing dashboards. An Access Control List (ACL) is used where **Organization Role**, **Team** and Individual **User** can be assigned permissions. Read the -[Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md#dashboard-permissions" >}}) docs for more detail +[Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/#dashboard-permissions" >}}) docs for more detail about permissions. diff --git a/docs/sources/dashboards/dashboard-history.md b/docs/sources/dashboards/dashboard-history.md index daea155bec5..fd78a68fc92 100644 --- a/docs/sources/dashboards/dashboard-history.md +++ b/docs/sources/dashboards/dashboard-history.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-history/", "/docs/grafana/latest/reference/dashboard_history/"] -keywords = ["grafana", "dashboard", "documentation", "version", "history"] -title = "Dashboard version history" -weight = 14 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-history/ + - /docs/grafana/latest/reference/dashboard_history/ +keywords: + - grafana + - dashboard + - documentation + - version + - history +title: Dashboard version history +weight: 14 +--- # Dashboard version history diff --git a/docs/sources/dashboards/dashboard-manage.md b/docs/sources/dashboards/dashboard-manage.md index 46825b835c1..410e91020e4 100644 --- a/docs/sources/dashboards/dashboard-manage.md +++ b/docs/sources/dashboards/dashboard-manage.md @@ -1,17 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-manage/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = "Manage dashboards" -weight = 8 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-manage/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: Manage dashboards +weight: 8 +--- ## Manage dashboards When managing dashboads, you can use: -- Select a time period for a dashboard using the [Time range controls]({{< relref "time-range-controls.md" >}}) in the upper right of the dashboard. +- Select a time period for a dashboard using the [Time range controls]({{< relref "time-range-controls/" >}}) in the upper right of the dashboard. - Tag dashboards. -- Use [templating]({{< relref "../variables/_index.md" >}}) to make them more dynamic and interactive. -- Use [annotations]({{< relref "annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. +- Use [templating]({{< relref "../variables/" >}}) to make them more dynamic and interactive. +- Use [annotations]({{< relref "annotations/" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. - Use the dashboard picker for quick, searchable access to all dashboards in a particular organization. -You can also [share dashboards]({{< relref "../sharing/share-dashboard.md" >}}) in a variety of ways. +You can also [share dashboards]({{< relref "../sharing/share-dashboard/" >}}) in a variety of ways. diff --git a/docs/sources/dashboards/dashboard-ui/_index.md b/docs/sources/dashboards/dashboard-ui/_index.md index d396a980773..f59337b6713 100644 --- a/docs/sources/dashboards/dashboard-ui/_index.md +++ b/docs/sources/dashboards/dashboard-ui/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-ui/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = " Dashboard UI" -weight = 2 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-ui/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: ' Dashboard UI' +weight: 2 +--- # Working with Grafana dashboard UI @@ -16,4 +18,4 @@ The dashboard UI has the following sections to allow you to customize the presen - **Dashboard panel** (4) Click the panel title to edit panels. - **Graph legend** (5) Change series colors, y-axis and series visibility directly from the legend. -For more details, see [Dashboard header]({{< relref "./dashboard-header.md" >}}) and [Dashboard rows]({{< relref "./dashboard-row.md" >}}). +For more details, see [Dashboard header]({{< relref "dashboard-header/" >}}) and [Dashboard rows]({{< relref "dashboard-row/" >}}). diff --git a/docs/sources/dashboards/dashboard-ui/dashboard-header.md b/docs/sources/dashboards/dashboard-ui/dashboard-header.md index 5b0e51ac912..2bcdea21eec 100644 --- a/docs/sources/dashboards/dashboard-ui/dashboard-header.md +++ b/docs/sources/dashboards/dashboard-ui/dashboard-header.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-ui/dashboard-header/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = "Dashboard header" -weight = 80 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-ui/dashboard-header/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: Dashboard header +weight: 80 +--- ## Dashboard header diff --git a/docs/sources/dashboards/dashboard-ui/dashboard-row.md b/docs/sources/dashboards/dashboard-ui/dashboard-row.md index c26b2df886b..2d29561db09 100644 --- a/docs/sources/dashboards/dashboard-ui/dashboard-row.md +++ b/docs/sources/dashboards/dashboard-ui/dashboard-row.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/dashboard-ui/dashboard-row/", "/docs/grafana/latest/features/dashboard/dashboards/"] -title = "Dashboard rows" -weight = 80 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-ui/dashboard-row/ + - /docs/grafana/latest/features/dashboard/dashboards/ +title: Dashboard rows +weight: 80 +--- # Dashboard rows @@ -14,7 +16,7 @@ Grafana uses a base unit abstraction so that dashboards and panels look great on ## Create or remove rows -Use the [repeating rows]({{< relref "../../variables/_index.md#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected. +Use the [repeating rows]({{< relref "../../variables/#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected. ## Collapse rows diff --git a/docs/sources/dashboards/export-import.md b/docs/sources/dashboards/export-import.md index b5094328fb8..8f1f4c7d376 100644 --- a/docs/sources/dashboards/export-import.md +++ b/docs/sources/dashboards/export-import.md @@ -1,13 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/export-import/", "/docs/grafana/latest/reference/export_import/"] -keywords = ["grafana", "dashboard", "documentation", "export", "import"] -title = "Export and import" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/export-import/ + - /docs/grafana/latest/reference/export_import/ +keywords: + - grafana + - dashboard + - documentation + - export + - import +title: Export and import +weight: 800 +--- # Export and import -Grafana Dashboards can easily be exported and imported, either from the UI or from the [HTTP API]({{< relref "../developers/http_api/dashboard.md#create-update-dashboard" >}}). +Grafana Dashboards can easily be exported and imported, either from the UI or from the [HTTP API]({{< relref "../developers/http_api/dashboard/#create-update-dashboard" >}}). ## Exporting a dashboard diff --git a/docs/sources/dashboards/json-model.md b/docs/sources/dashboards/json-model.md index e9e45d9d233..c9d01f8a368 100644 --- a/docs/sources/dashboards/json-model.md +++ b/docs/sources/dashboards/json-model.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/json-model/", "/docs/grafana/latest/reference/dashboard/"] -keywords = ["grafana", "dashboard", "documentation", "json", "model"] -title = "JSON model" -weight = 1200 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/json-model/ + - /docs/grafana/latest/reference/dashboard/ +keywords: + - grafana + - dashboard + - documentation + - json + - model +title: JSON model +weight: 1200 +--- # Dashboard JSON model diff --git a/docs/sources/dashboards/playlist.md b/docs/sources/dashboards/playlist.md index c5a4ccff44f..9fc153aa81f 100644 --- a/docs/sources/dashboards/playlist.md +++ b/docs/sources/dashboards/playlist.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/playlist/", "/docs/grafana/latest/reference/playlist/"] -keywords = ["grafana", "dashboard", "documentation", "playlist"] -title = "Playlist" -weight = 9 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/playlist/ + - /docs/grafana/latest/reference/playlist/ +keywords: + - grafana + - dashboard + - documentation + - playlist +title: Playlist +weight: 9 +--- # Playlist diff --git a/docs/sources/dashboards/previews.md b/docs/sources/dashboards/previews.md index 1f4c79f759e..8cf8bcb5b3b 100644 --- a/docs/sources/dashboards/previews.md +++ b/docs/sources/dashboards/previews.md @@ -1,9 +1,15 @@ -+++ -title = "Dashboard previews" -keywords = ["grafana", "dashboard", "documentation", "previews"] -aliases = ["/docs/grafana/latest/reference/previews/"] -weight = 9 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/previews/ + - /docs/grafana/latest/reference/previews/ +keywords: + - grafana + - dashboard + - documentation + - previews +title: Dashboard previews +weight: 9 +--- # Dashboard previews @@ -13,7 +19,7 @@ Dashboard previews provide an overview of all available dashboards. They help yo > **Note:** Dashboard previews are available in Grafana 9.0+ as an opt-in beta feature. Data source permissions are not yet taken into the account when displaying the dashboard previews - refer to the [permissions]({{< relref "#preview-visibility">}}) to learn more before enabling the feature. -You can view dashboard previews only when the feature is enabled for your instance. It is an opt-in feature that is, by default, disabled. You can view the previews in the Grafana UI after clicking on the _Show previews_ toggle once the administrator enables the feature following the procedure described below. +You can view dashboard previews after the administrator enables the feature following the procedure described below, and after you select the new grid layout. The dashboard previews feature is an opt-in feature that is disabled by default. - [Enable dashboard previews](#enable-dashboard-previews) - [About the dashboard previews crawler](#about-the-dashboard-previews-crawler) @@ -21,8 +27,8 @@ You can view dashboard previews only when the feature is enabled for your instan ## Enable dashboard previews -1. Install the Image Renderer plugin or set up a remote rendering service. The minimum version of Image Renderer required for the dashboard preview feature `3.4.0`. Refer to [Image rendering]({{< relref "../image-rendering/" >}}) for more information. -2. Modify the [configuration file]({{< relref "../administration/configuration.md#configuration-file-location" >}}) to enable the `dashboardPreviews` [feature toggle]({{< relref "../administration/configuration.md#feature_toggles" >}}). +1. Install the Image Renderer plugin or set up a remote rendering service. The minimum version of Image Renderer required for the dashboard preview feature `3.4.0`. Refer to [Image rendering]({{< relref "../setup-grafana/image-rendering/" >}}) for more information. +2. Modify the [configuration file]({{< relref "../setup-grafana/configure-grafana/#configuration-file-location" >}}) to enable the `dashboardPreviews` [feature toggle]({{< relref "../setup-grafana/configure-grafana/#feature_toggles" >}}). ``` [feature_toggles] @@ -32,13 +38,13 @@ enable = dashboardPreviews 3. Save your changes. Grafana should reload automatically; we recommend restarting the Grafana server in case of any issues. -Verify that your setup was successful in the dashboard search page. You should see dashboard preview placeholders for all your existing dashboards after clicking on the _Show previews_ toggle at the top of the page. +The first crawler run should begin approximately five minutes after Grafana server restart. + +To determine that your setup is successful, select the new grid layout and verify that the dashboard preview placeholders appear. {{< video-embed src="/static/img/docs/dashboards/previews-successful-setup.webm" max-width="950px" >}} -The first crawler run should begin approximately five minutes after restarting the Grafana instance. - -In case you see any warnings after clicking on the toggle, check [Grafana server logs]({{< relref "../administration/configuration.md#log" >}}) for more context. The logger used by the Previews Service is named `previews_service`. +If the dashboard preview placeholders do not appear or if you see any warning messages, check [Grafana server logs]({{< relref "../setup-grafana/configure-grafana/#log" >}}) for more context. The logger used by the Previews Service is named `previews_service`. {{< figure src="/static/img/docs/dashboards/previews-unsuccessful-setup.png" max-width="950px" >}} @@ -50,7 +56,7 @@ The dashboard previews crawler is a background process that: - [Visits and takes a screenshot of each dashboard](#rendering-previews) - [Saves the screenshots in persistent storage](#saving-previews) -The crawler can be configured via the main config file. Check the [dashboard previews section]({{< relref "../administration/configuration.md#dashboard_previews" >}}) for more details. +The crawler can be configured via the main config file. Check the [dashboard previews section]({{< relref "../setup-grafana/configure-grafana/#dashboard_previews" >}}) for more details. ### Preparing the dashboard list @@ -68,11 +74,11 @@ Modifying a dashboard is the only way of refreshing that dashboard's preview; pr The crawler sends a render request to the Image Renderer for each dashboard in the list. The renderer is then instructed to open the dashboard in kiosk mode, take a screenshot, and scale it down to a small, 320 x 240px thumbnail. The following dashboard in Grafana Play is an example of kiosk mode: https://play.grafana.org/playlists/play/1?kiosk. Multiple render requests are issued concurrently to improve performance. The maximum number of concurrent requests can be configured via the `dashboard_previews.crawler.thread_count` config option. -Use the new [contextPerRenderKey]({{< relref "../image-rendering/#rendering-mode" >}}) clustering mode in Image Renderer to further optimize crawler's resource usage. +Use the new [contextPerRenderKey]({{< relref "../setup-grafana/image-rendering/#rendering-mode" >}}) clustering mode in Image Renderer to further optimize crawler's resource usage. ### Saving previews -The crawler saves previews and their metadata in Grafana's DB. Preview's metadata contains, among other things, the [dashboard version]({{< relref "./dashboard-history" >}}) from the time of taking the screenshot. During subsequent runs, the crawler uses the saved version to find stale dashboard previews. +The crawler saves previews and their metadata in Grafana's DB. Preview's metadata contains, among other things, the [dashboard version]({{< relref "dashboard-history/" >}}) from the time of taking the screenshot. During subsequent runs, the crawler uses the saved version to find stale dashboard previews. ## Permissions @@ -81,7 +87,7 @@ The crawler saves previews and their metadata in Grafana's DB. Preview's metadat The crawler is set up with the required permissions to display all dashboards and query all data sources. The way the permissions are set up depends on the version of Grafana. In OSS and Enterprise Grafana instances without RBAC enabled, the crawler uses a special user with an `Admin` role. -In an Enterprise Grafana instance with RBAC enabled, the crawler uses [service accounts]({{< relref "../administration/service-accounts" >}}) with three fixed roles: +In an Enterprise Grafana instance with RBAC enabled, the crawler uses [service accounts]({{< relref "../administration/service-accounts/" >}}) with three fixed roles: - `fixed:dashboards:reader` - `fixed:datasources:reader` diff --git a/docs/sources/dashboards/reporting.md b/docs/sources/dashboards/reporting.md index 1a475d4ae05..35eafa8e54f 100644 --- a/docs/sources/dashboards/reporting.md +++ b/docs/sources/dashboards/reporting.md @@ -1,10 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/administration/reports/", "/docs/grafana/latest/dashboards/reporting/"] -description = "" -keywords = ["grafana", "reporting"] -title = "Reporting" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/administration/reports/ + - /docs/grafana/latest/dashboards/reporting/ +description: '' +keywords: + - grafana + - reporting +title: Reporting +weight: 10 +--- # Reporting @@ -12,4 +16,4 @@ Reporting allows you to generate PDFs from any of your dashboards and have them {{< figure src="/static/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}} -> Reporting is only available in Grafana Enterprise, v6.4 or later. For more information, refer to [Reporting]({{< relref "../enterprise/reporting.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). +> Reporting is only available in Grafana Enterprise, v6.4 or later. For more information, refer to [Reporting]({{< relref "../enterprise/reporting/" >}}) in [Grafana Enterprise]({{< relref "../enterprise/" >}}). diff --git a/docs/sources/dashboards/scripted-dashboards.md b/docs/sources/dashboards/scripted-dashboards.md index c4204146a53..ba4b1f0c850 100644 --- a/docs/sources/dashboards/scripted-dashboards.md +++ b/docs/sources/dashboards/scripted-dashboards.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/scripted-dashboards/", "/docs/grafana/latest/reference/scripting/"] -keywords = ["grafana", "dashboard", "documentation", "scripted"] -title = "Scripted dashboards" -weight = 1500 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/scripted-dashboards/ + - /docs/grafana/latest/reference/scripting/ +keywords: + - grafana + - dashboard + - documentation + - scripted +title: Scripted dashboards +weight: 1500 +--- # Scripted dashboards diff --git a/docs/sources/dashboards/search.md b/docs/sources/dashboards/search.md index dbdf9353fb4..60fe8f2b5e6 100644 --- a/docs/sources/dashboards/search.md +++ b/docs/sources/dashboards/search.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/search/", "/docs/grafana/latest/reference/search/"] -keywords = ["grafana", "dashboard", "documentation", "search"] -title = "Search" -weight = 9 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/search/ + - /docs/grafana/latest/reference/search/ +keywords: + - grafana + - dashboard + - documentation + - search +title: Search +weight: 9 +--- # Dashboard Search diff --git a/docs/sources/dashboards/shortcuts.md b/docs/sources/dashboards/shortcuts.md index 89317a6a553..b0b5fd40522 100644 --- a/docs/sources/dashboards/shortcuts.md +++ b/docs/sources/dashboards/shortcuts.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/shortcuts/"] -title = "Keyboard shortcuts" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/shortcuts/ +title: Keyboard shortcuts +weight: 10 +--- # Keyboard shortcuts diff --git a/docs/sources/dashboards/time-range-controls.md b/docs/sources/dashboards/time-range-controls.md index 715c13c9c28..22f9fd3c307 100644 --- a/docs/sources/dashboards/time-range-controls.md +++ b/docs/sources/dashboards/time-range-controls.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/dashboards/time-range-controls/", "/docs/grafana/latest/reference/timerange/"] -keywords = ["grafana", "dashboard", "documentation", "time range"] -title = "Time range controls" -weight = 13 -+++ +--- +aliases: + - /docs/grafana/latest/dashboards/time-range-controls/ + - /docs/grafana/latest/reference/timerange/ +keywords: + - grafana + - dashboard + - documentation + - time range +title: Time range controls +weight: 13 +--- # Time range controls @@ -117,7 +123,7 @@ For more advanced time settings, click the **Dashboard settings** (gear) icon at ## Panel time overrides and timeshift -In [Query options]({{< relref "../panels/query-options.md" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time. +In [Query options]({{< relref "../panels/query-options/" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time. > **Note:** Panel time overrides have no effect when the time range for the dashboard is absolute. diff --git a/docs/sources/datasources/_index.md b/docs/sources/datasources/_index.md index d59d20fba6f..3d512275775 100644 --- a/docs/sources/datasources/_index.md +++ b/docs/sources/datasources/_index.md @@ -1,12 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/", "/docs/grafana/latest/datasources/overview/"] -title = "Data sources" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/ + - /docs/grafana/latest/datasources/overview/ +title: Data sources +weight: 60 +--- # Data sources -Grafana supports many different storage backends for your time series data (data source). Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +Grafana supports many different storage backends for your time series data (data source). Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. ## Querying @@ -16,23 +18,23 @@ Each data source has a specific Query Editor that is customized for the features The following data sources are officially supported: -- [Alertmanager]({{< relref "alertmanager.md" >}}) -- [AWS CloudWatch]({{< relref "aws-cloudwatch/_index.md" >}}) -- [Azure Monitor]({{< relref "azuremonitor/_index.md" >}}) -- [Elasticsearch]({{< relref "elasticsearch.md" >}}) -- [Google Cloud Monitoring]({{< relref "google-cloud-monitoring/_index.md" >}}) -- [Graphite]({{< relref "graphite.md" >}}) -- [InfluxDB]({{< relref "influxdb/_index.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" >}}) -- [Jaeger]({{< relref "jaeger.md" >}}) -- [Zipkin]({{< relref "zipkin.md" >}}) -- [Tempo]({{< relref "tempo.md" >}}) -- [Testdata]({{< relref "testdata.md" >}}) +- [Alertmanager]({{< relref "alertmanager/" >}}) +- [AWS CloudWatch]({{< relref "aws-cloudwatch/" >}}) +- [Azure Monitor]({{< relref "azuremonitor/" >}}) +- [Elasticsearch]({{< relref "elasticsearch/" >}}) +- [Google Cloud Monitoring]({{< relref "google-cloud-monitoring/" >}}) +- [Graphite]({{< relref "graphite/" >}}) +- [InfluxDB]({{< relref "influxdb/" >}}) +- [Loki]({{< relref "loki/" >}}) +- [Microsoft SQL Server (MSSQL)]({{< relref "mssql/" >}}) +- [MySQL]({{< relref "mysql/" >}}) +- [OpenTSDB]({{< relref "opentsdb/" >}}) +- [PostgreSQL]({{< relref "postgres/" >}}) +- [Prometheus]({{< relref "prometheus/" >}}) +- [Jaeger]({{< relref "jaeger/" >}}) +- [Zipkin]({{< relref "zipkin/" >}}) +- [Tempo]({{< relref "tempo/" >}}) +- [Testdata]({{< relref "testdata/" >}}) In addition to the data sources that you have configured in your Grafana, there are three special data sources available: diff --git a/docs/sources/datasources/add-a-data-source.md b/docs/sources/datasources/add-a-data-source.md index f1e57a2056b..56b96c80711 100644 --- a/docs/sources/datasources/add-a-data-source.md +++ b/docs/sources/datasources/add-a-data-source.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/add-a-data-source/", "/docs/grafana/latest/features/datasources/add-a-data-source/"] -title = "Add data source" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/add-a-data-source/ + - /docs/grafana/latest/features/datasources/add-a-data-source/ +title: Add data source +weight: 100 +--- # Add a data source diff --git a/docs/sources/datasources/alertmanager.md b/docs/sources/datasources/alertmanager.md index aa03f2c0e83..27522a8f0f9 100644 --- a/docs/sources/datasources/alertmanager.md +++ b/docs/sources/datasources/alertmanager.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/alertmanager/", "/docs/grafana/latest/features/datasources/alertmanager/"] -description = "Guide for using Alertmanager in Grafana" -keywords = ["grafana", "prometheus", "guide"] -title = "Alertmanager" -weight = 150 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/alertmanager/ + - /docs/grafana/latest/features/datasources/alertmanager/ +description: Guide for using Alertmanager in Grafana +keywords: + - grafana + - prometheus + - guide +title: Alertmanager +weight: 150 +--- # Alertmanager data source @@ -32,5 +37,6 @@ datasources: # optionally basicAuth: true basicAuthUser: my_user - basicAuthPassword: test_password + secureJsonData: + basicAuthPassword: test_password ``` diff --git a/docs/sources/datasources/aws-cloudwatch/_index.md b/docs/sources/datasources/aws-cloudwatch/_index.md index 514b6ebd21a..cdea036a9ce 100644 --- a/docs/sources/datasources/aws-cloudwatch/_index.md +++ b/docs/sources/datasources/aws-cloudwatch/_index.md @@ -1,14 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/aws-cloudwatch/", "/docs/grafana/latest/datasources/cloudwatch/"] -description = "Guide for using CloudWatch in Grafana" -keywords = ["grafana", "cloudwatch", "guide"] -title = "AWS CloudWatch" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/aws-cloudwatch/ + - /docs/grafana/latest/datasources/cloudwatch/ +description: Guide for using CloudWatch in Grafana +keywords: + - grafana + - cloudwatch + - guide +title: AWS CloudWatch +weight: 200 +--- # AWS CloudWatch data source -Grafana ships with built-in support for CloudWatch. This topic describes queries, templates, variables, and other configuration specific to the CloudWatch data source. For instructions on how to add a data source to Grafana, refer to [Add a data source]({{< relref "../add-a-data-source.md" >}}). Only users with the organization admin role can add data sources. +Grafana ships with built-in support for CloudWatch. This topic describes queries, templates, variables, and other configuration specific to the CloudWatch data source. For instructions on how to add a data source to Grafana, refer to [Add a data source]({{< relref "../add-a-data-source/" >}}). Only users with the organization admin role can add data sources. Once you have added the Cloudwatch data source, you can build dashboards or use Explore with CloudWatch metrics and CloudWatch Logs. @@ -18,7 +23,7 @@ Once you have added the Cloudwatch data source, you can build dashboards or use To access data source settings, hover your mouse over the **Configuration** (gear) icon, then click **Data Sources**, and then click the AWS Cloudwatch data source. -For authentication options and configuration details, see [AWS authentication]({{< relref "aws-authentication.md" >}}) topic. +For authentication options and configuration details, see [AWS authentication]({{< relref "aws-authentication/" >}}) topic. ### CloudWatch specific data source configuration @@ -160,7 +165,7 @@ Link an X-Ray data source in the "X-Ray trace link" section of the configuration The data source select will contain only existing data source instances of type X-Ray so in order to use this feature you need to have existing X-Ray data source already configured, see [X-Ray docs](https://grafana.com/grafana/plugins/grafana-x-ray-datasource/) for details. -The X-Ray link will then appear in the log details section which is accessible by clicking on the log row either in Explore or in dashboard [Logs panel]({{< relref "../../visualizations/logs-panel.md" >}}). To log the `@xrayTraceId` in your logs see the [AWS X-Ray documentation](https://docs.amazonaws.cn/en_us/xray/latest/devguide/xray-services.html). To provide the field to Grafana your log queries also have to contain the `@xrayTraceId` field, for example using query `fields @message, @xrayTraceId`. +The X-Ray link will then appear in the log details section which is accessible by clicking on the log row either in Explore or in dashboard [Logs panel]({{< relref "../../visualizations/logs-panel/" >}}). To log the `@xrayTraceId` in your logs see the [AWS X-Ray documentation](https://docs.amazonaws.cn/en_us/xray/latest/devguide/xray-services.html). To provide the field to Grafana your log queries also have to contain the `@xrayTraceId` field, for example using query `fields @message, @xrayTraceId`. ![Trace link in log details](/static/img/docs/cloudwatch/xray-link-log-details-8-2.png 'Trace link in log details') @@ -288,21 +293,13 @@ A period is the length of time associated with a specific Amazon CloudWatch stat If the period field is left blank or set to `auto`, then it calculates automatically based on the time range and [cloudwatch's retention policy](https://aws.amazon.com/about-aws/whats-new/2016/11/cloudwatch-extends-metrics-retention-and-new-user-interface/). The formula used is `time range in seconds / 2000`, and then it snaps to the next higher value in an array of predefined periods `[60, 300, 900, 3600, 21600, 86400]` after removing periods based on retention. By clicking `Show Query Preview` in the query editor, you can see what period Grafana used. -#### Alias +#### Label -The alias field allows you to override the default name of the metric legend. +The label field allows you to override the default name of the metric legend using CloudWatch dynamic labels. If you're using a time-based dynamic label such as `${MIN_MAX_TIME_RANGE}`, then the legend value is derived from the current timezone specified in the time range picker. To see the full list of label patterns and the dynamic label limitations, refer to the [CloudWatch dynamic labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) documentation. -##### Alias patterns +**Alias pattern deprecation:** In Grafana 9, dynamic labels have replaced alias patterns in the CloudWatch data source. Any existing alias pattern will get migrated to a corresponding dynamic label pattern. If you wish to use alias patterns instead of dynamic labels, set the feature toggle `cloudWatchDynamicLabels` to `false` in the Grafana configuration file. It will revert to the alias pattern system and use the previous alias formatting logic. -| Alias Pattern | Description | Example Result | -| ---------------------- | ------------------------------------------------------------- | ---------------- | -| `{{region}}` | returns the region | `us-east-1` | -| `{{period}}` | returns the period | `3000` | -| `{{metric}}` | returns the metric | `CPUUtilization` | -| `{{label}}` | returns the label returned by the API (only in Metric Search) | `i-01343` | -| `{{namespace}}` | returns the namespace (only in Metric Search) | `AWS/EC2` | -| `{{stat}}` | returns the statistic (only in Metric Search) | `Average` | -| `{{[dimension name]}}` | returns the dimension name (only in Metric Search) | `i-01343` | +The alias field will be deprecated and removed in a release. During this interim period, we won’t fix bugs related to the alias pattern system. For details on why we're doing this change, refer to [issue 48434](https://github.com/grafana/grafana/issues/48434). ## Using the Logs query editor @@ -333,11 +330,11 @@ filter @message like /Exception/ **NOTE**: When trying to alert on a query, if an error like `input data must be a wide series but got ...` is received, make sure that your query returns valid numeric data that can be printed in a Time series panel. -For more information on Grafana alerts, refer to [Alerting]({{< relref "../../alerting/_index.md" >}}) documentation. +For more information on Grafana alerts, refer to [Alerting]({{< relref "../../alerting/" >}}) documentation. ## Configure CloudWatch with grafana.ini -The Grafana [configuration]({{< relref "../../administration/configuration.md#aws" >}}) file includes an `AWS` section where you can customize the data source. +The Grafana [configuration]({{< relref "../../setup-grafana/configure-grafana/#aws" >}}) file includes an `AWS` section where you can customize the data source. | Configuration option | Description | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sources/datasources/aws-cloudwatch/aws-authentication.md b/docs/sources/datasources/aws-cloudwatch/aws-authentication.md index 72dd753c548..91a6ee6ad67 100644 --- a/docs/sources/datasources/aws-cloudwatch/aws-authentication.md +++ b/docs/sources/datasources/aws-cloudwatch/aws-authentication.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/aws-cloudwatch/aws-authentication/", "/docs/grafana/latest/datasources/cloudwatch/"] -description = "AWS authentication" -keywords = ["grafana", "aws", "authentication"] -title = "Authentication" -weight = 5 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/aws-cloudwatch/aws-authentication/ + - /docs/grafana/latest/datasources/cloudwatch/ +description: AWS authentication +keywords: + - grafana + - aws + - authentication +title: Authentication +weight: 5 +--- # AWS authentication @@ -22,7 +27,7 @@ This topic has the following sections: ## Authentication methods -You can use one of the following authentication methods. Currently, `AWS SDK Default`, `Credentials file` and `Access and secret key` are enabled by default in open source Grafana. You can enable/disable them if necessary if you have server configuration access. For more information, refer to [allowed_auth_providers]({{< relref "../../administration/configuration.md#allowed_auth_providers" >}}) documentation. +You can use one of the following authentication methods. Currently, `AWS SDK Default`, `Credentials file` and `Access and secret key` are enabled by default in open source Grafana. You can enable/disable them if necessary if you have server configuration access. For more information, refer to [allowed_auth_providers]({{< relref "../../setup-grafana/configure-grafana/#allowed_auth_providers" >}}) documentation. - `AWS SDK Default` performs no custom configuration and instead uses the [default provider](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html) as specified by the AWS SDK for Go. It requires you to configure your AWS credentials separately, such as if you've [configured the CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html), if you're [running on an EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html), [in an ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html), or for a [Service Account in a Kubernetes cluster](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html). @@ -36,7 +41,7 @@ You can use one of the following authentication methods. Currently, `AWS SDK Def The `Assume Role ARN` field allows you to specify which IAM role to assume. When left blank, the provided credentials are used directly and the associated role or user should have the required permissions. If this field is non-blank, on the other hand, the provided credentials are used to perform an [sts:AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) call. -You can disable this feature in the Grafana configuration. For more information, refer to [assume_role_enabled]({{< relref "../../administration/configuration.md#assume_role_enabled" >}}) documentation. +You can disable this feature in the Grafana configuration. For more information, refer to [assume_role_enabled]({{< relref "../../setup-grafana/configure-grafana/#assume_role_enabled" >}}) documentation. ### External ID diff --git a/docs/sources/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards.md b/docs/sources/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards.md index a66e3c4b0e0..1e6802006d4 100644 --- a/docs/sources/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards.md +++ b/docs/sources/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards/", "/docs/grafana/latest/datasources/cloudwatch/"] -description = "Guide for using AWS CloudWatch in Grafana" -keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"] -title = "Curated CloudWatch dashboards" -weight = 15 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/aws-cloudwatch/preconfig-cloudwatch-dashboards/ + - /docs/grafana/latest/datasources/cloudwatch/ +description: Guide for using AWS CloudWatch in Grafana +keywords: + - grafana + - stackdriver + - google + - guide + - cloud + - monitoring +title: Curated CloudWatch dashboards +weight: 15 +--- # Curated CloudWatch dashboards diff --git a/docs/sources/datasources/aws-cloudwatch/provision-cloudwatch.md b/docs/sources/datasources/aws-cloudwatch/provision-cloudwatch.md index 147fc7dc2db..a8736a85223 100644 --- a/docs/sources/datasources/aws-cloudwatch/provision-cloudwatch.md +++ b/docs/sources/datasources/aws-cloudwatch/provision-cloudwatch.md @@ -1,9 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/aws-cloudwatch/provision-cloudwatch/", "/docs/grafana/latest/datasources/cloudwatch/"] -description = "Guide for provisioning CloudWatch" -title = "Provision CloudWatch" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/aws-cloudwatch/provision-cloudwatch/ + - /docs/grafana/latest/datasources/cloudwatch/ +description: Guide for provisioning CloudWatch +title: Provision CloudWatch +weight: 400 +--- # Provision CloudWatch data source diff --git a/docs/sources/datasources/aws-cloudwatch/template-queries-cloudwatch.md b/docs/sources/datasources/aws-cloudwatch/template-queries-cloudwatch.md index d3a21c1c8b0..761da05cf04 100644 --- a/docs/sources/datasources/aws-cloudwatch/template-queries-cloudwatch.md +++ b/docs/sources/datasources/aws-cloudwatch/template-queries-cloudwatch.md @@ -1,15 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/aws-cloudwatch/template-queries-cloudwatch/", "/docs/grafana/latest/datasources/cloudwatch/"] -description = "Template variables in CloudWatch queryh" -title = "Template variables in CloudWatch query" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/aws-cloudwatch/template-queries-cloudwatch/ + - /docs/grafana/latest/datasources/cloudwatch/ +description: Template variables in CloudWatch queryh +title: Template variables in CloudWatch query +weight: 10 +--- # Using template variables in CloudWatch queries Instead of hard-coding server, application, and sensor names in your metric queries, you can use variables. The variables are listed as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the display of data in your dashboard. -For an introduction to templating and template variables, refer to the [Templating]({{< relref "../../variables/_index.md" >}}) documentation. +For an introduction to templating and template variables, refer to the [Templating]({{< relref "../../variables/" >}}) documentation. ## Query variable @@ -28,12 +30,13 @@ Read more about the available dimensions in the [CloudWatch Metrics and Dimensio | `EC2 Instance Attributes` | Returns a list of attributes matching the specified `region`, `attribute_name`, and `filters`. | | `Resource ARNs` | Returns a list of ARNs matching the specified `region`, `resource_type` and `tags`. | | `Statistics` | Returns a list of all the standard statistics. | +| `LogGroups` | Returns a list of all log groups matching the specified `region`. | For details about the metrics CloudWatch provides, please refer to the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html). ### Using variables in queries -Variables can be used in the variable form. Refer to the [variable syntax documentation]({{< relref "../../variables/syntax.md" >}}). +Variables can be used in the variable form. Refer to the [variable syntax documentation]({{< relref "../../variables/syntax/" >}}). ## ec2_instance_attribute examples diff --git a/docs/sources/datasources/azuremonitor/_index.md b/docs/sources/datasources/azuremonitor/_index.md index b2f1638a6a3..095824c0798 100644 --- a/docs/sources/datasources/azuremonitor/_index.md +++ b/docs/sources/datasources/azuremonitor/_index.md @@ -1,10 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/azuremonitor/", "/docs/grafana/latest/features/datasources/azuremonitor/"] -description = "Guide for using Azure Monitor in Grafana" -keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"] -title = "Azure Monitor" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/azuremonitor/ + - /docs/grafana/latest/features/datasources/azuremonitor/ +description: Guide for using Azure Monitor in Grafana +keywords: + - grafana + - microsoft + - azure + - monitor + - application + - insights + - log + - analytics + - guide +title: Azure Monitor +weight: 300 +--- # Azure Monitor data source @@ -14,11 +25,11 @@ Grafana includes built-in support for Azure Monitor, the Azure service to maximi - **Azure Monitor Logs** to collect log and performance data from your Azure account, and query using the powerful Kusto Language. - **Azure Resource Graph** to quickly query your Azure resources across subscriptions. -This topic explains configuring, querying, and other options specific to the Azure Monitor data source. Refer to [Add a data source]({{< relref "../add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. +This topic explains configuring, querying, and other options specific to the Azure Monitor data source. Refer to [Add a data source]({{< relref "../add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. ## Azure Monitor configuration -To access Azure Monitor configuration, hover your mouse over the **Configuration** (gear) icon, click **Data Sources**, and then select the Azure Monitor data source. If you haven't already, you'll need to [add the Azure Monitor data source]({{< relref "../add-a-data-source.md" >}}). +To access Azure Monitor configuration, hover your mouse over the **Configuration** (gear) icon, click **Data Sources**, and then select the Azure Monitor data source. If you haven't already, you'll need to [add the Azure Monitor data source]({{< relref "../add-a-data-source/" >}}). You must create an app registration and service principal in Azure AD to authenticate the data source. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in) for configuration details. Alternatively, if you are hosting Grafana in Azure (e.g. App Service, or Azure Virtual Machines) you can configure the Azure Monitor data source to use Managed Identity to securely authenticate without entering credentials into Grafana. Refer to [Configuring using Managed Identity](#configuring-using-managed-identity) for more details. @@ -261,13 +272,17 @@ You can use Grafana macros when constructing a query. Use the macros in the wher If using the `All` option, then check the `Include All Option` checkbox and in the `Custom all value` field type in the following value: `all`. If `$myVar` has value `all` then the macro will instead expand to `1 == 1`. For template variables with a lot of options, this will increase the query performance by not building a large "where..in" clause. +### Working with large Azure resource data sets + +If a request exceeds the [maximum allowed value of records](https://docs.microsoft.com/en-us/azure/governance/resource-graph/concepts/work-with-data#paging-results), the result is paginated and only the first page of results are returned. You can use filters to reduce the amount of records returned under that value. + ## Going further with Azure Monitor See the following topics to learn more about the Azure Monitor data source: -- [Azure Monitor template variables]({{< relref "./template-variables.md" >}}) for more interactive, dynamic, and reusable dashboards. -- [Provisioning Azure Monitor]({{< relref "./provisioning.md" >}}) for configuring the Azure Monitor data source using YAML files -- [Deprecating Application Insights]({{< relref "./provisioning.md" >}}) and migrating to Metrics and Logs queries +- [Azure Monitor template variables]({{< relref "template-variables/" >}}) for more interactive, dynamic, and reusable dashboards. +- [Provisioning Azure Monitor]({{< relref "provisioning/" >}}) for configuring the Azure Monitor data source using YAML files +- [Deprecating Application Insights]({{< relref "provisioning/" >}}) and migrating to Metrics and Logs queries ### Configuring using Managed Identity diff --git a/docs/sources/datasources/azuremonitor/deprecated-application-insights.md b/docs/sources/datasources/azuremonitor/deprecated-application-insights.md index 850e509be22..68c836a83af 100644 --- a/docs/sources/datasources/azuremonitor/deprecated-application-insights.md +++ b/docs/sources/datasources/azuremonitor/deprecated-application-insights.md @@ -1,10 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/azuremonitor/deprecated-application-insights/"] -description = "Template to provision the Azure Monitor data source" -keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"] -title = "Application Insights deprecation" -weight = 999 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/azuremonitor/deprecated-application-insights/ +description: Template to provision the Azure Monitor data source +keywords: + - grafana + - microsoft + - azure + - monitor + - application + - insights + - log + - analytics + - guide +title: Application Insights deprecation +weight: 999 +--- # Deprecated Application Insights and Insights Analytics diff --git a/docs/sources/datasources/azuremonitor/provisioning.md b/docs/sources/datasources/azuremonitor/provisioning.md index b62be69df0c..8ee6790b8ce 100644 --- a/docs/sources/datasources/azuremonitor/provisioning.md +++ b/docs/sources/datasources/azuremonitor/provisioning.md @@ -1,10 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/azuremonitor/provisioning/"] -description = "Template to provision the Azure Monitor data source" -keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"] -title = "Provisioning Azure Monitor" -weight = 2 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/azuremonitor/provisioning/ +description: Template to provision the Azure Monitor data source +keywords: + - grafana + - microsoft + - azure + - monitor + - application + - insights + - log + - analytics + - guide +title: Provisioning Azure Monitor +weight: 2 +--- # Configure the data source with provisioning diff --git a/docs/sources/datasources/azuremonitor/template-variables.md b/docs/sources/datasources/azuremonitor/template-variables.md index a30c3680480..da6f53567d8 100644 --- a/docs/sources/datasources/azuremonitor/template-variables.md +++ b/docs/sources/datasources/azuremonitor/template-variables.md @@ -1,16 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/azuremonitor/template-variables/"] -description = "Using template variables with Azure Monitor in Grafana" -keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"] -title = "Azure Monitor template variables" -weight = 2 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/azuremonitor/template-variables/ +description: Using template variables with Azure Monitor in Grafana +keywords: + - grafana + - microsoft + - azure + - monitor + - application + - insights + - log + - analytics + - guide +title: Azure Monitor template variables +weight: 2 +--- # Template variables Instead of hard-coding values for fields like resource group or resource name in your queries, you can use variables in their place to create more interactive, dynamic, and reusable dashboards. -Check out the [Templating]({{< relref "../../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different +Check out the [Templating]({{< relref "../../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. The Azure Monitor data source provides the following queries you can specify in the Query field in the Variable edit view diff --git a/docs/sources/datasources/elasticsearch.md b/docs/sources/datasources/elasticsearch.md index b81691f04a2..e41abe6d827 100644 --- a/docs/sources/datasources/elasticsearch.md +++ b/docs/sources/datasources/elasticsearch.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/elasticsearch/", "/docs/grafana/latest/features/datasources/elasticsearch/"] -description = "Guide for using Elasticsearch in Grafana" -keywords = ["grafana", "elasticsearch", "guide"] -title = "Elasticsearch" -weight = 325 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/elasticsearch/ + - /docs/grafana/latest/features/datasources/elasticsearch/ +description: Guide for using Elasticsearch in Grafana +keywords: + - grafana + - elasticsearch + - guide +title: Elasticsearch +weight: 325 +--- # Using Elasticsearch in Grafana @@ -76,7 +81,7 @@ When `X-Pack enabled` is active and the configured Elasticsearch version is high ### Logs There are two parameters, `Message field name` and `Level field name`, that can optionally be configured from the data source settings page that determine -which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../explore" >}}). +which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../explore/" >}}). For example, if you're using a default setup of Filebeat for shipping logs to Elasticsearch the following configuration should work: @@ -123,7 +128,7 @@ Instead of hard-coding things like server, application and sensor name in your m Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query variable @@ -175,7 +180,7 @@ Example dashboard: ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Grafana can query any Elasticsearch index for annotation events. @@ -189,7 +194,7 @@ for annotation events. ## Querying Logs -Querying and displaying log data from Elasticsearch is available in [Explore]({{< relref "../explore" >}}), and in the [logs panel]({{< relref "../visualizations/logs-panel.md" >}}) in dashboards. +Querying and displaying log data from Elasticsearch is available in [Explore]({{< relref "../explore/" >}}), and in the [logs panel]({{< relref "../visualizations/logs-panel/" >}}) in dashboards. Select the Elasticsearch data source, and then optionally enter a lucene query to display your logs. When switching from a Prometheus or Loki data source in Explore, your query is translated to an Elasticsearch log query with a correct Lucene filter. @@ -257,8 +262,8 @@ For more details on AWS SigV4, refer to the [AWS documentation](https://docs.aws > **Note:** Only available in Grafana v7.3+. -In order to sign requests to your Amazon Elasticsearch Service domain, SigV4 can be enabled in the Grafana [configuration]({{< relref "../administration/configuration.md#sigv4_auth_enabled" >}}). +In order to sign requests to your Amazon Elasticsearch Service domain, SigV4 can be enabled in the Grafana [configuration]({{< relref "../setup-grafana/configure-grafana/#sigv4_auth_enabled" >}}). -Once AWS SigV4 is enabled, it can be configured on the Elasticsearch data source configuration page. Refer to [Cloudwatch authentication]({{< relref "../datasources/aws-cloudwatch/aws-authentication.md" >}}) for more information about authentication options. +Once AWS SigV4 is enabled, it can be configured on the Elasticsearch data source configuration page. Refer to [Cloudwatch authentication]({{< relref "aws-cloudwatch/aws-authentication/" >}}) for more information about authentication options. {{< figure src="/static/img/docs/v73/elasticsearch-sigv4-config-editor.png" max-width="500px" class="docs-image--no-shadow" caption="SigV4 configuration for AWS Elasticsearch Service" >}} diff --git a/docs/sources/datasources/google-cloud-monitoring/_index.md b/docs/sources/datasources/google-cloud-monitoring/_index.md index 28008861985..bbe74d431bb 100644 --- a/docs/sources/datasources/google-cloud-monitoring/_index.md +++ b/docs/sources/datasources/google-cloud-monitoring/_index.md @@ -1,14 +1,24 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/google-cloud-monitoring/", "/docs/grafana/latest/features/datasources/stackdriver/", "/docs/grafana/next/datasources/cloudmonitoring/", "/docs/grafana/next/features/datasources/cloudmonitoring/"] -description = "Guide for using Google Cloud Monitoring in Grafana" -keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"] -title = "Google Cloud Monitoring" -weight = 350 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/google-cloud-monitoring/ + - /docs/grafana/latest/features/datasources/stackdriver/ + - /docs/grafana/next/datasources/cloudmonitoring/ + - /docs/grafana/next/features/datasources/cloudmonitoring/ +description: Guide for using Google Cloud Monitoring in Grafana +keywords: + - grafana + - stackdriver + - google + - guide + - cloud + - monitoring +title: Google Cloud Monitoring +weight: 350 +--- # Using Google Cloud Monitoring in Grafana -Grafana ships with built-in support for Google Cloud Monitoring. Add it as a data source to build dashboards for your Google Cloud Monitoring metrics. For instructions on how to add a data source, refer to [Add a data source]({{< relref "../add-a-data-source.md" >}}). Only users with the organization admin role can add data sources. +Grafana ships with built-in support for Google Cloud Monitoring. Add it as a data source to build dashboards for your Google Cloud Monitoring metrics. For instructions on how to add a data source, refer to [Add a data source]({{< relref "../add-a-data-source/" >}}). Only users with the organization admin role can add data sources. > **Note** Before Grafana v7.1, Google Cloud Monitoring was referred to as Google Stackdriver. @@ -21,7 +31,7 @@ To access Google Cloud Monitoring settings, hover your mouse over the **Configur | `Name` | The data source name. This is how you refer to the data source in panels and queries. | | `Default` | Default data source means that it is pre-selected for new panels. | -For authentication options and configuration details, see the [Google authentication]({{< relref "google-authentication.md" >}}) documentation. +For authentication options and configuration details, see the [Google authentication]({{< relref "google-authentication/" >}}) documentation. ### Google Cloud Monitoring specific data source configuration @@ -119,7 +129,7 @@ The option is called `cloud monitoring auto` and the defaults are: - 5m for time ranges >= 23 hours and < 6 days - 1h for time ranges >= 6 days -The other automatic option is `grafana auto`. This will automatically set the group by time depending on the time range chosen and the width of the time series panel. For more information about grafana auto, refer to the [interval variable]({{< relref "../../variables/variable-types/add-interval-variable.md" >}}). +The other automatic option is `grafana auto`. This will automatically set the group by time depending on the time range chosen and the width of the time series panel. For more information about grafana auto, refer to the [interval variable]({{< relref "../../variables/variable-types/add-interval-variable/" >}}). You can also choose fixed time intervals to group by, like `1h` or `1d`. @@ -241,7 +251,7 @@ Instead of hard-coding things like server, application and sensor name in your m Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different +Check out the [Templating]({{< relref "../../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query Variable @@ -263,13 +273,13 @@ Variable of the type _Query_ allows you to query Google Cloud Monitoring for var ### Using variables in queries -Refer to the [variable syntax documentation]({{< relref "../../variables/syntax.md" >}}). +Refer to the [variable syntax documentation]({{< relref "../../variables/syntax/" >}}). ## Annotations {{< figure src="/static/img/docs/google-cloud-monitoring/annotations-8-0.png" max-width= "400px" class="docs-image--right" >}} -[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Annotation rendering is expensive so it is important to limit the number of rows returned. There is no support for showing Google Cloud Monitoring annotations and events yet but it works well with [custom metrics](https://cloud.google.com/monitoring/custom-metrics/) in Google Cloud Monitoring. With the query editor for annotations, you can select a metric and filters. The `Title` and `Text` fields support templating and can use data returned from the query. For example, the Title field could have the following text: diff --git a/docs/sources/datasources/google-cloud-monitoring/google-authentication.md b/docs/sources/datasources/google-cloud-monitoring/google-authentication.md index 395d94e5b63..7829f8d0d32 100644 --- a/docs/sources/datasources/google-cloud-monitoring/google-authentication.md +++ b/docs/sources/datasources/google-cloud-monitoring/google-authentication.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/google-cloud-monitoring/google-authentication/", "/docs/grafana/next/datasources/cloudmonitoring/"] -description = "Google authentication" -keywords = ["grafana", "google", "authentication"] -title = "Authentication" -weight = 5 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/google-cloud-monitoring/google-authentication/ + - /docs/grafana/next/datasources/cloudmonitoring/ +description: Google authentication +keywords: + - grafana + - google + - authentication +title: Authentication +weight: 5 +--- # Google authentication diff --git a/docs/sources/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards.md b/docs/sources/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards.md index 8bcdc2ef894..8222fbae20e 100644 --- a/docs/sources/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards.md +++ b/docs/sources/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards.md @@ -1,14 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards/", "/docs/grafana/latest/features/datasources/stackdriver/", "/docs/grafana/next/features/datasources/cloudmonitoring/"] -description = "Guide for using Google Cloud Monitoring in Grafana" -keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"] -title = "Preconfigured dashboards" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/google-cloud-monitoring/preconfig-cloud-monitoring-dashboards/ + - /docs/grafana/latest/features/datasources/stackdriver/ + - /docs/grafana/next/features/datasources/cloudmonitoring/ +description: Guide for using Google Cloud Monitoring in Grafana +keywords: + - grafana + - stackdriver + - google + - guide + - cloud + - monitoring +title: Preconfigured dashboards +weight: 10 +--- # Preconfigured Cloud Monitoring dashboards -Google Cloud Monitoring data source ships with pre-configured dashboards for some of the most popular GCP services. These curated dashboards are based on similar dashboards in the GCP dashboard samples repository. See also, [Using Google Cloud Monitoring in Grafana]({{< relref "./_index.md" >}}) for detailed instructions on how to add and configure the Google Cloud Monitoring data source. +Google Cloud Monitoring data source ships with pre-configured dashboards for some of the most popular GCP services. These curated dashboards are based on similar dashboards in the GCP dashboard samples repository. See also, [Using Google Cloud Monitoring in Grafana]({{< relref "_index.md" >}}) for detailed instructions on how to add and configure the Google Cloud Monitoring data source. ## Curated dashboards diff --git a/docs/sources/datasources/graphite.md b/docs/sources/datasources/graphite.md index b31ea462836..70680c116f2 100644 --- a/docs/sources/datasources/graphite.md +++ b/docs/sources/datasources/graphite.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/graphite/", "/docs/grafana/latest/features/datasources/graphite/"] -description = "Guide for using graphite in Grafana" -keywords = ["grafana", "graphite", "guide"] -title = "Graphite" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/graphite/ + - /docs/grafana/latest/features/datasources/graphite/ +description: Guide for using graphite in Grafana +keywords: + - grafana + - graphite + - guide +title: Graphite +weight: 600 +--- # Using Graphite in Grafana @@ -12,27 +17,27 @@ Grafana has an advanced Graphite query editor that lets you quickly navigate the change function parameters and much more. The editor can handle all types of graphite queries. It can even handle complex nested queries through the use of query references. -Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only organization admins can add data sources. To learn more about the Graphite data source, refer to Graphite's [product documentation](https://graphite.readthedocs.io/en/stable/). +Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only organization admins can add data sources. To learn more about the Graphite data source, refer to Graphite's [product documentation](https://graphite.readthedocs.io/en/stable/). ## Graphite settings To access Graphite settings, hover your mouse over the **Configuration** (gear) icon, then click **Data Sources**, and then click the Graphite data source. -| Name | Description | -| --------------------- | ------------------------------------------------------------------------------------- | -| `Name` | The data source name. This is how you refer to the data source in panels and queries. | -| `Default` | Default data source means that it will be pre-selected for new panels. | -| `URL` | The HTTP protocol, IP, and port of your graphite-web or graphite-api install. | -| `Auth` | Refer to [Authentication]({{< relref "../auth/_index.md" >}}) for more information. | -| `Basic Auth` | Enable basic authentication to the data source. | -| `User` | User name for basic authentication. | -| `Password` | Password for basic authentication. | -| `Custom HTTP Headers` | Click **Add header** to add a custom HTTP header. | -| `Header` | Enter the custom header name. | -| `Value` | Enter the custom header value. | +| Name | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `Name` | The data source name. This is how you refer to the data source in panels and queries. | +| `Default` | Default data source means that it will be pre-selected for new panels. | +| `URL` | The HTTP protocol, IP, and port of your graphite-web or graphite-api install. | +| `Auth` | Refer to [Authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/" >}}) for more information. | +| `Basic Auth` | Enable basic authentication to the data source. | +| `User` | User name for basic authentication. | +| `Password` | Password for basic authentication. | +| `Custom HTTP Headers` | Click **Add header** to add a custom HTTP header. | +| `Header` | Enter the custom header name. | +| `Value` | Enter the custom header value. | | `Graphite details` | -| `Version` | Select your version of Graphite. | -| `Type` | Select your type of Graphite. | +| `Version` | Select your version of Graphite. | +| `Type` | Select your type of Graphite. | ## Graphite query editor @@ -112,7 +117,7 @@ Instead of hard-coding things like server, application, and sensor name in your Variables are shown as drop-down select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -For more information, refer to [Variables and templates]({{< relref "../variables/_index.md" >}}). +For more information, refer to [Variables and templates]({{< relref "../variables/" >}}). Graphite 1.1 introduced tags and Grafana added support for Graphite queries with tags in version 5.0. To create a variable using tag values, use the Grafana functions `tags` and `tag_values`. @@ -207,11 +212,11 @@ Example of a tag expression with regex formatting and using the Equal Tilde oper server=~${servers:regex} ``` -For more information, refer to [Advanced variable format options]({{< relref "../variables/advanced-variable-format-options.md" >}}). +For more information, refer to [Advanced variable format options]({{< relref "../variables/advanced-variable-format-options/" >}}). ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox, @@ -219,7 +224,7 @@ specify a tag or wildcard (leave empty should also work) ## Get Grafana metrics into Graphite -Grafana exposes metrics for Graphite on the `/metrics` endpoint. For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/view-server/internal-metrics.md" >}}). +Grafana exposes metrics for Graphite on the `/metrics` endpoint. For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../setup-grafana/set-up-grafana-monitoring/" >}}). ## Configure the data source with provisioning diff --git a/docs/sources/datasources/influxdb/_index.md b/docs/sources/datasources/influxdb/_index.md index 140fbc05f35..2c1b599ebc5 100644 --- a/docs/sources/datasources/influxdb/_index.md +++ b/docs/sources/datasources/influxdb/_index.md @@ -1,16 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/influxdb/", "/docs/grafana/latest/features/datasources/influxdb/"] -description = "Guide for using InfluxDB in Grafana" -keywords = ["grafana", "influxdb", "guide", "flux"] -title = "InfluxDB data source" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/influxdb/ + - /docs/grafana/latest/features/datasources/influxdb/ +description: Guide for using InfluxDB in Grafana +keywords: + - grafana + - influxdb + - guide + - flux +title: InfluxDB data source +weight: 700 +--- # InfluxDB data source {{< docs/shared "influxdb/intro.md" >}} -This topic explains options, variables, querying, and other options specific to this data source. Refer to [Add a data source]({{< relref "../add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +This topic explains options, variables, querying, and other options specific to this data source. Refer to [Add a data source]({{< relref "../add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. ## Data source options @@ -25,7 +31,7 @@ InfluxDB data source options differ depending on which [query language](#query-l ### InfluxQL (classic InfluxDB query) -These options apply if you are using the InfluxQL query language. If you are using Flux, refer to [Flux support in Grafana]({{< relref "influxdb-flux.md" >}}). +These options apply if you are using the InfluxQL query language. If you are using Flux, refer to [Flux support in Grafana]({{< relref "influxdb-flux/" >}}). | Name | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -43,7 +49,7 @@ These options apply if you are using the InfluxQL query language. If you are usi ### Flux -For information on data source settings and using Flux in Grafana, refer to [Flux support in Grafana]({{< relref "influxdb-flux.md" >}}). +For information on data source settings and using Flux in Grafana, refer to [Flux support in Grafana]({{< relref "influxdb-flux/" >}}). #### Min time interval @@ -125,7 +131,7 @@ You can switch to raw query mode by clicking hamburger icon and then `Switch edi ## Querying logs -Querying and displaying log data from InfluxDB is available in [Explore]({{< relref "../../explore/_index.md" >}}), and in the [logs panel]({{< relref "../../visualizations/logs-panel.md" >}}) in dashboards. +Querying and displaying log data from InfluxDB is available in [Explore]({{< relref "../../explore/" >}}), and in the [logs panel]({{< relref "../../visualizations/logs-panel/" >}}) in dashboards. Select the InfluxDB data source, and then enter a query to display your logs. ### Log queries @@ -140,7 +146,7 @@ To add a filter, click the plus icon to the right of the `Measurements/Fields` b ## Annotations -[Annotations]({{< relref "../../dashboards/annotations.md" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu. +[Annotations]({{< relref "../../dashboards/annotations/" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu. An example query: diff --git a/docs/sources/datasources/influxdb/influxdb-flux.md b/docs/sources/datasources/influxdb/influxdb-flux.md index aa66380316c..5d514e303ac 100644 --- a/docs/sources/datasources/influxdb/influxdb-flux.md +++ b/docs/sources/datasources/influxdb/influxdb-flux.md @@ -1,9 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/influxdb/influxdb-flux/"] -description = "Guide for Flux in Grafana" -title = "Flux support in Grafana" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/influxdb/influxdb-flux/ +description: Guide for Flux in Grafana +title: Flux support in Grafana +weight: 200 +--- # Flux query language in Grafana @@ -75,4 +76,4 @@ from(bucket: "grafana") |> yield(name: "mean") ``` -You can view the interpolated version of a query with the query inspector. For more information, refer to [Navigate the Query Inspector]({{< relref "../../panels/working-with-panels/navigate-inspector-panel.md" >}}). +You can view the interpolated version of a query with the query inspector. For more information, refer to [Navigate the Query Inspector]({{< relref "../../panels/working-with-panels/navigate-inspector-panel/" >}}). diff --git a/docs/sources/datasources/influxdb/influxdb-templates.md b/docs/sources/datasources/influxdb/influxdb-templates.md index e894309078f..2518a32202c 100644 --- a/docs/sources/datasources/influxdb/influxdb-templates.md +++ b/docs/sources/datasources/influxdb/influxdb-templates.md @@ -1,15 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/influxdb/influxdb-templates/"] -description = "Guide for templates in InfluxDB" -title = "InfluxDB templates" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/influxdb/influxdb-templates/ +description: Guide for templates in InfluxDB +title: InfluxDB templates +weight: 300 +--- ## InfluxDB templates Instead of hard-coding things like server, application and sensor name in your metric queries you can use variables in their place. -For more information, refer to [Templates and variables]({{< relref "../../variables/_index.md" >}}). +For more information, refer to [Templates and variables]({{< relref "../../variables/" >}}). ## Using variables in InfluxDB queries @@ -34,7 +35,7 @@ Example dashboard: ## Query variables -If you add a query template variable, then you can write an InfluxDB exploration (metadata) query. These queries can return things like measurement names, key names or key values. For more information, refer to [Add query variable]({{< relref "../../variables/variable-types/add-query-variable.md" >}}). +If you add a query template variable, then you can write an InfluxDB exploration (metadata) query. These queries can return things like measurement names, key names or key values. For more information, refer to [Add query variable]({{< relref "../../variables/variable-types/add-query-variable/" >}}). For example, you can have a variable that contains all values for tag `hostname` if you specify a query like this in the query variable **Query**. @@ -44,7 +45,7 @@ SHOW TAG VALUES WITH KEY = "hostname" ## Chained or nested variables -You can also create nested variables, sometimes called [chained variables]({{< relref "../../variables/variable-types/chained-variables.md" >}}). +You can also create nested variables, sometimes called [chained variables]({{< relref "../../variables/variable-types/chained-variables/" >}}). For example, if you had another variable, for example `region`. Then you could have the hosts variable only show hosts from the current selected region with a query like this: @@ -64,4 +65,4 @@ If you have a variable with key names you can use this variable in a group by cl InfluxDB supports the special `Ad hoc filters` variable type. This variable allows you to specify any number of key/value filters on the fly. These filters are automatically applied to all your InfluxDB queries. -For more information, refer to [Add ad hoc filters]({{< relref "../../variables/variable-types/add-ad-hoc-filters.md" >}}). +For more information, refer to [Add ad hoc filters]({{< relref "../../variables/variable-types/add-ad-hoc-filters/" >}}). diff --git a/docs/sources/datasources/influxdb/provision-influxdb.md b/docs/sources/datasources/influxdb/provision-influxdb.md index cdabdfdaca0..6caece5f25c 100644 --- a/docs/sources/datasources/influxdb/provision-influxdb.md +++ b/docs/sources/datasources/influxdb/provision-influxdb.md @@ -1,9 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/influxdb/provision-influxdb/"] -description = "Guide for provisioning InfluxDB" -title = "Provision InfluxDB" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/influxdb/provision-influxdb/ +description: Guide for provisioning InfluxDB +title: Provision InfluxDB +weight: 400 +--- # Provision InfluxDB diff --git a/docs/sources/datasources/jaeger.md b/docs/sources/datasources/jaeger.md index 001574b4c45..20ab026c23f 100644 --- a/docs/sources/datasources/jaeger.md +++ b/docs/sources/datasources/jaeger.md @@ -1,15 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/jaeger/", "/docs/grafana/latest/features/datasources/jaeger/"] -description = "Guide for using Jaeger in Grafana" -keywords = ["grafana", "jaeger", "guide", "tracing"] -title = "Jaeger" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/jaeger/ + - /docs/grafana/latest/features/datasources/jaeger/ +description: Guide for using Jaeger in Grafana +keywords: + - grafana + - jaeger + - guide + - tracing +title: Jaeger +weight: 800 +--- # Jaeger data source Grafana ships with built-in support for Jaeger, which provides open source, end-to-end distributed tracing. -Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore/_index.md" >}}). +Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore/" >}}). ## Add data source @@ -28,7 +34,7 @@ To access Jaeger settings, click the **Configuration** (gear) icon, then click * > **Note:** This feature is available in Grafana 7.4+. -This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration" >}}). Select target data source (at this moment limited to Loki and Splunk \[logs\] data sources) and select which tags will be used in the logs query. +This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration/" >}}). Select target data source (at this moment limited to Loki and Splunk \[logs\] data sources) and select which tags will be used in the logs query. - **Data source -** Target data source. - **Tags -** The tags that will be used in the logs query. Default is `'cluster', 'hostname', 'namespace', 'pod'`. @@ -47,11 +53,12 @@ This is a configuration for the [trace to logs feature]({{< relref "../explore/t To configure trace to metrics, select the target Prometheus data source and create any desired linked queries. -- **Data source -** Target data source. +-- **Tags -** You can use tags in the linked queries. The key is the span attribute name. The optional value is the corresponding metric label name (for example, map `k8s.pod` to `pod`). You may interpolate these tags into your queries using the `$__tags` keyword. Each linked query consists of: -- **Link Label -** (Optional) Descriptive label for the linked query. --- **Query -** Query that runs when navigating from a trace to the metrics data source. +-- **Query -** Query that runs when navigating from a trace to the metrics data source. Interpolate tags using the `$__tags` keyword. For example, when you configure the query `requests_total{$__tags}`with the tags `k8s.pod=pod` and `cluster`, it results in `requests_total{pod="nginx-554b9", cluster="us-east-1"}`. ### Node Graph @@ -61,7 +68,7 @@ This is a configuration for the beta Node Graph visualization. The Node Graph is ## Query traces -You can query and display traces from Jaeger via [Explore]({{< relref "../explore/_index.md" >}}). +You can query and display traces from Jaeger via [Explore]({{< relref "../explore/" >}}). {{< figure src="/static/img/docs/explore/jaeger-search-form.png" class="docs-image--no-shadow" caption="Screenshot of the Jaeger query editor" >}} @@ -136,7 +143,7 @@ Here is an example JSON: ## Linking Trace ID from logs -You can link to Jaeger trace from logs in Loki by configuring a derived field with internal link. See the [Derived fields]({{< relref "loki.md#derived-fields" >}}) section in the [Loki data source]({{< relref "loki.md" >}}) documentation for details. +You can link to Jaeger trace from logs in Loki by configuring a derived field with internal link. See the [Derived fields]({{< relref "loki/#derived-fields" >}}) section in the [Loki data source]({{< relref "loki/" >}}) documentation for details. ## Configure the data source with provisioning @@ -169,6 +176,12 @@ datasources: spanEndTimeShift: '1h' filterByTraceID: false filterBySpanID: false + tracesToMetrics: + datasourceUid: 'prom' + tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }] + queries: + - name: 'Sample query' + query: 'sum(rate(tempo_spanmetrics_latency_bucket{$__tags}[5m]))' secureJsonData: basicAuthPassword: my_password ``` diff --git a/docs/sources/datasources/loki.md b/docs/sources/datasources/loki.md index 22f40a7eac2..45bd2273c10 100644 --- a/docs/sources/datasources/loki.md +++ b/docs/sources/datasources/loki.md @@ -1,16 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/loki/", "/docs/grafana/latest/features/datasources/loki/"] -description = "Guide for using Loki in Grafana" -keywords = ["grafana", "loki", "logging", "guide"] -title = "Loki" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/loki/ + - /docs/grafana/latest/features/datasources/loki/ +description: Guide for using Loki in Grafana +keywords: + - grafana + - loki + - logging + - guide +title: Loki +weight: 800 +--- # Using Loki in Grafana Grafana ships with built-in support for Loki, an open source log aggregation system by Grafana Labs. This topic explains options, variables, querying, and other options specific to this data source. -Add it as a data source and you are ready to build dashboards or query your log data in [Explore]({{< relref "../explore" >}}). Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +Add it as a data source and you are ready to build dashboards or query your log data in [Explore]({{< relref "../explore/" >}}). Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. ## Hosted Loki @@ -57,7 +63,9 @@ The new field with the link shown in log details: Loki query editor is separated into 3 distinct modes that you can switch between. See docs for each section below. -At the top of the editor there is `Run query` button that will run the query and `Explain | Builder | Code` tabs to switch between the editor modes. If the query editor is in Builder mode there are additional elements explained in the Builder section. +At the top of the editor, select `Run queries` to run a query. Select `Explain | Builder | Code` tabs to switch between the editor modes. If the query editor is in Builder mode, there are additional elements explained in the Builder section. + +> **Note:** In Explore, to run Loki queries, select `Run query`. Each mode is synchronized with the other modes, so you can switch between them without losing your work, although there are some limitations. Some more complex queries are not yet supported in the builder mode. If you try to switch from `Code` to `Builder` with such query, editor will show a popup explaining that you can lose some parts of the query, and you can decide if you still want to continue to `Builder` mode or not. @@ -132,7 +140,7 @@ There are two types of LogQL queries: ### Log queries -Loki log queries return the contents of the log lines. Querying and displaying log data from Loki is available via [Explore]({{< relref "../explore" >}}), and with the [logs panel]({{< relref "../visualizations/logs-panel.md" >}}) in dashboards. Select the Loki data source, and then enter a LogQL query to display your logs.F or more information about log queries and LogQL, refer to the [Loki log queries documentation](https://grafana.com/docs/loki/latest/logql/log_queries/) +Loki log queries return the contents of the log lines. Querying and displaying log data from Loki is available via [Explore]({{< relref "../explore/" >}}), and with the [logs panel]({{< relref "../visualizations/logs-panel/" >}}) in dashboards. Select the Loki data source, and then enter a LogQL query to display your logs.F or more information about log queries and LogQL, refer to the [Loki log queries documentation](https://grafana.com/docs/loki/latest/logql/log_queries/) #### Log context @@ -193,7 +201,7 @@ LogQL supports wrapping a log query with functions that allow for creating metri Instead of hard-coding things like server, application and sensor name in your metric queries, you can use variables in their place. Variables are shown as drop-down select boxes at the top of the dashboard. These drop-down boxes make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different types of template variables. +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ## Query variable @@ -212,11 +220,11 @@ Loki supports the special ad hoc filters variable type. It allows you to specify ### Using interval and range variables -You can use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`. For more information, refer to [Global built-in variables]({{< relref "../variables/variable-types/global-variables.md" >}}). +You can use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`. For more information, refer to [Global built-in variables]({{< relref "../variables/variable-types/global-variables/" >}}). ## Annotations -You can use any non-metric Loki query as a source for [annotations]({{< relref "../dashboards/annotations" >}}). Log content will be used as annotation text and your log stream labels as tags, so there is no need for additional mapping. +You can use any non-metric Loki query as a source for [annotations]({{< relref "../dashboards/annotations/" >}}). Log content will be used as annotation text and your log stream labels as tags, so there is no need for additional mapping. ## Configure the data source with provisioning @@ -249,7 +257,6 @@ datasources: url: http://localhost:3100 basicAuth: true basicAuthUser: my_user - basicAuthPassword: test_password jsonData: maxLines: 1000 derivedFields: @@ -266,6 +273,8 @@ datasources: - matcherRegex: "traceID=(\\w+)" name: TraceID url: 'http://localhost:16686/trace/$${__value.raw}' + secureJsonData: + basicAuthPassword: test_password ``` Here's an example of a Jaeger data source corresponding to the above example. Note that the Jaeger `uid` value does match the Loki `datasourceUid` value. diff --git a/docs/sources/datasources/mssql.md b/docs/sources/datasources/mssql.md index d9bd5aa04d5..9a41a65ac80 100644 --- a/docs/sources/datasources/mssql.md +++ b/docs/sources/datasources/mssql.md @@ -1,14 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/mssql/", "/docs/grafana/latest/features/datasources/mssql/"] -description = "Guide for using Microsoft SQL Server in Grafana" -keywords = ["grafana", "MSSQL", "Microsoft", "SQL", "guide", "Azure SQL Database"] -title = "Microsoft SQL Server" -weight = 900 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/mssql/ + - /docs/grafana/latest/features/datasources/mssql/ +description: Guide for using Microsoft SQL Server in Grafana +keywords: + - grafana + - MSSQL + - Microsoft + - SQL + - guide + - Azure SQL Database +title: Microsoft SQL Server +weight: 900 +--- # Using Microsoft SQL Server in Grafana -Grafana ships with a built-in Microsoft SQL Server (MS SQL) data source plugin that allows you to query and visualize data from any Microsoft SQL Server 2005 or newer, including Microsoft Azure SQL Database. This topic explains options, variables, querying, and other options specific to the MS SQL data source. Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +Grafana ships with a built-in Microsoft SQL Server (MS SQL) data source plugin that allows you to query and visualize data from any Microsoft SQL Server 2005 or newer, including Microsoft Azure SQL Database. This topic explains options, variables, querying, and other options specific to the MS SQL data source. Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. ## Data source options @@ -170,11 +178,11 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames/#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions/#display-name" >}}). **Example with `metric` column:** @@ -218,7 +226,7 @@ GROUP BY ORDER BY 1 ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display name value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions/#display-name" >}}) display name value of `${__field.labels.hostname}`. Data frame result: @@ -263,7 +271,7 @@ Data frame result: Instead of hard-coding things like server, application and sensor name in your metric queries you can use variables in their place. Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different types of template variables. +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query variable @@ -333,11 +341,11 @@ Grafana automatically creates a quoted, comma-separated string for multi-value v `${servers:csv}` -Read more about variable formatting options in the [Variables]({{< relref "../variables/variable-types/_index.md#advanced-formatting-options" >}}) documentation. +Read more about variable formatting options in the [Variables]({{< relref "../variables/variable-types/#advanced-formatting-options" >}}) documentation. ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Columns:** diff --git a/docs/sources/datasources/mysql.md b/docs/sources/datasources/mysql.md index 4189a62d7c8..41967f9f1d3 100644 --- a/docs/sources/datasources/mysql.md +++ b/docs/sources/datasources/mysql.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/mysql/", "/docs/grafana/latest/features/datasources/mysql/"] -description = "Guide for using MySQL in Grafana" -keywords = ["grafana", "mysql", "guide"] -title = "MySQL" -weight = 1000 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/mysql/ + - /docs/grafana/latest/features/datasources/mysql/ +description: Guide for using MySQL in Grafana +keywords: + - grafana + - mysql + - guide +title: MySQL +weight: 1000 +--- # Using MySQL in Grafana @@ -182,11 +187,11 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames/#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions/#display-name" >}}). **Example with `metric` column:** @@ -228,7 +233,7 @@ GROUP BY time, hostname ORDER BY time ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions/#display-name" >}}) display value of `${__field.labels.hostname}`. Data frame result: @@ -278,7 +283,7 @@ This feature is currently available in the nightly builds and will be included i Instead of hard-coding things like server, application and sensor name in your metric queries you can use variables in their place. Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different types of template variables. +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query Variable @@ -373,11 +378,11 @@ Grafana automatically creates a quoted, comma-separated string for multi-value v `${servers:csv}` -Read more about variable formatting options in the [Variables]({{< relref "../variables/_index.md#advanced-formatting-options" >}}) documentation. +Read more about variable formatting options in the [Variables]({{< relref "../variables/#advanced-formatting-options" >}}) documentation. ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Example query using time column with epoch values:** diff --git a/docs/sources/datasources/opentsdb.md b/docs/sources/datasources/opentsdb.md index f7c8782b3bd..cd54a719998 100644 --- a/docs/sources/datasources/opentsdb.md +++ b/docs/sources/datasources/opentsdb.md @@ -1,14 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/opentsdb/", "/docs/grafana/latest/features/datasources/opentsdb/", "/docs/grafana/latest/features/opentsdb/"] -description = "Guide for using OpenTSDB in Grafana" -keywords = ["grafana", "opentsdb", "guide"] -title = "OpenTSDB" -weight = 1100 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/opentsdb/ + - /docs/grafana/latest/features/datasources/opentsdb/ + - /docs/grafana/latest/features/opentsdb/ +description: Guide for using OpenTSDB in Grafana +keywords: + - grafana + - opentsdb + - guide +title: OpenTSDB +weight: 1100 +--- # Using OpenTSDB in Grafana -Grafana ships with advanced support for OpenTSDB. This topic explains options, variables, querying, and other options specific to the OpenTSDB data source. Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +Grafana ships with advanced support for OpenTSDB. This topic explains options, variables, querying, and other options specific to the OpenTSDB data source. Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. ## OpenTSDB settings @@ -45,7 +51,7 @@ Instead of hard-coding things like server, application and sensor name in your m Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query variable diff --git a/docs/sources/datasources/postgres.md b/docs/sources/datasources/postgres.md index 5e9b432a41e..27f37a6c3a6 100644 --- a/docs/sources/datasources/postgres.md +++ b/docs/sources/datasources/postgres.md @@ -1,14 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/postgres/", "/docs/grafana/latest/features/datasources/postgres/"] -description = "Guide for using PostgreSQL in Grafana" -keywords = ["grafana", "postgresql", "guide"] -title = "PostgreSQL" -weight = 1200 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/postgres/ + - /docs/grafana/latest/features/datasources/postgres/ +description: Guide for using PostgreSQL in Grafana +keywords: + - grafana + - postgresql + - guide +title: PostgreSQL +weight: 1200 +--- # PostgreSQL data source -Grafana ships with a built-in PostgreSQL data source plugin that allows you to query and visualize data from a PostgreSQL compatible database. This topic explains options, variables, querying, and other options specific to this data source. For instructions about how to add a data source to Grafana, refer to [Add a data source]({{< relref "add-a-data-source.md" >}}). Only users with the organization admin role can add data sources. +Grafana ships with a built-in PostgreSQL data source plugin that allows you to query and visualize data from a PostgreSQL compatible database. This topic explains options, variables, querying, and other options specific to this data source. For instructions about how to add a data source to Grafana, refer to [Add a data source]({{< relref "add-a-data-source/" >}}). Only users with the organization admin role can add data sources. ## PostgreSQL settings @@ -187,11 +192,11 @@ The resulting table panel: If you set Format as to _Time series_, then the query must have a column named time that returns either a SQL datetime or any numeric datatype representing Unix epoch in seconds. In addition, result sets of time series queries must be sorted by time for panels to properly visualize the result. -A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames.md#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. +A time series query result is returned in a [wide data frame format]({{< relref "../developers/plugins/data-frames/#wide-format" >}}). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result. > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions/#display-name" >}}). **Example with `metric` column:** @@ -233,7 +238,7 @@ GROUP BY time, hostname ORDER BY time ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions/#display-name" >}}) display value of `${__field.labels.hostname}`. Data frame result: @@ -278,7 +283,7 @@ Data frame result: Instead of hard-coding things like server, application and sensor name in your metric queries you can use variables in their place. Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Refer to [Templates and variables]({{< relref "../variables/_index.md" >}}) for an introduction to the templating feature and the different types of template variables. +Refer to [Templates and variables]({{< relref "../variables/" >}}) for an introduction to the templating feature and the different types of template variables. ### Query variable @@ -371,11 +376,11 @@ Grafana automatically creates a quoted, comma-separated string for multi-value v `${servers:csv}` -Read more about variable formatting options in the [Variables]({{< relref "../variables/_index.md#advanced-formatting-options" >}}) documentation. +Read more about variable formatting options in the [Variables]({{< relref "../variables/#advanced-formatting-options" >}}) documentation. ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Example query using time column with epoch values:** diff --git a/docs/sources/datasources/prometheus.md b/docs/sources/datasources/prometheus.md index 3b22249aa9d..e070538ce98 100644 --- a/docs/sources/datasources/prometheus.md +++ b/docs/sources/datasources/prometheus.md @@ -1,14 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/prometheus/", "/docs/grafana/latest/features/datasources/prometheus/"] -description = "Guide for using Prometheus in Grafana" -keywords = ["grafana", "prometheus", "guide"] -title = "Prometheus" -weight = 1300 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/prometheus/ + - /docs/grafana/latest/features/datasources/prometheus/ +description: Guide for using Prometheus in Grafana +keywords: + - grafana + - prometheus + - guide +title: Prometheus +weight: 1300 +--- # Prometheus data source -Grafana includes built-in support for Prometheus. This topic explains options, variables, querying, and other options specific to the Prometheus data source. Refer to [Add a data source]({{< relref "add-a-data-source.md" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. +Grafana includes built-in support for Prometheus. This topic explains options, variables, querying, and other options specific to the Prometheus data source. Refer to [Add a data source]({{< relref "add-a-data-source/" >}}) for instructions on how to add a data source to Grafana. Only users with the organization admin role can add data sources. > **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text). @@ -42,7 +47,9 @@ Prometheus query editor is separated into 3 distinct modes that you can switch b ![Editor toolbar](/static/img/docs/prometheus/header-8-5.png 'Editor toolbar') -At the top of the editor there is `Run query` button that will run the query and `Explain | Builder | Code` tabs to switch between the editor modes. If the query editor is in Builder mode there are additional elements explained in the Builder section. +At the top of the editor, select `Run queries` to run a query. Select `Explain | Builder | Code` tabs to switch between the editor modes. If the query editor is in Builder mode, there are additional elements explained in the Builder section. + +> **Note:** In Explore, to run Prometheus queries, select `Run query`. Each mode is synchronized with the other modes, so you can switch between them without losing your work, although there are some limitations. Some more complex queries are not yet supported in the builder mode. If you try to switch from `Code` to `Builder` with such query, editor will show a popup explaining that you can lose some parts of the query, and you can decide if you still want to continue to `Builder` mode or not. @@ -60,7 +67,7 @@ For more information about Prometheus query language, refer to the [Prometheus d Autocomplete kicks automatically in appropriate times during typing. Use `ctrl/cmd + space` to trigger autocomplete manually when needed. Autocomplete can suggest both static functions, aggregations and keywords but also dynamic items like metrics and labels. Autocomplete dropdown also shows documentation for the suggested items, either static one or dynamic metric documentation where available. -In [Explore]({{< relref "../explore/_index.md" >}}) use `shift + enter` to run the query. +In [Explore]({{< relref "../explore/" >}}) use `shift + enter` to run the query. #### Metrics browser @@ -85,13 +92,13 @@ The "Validate selector" button will check with Prometheus how many time series a ![Options](/static/img/docs/prometheus/options-8-5.png 'Options') -| Name | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Legend` | Controls the name of the time series. Use predefined format or use custom format.
`Auto` - only includes unique labels.
`Verbose` - includes all labels.
`Custom` - select will change to text input. Use use tamplating to select which labels will be included. For example, `{{hostname}}` is replaced by the label value for the label `hostname`. Clear the input and click outside the input to go back to select mode. | -| `Min step` | Set the lower bounds on the interval between data points. For example, set "1h" to hint that measurements are not frequent (taken hourly). `$__interval` and `$__rate_interval` are supported. | -| `Format` | You can switch between `Table` `Time series` or `Heatmap` options. The `Table` option works only in the Table panel. `Heatmap` displays metrics of the Histogram type on a Heatmap panel. Under the hood, it converts cumulative histograms to regular ones and sorts series by the bucket bound. | -| `Type` | `Range` - Query returning a Range vector, a set of time series containing a range of data points over time for each time series.
`Instant` - Perform an "instant" query to return only the latest value that Prometheus has scraped for the requested time series. Instant queries can return results much faster than normal range queries. Use them to look up label sets. Instant query results are made up only of one data point per series but can be shown in the graph panel in a dashboard with the help of [series overrides]({{< relref "../visualizations/graph-panel.md#series-overrides" >}}). To show them in the graph as a latest value point, add a series override and select `Points > true`. To show a horizontal line across the whole graph, add a series override and select `Transform > constant`.
`Both` - Available only in Explore. Runs both range and instant query | -| `Exemplars` | If on, run exemplars query with the regular query and show exemplars in the graph. | +| Name | Description | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Legend` | Controls the name of the time series. Use predefined format or use custom format.
`Auto` - only includes unique labels.
`Verbose` - includes all labels.
`Custom` - select will change to text input. Use use tamplating to select which labels will be included. For example, `{{hostname}}` is replaced by the label value for the label `hostname`. Clear the input and click outside the input to go back to select mode. | +| `Min step` | Set the lower bounds on the interval between data points. For example, set "1h" to hint that measurements are not frequent (taken hourly). `$__interval` and `$__rate_interval` are supported. | +| `Format` | You can switch between `Table` `Time series` or `Heatmap` options. The `Table` option works only in the Table panel. `Heatmap` displays metrics of the Histogram type on a Heatmap panel. Under the hood, it converts cumulative histograms to regular ones and sorts series by the bucket bound. | +| `Type` | `Range` - Query returning a Range vector, a set of time series containing a range of data points over time for each time series.
`Instant` - Perform an "instant" query to return only the latest value that Prometheus has scraped for the requested time series. Instant queries can return results much faster than normal range queries. Use them to look up label sets. Instant query results are made up only of one data point per series but can be shown in the graph panel in a dashboard with the help of [series overrides]({{< relref "../visualizations/graph-panel/#series-overrides" >}}). To show them in the graph as a latest value point, add a series override and select `Points > true`. To show a horizontal line across the whole graph, add a series override and select `Transform > constant`.
`Both` - Available only in Explore. Runs both range and instant query | +| `Exemplars` | If on, run exemplars query with the regular query and show exemplars in the graph. | > **Note:** Grafana modifies the request dates for queries to align them with the dynamically calculated step. This ensures consistent display of metrics data, but it can result in a small gap of data at the right edge of a graph. @@ -154,7 +161,7 @@ Instead of hard-coding things like server, application and sensor name in your m Variables are shown as dropdown select boxes at the top of the dashboard. These dropdowns make it easy to change the data being displayed in your dashboard. -Check out the [Templating]({{< relref "../variables/_index.md" >}}) documentation for an introduction to the templating feature and the different +Check out the [Templating]({{< relref "../variables/" >}}) documentation for an introduction to the templating feature and the different types of template variables. ### Query variable @@ -176,7 +183,7 @@ For details of what _metric names_, _label names_ and _label values_ are please > Support for `$__range`, `$__range_s` and `$__range_ms` only available from Grafana v5.3 -You can use some global built-in variables in query variables, for example, `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`. See [Global built-in variables]({{< relref "../variables/variable-types/global-variables.md" >}}) for more information. They are convenient to use in conjunction with the `query_result` function when you need to filter variable queries since the `label_values` function doesn't support queries. +You can use some global built-in variables in query variables, for example, `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`. See [Global built-in variables]({{< relref "../variables/variable-types/global-variables/" >}}) for more information. They are convenient to use in conjunction with the `query_result` function when you need to filter variable queries since the `label_values` function doesn't support queries. Make sure to set the variable's `refresh` trigger to be `On Time Range Change` to get the correct instances when changing the time range on the dashboard. @@ -221,12 +228,12 @@ options are enabled, Grafana converts the labels from plain text to a regex comp ### Ad hoc filters variable -Prometheus supports the special [ad hoc filters]({{< relref "../variables/variable-types/add-ad-hoc-filters.md" >}}) variable type. It allows you to specify any number of label/value filters on the fly. These filters are automatically +Prometheus supports the special [ad hoc filters]({{< relref "../variables/variable-types/add-ad-hoc-filters/" >}}) variable type. It allows you to specify any number of label/value filters on the fly. These filters are automatically applied to all your Prometheus queries. ## Annotations -[Annotations]({{< relref "../dashboards/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../dashboards/annotations/" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Prometheus supports two ways to query annotations. @@ -240,7 +247,7 @@ The step option is useful to limit the number of events returned from your query Grafana exposes metrics for Prometheus on the `/metrics` endpoint. We also bundle a dashboard within Grafana so you can get started viewing your metrics faster. You can import the bundled dashboard by going to the data source edit page and click the dashboard tab. There you can find a dashboard for Grafana and one for Prometheus. Import and start viewing all the metrics! -For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/view-server/internal-metrics.md" >}}). +For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../setup-grafana/set-up-grafana-monitoring/" >}}). ## Prometheus API diff --git a/docs/sources/datasources/tempo.md b/docs/sources/datasources/tempo.md index 7993df800f8..63c03286255 100644 --- a/docs/sources/datasources/tempo.md +++ b/docs/sources/datasources/tempo.md @@ -1,14 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/tempo/", "/docs/grafana/latest/features/datasources/tempo/"] -description = "High volume, minimal dependency trace storage. OSS tracing solution from Grafana Labs." -keywords = ["grafana", "tempo", "guide", "tracing"] -title = "Tempo" -weight = 1400 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/tempo/ + - /docs/grafana/latest/features/datasources/tempo/ +description: High volume, minimal dependency trace storage. OSS tracing solution from + Grafana Labs. +keywords: + - grafana + - tempo + - guide + - tracing +title: Tempo +weight: 1400 +--- # Tempo data source -Grafana ships with built-in support for Tempo a high volume, minimal dependency trace storage, OSS tracing solution from Grafana Labs. Add it as a data source, and you are ready to query your traces in [Explore]({{< relref "../explore/_index.md" >}}). +Grafana ships with built-in support for Tempo a high volume, minimal dependency trace storage, OSS tracing solution from Grafana Labs. Add it as a data source, and you are ready to query your traces in [Explore]({{< relref "../explore/" >}}). ## Add data source @@ -27,7 +34,7 @@ To access Tempo settings, click the **Configuration** (gear) icon, then click ** > **Note:** This feature is available in Grafana 7.4+. -This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration" >}}). Select target data source (at this moment limited to Loki or Splunk \[logs\] data sources) and select which tags will be used in the logs query. +This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration/" >}}). Select target data source (at this moment limited to Loki or Splunk \[logs\] data sources) and select which tags will be used in the logs query. - **Data source -** Target data source. - **Tags -** The tags that will be used in the logs query. Default is `'cluster', 'hostname', 'namespace', 'pod'`. @@ -46,11 +53,12 @@ This is a configuration for the [trace to logs feature]({{< relref "../explore/t To configure trace to metrics, select the target Prometheus data source and create any desired linked queries. -- **Data source -** Target data source. +-- **Tags -** You can use tags in the linked queries. The key is the span attribute name. The optional value is the corresponding metric label name (for example, map `k8s.pod` to `pod`). You may interpolate these tags into your queries using the `$__tags` keyword. Each linked query consists of: -- **Link Label -** (Optional) Descriptive label for the linked query. --- **Query -** Query that runs when navigating from a trace to the metrics data source. +-- **Query -** Query that runs when navigating from a trace to the metrics data source. Interpolate tags using the `$__tags` keyword. For example, when you configure the query `requests_total{$__tags}`with the tags `k8s.pod=pod` and `cluster`, it results in `requests_total{pod="nginx-554b9", cluster="us-east-1"}`. ### Service Graph @@ -78,7 +86,7 @@ This is a configuration for the Loki search query type. ## Query traces -You can query and display traces from Tempo via [Explore]({{< relref "../explore/_index.md" >}}). +You can query and display traces from Tempo via [Explore]({{< relref "../explore/" >}}). ### Tempo search @@ -88,19 +96,15 @@ Tempo search is an experimental feature behind a feature toggle. Use this to sea #### Search recent traces -Tempo allows you to search recent traces held in the ingesters. By default, ingesters store the last 15 minutes of tracing data, and this search is disabled. Enable this search capability by setting the `tempoSearch` feature toggle. - -You must also configure your Tempo data source to use this feature. Refer to the [Tempo documentation](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-recent-traces). +Tempo allows you to search recent traces held in the ingesters. By default, ingesters store the last 15 minutes of tracing data. You must configure your Tempo data source to use this feature. Refer to the [Tempo documentation](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-recent-traces). #### Search backend datastore -Tempo includes the ability to search the entire backend datastore. You can enable this capability by setting the `tempoSearch` and `tempoBackendSearch` feature toggles. - -You must also configure your Tempo data source to use this feature.Refer to the [Tempo documentation](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-the-backend-datastore). +Tempo includes the ability to search the entire backend datastore. You must configure your Tempo data source to use this feature. Refer to the [Tempo documentation](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-the-backend-datastore). ### Loki search -To find traces to visualize, use the [Loki query editor]({{< relref "loki.md#loki-query-editor" >}}). To get search results, you must have [derived fields]({{< relref "loki.md#derived-fields" >}}) configured, which point to this data source. +To find traces to visualize, use the [Loki query editor]({{< relref "loki/#loki-query-editor" >}}). To get search results, you must have [derived fields]({{< relref "loki/#derived-fields" >}}) configured, which point to this data source. {{< figure src="/static/img/docs/tempo/query-editor-search.png" class="docs-image--no-shadow" max-width="750px" caption="Screenshot of the Tempo query editor showing the search tab" >}} @@ -112,7 +116,9 @@ To query a particular trace, select the **TraceID** query type, and then put the ## Upload JSON trace file -You can upload a JSON file that contains a single trace to visualize it. If the file has multiple traces then the first trace is used for visualization. +You can upload a JSON file that contains a single trace or service graph to visualize it. If the file has multiple traces, the first trace is used for visualization. + +You can download a trace or service graph through the inspector. Open the inspector, navigate to the 'Data' tab, and click 'Download traces' or 'Download service graph'. Here is an example JSON: @@ -168,7 +174,7 @@ To display the service graph: - [Configure the Grafana Agent](https://grafana.com/docs/tempo/next/grafana-agent/service-graphs/#quickstart) to generate service graph data - Link a Prometheus datasource in the Tempo datasource settings. -- Navigate to [Explore]({{< relref "../explore/_index.md" >}}) +- Navigate to [Explore]({{< relref "../explore/" >}}) - Select the Tempo datasource - Select the **Service Graph** query type and run the query - Optionally, filter by service name @@ -188,7 +194,7 @@ Click on the service to see a context menu with additional links for quick navig ## Linking Trace ID from logs -You can link to Tempo trace from logs in Loki or Elastic by configuring an internal link. See the [Derived fields]({{< relref "loki.md#derived-fields" >}}) section in the [Loki data source]({{< relref "loki.md" >}}) or [Data links]({{< relref "elasticsearch.md#data-links" >}}) section in the [Elastic data source]({{< relref "elasticsearch.md" >}}) for configuration instructions. +You can link to Tempo trace from logs in Loki or Elastic by configuring an internal link. See the [Derived fields]({{< relref "loki/#derived-fields" >}}) section in the [Loki data source]({{< relref "loki/" >}}) or [Data links]({{< relref "elasticsearch/#data-links" >}}) section in the [Elastic data source]({{< relref "elasticsearch/" >}}) for configuration instructions. ## Provision the Tempo data source @@ -216,6 +222,12 @@ datasources: spanEndTimeShift: '1h' filterByTraceID: false filterBySpanID: false + tracesToMetrics: + datasourceUid: 'prom' + tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }] + queries: + - name: 'Sample query' + query: 'sum(rate(tempo_spanmetrics_latency_bucket{$__tags}[5m]))' serviceMap: datasourceUid: 'prometheus' search: diff --git a/docs/sources/datasources/testdata.md b/docs/sources/datasources/testdata.md index 01b56da7b2f..75d8a7292d7 100644 --- a/docs/sources/datasources/testdata.md +++ b/docs/sources/datasources/testdata.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/testdata/", "/docs/grafana/latest/features/datasources/testdata/"] -keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"] -title = "TestData" -weight = 1500 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/testdata/ + - /docs/grafana/latest/features/datasources/testdata/ +keywords: + - grafana + - dashboard + - documentation + - panels + - testdata +title: TestData +weight: 1500 +--- # Grafana TestData DB diff --git a/docs/sources/datasources/zipkin.md b/docs/sources/datasources/zipkin.md index 88ba196ce12..d9fbcdd53c5 100644 --- a/docs/sources/datasources/zipkin.md +++ b/docs/sources/datasources/zipkin.md @@ -1,15 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/datasources/zipkin/"] -description = "Guide for using Zipkin in Grafana" -keywords = ["grafana", "zipkin", "guide", "tracing"] -title = "Zipkin" -weight = 1600 -+++ +--- +aliases: + - /docs/grafana/latest/datasources/zipkin/ +description: Guide for using Zipkin in Grafana +keywords: + - grafana + - zipkin + - guide + - tracing +title: Zipkin +weight: 1600 +--- # Zipkin data source Grafana ships with built-in support for Zipkin, an open source, distributed tracing system. -Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore" >}}). +Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore/" >}}). ## Adding the data source @@ -28,7 +33,7 @@ To access Zipkin settings, click the **Configuration** (gear) icon, then click * > **Note:** This feature is available in Grafana 7.4+. -This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration" >}}). Select target data source (at this moment limited to Loki or Splunk \[logs\] data sources) and select which tags will be used in the logs query. +This is a configuration for the [trace to logs feature]({{< relref "../explore/trace-integration/" >}}). Select target data source (at this moment limited to Loki or Splunk \[logs\] data sources) and select which tags will be used in the logs query. - **Data source -** Target data source. - **Tags -** The tags that will be used in the logs query. Default is `'cluster', 'hostname', 'namespace', 'pod'`. @@ -47,11 +52,12 @@ This is a configuration for the [trace to logs feature]({{< relref "../explore/t To configure trace to metrics, select the target Prometheus data source and create any desired linked queries. -- **Data source -** Target data source. +-- **Tags -** You can use tags in the linked queries. The key is the span attribute name. The optional value is the corresponding metric label name (for example, map `k8s.pod` to `pod`). You may interpolate these tags into your queries using the `$__tags` keyword. Each linked query consists of: -- **Link Label -** (Optional) Descriptive label for the linked query. --- **Query -** Query that runs when navigating from a trace to the metrics data source. +-- **Query -** Query that runs when navigating from a trace to the metrics data source. Interpolate tags using the `$__tags` keyword. For example, when you configure the query `requests_total{$__tags}`with the tags `k8s.pod=pod` and `cluster`, it results in `requests_total{pod="nginx-554b9", cluster="us-east-1"}`. ### Node Graph @@ -61,7 +67,7 @@ This is a configuration for the beta Node Graph visualization. The Node Graph is ## Query traces -Querying and displaying traces from Zipkin is available via [Explore]({{< relref "../explore" >}}). +Querying and displaying traces from Zipkin is available via [Explore]({{< relref "../explore/" >}}). {{< figure src="/static/img/docs/v70/zipkin-query-editor.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor" >}} @@ -111,4 +117,4 @@ Here is an example JSON: ## Linking Trace ID from logs -You can link to Zipkin trace from logs in Loki or Splunk by configuring a derived field with internal link. See [Loki documentation]({{< relref "loki#derived-fields" >}}) for details. +You can link to Zipkin trace from logs in Loki or Splunk by configuring a derived field with internal link. See [Loki documentation]({{< relref "loki/#derived-fields" >}}) for details. diff --git a/docs/sources/developers/_index.md b/docs/sources/developers/_index.md index 9d4232b6191..ef00f162ab5 100644 --- a/docs/sources/developers/_index.md +++ b/docs/sources/developers/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/developers/", "/docs/grafana/latest/plugins/developing/"] -title = "Developers" -weight = 190 -+++ +--- +aliases: + - /docs/grafana/latest/developers/ + - /docs/grafana/latest/plugins/developing/ +title: Developers +weight: 190 +--- # Developers diff --git a/docs/sources/developers/angular_deprecation.md b/docs/sources/developers/angular_deprecation.md index e03031f1748..1631198066d 100644 --- a/docs/sources/developers/angular_deprecation.md +++ b/docs/sources/developers/angular_deprecation.md @@ -1,9 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/angular_deprecation/"] -keywords = ["grafana", "documentation", "developers", "resources"] -title = "Angular support deprecation" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/developers/angular_deprecation/ +keywords: + - grafana + - documentation + - developers + - resources +title: Angular support deprecation +weight: 500 +--- # Angular support deprecation diff --git a/docs/sources/developers/cla.md b/docs/sources/developers/cla.md index b4257216091..291a25c4a14 100644 --- a/docs/sources/developers/cla.md +++ b/docs/sources/developers/cla.md @@ -1,9 +1,12 @@ -+++ -aliases = ["/docs/contributing/cla.html/", "/docs/grafana/latest/developers/cla/", "/docs/grafana/latest/project/cla/"] -description = "Contributor License Agreement (CLA)" -title = "Contributor License Agreement (CLA)" -weight = 400 -+++ +--- +aliases: + - /docs/contributing/cla.html/ + - /docs/grafana/latest/developers/cla/ + - /docs/grafana/latest/project/cla/ +description: Contributor License Agreement (CLA) +title: Contributor License Agreement (CLA) +weight: 400 +--- # Grafana Labs Software Grant and Contributor License Agreement ("Agreement") diff --git a/docs/sources/developers/contribute.md b/docs/sources/developers/contribute.md index eb0f4fe5e10..27839534e50 100644 --- a/docs/sources/developers/contribute.md +++ b/docs/sources/developers/contribute.md @@ -1,9 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/contribute/"] -keywords = ["grafana", "documentation", "developers", "resources"] -title = "Contribute to Grafana" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/developers/contribute/ +keywords: + - grafana + - documentation + - developers + - resources +title: Contribute to Grafana +weight: 300 +--- # Contribute to Grafana diff --git a/docs/sources/developers/http_api/_index.md b/docs/sources/developers/http_api/_index.md index 6218af7a49e..03546de0e01 100644 --- a/docs/sources/developers/http_api/_index.md +++ b/docs/sources/developers/http_api/_index.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/", "/docs/grafana/latest/http_api/", "/docs/grafana/latest/overview/"] -description = "Grafana HTTP API" -keywords = ["grafana", "http", "documentation", "api", "overview"] -title = "HTTP API" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/ + - /docs/grafana/latest/http_api/ + - /docs/grafana/latest/overview/ +description: Grafana HTTP API +keywords: + - grafana + - http + - documentation + - api + - overview +title: HTTP API +weight: 100 +--- # HTTP API reference @@ -13,34 +21,34 @@ dashboards, creating users, and updating data sources. ## HTTP APIs -- [Admin API]({{< relref "admin.md" >}}) -- [Alerting Notification Channels API]({{< relref "alerting_notification_channels.md" >}}) -- [Alerting API]({{< relref "alerting.md" >}}) -- [Annotations API]({{< relref "annotations.md" >}}) -- [Authentication API]({{< relref "auth.md" >}}) -- [Dashboard API]({{< relref "dashboard.md" >}}) -- [Dashboard Permissions API]({{< relref "dashboard_permissions.md" >}}) -- [Dashboard Versions API]({{< relref "dashboard_versions.md" >}}) -- [Data source API]({{< relref "data_source.md" >}}) -- [Folder API]({{< relref "folder.md" >}}) -- [Folder Permissions API]({{< relref "folder_permissions.md" >}}) -- [Folder/Dashboard Search API]({{< relref "folder_dashboard_search.md" >}}) -- [Library Element API]({{< relref "library_element.md" >}}) -- [Organization API]({{< relref "org.md" >}}) -- [Other API]({{< relref "other.md" >}}) -- [Playlists API]({{< relref "playlist.md" >}}) -- [Preferences API]({{< relref "preferences.md" >}}) -- [Short URL API]({{< relref "short_url.md" >}}) -- [Snapshot API]({{< relref "snapshot.md" >}}) -- [Team API]({{< relref "team.md" >}}) -- [User API]({{< relref "user.md" >}}) +- [Admin API]({{< relref "admin/" >}}) +- [Alerting Notification Channels API]({{< relref "alerting_notification_channels/" >}}) +- [Alerting API]({{< relref "alerting/" >}}) +- [Annotations API]({{< relref "annotations/" >}}) +- [Authentication API]({{< relref "auth/" >}}) +- [Dashboard API]({{< relref "dashboard/" >}}) +- [Dashboard Permissions API]({{< relref "dashboard_permissions/" >}}) +- [Dashboard Versions API]({{< relref "dashboard_versions/" >}}) +- [Data source API]({{< relref "data_source/" >}}) +- [Folder API]({{< relref "folder/" >}}) +- [Folder Permissions API]({{< relref "folder_permissions/" >}}) +- [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}}) +- [Library Element API]({{< relref "library_element/" >}}) +- [Organization API]({{< relref "org/" >}}) +- [Other API]({{< relref "other/" >}}) +- [Playlists API]({{< relref "playlist/" >}}) +- [Preferences API]({{< relref "preferences/" >}}) +- [Short URL API]({{< relref "short_url/" >}}) +- [Snapshot API]({{< relref "snapshot/" >}}) +- [Team API]({{< relref "team/" >}}) +- [User API]({{< relref "user/" >}}) ## Grafana Enterprise HTTP APIs Grafana Enterprise includes all of the Grafana OSS APIs as well as those that follow: -- [Role-based access control API]({{< relref "access_control.md" >}}) -- [Data source permissions API]({{< relref "datasource_permissions.md" >}}) -- [External group sync API]({{< relref "external_group_sync.md" >}}) -- [License API]({{< relref "licensing.md" >}}) -- [Reporting API]({{< relref "reporting.md" >}}) +- [Role-based access control API]({{< relref "access_control/" >}}) +- [Data source permissions API]({{< relref "datasource_permissions/" >}}) +- [External group sync API]({{< relref "external_group_sync/" >}}) +- [License API]({{< relref "licensing/" >}}) +- [Reporting API]({{< relref "reporting/" >}}) diff --git a/docs/sources/developers/http_api/access_control.md b/docs/sources/developers/http_api/access_control.md index 73f709e4965..fa92323ad2c 100644 --- a/docs/sources/developers/http_api/access_control.md +++ b/docs/sources/developers/http_api/access_control.md @@ -1,13 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/access_control/", "/docs/grafana/latest/http_api/access_control/", "/docs/grafana/latest/http_api/accesscontrol/"] -description = "" -keywords = ["grafana", "http", "documentation", "api", "role-based-access-control", "acl", "enterprise"] -title = "RBAC HTTP API" -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/access_control/ + - /docs/grafana/latest/http_api/access_control/ + - /docs/grafana/latest/http_api/accesscontrol/ +description: '' +keywords: + - grafana + - http + - documentation + - api + - role-based-access-control + - acl + - enterprise +title: RBAC HTTP API +--- # RBAC API -> Role-based access control API is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}). +> Role-based access control API is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}). The API can be used to create, update, delete, get, and list roles. @@ -69,7 +79,7 @@ Query Parameters: | Action | Scope | | ---------- | -------- | -| roles:list | roles:\* | +| roles:read | roles:\* | #### Example request @@ -170,13 +180,13 @@ Content-Type: application/json; charset=UTF-8 "created": "2021-11-19T10:48:00+01:00" }, { - "action": "reports.admin:create", + "action": "reports:create", "scope": "", "updated": "2021-11-19T10:48:00+01:00", "created": "2021-11-19T10:48:00+01:00" }, { - "action": "reports.admin:write", + "action": "reports:write", "scope": "reports:*", "updated": "2021-11-19T10:48:00+01:00", "created": "2021-11-19T10:48:00+01:00" @@ -212,7 +222,7 @@ Content-Type: application/json; charset=UTF-8 `POST /api/access-control/roles` -Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as [Fixed roles]({{< relref "../../enterprise/access-control/about-rbac#fixed-roles" >}}) can't be created. +Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as [Fixed roles]({{< relref "../../enterprise/access-control/about-rbac/#fixed-roles" >}}) can't be created. #### Required permissions @@ -250,24 +260,24 @@ Content-Type: application/json #### JSON body schema -| Field Name | Date Type | Required | Description | -| ----------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| uid | string | No | UID of the role. If not present, the UID will be automatically created for you and returned in response. Refer to the [Custom roles]({{< relref "../../enterprise/access-control/about-rbac#custom-roles" >}}) for more information. | -| global | boolean | No | A flag indicating if the role is global or not. If set to `false`, the default org ID of the authenticated user will be used from the request. | -| version | number | No | Version of the role. If not present, version 0 will be assigned to the role and returned in the response. Refer to the [Custom roles]({{< relref "../../enterprise/access-control/about-rbac#custom-roles" >}}) for more information. | -| name | string | Yes | Name of the role. Refer to [Custom roles]({{< relref "../../enterprise/access-control/about-rbac#custom-roles" >}}) for more information. | -| description | string | No | Description of the role. | -| displayName | string | No | Display name of the role, visible in the UI. | -| group | string | No | The group name the role belongs to. | -| hidden | boolean | No | Specify whether the role is hidden or not. If set to `true`, then the role does not show in the role picker. It will not be listed by API endpoints unless explicitly specified. | -| permissions | Permission | No | If not present, the role will be created without any permissions. | +| Field Name | Date Type | Required | Description | +| ----------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| uid | string | No | UID of the role. If not present, the UID will be automatically created for you and returned in response. Refer to the [Custom roles]({{< relref "../../enterprise/access-control/about-rbac/#custom-roles" >}}) for more information. | +| global | boolean | No | A flag indicating if the role is global or not. If set to `false`, the default org ID of the authenticated user will be used from the request. | +| version | number | No | Version of the role. If not present, version 0 will be assigned to the role and returned in the response. Refer to the [Custom roles]({{< relref "../../enterprise/access-control/about-rbac/#custom-roles" >}}) for more information. | +| name | string | Yes | Name of the role. Refer to [Custom roles]({{< relref "../../enterprise/access-control/about-rbac/#custom-roles" >}}) for more information. | +| description | string | No | Description of the role. | +| displayName | string | No | Display name of the role, visible in the UI. | +| group | string | No | The group name the role belongs to. | +| hidden | boolean | No | Specify whether the role is hidden or not. If set to `true`, then the role does not show in the role picker. It will not be listed by API endpoints unless explicitly specified. | +| permissions | Permission | No | If not present, the role will be created without any permissions. | **Permission** -| Field Name | Data Type | Required | Description | -| ---------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for full list of available actions. | -| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [[Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for full list of available scopes. | +| Field Name | Data Type | Required | Description | +| ---------- | --------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for full list of available actions. | +| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [[Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for full list of available scopes. | #### Example response @@ -365,10 +375,10 @@ Content-Type: application/json **Permission** -| Field Name | Data Type | Required | Description | -| ---------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for full list of available actions. | -| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for full list of available scopes. | +| Field Name | Data Type | Required | Description | +| ---------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for full list of available actions. | +| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for full list of available scopes. | #### Example response @@ -438,10 +448,10 @@ Accept: application/json #### Query parameters -| Param | Type | Required | Description | -| ------ | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| force | boolean | No | When set to `true`, the role will be deleted with all it's assignments. | -| global | boolean | No | A flag indicating if the role is global or not. If set to false, the default org ID of the authenticated user will be used from the request. Refer to the [About RBAC]({{< relref "../../enterprise/access-control/about-rbac" >}}) for more information. | +| Param | Type | Required | Description | +| ------ | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| force | boolean | No | When set to `true`, the role will be deleted with all it's assignments. | +| global | boolean | No | A flag indicating if the role is global or not. If set to false, the default org ID of the authenticated user will be used from the request. Refer to the [About RBAC]({{< relref "../../enterprise/access-control/about-rbac/" >}}) for more information. | #### Example response @@ -479,7 +489,7 @@ Query Parameters: | Action | Scope | | ---------------- | -------------------- | -| users.roles:list | users:id:`` | +| users.roles:read | users:id:`` | #### Example request @@ -527,7 +537,7 @@ Lists the permissions that a given user has. | Action | Scope | | ---------------------- | -------------------- | -| users.permissions:list | users:id:`` | +| users.permissions:read | users:id:`` | #### Example request @@ -753,7 +763,7 @@ Query Parameters: | Action | Scope | | ---------------- | -------------------- | -| teams.roles:list | teams:id:`` | +| teams.roles:read | teams:id:`` | #### Example request diff --git a/docs/sources/developers/http_api/admin.md b/docs/sources/developers/http_api/admin.md index 3dc5de3a592..9780f1faaba 100644 --- a/docs/sources/developers/http_api/admin.md +++ b/docs/sources/developers/http_api/admin.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/admin/", "/docs/grafana/latest/http_api/admin/"] -description = "Grafana Admin HTTP API" -keywords = ["grafana", "http", "documentation", "api", "admin"] -title = "Admin HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/admin/ + - /docs/grafana/latest/http_api/admin/ +description: Grafana Admin HTTP API +keywords: + - grafana + - http + - documentation + - api + - admin +title: 'Admin HTTP API ' +--- # Admin API @@ -11,7 +18,7 @@ The Admin HTTP API does not currently work with an API Token. API Tokens are cur the permission of server admin, only users can be given that permission. So in order to use these API calls you will have to use Basic Auth and the Grafana user must have the Grafana Admin permission. (The default admin user is called `admin` and has permission to use this API.) -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Fetch settings @@ -351,7 +358,7 @@ Content-Type: application/json } ``` -Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org]({{< relref "../../administration/configuration.md#auto-assign-org" >}}) is set to `true`. +Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org]({{< relref "../../setup-grafana/configure-grafana/#auto-assign-org" >}}) is set to `true`. **Example Response**: @@ -373,9 +380,9 @@ Change password for a specific user. See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. -| Action | Scope | -| --------------------- | --------------- | -| users.password:update | global.users:\* | +| Action | Scope | +| -------------------- | --------------- | +| users.password:write | global.users:\* | **Example Request**: @@ -406,9 +413,9 @@ Only works with Basic Authentication (username and password). See [introduction] See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. -| Action | Scope | -| ------------------------ | --------------- | -| users.permissions:update | global.users:\* | +| Action | Scope | +| ----------------------- | --------------- | +| users.permissions:write | global.users:\* | **Example Request**: @@ -509,7 +516,7 @@ See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. | Action | Scope | | -------------------- | --------------- | -| users.authtoken:list | global.users:\* | +| users.authtoken:read | global.users:\* | **Example Request**: @@ -566,9 +573,9 @@ Only works with Basic Authentication (username and password). See [introduction] See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation. -| Action | Scope | -| ---------------------- | --------------- | -| users.authtoken:update | global.users:\* | +| Action | Scope | +| --------------------- | --------------- | +| users.authtoken:write | global.users:\* | **Example Request**: diff --git a/docs/sources/developers/http_api/alerting.md b/docs/sources/developers/http_api/alerting.md index 9d43f0b20a7..1b729fa240e 100644 --- a/docs/sources/developers/http_api/alerting.md +++ b/docs/sources/developers/http_api/alerting.md @@ -1,15 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/alerting/", "/docs/grafana/latest/http_api/alerting/"] -description = "Grafana Alerts HTTP API" -keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts"] -title = "Alerting HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/alerting/ + - /docs/grafana/latest/http_api/alerting/ +description: Grafana Alerts HTTP API +keywords: + - grafana + - http + - documentation + - api + - alerting + - alerts +title: 'Alerting HTTP API ' +--- # Alerting API > **Note:** This topic is relevant for the [legacy dashboard alerts](https://grafana.com/docs/grafana/latest/alerting/old-alerting/) only. -You can find Grafana alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana alerting alerts documentation]({{< relref "../../alerting/_index.md" >}}) for details on how to create and manage new alerts. +You can find Grafana alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana alerting alerts documentation]({{< relref "../../alerting/" >}}) for details on how to create and manage new alerts. You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert. To create new alerts or modify them you need to update the dashboard JSON that contains the alerts. @@ -155,4 +163,4 @@ Content-Type: application/json ## Pause all alerts -See [Admin API]({{< relref "admin.md#pause-all-alerts" >}}). +See [Admin API]({{< relref "admin/#pause-all-alerts" >}}). diff --git a/docs/sources/developers/http_api/alerting_notification_channels.md b/docs/sources/developers/http_api/alerting_notification_channels.md index 05ef45944a3..fda3224f777 100644 --- a/docs/sources/developers/http_api/alerting_notification_channels.md +++ b/docs/sources/developers/http_api/alerting_notification_channels.md @@ -1,9 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/alerting_notification_channels/", "/docs/grafana/latest/http_api/alerting_notification_channels/"] -description = "Grafana Alerting Notification Channel HTTP API" -keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts", "notifications"] -title = "Alerting Notification Channels HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/alerting_notification_channels/ + - /docs/grafana/latest/http_api/alerting_notification_channels/ +description: Grafana Alerting Notification Channel HTTP API +keywords: + - grafana + - http + - documentation + - api + - alerting + - alerts + - notifications +title: 'Alerting Notification Channels HTTP API ' +--- # Alerting Notification Channels API @@ -16,7 +25,7 @@ The identifier (id) of a notification channel is an auto-incrementing numeric va The unique identifier (uid) of a notification channel can be used for uniquely identify a notification channel between multiple Grafana installs. It's automatically generated if not provided when creating a notification channel. The uid allows having consistent URLs for accessing notification channels and when syncing notification channels between multiple -Grafana installations, refer to [alert notification channel provisioning]({{< relref "../../administration/provisioning.md#alert-notification-channels" >}}). +Grafana installations, refer to [alert notification channel provisioning]({{< relref "../../administration/provisioning/#alert-notification-channels" >}}). The uid can have a maximum length of 40 characters. diff --git a/docs/sources/developers/http_api/annotations.md b/docs/sources/developers/http_api/annotations.md index fa87f9a6ff9..251156ca36d 100644 --- a/docs/sources/developers/http_api/annotations.md +++ b/docs/sources/developers/http_api/annotations.md @@ -1,15 +1,24 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/annotations/", "/docs/grafana/latest/http_api/annotations/"] -description = "Grafana Annotations HTTP API" -keywords = ["grafana", "http", "documentation", "api", "annotation", "annotations", "comment"] -title = "Annotations HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/annotations/ + - /docs/grafana/latest/http_api/annotations/ +description: Grafana Annotations HTTP API +keywords: + - grafana + - http + - documentation + - api + - annotation + - annotations + - comment +title: 'Annotations HTTP API ' +--- # Annotations API This is the API documentation for the new Grafana Annotations feature released in Grafana 4.6. Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annotations can be organization annotations that can be shown on any dashboard by configuring an annotation data source - they are filtered by tags. Or they can be tied to a panel on a dashboard and are then only shown on that panel. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Find Annotations diff --git a/docs/sources/developers/http_api/auth.md b/docs/sources/developers/http_api/auth.md index af377df401a..7c21243e497 100644 --- a/docs/sources/developers/http_api/auth.md +++ b/docs/sources/developers/http_api/auth.md @@ -1,13 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/auth/", "/docs/grafana/latest/http_api/auth/", "/docs/grafana/latest/http_api/authentication/"] -description = "Grafana Authentication HTTP API" -keywords = ["grafana", "http", "documentation", "api", "authentication"] -title = "Authentication HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/auth/ + - /docs/grafana/latest/http_api/auth/ + - /docs/grafana/latest/http_api/authentication/ +description: Grafana Authentication HTTP API +keywords: + - grafana + - http + - documentation + - api + - authentication +title: 'Authentication HTTP API ' +--- # Authentication API -> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Tokens @@ -41,7 +49,7 @@ standard basic auth. Basic auth will also authenticate LDAP users. curl example: ```bash -?curl http://admin:admin@localhost:3000/api/org +curl http://admin:admin@localhost:3000/api/org {"id":1,"name":"Main Org."} ``` @@ -68,7 +76,7 @@ The API Token can also be passed as a Basic authorization password with the spec curl example: ```bash -?curl http://api_key:eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk@localhost:3000/api/org +curl http://api_key:eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk@localhost:3000/api/org {"id":1,"name":"Main Org."} ``` diff --git a/docs/sources/developers/http_api/create-api-tokens-for-org.md b/docs/sources/developers/http_api/create-api-tokens-for-org.md index 1c93ec6932f..1d35d51beb8 100644 --- a/docs/sources/developers/http_api/create-api-tokens-for-org.md +++ b/docs/sources/developers/http_api/create-api-tokens-for-org.md @@ -1,9 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/create-api-tokens-for-org/", "/docs/grafana/latest/http_api/create-api-tokens-for-org/", "/docs/grafana/latest/tutorials/api_org_token_howto/"] -keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"] -title = "API Tutorial: Create API tokens and dashboards for an organization" -weight = 150 -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/create-api-tokens-for-org/ + - /docs/grafana/latest/http_api/create-api-tokens-for-org/ + - /docs/grafana/latest/tutorials/api_org_token_howto/ +keywords: + - grafana + - tutorials + - API + - Token + - Org + - Organization +title: 'API Tutorial: Create API tokens and dashboards for an organization' +weight: 150 +--- # Create API tokens and dashboards for an organization diff --git a/docs/sources/developers/http_api/curl-examples.md b/docs/sources/developers/http_api/curl-examples.md index 0849c597899..8e89983533c 100644 --- a/docs/sources/developers/http_api/curl-examples.md +++ b/docs/sources/developers/http_api/curl-examples.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/curl-examples/", "/docs/grafana/latest/http_api/curl-examples/"] -description = "cURL examples" -keywords = ["grafana", "http", "documentation", "api", "curl"] -title = "cURL examples" -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/curl-examples/ + - /docs/grafana/latest/http_api/curl-examples/ +description: cURL examples +keywords: + - grafana + - http + - documentation + - api + - curl +title: cURL examples +--- # cURL examples @@ -15,7 +22,7 @@ The most basic example for a dashboard for which there is no authentication. You curl http://localhost:3000/api/search ``` -Here’s a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication]({{< relref "../../auth#basic-auth" >}}) enabled using the default admin credentials: +Here’s a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication]({{< relref "../../setup-grafana/configure-security/configure-authentication/#basic-auth" >}}) enabled using the default admin credentials: ``` curl http://admin:admin@localhost:3000/api/search diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index ce0d4ec354c..54ebdb22828 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -1,13 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/dashboard/", "/docs/grafana/latest/http_api/dashboard/"] -description = "Grafana Dashboard HTTP API" -keywords = ["grafana", "http", "documentation", "api", "dashboard"] -title = "Dashboard HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/dashboard/ + - /docs/grafana/latest/http_api/dashboard/ +description: Grafana Dashboard HTTP API +keywords: + - grafana + - http + - documentation + - api + - dashboard +title: 'Dashboard HTTP API ' +--- # Dashboard API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Identifier (id) vs unique identifier (uid) @@ -15,7 +22,7 @@ The identifier (id) of a dashboard is an auto-incrementing numeric value and is The unique identifier (uid) of a dashboard can be used for uniquely identify a dashboard between multiple Grafana installs. It's automatically generated if not provided when creating a dashboard. The uid allows having consistent URLs for accessing -dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning]({{< relref "../../administration/provisioning.md#dashboards" >}}) +dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning]({{< relref "../../administration/provisioning/#dashboards" >}}) for more information. This means that changing the title of a dashboard will not break any bookmarked links to that dashboard. The uid can have a maximum length of 40 characters. @@ -69,7 +76,7 @@ JSON Body schema: - **folderUid** – The UID of the folder to save the dashboard in. Overrides the `folderId`. - **overwrite** – Set to true if you want to overwrite existing dashboard with newer version, same dashboard title in folder or same dashboard uid. - **message** - Set a commit message for the version history. -- **refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval]({{< relref "../../administration/configuration.md#min_refresh_interval" >}}), then Grafana will ignore it and will enforce the minimum refresh interval. +- **refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval]({{< relref "../../setup-grafana/configure-grafana/#min_refresh_interval" >}}), then Grafana will ignore it and will enforce the minimum refresh interval. For adding or updating an alert rule for a dashboard panel the user should declare a `dashboard.panels.alert` block. @@ -465,4 +472,4 @@ Content-Type: application/json ## Dashboard Search -See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search.md" >}}). +See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}}). diff --git a/docs/sources/developers/http_api/dashboard_permissions.md b/docs/sources/developers/http_api/dashboard_permissions.md index 57ec549c021..e111a66d29c 100644 --- a/docs/sources/developers/http_api/dashboard_permissions.md +++ b/docs/sources/developers/http_api/dashboard_permissions.md @@ -1,9 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/dashboard_permissions/", "/docs/grafana/latest/http_api/dashboard_permissions/", "/docs/grafana/latest/http_api/dashboardpermissions/"] -description = "Grafana Dashboard Permissions HTTP API" -keywords = ["grafana", "http", "documentation", "api", "dashboard", "permission", "permissions", "acl"] -title = "Dashboard Permissions HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/dashboard_permissions/ + - /docs/grafana/latest/http_api/dashboard_permissions/ + - /docs/grafana/latest/http_api/dashboardpermissions/ +description: Grafana Dashboard Permissions HTTP API +keywords: + - grafana + - http + - documentation + - api + - dashboard + - permission + - permissions + - acl +title: 'Dashboard Permissions HTTP API ' +--- # Dashboard Permissions API @@ -17,7 +28,7 @@ The permission levels for the permission field: - 2 = Edit - 4 = Admin -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Get permissions for a dashboard diff --git a/docs/sources/developers/http_api/dashboard_versions.md b/docs/sources/developers/http_api/dashboard_versions.md index 291c03f9ae8..a337cf27218 100644 --- a/docs/sources/developers/http_api/dashboard_versions.md +++ b/docs/sources/developers/http_api/dashboard_versions.md @@ -1,9 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/dashboard_versions/", "/docs/grafana/latest/http_api/dashboard_versions/", "/docs/grafana/latest/http_api/dashboardversions/"] -description = "Grafana Dashboard Versions HTTP API" -keywords = ["grafana", "http", "documentation", "api", "dashboard", "versions"] -title = "Dashboard Versions HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/dashboard_versions/ + - /docs/grafana/latest/http_api/dashboard_versions/ + - /docs/grafana/latest/http_api/dashboardversions/ +description: Grafana Dashboard Versions HTTP API +keywords: + - grafana + - http + - documentation + - api + - dashboard + - versions +title: 'Dashboard Versions HTTP API ' +--- # Dashboard Versions diff --git a/docs/sources/developers/http_api/data_source.md b/docs/sources/developers/http_api/data_source.md index b3c2a024e20..8f4a9da2147 100644 --- a/docs/sources/developers/http_api/data_source.md +++ b/docs/sources/developers/http_api/data_source.md @@ -1,13 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/data_source/", "/docs/grafana/latest/http_api/data_source/", "/docs/grafana/latest/http_api/datasource/"] -description = "Grafana Data source HTTP API" -keywords = ["grafana", "http", "documentation", "api", "data source"] -title = "Data source HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/data_source/ + - /docs/grafana/latest/http_api/data_source/ + - /docs/grafana/latest/http_api/datasource/ +description: Grafana Data source HTTP API +keywords: + - grafana + - http + - documentation + - api + - data source +title: 'Data source HTTP API ' +--- # Data source API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Get all data sources @@ -952,117 +960,3 @@ In addition, specific properties of each data source should be added in a reques | 403 | Access denied. | | 404 | Either the data source or plugin required to fulfil the request could not be found. | | 500 | Unexpected error. Refer to the body and/or server logs for more details. | - -## Deprecated resources - -The following resources have been deprecated. They will be removed in a future release. - -### Query a data source by id - -> **Warning:** This API is deprecated since Grafana v8.5.0 and will be removed in a future release. Refer to the [new data source query API](#query-a-data-source). - -Queries a data source having a backend implementation. - -`POST /api/tsdb/query` - -> **Note:** Grafana's built-in data sources usually have a backend implementation. - -**Example Request**: - -```http -POST /api/tsdb/query HTTP/1.1 -Accept: application/json -Content-Type: application/json - -{ - "from": "1420066800000", - "to": "1575845999999", - "queries": [ - { - "refId": "A", - "intervalMs": 86400000, - "maxDataPoints": 1092, - "datasourceId": 86, - "rawSql": "SELECT 1 as valueOne, 2 as valueTwo", - "format": "table" - } - ] -} -``` - -JSON Body schema: - -- **from/to** – Specifies the time range for the queries. The time can be either epoch timestamps in milliseconds or relative using Grafana time units. For example, `now-5m`. -- **queries.refId** – Specifies an identifier of the query. Defaults to "A". -- **queries.format** – Specifies the format the data should be returned in. Valid options are `time_series` or `table` depending on the data source. -- **queries.datasourceId** – Specifies the data source to be queried. Each `query` in the request must have a unique `datasourceId`. -- **queries.maxDataPoints** - Species the maximum amount of data points that a dashboard panel can render. Defaults to 100. -- **queries.intervalMs** - Specifies the time series time interval in milliseconds. Defaults to 1000. - -In addition, specific properties of each data source should be added in a request. To better understand how to form a query for a certain data source, use the Developer Tools in your browser of choice and inspect the HTTP requests being made to `/api/tsdb/query`. - -**Example request for the MySQL data source:** - -```http -POST /api/tsdb/query HTTP/1.1 -Accept: application/json -Content-Type: application/json - -{ - "from": "1420066800000", - "to": "1575845999999", - "queries": [ - { - "refId": "A", - "intervalMs": 86400000, - "maxDataPoints": 1092, - "datasourceId": 86, - "rawSql": "SELECT\n time,\n sum(opened) AS \"Opened\",\n sum(closed) AS \"Closed\"\nFROM\n issues_activity\nWHERE\n $__unixEpochFilter(time) AND\n period = 'm' AND\n repo IN('grafana/grafana') AND\n opened_by IN('Contributor','Grafana Labs')\nGROUP BY 1\nORDER BY 1\n", - "format": "time_series" - } - ] -} -``` - -**Example MySQL time series query response:** - -```http -HTTP/1.1 200 -Content-Type: application/json - -{ - "results": { - "A": { - "refId": "A", - "meta": { - "rowCount": 0, - "sql": "SELECT\n time,\n sum(opened) AS \"Opened\",\n sum(closed) AS \"Closed\"\nFROM\n issues_activity\nWHERE\n time >= 1420066800 AND time <= 1575845999 AND\n period = 'm' AND\n repo IN('grafana/grafana') AND\n opened_by IN('Contributor','Grafana Labs')\nGROUP BY 1\nORDER BY 1\n" - }, - "series": [ - { - "name": "Opened", - "points": [ - [ - 109, - 1420070400000 - ], - [ - 122, - 1422748800000 - ] - ] - }, - { - "name": "Closed", - "points": [ - [ - 89, - 1420070400000 - ] - ] - } - ] - } - } -} -``` diff --git a/docs/sources/developers/http_api/datasource_permissions.md b/docs/sources/developers/http_api/datasource_permissions.md index e18d3e68b7a..e2b4128b1b2 100644 --- a/docs/sources/developers/http_api/datasource_permissions.md +++ b/docs/sources/developers/http_api/datasource_permissions.md @@ -1,15 +1,27 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/datasource_permissions/", "/docs/grafana/latest/http_api/datasource_permissions/", "/docs/grafana/latest/http_api/datasourcepermissions/"] -description = "Data Source Permissions API" -keywords = ["grafana", "http", "documentation", "api", "datasource", "permission", "permissions", "acl", "enterprise"] -title = "Datasource Permissions HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/datasource_permissions/ + - /docs/grafana/latest/http_api/datasource_permissions/ + - /docs/grafana/latest/http_api/datasourcepermissions/ +description: Data Source Permissions API +keywords: + - grafana + - http + - documentation + - api + - datasource + - permission + - permissions + - acl + - enterprise +title: 'Datasource Permissions HTTP API ' +--- # Data Source Permissions API -> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}). +> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. This API can be used to enable, disable, list, add and remove permissions for a data source. diff --git a/docs/sources/developers/http_api/external_group_sync.md b/docs/sources/developers/http_api/external_group_sync.md index 65d9791b692..34225e0d0f2 100644 --- a/docs/sources/developers/http_api/external_group_sync.md +++ b/docs/sources/developers/http_api/external_group_sync.md @@ -1,15 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/external_group_sync/", "/docs/grafana/latest/http_api/external_group_sync/"] -description = "Grafana External Group Sync HTTP API" -keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group", "member", "enterprise"] -title = "External Group Sync HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/external_group_sync/ + - /docs/grafana/latest/http_api/external_group_sync/ +description: Grafana External Group Sync HTTP API +keywords: + - grafana + - http + - documentation + - api + - team + - teams + - group + - member + - enterprise +title: 'External Group Sync HTTP API ' +--- # External Group Synchronization API -> External Group Synchronization is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}). +> External Group Synchronization is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Get External Groups diff --git a/docs/sources/developers/http_api/folder.md b/docs/sources/developers/http_api/folder.md index a19275594c9..d99887f8dc2 100644 --- a/docs/sources/developers/http_api/folder.md +++ b/docs/sources/developers/http_api/folder.md @@ -1,13 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/folder/", "/docs/grafana/latest/http_api/folder/"] -description = "Grafana Folder HTTP API" -keywords = ["grafana", "http", "documentation", "api", "folder"] -title = "Folder HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/folder/ + - /docs/grafana/latest/http_api/folder/ +description: Grafana Folder HTTP API +keywords: + - grafana + - http + - documentation + - api + - folder +title: 'Folder HTTP API ' +--- # Folder API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Identifier (id) vs unique identifier (uid) @@ -273,7 +280,7 @@ Content-Length: 97 Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted. -If [Grafana alerting]({{< relref "../../alerting/_index.md" >}}) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder. +If [Grafana alerting]({{< relref "../../alerting/" >}}) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder. **Required permissions** diff --git a/docs/sources/developers/http_api/folder_dashboard_search.md b/docs/sources/developers/http_api/folder_dashboard_search.md index 75890179ffc..85ff060589f 100644 --- a/docs/sources/developers/http_api/folder_dashboard_search.md +++ b/docs/sources/developers/http_api/folder_dashboard_search.md @@ -1,9 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/folder_dashboard_search/", "/docs/grafana/latest/http_api/folder_dashboard_search/"] -description = "Grafana Folder/Dashboard Search HTTP API" -keywords = ["grafana", "http", "documentation", "api", "search", "folder", "dashboard"] -title = "Folder/Dashboard Search HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/folder_dashboard_search/ + - /docs/grafana/latest/http_api/folder_dashboard_search/ +description: Grafana Folder/Dashboard Search HTTP API +keywords: + - grafana + - http + - documentation + - api + - search + - folder + - dashboard +title: 'Folder/Dashboard Search HTTP API ' +--- # Folder/Dashboard Search API @@ -11,7 +20,7 @@ title = "Folder/Dashboard Search HTTP API " `GET /api/search/` -> Note: When using [Role-based access control]({{< relref "../../enterprise/access-control" >}}), search results will contain only dashboards and folders which you have access to. +> Note: When using [Role-based access control]({{< relref "../../enterprise/access-control/" >}}), search results will contain only dashboards and folders which you have access to. Query parameters: diff --git a/docs/sources/developers/http_api/folder_permissions.md b/docs/sources/developers/http_api/folder_permissions.md index 1b06a6b7c03..e5989981921 100644 --- a/docs/sources/developers/http_api/folder_permissions.md +++ b/docs/sources/developers/http_api/folder_permissions.md @@ -1,9 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/folder_permissions/", "/docs/grafana/latest/http_api/dashboardpermissions/", "/docs/grafana/latest/http_api/folder_permissions/"] -description = "Grafana Folder Permissions HTTP API" -keywords = ["grafana", "http", "documentation", "api", "folder", "permission", "permissions", "acl"] -title = "Folder Permissions HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/folder_permissions/ + - /docs/grafana/latest/http_api/dashboardpermissions/ + - /docs/grafana/latest/http_api/folder_permissions/ +description: Grafana Folder Permissions HTTP API +keywords: + - grafana + - http + - documentation + - api + - folder + - permission + - permissions + - acl +title: 'Folder Permissions HTTP API ' +--- # Folder Permissions API @@ -17,7 +28,7 @@ The permission levels for the permission field: - 2 = Edit - 4 = Admin -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Get permissions for a folder diff --git a/docs/sources/developers/http_api/library_element.md b/docs/sources/developers/http_api/library_element.md index 38afb3a1cd0..2065b468fb4 100644 --- a/docs/sources/developers/http_api/library_element.md +++ b/docs/sources/developers/http_api/library_element.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/library_element/", "/docs/grafana/latest/http_api/library_element/"] -description = "Grafana Library Element HTTP API" -keywords = ["grafana", "http", "documentation", "api", "library-element"] -title = "Library Element HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/library_element/ + - /docs/grafana/latest/http_api/library_element/ +description: Grafana Library Element HTTP API +keywords: + - grafana + - http + - documentation + - api + - library-element +title: 'Library Element HTTP API ' +--- # Library Element API diff --git a/docs/sources/developers/http_api/licensing.md b/docs/sources/developers/http_api/licensing.md index 2c6bef8ec7f..9a61e645564 100644 --- a/docs/sources/developers/http_api/licensing.md +++ b/docs/sources/developers/http_api/licensing.md @@ -1,15 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/licensing/", "/docs/grafana/latest/http_api/licensing/"] -description = "Enterprise Licensing HTTP API" -keywords = ["grafana", "http", "documentation", "api", "licensing", "enterprise"] -title = "Licensing HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/licensing/ + - /docs/grafana/latest/http_api/licensing/ +description: Enterprise Licensing HTTP API +keywords: + - grafana + - http + - documentation + - api + - licensing + - enterprise +title: 'Licensing HTTP API ' +--- # Enterprise License API -Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}). +Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Check license availability @@ -63,9 +71,9 @@ Manually ask license issuer for a new token. See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation. -| Action | Scope | -| ---------------- | ----- | -| licensing:update | n/a | +| Action | Scope | +| --------------- | ----- | +| licensing:write | n/a | ### Examples diff --git a/docs/sources/developers/http_api/org.md b/docs/sources/developers/http_api/org.md index cff2b6d3979..26f0fdff4d4 100644 --- a/docs/sources/developers/http_api/org.md +++ b/docs/sources/developers/http_api/org.md @@ -1,9 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/org/", "/docs/grafana/latest/http_api/org/", "/docs/grafana/latest/http_api/organization/"] -description = "Grafana Organization HTTP API" -keywords = ["grafana", "http", "documentation", "api", "organization"] -title = "Organization HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/org/ + - /docs/grafana/latest/http_api/org/ + - /docs/grafana/latest/http_api/organization/ +description: Grafana Organization HTTP API +keywords: + - grafana + - http + - documentation + - api + - organization +title: 'Organization HTTP API ' +--- # Organization API @@ -11,7 +19,7 @@ The Organization HTTP API is divided in two resources, `/api/org` (current organ and `/api/orgs` (admin organizations). One big difference between these are that the admin of all organizations API only works with basic authentication, see [Admin Organizations API](#admin-organizations-api) for more information. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Current Organization API @@ -141,9 +149,9 @@ Content-Type: application/json See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. -| Action | Scope | -| --------------------- | -------- | -| org.users.role:update | users:\* | +| Action | Scope | +| --------------- | -------- | +| org.users:write | users:\* | **Example Request**: @@ -597,9 +605,9 @@ Only works with Basic Authentication (username and password), see [introduction] See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. -| Action | Scope | -| --------------------- | -------- | -| org.users.role:update | users:\* | +| Action | Scope | +| --------------- | -------- | +| org.users:write | users:\* | **Example Request**: diff --git a/docs/sources/developers/http_api/other.md b/docs/sources/developers/http_api/other.md index 1e5118e0323..7b7cda4c8ac 100644 --- a/docs/sources/developers/http_api/other.md +++ b/docs/sources/developers/http_api/other.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/other/", "/docs/grafana/latest/http_api/other/"] -description = "Grafana Other HTTP API" -keywords = ["grafana", "http", "documentation", "api", "other"] -title = "Other HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/other/ + - /docs/grafana/latest/http_api/other/ +description: Grafana Other HTTP API +keywords: + - grafana + - http + - documentation + - api + - other +title: 'Other HTTP API ' +--- # Frontend Settings API diff --git a/docs/sources/developers/http_api/playlist.md b/docs/sources/developers/http_api/playlist.md index b8cb81f253b..feb9ab077b9 100644 --- a/docs/sources/developers/http_api/playlist.md +++ b/docs/sources/developers/http_api/playlist.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/playlist/", "/docs/grafana/latest/http_api/playlist/"] -description = "Playlist Admin HTTP API" -keywords = ["grafana", "http", "documentation", "api", "playlist"] -title = "Playlist HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/playlist/ + - /docs/grafana/latest/http_api/playlist/ +description: Playlist Admin HTTP API +keywords: + - grafana + - http + - documentation + - api + - playlist +title: 'Playlist HTTP API ' +--- # Playlist API diff --git a/docs/sources/developers/http_api/preferences.md b/docs/sources/developers/http_api/preferences.md index da4239620d0..ffc13320203 100644 --- a/docs/sources/developers/http_api/preferences.md +++ b/docs/sources/developers/http_api/preferences.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/preferences/", "/docs/grafana/latest/http_api/preferences/"] -description = "Grafana HTTP API" -keywords = ["grafana", "http", "documentation", "api", "preferences"] -title = "HTTP Preferences API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/preferences/ + - /docs/grafana/latest/http_api/preferences/ +description: Grafana HTTP API +keywords: + - grafana + - http + - documentation + - api + - preferences +title: 'HTTP Preferences API ' +--- # User and Org Preferences API diff --git a/docs/sources/developers/http_api/query_history.md b/docs/sources/developers/http_api/query_history.md index a82f3856a0d..b7616fb1ba8 100644 --- a/docs/sources/developers/http_api/query_history.md +++ b/docs/sources/developers/http_api/query_history.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/query_history/", "/docs/grafana/latest/http_api/query_history/"] -description = "Grafana Query History HTTP API" -keywords = ["grafana", "http", "documentation", "api", "queryHistory"] -title = "Query History HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/query_history/ + - /docs/grafana/latest/http_api/query_history/ +description: Grafana Query History HTTP API +keywords: + - grafana + - http + - documentation + - api + - queryHistory +title: 'Query History HTTP API ' +--- # Query history API diff --git a/docs/sources/developers/http_api/reporting.md b/docs/sources/developers/http_api/reporting.md index 63bc42f59f2..dffb1c4159c 100644 --- a/docs/sources/developers/http_api/reporting.md +++ b/docs/sources/developers/http_api/reporting.md @@ -1,17 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/reporting/", "/docs/grafana/latest/http_api/reporting/"] -description = "Grafana Enterprise APIs" -keywords = ["grafana", "enterprise", "api", "reporting"] -title = "Reporting API" -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/reporting/ + - /docs/grafana/latest/http_api/reporting/ +description: Grafana Enterprise APIs +keywords: + - grafana + - enterprise + - api + - reporting +title: Reporting API +--- # Reporting API -This API allows you to interact programmatically with the [Reporting]({{< relref "../../enterprise/reporting.md" >}}) feature. +This API allows you to interact programmatically with the [Reporting]({{< relref "../../enterprise/reporting/" >}}) feature. -> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise" >}}). +> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../../enterprise/" >}}). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Send a report @@ -69,7 +75,7 @@ Content-Length: 29 | ---- | ----------------------------------------------------------------------------------- | | 200 | Report was sent. | | 400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). | -| 401 | Authentication failed, refer to [Authentication API]({{< relref "auth.md" >}}). | +| 401 | Authentication failed, refer to [Authentication API]({{< relref "auth/" >}}). | | 403 | User is authenticated but is not authorized to generate the report. | | 404 | Report not found. | | 500 | Unexpected error or server misconfiguration. Refer to server logs for more details. | diff --git a/docs/sources/developers/http_api/serviceaccount.md b/docs/sources/developers/http_api/serviceaccount.md index d69e666d42f..0e12e8e285e 100644 --- a/docs/sources/developers/http_api/serviceaccount.md +++ b/docs/sources/developers/http_api/serviceaccount.md @@ -1,13 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/serviceaccount/", "/docs/grafana/latest/http_api/serviceaccount/"] -description = "Grafana service account HTTP API" -keywords = ["grafana", "http", "documentation", "api", "serviceaccount"] -title = "Service account HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/serviceaccount/ + - /docs/grafana/latest/http_api/serviceaccount/ +description: Grafana service account HTTP API +keywords: + - grafana + - http + - documentation + - api + - serviceaccount +title: 'Service account HTTP API ' +--- # Service account API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Search service accounts with Paging diff --git a/docs/sources/developers/http_api/short_url.md b/docs/sources/developers/http_api/short_url.md index de9f0604ece..72d68033615 100644 --- a/docs/sources/developers/http_api/short_url.md +++ b/docs/sources/developers/http_api/short_url.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/short_url/", "/docs/grafana/latest/http_api/short_url/"] -description = "Grafana Short URL HTTP API" -keywords = ["grafana", "http", "documentation", "api", "shortUrl"] -title = "Short URL HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/short_url/ + - /docs/grafana/latest/http_api/short_url/ +description: Grafana Short URL HTTP API +keywords: + - grafana + - http + - documentation + - api + - shortUrl +title: 'Short URL HTTP API ' +--- # Short URL API @@ -30,7 +37,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk JSON body schema: -- **path** – The path to shorten, relative to the Grafana [root_url]({{< relref "../../administration/configuration.md#root_url" >}}). +- **path** – The path to shorten, relative to the Grafana [root_url]({{< relref "../../setup-grafana/configure-grafana/#root_url" >}}). **Example response:** diff --git a/docs/sources/developers/http_api/snapshot.md b/docs/sources/developers/http_api/snapshot.md index 0c1ab30eb2e..664cfa4ecb8 100644 --- a/docs/sources/developers/http_api/snapshot.md +++ b/docs/sources/developers/http_api/snapshot.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/snapshot/", "/docs/grafana/latest/http_api/snapshot/"] -description = "Grafana HTTP API" -keywords = ["grafana", "http", "documentation", "api", "snapshot"] -title = "HTTP Snapshot API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/snapshot/ + - /docs/grafana/latest/http_api/snapshot/ +description: Grafana HTTP API +keywords: + - grafana + - http + - documentation + - api + - snapshot +title: 'HTTP Snapshot API ' +--- # Snapshot API diff --git a/docs/sources/developers/http_api/team.md b/docs/sources/developers/http_api/team.md index 44bdcdc5a0c..8b6aebb6bc2 100644 --- a/docs/sources/developers/http_api/team.md +++ b/docs/sources/developers/http_api/team.md @@ -1,9 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/team/", "/docs/grafana/latest/http_api/team/"] -description = "Grafana Team HTTP API" -keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group"] -title = "Team HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/team/ + - /docs/grafana/latest/http_api/team/ +description: Grafana Team HTTP API +keywords: + - grafana + - http + - documentation + - api + - team + - teams + - group +title: 'Team HTTP API ' +--- # Team API @@ -16,7 +25,7 @@ Access to these API endpoints is restricted as follows: - If you enable `editors_can_admin` configuration flag, then Organization Editors can create teams and manage teams where they are Admin. - If you enable `editors_can_admin` configuration flag, Editors can find out whether a team that they are not members of exists by trying to create a team with the same name. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Team Search With Paging diff --git a/docs/sources/developers/http_api/user.md b/docs/sources/developers/http_api/user.md index 354f2f1802f..5d8e64488ae 100644 --- a/docs/sources/developers/http_api/user.md +++ b/docs/sources/developers/http_api/user.md @@ -1,13 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/http_api/user/", "/docs/grafana/latest/http_api/user/"] -description = "Grafana User HTTP API" -keywords = ["grafana", "http", "documentation", "api", "user"] -title = "User HTTP API " -+++ +--- +aliases: + - /docs/grafana/latest/developers/http_api/user/ + - /docs/grafana/latest/http_api/user/ +description: Grafana User HTTP API +keywords: + - grafana + - http + - documentation + - api + - user +title: 'User HTTP API ' +--- # User API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../enterprise/access-control/custom-role-actions-scopes/" >}}) for more information. ## Search Users @@ -133,9 +140,9 @@ Content-Type: application/json See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. -| Action | Scope | -| ---------- | -------- | -| users:read | users:\* | +| Action | Scope | +| ---------- | --------------- | +| users:read | global.users:\* | **Example Request**: @@ -234,9 +241,9 @@ Content-Type: application/json See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. -| Action | Scope | -| ----------- | -------- | -| users:write | users:\* | +| Action | Scope | +| ----------- | --------------- | +| users:write | global.users:\* | **Example Request**: @@ -273,9 +280,9 @@ Content-Type: application/json See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. -| Action | Scope | -| ---------- | -------- | -| users:read | users:\* | +| Action | Scope | +| ---------- | --------------- | +| users:read | global.users:\* | **Example Request**: @@ -311,9 +318,10 @@ Content-Type: application/json See note in the [introduction]({{< ref "#user-api" >}}) for an explanation. -| Action | Scope | -| ---------------- | -------- | -| users.teams:read | users:\* | +| Action | Scope | +| ---------- | --------------- | +| users:read | global.users:\* | +| teams:read | teams:\* | **Example Request**: diff --git a/docs/sources/developers/plugins/_index.md b/docs/sources/developers/plugins/_index.md index d3560b3422a..d026d2ea24c 100644 --- a/docs/sources/developers/plugins/_index.md +++ b/docs/sources/developers/plugins/_index.md @@ -1,18 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/", "/docs/grafana/latest/plugins/developing/"] -title = "Build a plugin" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/ + - /docs/grafana/latest/plugins/developing/ +title: Build a plugin +weight: 200 +--- # Build a plugin -For more information on the types of plugins you can build, refer to the [Plugin Overview]({{< relref "../../plugins/_index.md" >}}). +For more information on the types of plugins you can build, refer to the [Plugin Overview]({{< relref "../../plugins/" >}}). ## Get started The easiest way to start developing Grafana plugins is to use the [Grafana Toolkit](https://www.npmjs.com/package/@grafana/toolkit). -Open the terminal, and run the following command in your [plugin directory]({{< relref "../../administration/configuration.md#plugins" >}}): +Open the terminal, and run the following command in your [plugin directory]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}): ```bash npx @grafana/toolkit plugin:create my-grafana-plugin @@ -22,8 +24,8 @@ npx @grafana/toolkit plugin:create my-grafana-plugin If you want a more guided introduction to plugin development, check out our tutorials: -- [Build a panel plugin]({{< relref "/tutorials/build-a-panel-plugin.md" >}}) -- [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}) +- [Build a panel plugin]({{< ref "/tutorials/build-a-panel-plugin/" >}}) +- [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}) ## Go further @@ -33,34 +35,34 @@ Learn more about specific areas of plugin development. If you're looking to build your first plugin, check out these introductory tutorials: -- [Build a panel plugin]({{< relref "/tutorials/build-a-panel-plugin.md" >}}) -- [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}) -- [Build a data source backend plugin]({{< relref "/tutorials/build-a-data-source-backend-plugin.md" >}}) +- [Build a panel plugin]({{< ref "/tutorials/build-a-panel-plugin/" >}}) +- [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}) +- [Build a data source backend plugin]({{< ref "/tutorials/build-a-data-source-backend-plugin/" >}}) Ready to learn more? Check out our other tutorials: -- [Build a panel plugin with D3.js]({{< relref "/tutorials/build-a-panel-plugin-with-d3.md" >}}) +- [Build a panel plugin with D3.js]({{< ref "/tutorials/build-a-panel-plugin-with-d3/" >}}) ### Guides Improve an existing plugin with one of our guides: -- [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins" >}}) -- [Add support for annotations]({{< relref "add-support-for-annotations.md" >}}) -- [Add support for Explore queries]({{< relref "add-support-for-explore-queries.md" >}}) -- [Add support for variables]({{< relref "add-support-for-variables.md" >}}) -- [Add a query editor help component]({{< relref "add-query-editor-help.md" >}}) -- [Build a logs data source plugin]({{< relref "build-a-logs-data-source-plugin.md" >}}) -- [Build a streaming data source plugin]({{< relref "build-a-streaming-data-source-plugin.md" >}}) -- [Error handling]({{< relref "error-handling.md" >}}) -- [Working with data frames]({{< relref "working-with-data-frames.md" >}}) -- [Development with local Grafana]({{< relref "development-with-local-grafana.md" >}}) +- [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins/" >}}) +- [Add support for annotations]({{< relref "add-support-for-annotations/" >}}) +- [Add support for Explore queries]({{< relref "add-support-for-explore-queries/" >}}) +- [Add support for variables]({{< relref "add-support-for-variables/" >}}) +- [Add a query editor help component]({{< relref "add-query-editor-help/" >}}) +- [Build a logs data source plugin]({{< relref "build-a-logs-data-source-plugin/" >}}) +- [Build a streaming data source plugin]({{< relref "build-a-streaming-data-source-plugin/" >}}) +- [Error handling]({{< relref "error-handling/" >}}) +- [Working with data frames]({{< relref "working-with-data-frames/" >}}) +- [Development with local Grafana]({{< relref "development-with-local-grafana/" >}}) ### Concepts Deepen your knowledge through a series of high-level overviews of plugin concepts: -- [Data frames]({{< relref "data-frames.md" >}}) +- [Data frames]({{< relref "data-frames/" >}}) ### UI library @@ -76,7 +78,7 @@ Learn more about Grafana options and packages. #### Metadata -- [Plugin metadata]({{< relref "metadata.md" >}}) +- [Plugin metadata]({{< relref "metadata/" >}}) #### Typescript @@ -86,4 +88,4 @@ Learn more about Grafana options and packages. #### Go -- [Grafana Plugin SDK for Go]({{< relref "backend/grafana-plugin-sdk-for-go" >}}) +- [Grafana Plugin SDK for Go]({{< relref "backend/grafana-plugin-sdk-for-go/" >}}) diff --git a/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md b/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md index 97a01321337..2164b771713 100644 --- a/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md +++ b/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md @@ -1,7 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/add-authentication-for-data-source-plugins/", "/docs/grafana/latest/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"] -title = "Add authentication for data source plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/add-authentication-for-data-source-plugins/ + - /docs/grafana/latest/plugins/developing/auth-for-datasources/ + - /docs/grafana/next/developers/plugins/authentication/ +title: Add authentication for data source plugins +--- # Add authentication for data source plugins @@ -104,7 +107,7 @@ Once the user has saved the configuration for a data source, any secret data sou The Grafana server comes with a proxy that lets you define templates for your requests. We call them _proxy routes_. Grafana sends the proxy route to the server, decrypts the secrets along with other configuration, and adds them to the request before sending it off. -> **Note:** Be sure not to confuse the data source proxy with the [auth proxy]({{< relref "../../auth/auth-proxy.md" >}}). The data source proxy is used to authenticate a data source, while the auth proxy is used to log into Grafana itself. +> **Note:** Be sure not to confuse the data source proxy with the [auth proxy]({{< relref "../../setup-grafana/configure-security/configure-authentication/auth-proxy/" >}}). The data source proxy is used to authenticate a data source, while the auth proxy is used to log into Grafana itself. ### Add a proxy route to your plugin @@ -265,7 +268,7 @@ While the data source proxy supports the most common authentication methods for - Proxy routes only support HTTP or HTTPS - Proxy routes don't support custom token authentication -If any of these limitations apply to your plugin, you need to add a [backend plugin]({{< relref "./backend/_index.md" >}}). Since backend plugins run on the server they can access decrypted secrets, which makes it easier to implement custom authentication methods. +If any of these limitations apply to your plugin, you need to add a [backend plugin]({{< relref "backend/" >}}). Since backend plugins run on the server they can access decrypted secrets, which makes it easier to implement custom authentication methods. The decrypted secrets are available from the `DecryptedSecureJSONData` field in the instance settings. @@ -283,13 +286,24 @@ func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataReque ## Forward OAuth identity for the logged-in user -If your data source uses the same OAuth provider as Grafana itself, for example using [Generic OAuth Authentication]({{< relref "../../auth/generic-oauth.md" >}}), your data source plugin can reuse the access token for the logged-in Grafana user. +If your data source uses the same OAuth provider as Grafana itself, for example using [Generic OAuth Authentication]({{< relref "../../setup-grafana/configure-security/configure-authentication/generic-oauth/" >}}), your data source plugin can reuse the access token for the logged-in Grafana user. To allow Grafana to pass the access token to the plugin, update the data source configuration and set the` jsonData.oauthPassThru` property to `true`. The [DataSourceHttpSettings](https://developers.grafana.com/ui/latest/index.html?path=/story/data-source-datasourcehttpsettings--basic) provides a toggle, the **Forward OAuth Identity** option, for this. You can also build an appropriate toggle to set `jsonData.oauthPassThru` in your data source configuration page UI. When configured, Grafana will pass the user's token to the plugin in an Authorization header, available on the `QueryDataRequest` object on the `QueryData` request in your backend data source. ```go +func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { + token := strings.Fields(req.Headers["Authorization"]) + var ( + tokenType = token[0] + accessToken = token[1] + ) + + // ... + return &backend.CheckHealthResult{Status: backend.HealthStatusOk}, nil +} + func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { token := strings.Fields(req.Headers["Authorization"]) var ( @@ -306,6 +320,13 @@ func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataReque In addition, if the user's token includes an ID token, Grafana will pass the user's ID token to the plugin in an `X-ID-Token` header, available on the `QueryDataRequest` object on the `QueryData` request in your backend data source. ```go +func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { + idToken := req.Headers["X-ID-Token"] + + // ... + return &backend.CheckHealthResult{Status: backend.HealthStatusOk}, nil +} + func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { idToken := req.Headers["X-ID-Token"] @@ -327,3 +348,29 @@ func (ds *dataSource) CallResource(ctx context.Context, req *backend.CallResourc ``` > **Note:** Due to a bug in Grafana, using this feature with PostgreSQL can cause a deadlock. For more information, refer to [Grafana causes deadlocks in PostgreSQL, while trying to refresh users token](https://github.com/grafana/grafana/issues/20515). + +## Forward cookies for the logged-in user + +Your data source plugin can forward certain cookies for the logged-in Grafana user to the data source. Use the [DataSourceHttpSettings](https://developers.grafana.com/ui/latest/index.html?path=/story/data-source-datasourcehttpsettings--basic) component on the data source's configuration page. It provides the **Allowed cookies** option, where the names of cookies to pass to the plugin can be specified. + +When configured, Grafana will pass these cookies to the plugin in the `Cookie` header, available in the `QueryData`, `CallResource` and `CheckHealth` requests in your backend data source. + +```go +func (ds *dataSource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { + cookies:= req.Headers["Cookie"] + + // ... +} + +func (ds *dataSource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { + cookies := req.Headers["Cookie"] + + // ... +} + +func (ds *dataSource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { + cookies:= req.Headers["Cookie"] + + // ... +} +``` diff --git a/docs/sources/developers/plugins/add-query-editor-help.md b/docs/sources/developers/plugins/add-query-editor-help.md index efe6fff5ebf..ea377ec46bb 100644 --- a/docs/sources/developers/plugins/add-query-editor-help.md +++ b/docs/sources/developers/plugins/add-query-editor-help.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/add-query-editor-help/"] -title = "Add query editor help" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/add-query-editor-help/ +title: Add query editor help +--- # Add a query editor help component diff --git a/docs/sources/developers/plugins/add-support-for-annotations.md b/docs/sources/developers/plugins/add-support-for-annotations.md index baa5c79cf21..3cabebb1081 100644 --- a/docs/sources/developers/plugins/add-support-for-annotations.md +++ b/docs/sources/developers/plugins/add-support-for-annotations.md @@ -1,13 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/add-support-for-annotations/"] -title = "Add support for annotations" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/add-support-for-annotations/ +title: Add support for annotations +--- # Add support for annotations -This guide explains how to add support for [annotations]({{< relref "../../dashboards/annotations.md" >}}) to an existing data source plugin. +This guide explains how to add support for [annotations]({{< relref "../../dashboards/annotations/" >}}) to an existing data source plugin. -This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}). +This guide assumes that you're already familiar with how to [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}). > **Note:** Annotation support for React plugins was released in Grafana 7.2. To support earlier versions, refer to the [Add support for annotation for Grafana 7.1](https://grafana.com/docs/grafana/v7.1/developers/plugins/add-support-for-annotations/). @@ -15,7 +16,7 @@ This guide assumes that you're already familiar with how to [Build a data source To enable annotation support for your data source, add the following two lines of code. Grafana uses your default query editor for editing annotation queries. -1. Add `"annotations": true` to the [plugin.json]({{< relref "metadata.md" >}}) file to let Grafana know that your plugin supports annotations. +1. Add `"annotations": true` to the [plugin.json]({{< relref "metadata/" >}}) file to let Grafana know that your plugin supports annotations. **plugin.json** diff --git a/docs/sources/developers/plugins/add-support-for-explore-queries.md b/docs/sources/developers/plugins/add-support-for-explore-queries.md index cc647f39947..ebd285bc44c 100644 --- a/docs/sources/developers/plugins/add-support-for-explore-queries.md +++ b/docs/sources/developers/plugins/add-support-for-explore-queries.md @@ -1,13 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/add-support-for-explore-queries/"] -title = "Add support for Explore queries" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/add-support-for-explore-queries/ +title: Add support for Explore queries +--- # Add support for Explore queries -This guide explains how to improve support for [Explore]({{< relref "../../explore/_index.md" >}}) in an existing data source plugin. +This guide explains how to improve support for [Explore]({{< relref "../../explore/" >}}) in an existing data source plugin. -This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}). +This guide assumes that you're already familiar with how to [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}). With Explore, users can make ad-hoc queries without the use of a dashboard. This is useful when users want to troubleshoot or to learn more about the data. diff --git a/docs/sources/developers/plugins/add-support-for-variables.md b/docs/sources/developers/plugins/add-support-for-variables.md index d33fd1a1bd1..f164d09a8ae 100644 --- a/docs/sources/developers/plugins/add-support-for-variables.md +++ b/docs/sources/developers/plugins/add-support-for-variables.md @@ -1,11 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/add-support-for-variables/"] -title = "Add support for variables in plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/add-support-for-variables/ +title: Add support for variables in plugins +--- # Add support for variables in plugins -Variables are placeholders for values, and can be used to create things like templated queries and dashboard or panel links. For more information on variables, refer to [Templates and variables]({{< relref "../../variables/_index.md" >}}). +Variables are placeholders for values, and can be used to create things like templated queries and dashboard or panel links. For more information on variables, refer to [Templates and variables]({{< relref "../../variables/" >}}). This guide explains how to leverage template variables in your panel plugins and data source plugins. @@ -77,7 +78,7 @@ Now, when users write `$service`, the query looks like this: SELECT * FROM services WHERE id IN (admin,auth,billing) ``` -For more information on the available variable formats, refer to [Advanced variable format options]({{< relref "../../variables/advanced-variable-format-options.md" >}}). +For more information on the available variable formats, refer to [Advanced variable format options]({{< relref "../../variables/advanced-variable-format-options/" >}}). ## Set a variable from your plugin @@ -100,7 +101,7 @@ locationService.partial({ 'var-service': 'billing' }, true); ## Add support for query variables to your data source -[Query variables]({{< relref "../../variables/variable-types/add-query-variable.md" >}}) is a type of variable that allows you to query a data source for the values. By adding support for query variables to your data source plugin, users can create dynamic dashboards based on data from your data source. +[Query variables]({{< relref "../../variables/variable-types/add-query-variable/" >}}) is a type of variable that allows you to query a data source for the values. By adding support for query variables to your data source plugin, users can create dynamic dashboards based on data from your data source. Let's start by defining a query model for the variable query. @@ -198,4 +199,4 @@ Let's create a custom query editor to allow the user to edit the query model. .setVariableQueryEditor(VariableQueryEditor); ``` -That's it! You can now try out the plugin by adding a [query variable]({{< relref "../../variables/variable-types/add-query-variable.md" >}}) to your dashboard. +That's it! You can now try out the plugin by adding a [query variable]({{< relref "../../variables/variable-types/add-query-variable/" >}}) to your dashboard. diff --git a/docs/sources/developers/plugins/backend/_index.md b/docs/sources/developers/plugins/backend/_index.md index c9e1dc9d608..8e34a3e8143 100644 --- a/docs/sources/developers/plugins/backend/_index.md +++ b/docs/sources/developers/plugins/backend/_index.md @@ -1,8 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/backend/", "/docs/grafana/latest/plugins/developing/backend-plugins-guide/"] -keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"] -title = "Backend plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/backend/ + - /docs/grafana/latest/plugins/developing/backend-plugins-guide/ +keywords: + - grafana + - plugins + - backend + - plugin + - backend-plugins + - documentation +title: Backend plugins +--- # Backend plugins @@ -12,13 +20,13 @@ However, one limitation with these plugins are that they execute on the client-s We use the term _backend plugin_ to denote that a plugin has a backend component. Still, normally a backend plugin requires frontend components as well. This is for example true for backend data source plugins which normally need configuration and query editor components implemented for the frontend. -Data source plugins can be extended with a backend component. In the future we plan to support additional types and possibly new kinds of plugins, such as [notifiers for Grafana alerting]({{< relref "../../../alerting/notifications/_index.md" >}}) and custom authentication to name a few. +Data source plugins can be extended with a backend component. In the future we plan to support additional types and possibly new kinds of plugins, such as [notifiers for Grafana alerting]({{< relref "../../../alerting/notifications/" >}}) and custom authentication to name a few. ## Use cases for implementing a backend plugin The following examples gives you an idea of why you'd consider implementing a backend plugin: -- Enable [Grafana alerting]({{< relref "../../../alerting" >}}) for data sources. +- Enable [Grafana alerting]({{< relref "../../../alerting/" >}}) for data sources. - Connect to non-HTTP services that normally can't be connected to from a web browser, e.g. SQL database servers. - Keep state between users, e.g. query caching for data sources. - Use custom authentication methods and/or authorization checks that aren't supported in Grafana. @@ -41,7 +49,7 @@ Grafana's backend plugin system exposes a couple of different capabilities, or b ### Query data -The query data capability allows a backend plugin to handle data source queries that are submitted from a [dashboard]({{< relref "../../../dashboards/_index.md" >}}), [Explore]({{< relref "../../../explore/_index.md" >}}) or [Grafana Alerting]({{< relref "../../../alerting" >}}). The response contains [data frames]({{< relref "../data-frames.md" >}}), which are used to visualize metrics, logs, and traces. The query data capability is required to implement for a backend data source plugin. +The query data capability allows a backend plugin to handle data source queries that are submitted from a [dashboard]({{< relref "../../../dashboards/" >}}), [Explore]({{< relref "../../../explore/" >}}) or [Grafana Alerting]({{< relref "../../../alerting/" >}}). The response contains [data frames]({{< relref "../data-frames/" >}}), which are used to visualize metrics, logs, and traces. The query data capability is required to implement for a backend data source plugin. ### Resources @@ -49,7 +57,7 @@ The resources capability allows a backend plugin to handle custom HTTP requests Examples of use cases for implementing resources: -- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy]({{< relref "../../http_api/data_source.md#data-source-proxy-calls" >}}). +- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy]({{< relref "../../http_api/data_source/#data-source-proxy-calls" >}}). - Return data or information in a format suitable to use within a data source query editor to provide auto-complete functionality. - Return static resources, such as images or files. - Send a command to a device, such as a micro controller or IOT device. @@ -63,6 +71,6 @@ The health checks capability allows a backend plugin to return the status of the ### Collect metrics -A backend plugin can collect and return runtime, process and custom metrics using the text-based Prometheus [exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). If you’re using the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go.md" >}}) to implement your backend plugin, then the [Prometheus instrumentation library for Go applications](https://github.com/prometheus/client_golang) is built-in, and gives you Go runtime metrics and process metrics out of the box. By using the [Prometheus instrumentation library](https://github.com/prometheus/client_golang) you can add custom metrics to instrument your backend plugin. +A backend plugin can collect and return runtime, process and custom metrics using the text-based Prometheus [exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). If you’re using the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) to implement your backend plugin, then the [Prometheus instrumentation library for Go applications](https://github.com/prometheus/client_golang) is built-in, and gives you Go runtime metrics and process metrics out of the box. By using the [Prometheus instrumentation library](https://github.com/prometheus/client_golang) you can add custom metrics to instrument your backend plugin. A metrics endpoint (`/api/plugins//metrics`) for a plugin is available in the Grafana HTTP API and allows a Prometheus instance to be configured to scrape the metrics. diff --git a/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md b/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md index 3bd6de02255..40c4b9aedac 100644 --- a/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md +++ b/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md @@ -1,18 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/"] -keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "sdk", "documentation"] -title = "Grafana Plugin SDK for Go" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/ +keywords: + - grafana + - plugins + - backend + - plugin + - backend-plugins + - sdk + - documentation +title: Grafana Plugin SDK for Go +--- # Grafana plugin SDK for Go -The Grafana plugin SDK for Go enables building Grafana backend plugins using [Go](https://golang.org/). The SDK provides a high-level framework with APIs, utilities and tooling that abstract away the details of the [plugin protocol]({{< relref "plugin-protocol.md" >}}) and RPC communication so plugin developers do not need to manage either. +The Grafana plugin SDK for Go enables building Grafana backend plugins using [Go](https://golang.org/). The SDK provides a high-level framework with APIs, utilities and tooling that abstract away the details of the [plugin protocol]({{< relref "plugin-protocol/" >}}) and RPC communication so plugin developers do not need to manage either. The [github.com/grafana/grafana-plugin-sdk-go](https://pkg.go.dev/mod/github.com/grafana/grafana-plugin-sdk-go?tab=overview) is a Go module that provides a set of [Go packages](https://pkg.go.dev/mod/github.com/grafana/grafana-plugin-sdk-go?tab=packages) that can be used to implement a backend plugin. ## Versioning -The SDK is still in development. The [plugin protocol]({{< relref "plugin-protocol.md" >}}) between Grafana and the plugin SDK is versioned separately and considered stable. However, there might be breaking changes introduced in the SDK. This means that plugins using an older version of the SDK should still work with Grafana, but might lose out on new features and capabilities introduced in the SDK. +The SDK is still in development. The [plugin protocol]({{< relref "plugin-protocol/" >}}) between Grafana and the plugin SDK is versioned separately and considered stable. However, there might be breaking changes introduced in the SDK. This means that plugins using an older version of the SDK should still work with Grafana, but might lose out on new features and capabilities introduced in the SDK. ## See also diff --git a/docs/sources/developers/plugins/backend/plugin-protocol.md b/docs/sources/developers/plugins/backend/plugin-protocol.md index 2be8462b4dc..ba22b332531 100644 --- a/docs/sources/developers/plugins/backend/plugin-protocol.md +++ b/docs/sources/developers/plugins/backend/plugin-protocol.md @@ -1,16 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/backend/plugin-protocol/"] -keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"] -title = "Plugin protocol" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/backend/plugin-protocol/ +keywords: + - grafana + - plugins + - backend + - plugin + - backend-plugins + - documentation +title: Plugin protocol +--- # Plugin protocol There’s a physical wire protocol that Grafana server uses to communicate with backend plugins. This is the contract between Grafana and backend plugins, that must be agreed upon for Grafana and a backend plugin to be able to communicate with each other. The plugin protocol is built on [gRPC](https://grpc.io/) and is defined in [Protocol Buffers (a.k.a., protobuf)](https://developers.google.com/protocol-buffers). -We advise for backend plugins to not be implemented directly against this protocol. Instead, prefer to use the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go.md" >}}) that implements this protocol and provides higher level APIs. +We advise for backend plugins to not be implemented directly against this protocol. Instead, prefer to use the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) that implements this protocol and provides higher level APIs. -The plugin protocol is available in the [GitHub repository](https://github.com/grafana/grafana-plugin-sdk-go/blob/master/proto/backend.proto). The plugin protocol lives in the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go.md" >}}) since Grafana itself uses parts of the SDK as a dependency. +The plugin protocol is available in the [GitHub repository](https://github.com/grafana/grafana-plugin-sdk-go/blob/master/proto/backend.proto). The plugin protocol lives in the [Grafana Plugin SDK for Go]({{< relref "grafana-plugin-sdk-for-go/" >}}) since Grafana itself uses parts of the SDK as a dependency. ## Versioning @@ -22,7 +29,7 @@ Because Grafana maintains the plugin protocol, the plugin protocol attempts to f If you want to write a backend plugin in another language than Go, then it’s possible as long as the language supports [gRPC](https://grpc.io/). However, writing a plugin in Go is recommended and has several advantages that should be carefully taken into account before proceeding: -- There's an official [SDK]({{< relref "grafana-plugin-sdk-for-go.md" >}}) available. +- There's an official [SDK]({{< relref "grafana-plugin-sdk-for-go/" >}}) available. - Single binary as the compiled output. - Building and compiling for multiple platforms is easy. - A statically compiled binary (in most cases) doesn't require any additional dependencies installed on the target platform enabling it to run “everywhere”. diff --git a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md index 5baff091349..7aabe0b2ef9 100644 --- a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md +++ b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md @@ -1,13 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/build-a-logs-data-source-plugin/"] -title = "Build a logs data source plugin" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/build-a-logs-data-source-plugin/ +title: Build a logs data source plugin +--- # Build a logs data source plugin This guide explains how to build a logs data source plugin. -Data sources in Grafana supports both metrics and log data. The steps to build a logs data source plugin are largely the same as for a metrics data source. This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}) for metrics. +Data sources in Grafana supports both metrics and log data. The steps to build a logs data source plugin are largely the same as for a metrics data source. This guide assumes that you're already familiar with how to [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}) for metrics. ## Add logs support to your data source @@ -19,7 +20,7 @@ To add logs support to an existing data source, you need to: ### Enable logs support -Tell Grafana that your data source plugin can return log data, by adding `"logs": true` to the [plugin.json]({{< relref "metadata.md" >}}) file. +Tell Grafana that your data source plugin can return log data, by adding `"logs": true` to the [plugin.json]({{< relref "metadata/" >}}) file. ```json { @@ -29,7 +30,7 @@ Tell Grafana that your data source plugin can return log data, by adding `"logs" ### Construct the log data -Just like for metrics data, Grafana expects your plugin to return log data as a [data frame]({{< relref "data-frames.md" >}}). +Just like for metrics data, Grafana expects your plugin to return log data as a [data frame]({{< relref "data-frames/" >}}). To return log data, return a data frame with at least one time field and one text field from the data source's `query` method. @@ -48,13 +49,13 @@ frame.add({ time: 1589189388597, content: 'user registered' }); frame.add({ time: 1589189406480, content: 'user logged in' }); ``` -That's all you need to start returning log data from your data source. Go ahead and try it out in [Explore]({{< relref "../../explore/_index.md" >}}) or by adding a [Logs panel]({{< relref "../../visualizations/logs-panel.md" >}}). +That's all you need to start returning log data from your data source. Go ahead and try it out in [Explore]({{< relref "../../explore/" >}}) or by adding a [Logs panel]({{< relref "../../visualizations/logs-panel/" >}}). Congratulations, you just wrote your first logs data source plugin! Next, let's look at a couple of features that can further improve the experience for the user. ### (Optional) Add preferred visualisation type hint to the data frame -To make sure Grafana recognizes data as logs and shows logs visualization automatically in Explore you have do set `meta.preferredVisualisationType` to `'logs'` in the returned data frame. See [Selecting preferred visualisation section]({{< relref "add-support-for-explore-queries.md#selecting-preferred-visualisation" >}}) +To make sure Grafana recognizes data as logs and shows logs visualization automatically in Explore you have do set `meta.preferredVisualisationType` to `'logs'` in the returned data frame. See [Selecting preferred visualisation section]({{< relref "add-support-for-explore-queries/#selecting-preferred-visualisation" >}}) **Example:** @@ -96,7 +97,7 @@ frame.add({ time: 1589189406480, content: 'user logged in' }); You can add additional information about each log line by adding more data frame fields. -If a data frame has more than one text field, then Grafana assumes the first field in the data frame to be the actual log line. Any subsequent text fields are treated as [detected fields]({{< relref "../../explore/_index.md#labels-and-detected-fields" >}}). +If a data frame has more than one text field, then Grafana assumes the first field in the data frame to be the actual log line. Any subsequent text fields are treated as [detected fields]({{< relref "../../explore/#labels-and-detected-fields" >}}). While you can add any number of custom fields to your data frame, Grafana comes with a couple of dedicated fields: `levels` and `id`. Let's have a closer look at each one. diff --git a/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md b/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md index 94f9f852236..410c27c931c 100644 --- a/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md +++ b/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md @@ -1,13 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/build-a-streaming-data-source-plugin/"] -title = "Build a streaming data source plugin" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/build-a-streaming-data-source-plugin/ +title: Build a streaming data source plugin +--- # Build a streaming data source plugin This guide explains how to build a streaming data source plugin. -This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}). +This guide assumes that you're already familiar with how to [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}}). When monitoring critical applications, you want your dashboard to refresh as soon as your data does. In Grafana, you can set your dashboards to automatically refresh at a certain interval, no matter what data source you use. Unfortunately, this means that your queries are requesting all the data to be sent again, regardless of whether the data has actually changed. diff --git a/docs/sources/developers/plugins/custom-panel-option-editors.md b/docs/sources/developers/plugins/custom-panel-option-editors.md index d2963cb7191..d9cbcf20a5f 100644 --- a/docs/sources/developers/plugins/custom-panel-option-editors.md +++ b/docs/sources/developers/plugins/custom-panel-option-editors.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/custom-panel-option-editors/"] -title = "Custom panel option editors" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/custom-panel-option-editors/ +title: Custom panel option editors +--- # Custom panel option editors diff --git a/docs/sources/developers/plugins/data-frames.md b/docs/sources/developers/plugins/data-frames.md index 5b4bd22c890..1619d42d65a 100644 --- a/docs/sources/developers/plugins/data-frames.md +++ b/docs/sources/developers/plugins/data-frames.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/data-frames/"] -title = "Data frames" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/data-frames/ +title: Data frames +--- # Data frames @@ -73,7 +74,7 @@ A data transformation is any function that accepts a data frame as input, and re A data frame with at least one time field is considered a _time series_. -For more information on time series, refer to our [Introduction to time series]({{< relref "../../basics/timeseries.md" >}}). +For more information on time series, refer to our [Introduction to time series]({{< relref "../../basics/timeseries/" >}}). ### Wide format @@ -164,7 +165,7 @@ Dimensions: 5 fields by 2 rows +---------------------+------------------+------------------+------------------+------------------+ ``` -> **Note:** Not all panels support the wide time series data frame format. To keep full backward compatibility we have introduced a transformation that can be used to convert from the wide to the long format. For usage information, refer to the [Prepare time series-transformation]({{< relref "../../panels/transform-data/transformation-functions.md#prepare-time-series" >}}). +> **Note:** Not all panels support the wide time series data frame format. To keep full backward compatibility we have introduced a transformation that can be used to convert from the wide to the long format. For usage information, refer to the [Prepare time series-transformation]({{< relref "../../panels/transform-data/transformation-functions/#prepare-time-series" >}}). ## Technical references diff --git a/docs/sources/developers/plugins/development-with-local-grafana.md b/docs/sources/developers/plugins/development-with-local-grafana.md index 65c216ca0ba..1d15d333317 100644 --- a/docs/sources/developers/plugins/development-with-local-grafana.md +++ b/docs/sources/developers/plugins/development-with-local-grafana.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/development-with-local-grafana/"] -title = "Development with local Grafana" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/development-with-local-grafana/ +title: Development with local Grafana +--- # Development with local Grafana diff --git a/docs/sources/developers/plugins/error-handling.md b/docs/sources/developers/plugins/error-handling.md index 203612d8754..bfc1b8e1331 100644 --- a/docs/sources/developers/plugins/error-handling.md +++ b/docs/sources/developers/plugins/error-handling.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/error-handling/"] -title = "Error handling" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/error-handling/ +title: Error handling +--- # Error handling diff --git a/docs/sources/developers/plugins/legacy/_index.md b/docs/sources/developers/plugins/legacy/_index.md index 9a96c0679f3..549d9631193 100644 --- a/docs/sources/developers/plugins/legacy/_index.md +++ b/docs/sources/developers/plugins/legacy/_index.md @@ -1,11 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/", "/docs/grafana/latest/plugins/development/", "/docs/grafana/next/plugins/apps/", "/docs/grafana/next/plugins/datasources/", "/docs/grafana/next/plugins/developing/development/", "/docs/grafana/next/plugins/panels/"] -title = "Legacy plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/ + - /docs/grafana/latest/plugins/development/ + - /docs/grafana/next/plugins/apps/ + - /docs/grafana/next/plugins/datasources/ + - /docs/grafana/next/plugins/developing/development/ + - /docs/grafana/next/plugins/panels/ +title: Legacy plugins +--- # Legacy plugins -> **Note:** Since Grafana 7.0, writing plugins using Angular is no longer recommended. If you're looking to build a new plugin, refer to [Plugins]({{< relref "../_index.md" >}}). +> **Note:** Since Grafana 7.0, writing plugins using Angular is no longer recommended. If you're looking to build a new plugin, refer to [Plugins]({{< relref "../" >}}). You can extend Grafana by writing your own plugins and then share them with other users in [our plugin repository](https://grafana.com/plugins). @@ -44,20 +50,20 @@ Grafana that can impact your plugin. ## Metadata -See the [coding styleguide]({{< relref "style-guide.md" >}}) for details on the metadata. +See the [coding styleguide]({{< relref "style-guide/" >}}) for details on the metadata. ## module.(js|ts) This is the entry point for every plugin. This is the place where you should export your plugin implementation. Depending on what kind of plugin you are developing you -will be expected to export different things. You can find what's expected for [datasource]({{< relref "data-sources.md" >}}), [panels]({{< relref "panels.md" >}}) -and [apps]({{< relref "apps.md" >}}) plugins in the documentation. +will be expected to export different things. You can find what's expected for [datasource]({{< relref "data-sources/" >}}), [panels]({{< relref "panels/" >}}) +and [apps]({{< relref "apps/" >}}) plugins in the documentation. The Grafana SDK is quite small so far and can be found here: - [SDK file in Grafana](https://github.com/grafana/grafana/blob/main/public/app/plugins/sdk.ts) -The SDK contains three different plugin classes: PanelCtrl, MetricsPanelCtrl and QueryCtrl. For plugins of the panel type, the module.js file should export one of these. There are some extra classes for [data sources]({{< relref "data-sources.md" >}}). +The SDK contains three different plugin classes: PanelCtrl, MetricsPanelCtrl and QueryCtrl. For plugins of the panel type, the module.js file should export one of these. There are some extra classes for [data sources]({{< relref "data-sources/" >}}). Example: @@ -105,7 +111,7 @@ There are a number of Grafana events that a plugin can hook into: - `data-snapshot-load` is an event triggered to load data when in snapshot mode. - `data-error` is used to handle errors on dashboard refresh. -If a panel receives data and hooks into the `data-received` event then it should handle snapshot mode too. Otherwise the panel will not work if saved as a snapshot. [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode.md" >}}) describes how to add support for this. +If a panel receives data and hooks into the `data-received` event then it should handle snapshot mode too. Otherwise the panel will not work if saved as a snapshot. [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode/" >}}) describes how to add support for this. ## Examples @@ -119,9 +125,9 @@ We have three different examples that you can fork/download to get started devel ## Other Articles -- [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode.md" >}}) -- [Plugin Defaults and Editor Mode]({{< relref "defaults-and-editor-mode.md" >}}) -- [Grafana Plugin Code Styleguide]({{< relref "style-guide.md" >}}) -- [Grafana Apps]({{< relref "apps.md" >}}) -- [Grafana Data Sources]({{< relref "data-sources.md" >}}) -- [plugin.json Schema]({{< relref "../metadata.md" >}}) +- [Getting Plugins to work in Snapshot Mode]({{< relref "snapshot-mode/" >}}) +- [Plugin Defaults and Editor Mode]({{< relref "defaults-and-editor-mode/" >}}) +- [Grafana Plugin Code Styleguide]({{< relref "style-guide/" >}}) +- [Grafana Apps]({{< relref "apps/" >}}) +- [Grafana Data Sources]({{< relref "data-sources/" >}}) +- [plugin.json Schema]({{< relref "../metadata/" >}}) diff --git a/docs/sources/developers/plugins/legacy/apps.md b/docs/sources/developers/plugins/legacy/apps.md index f653ff56c87..9a43032325b 100644 --- a/docs/sources/developers/plugins/legacy/apps.md +++ b/docs/sources/developers/plugins/legacy/apps.md @@ -1,8 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/apps/", "/docs/grafana/latest/plugins/developing/apps/"] -keywords = ["grafana", "plugins", "documentation"] -title = "Legacy app plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/apps/ + - /docs/grafana/latest/plugins/developing/apps/ +keywords: + - grafana + - plugins + - documentation +title: Legacy app plugins +--- # Legacy app plugins diff --git a/docs/sources/developers/plugins/legacy/data-sources.md b/docs/sources/developers/plugins/legacy/data-sources.md index 8c7f31459c9..a3116f4ee0e 100644 --- a/docs/sources/developers/plugins/legacy/data-sources.md +++ b/docs/sources/developers/plugins/legacy/data-sources.md @@ -1,8 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/data-sources/", "/docs/grafana/latest/plugins/developing/datasources/"] -keywords = ["grafana", "plugins", "documentation"] -title = "Legacy data source plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/data-sources/ + - /docs/grafana/latest/plugins/developing/datasources/ +keywords: + - grafana + - plugins + - documentation +title: Legacy data source plugins +--- # Legacy data source plugins diff --git a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md index c6da24ecb54..c686938978d 100644 --- a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md +++ b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md @@ -1,7 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/defaults-and-editor-mode/", "/docs/grafana/latest/plugins/developing/defaults-and-editor-mode/"] -title = "Legacy defaults and editor mode" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/defaults-and-editor-mode/ + - /docs/grafana/latest/plugins/developing/defaults-and-editor-mode/ +title: Legacy defaults and editor mode +--- # Legacy defaults and editor mode diff --git a/docs/sources/developers/plugins/legacy/panels.md b/docs/sources/developers/plugins/legacy/panels.md index 0f5525d2bdd..9ffd453586e 100644 --- a/docs/sources/developers/plugins/legacy/panels.md +++ b/docs/sources/developers/plugins/legacy/panels.md @@ -1,8 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/panels/", "/docs/grafana/latest/plugins/developing/panels/"] -keywords = ["grafana", "plugins", "panel", "documentation"] -title = "Legacy panel plugins" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/panels/ + - /docs/grafana/latest/plugins/developing/panels/ +keywords: + - grafana + - plugins + - panel + - documentation +title: Legacy panel plugins +--- # Legacy panel plugins diff --git a/docs/sources/developers/plugins/legacy/review-guidelines.md b/docs/sources/developers/plugins/legacy/review-guidelines.md index 7f5d9e71796..cc01f193434 100644 --- a/docs/sources/developers/plugins/legacy/review-guidelines.md +++ b/docs/sources/developers/plugins/legacy/review-guidelines.md @@ -1,7 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/review-guidelines/", "/docs/grafana/latest/plugins/developing/plugin-review-guidelines/"] -title = "Legacy review guidelines" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/review-guidelines/ + - /docs/grafana/latest/plugins/developing/plugin-review-guidelines/ +title: Legacy review guidelines +--- # Legacy review guidelines @@ -160,7 +162,7 @@ For more information about data sources, refer to the [basic guide for data sour If possible, any passwords or secrets should be saved in the `secureJsonData` blob. To encrypt sensitive data, the Grafana server's proxy feature must be used. The Grafana server has support for token authentication (OAuth) and HTTP Header authentication. If the calls have to be sent directly from the browser to a third-party API, this will not be possible and sensitive data will not be encrypted. -Read more here about how [authentication for data sources]({{< relref "../add-authentication-for-data-source-plugins.md" >}}) works. +Read more here about how [authentication for data sources]({{< relref "../add-authentication-for-data-source-plugins/" >}}) works. If using the proxy feature, the Configuration page should use the `secureJsonData` blob like this: diff --git a/docs/sources/developers/plugins/legacy/snapshot-mode.md b/docs/sources/developers/plugins/legacy/snapshot-mode.md index 826a6c33b8a..0952f1e40ea 100644 --- a/docs/sources/developers/plugins/legacy/snapshot-mode.md +++ b/docs/sources/developers/plugins/legacy/snapshot-mode.md @@ -1,13 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/snapshot-mode/", "/docs/grafana/latest/plugins/developing/snapshot-mode/"] -title = "Legacy snapshot mode" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/snapshot-mode/ + - /docs/grafana/latest/plugins/developing/snapshot-mode/ +title: Legacy snapshot mode +--- # Legacy snapshot mode {{< figure class="float-right" src="/static/img/docs/Grafana-snapshot-example.png" caption="A dashboard using snapshot data and not live data." >}} -Grafana has this great feature where you can [save a snapshot of your dashboard]({{< relref "../../../dashboards/json-model.md" >}}). Instead of sending a screenshot of a dashboard to someone, you can send them a working, interactive Grafana dashboard with the snapshot data embedded inside it. The snapshot can be saved on your Grafana server and is available to all your co-workers. Raintank also hosts a [snapshot server](https://snapshots.raintank.io) if you want to send the snapshot to someone who does not have access to your Grafana server. +Grafana has this great feature where you can [save a snapshot of your dashboard]({{< relref "../../../dashboards/json-model/" >}}). Instead of sending a screenshot of a dashboard to someone, you can send them a working, interactive Grafana dashboard with the snapshot data embedded inside it. The snapshot can be saved on your Grafana server and is available to all your co-workers. Raintank also hosts a [snapshot server](https://snapshots.raintank.io) if you want to send the snapshot to someone who does not have access to your Grafana server. {{< figure class="float-right" src="/static/img/docs/animated_gifs/snapshots.gif" caption="Selecting a snapshot" >}} diff --git a/docs/sources/developers/plugins/legacy/style-guide.md b/docs/sources/developers/plugins/legacy/style-guide.md index 812060d6022..2c41880a0c5 100644 --- a/docs/sources/developers/plugins/legacy/style-guide.md +++ b/docs/sources/developers/plugins/legacy/style-guide.md @@ -1,7 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/legacy/style-guide/", "/docs/grafana/latest/plugins/developing/code-styleguide/"] -title = "Legacy code style guide" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/legacy/style-guide/ + - /docs/grafana/latest/plugins/developing/code-styleguide/ +title: Legacy code style guide +--- # Legacy code style guide @@ -26,7 +28,7 @@ grafana-piechart-panel mtanda-histogram-panel ``` -For more information about the file format for `plugin.json` file, refer to [metadata]({{< relref "../metadata.md" >}}). +For more information about the file format for `plugin.json` file, refer to [metadata]({{< relref "../metadata/" >}}). Minimal plugin.json: diff --git a/docs/sources/developers/plugins/metadata.md b/docs/sources/developers/plugins/metadata.md index 3bdaea28ffe..9de5660286d 100644 --- a/docs/sources/developers/plugins/metadata.md +++ b/docs/sources/developers/plugins/metadata.md @@ -1,8 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/metadata/", "/docs/grafana/latest/plugins/developing/plugin.json/"] -keywords = ["grafana", "plugins", "documentation"] -title = "plugin.json" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/metadata/ + - /docs/grafana/latest/plugins/developing/plugin.json/ +keywords: + - grafana + - plugins + - documentation +title: plugin.json +--- # plugin.json diff --git a/docs/sources/developers/plugins/migration-guide.md b/docs/sources/developers/plugins/migration-guide.md index 00153a20ede..fbf3e1079a2 100644 --- a/docs/sources/developers/plugins/migration-guide.md +++ b/docs/sources/developers/plugins/migration-guide.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/migration-guide/"] -title = "Plugin migration guide" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/migration-guide/ +title: Plugin migration guide +--- # Plugin migration guide @@ -322,7 +323,7 @@ import { cx, css } from '@emotion/css'; ### Update needed for app plugins using dashboards -To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav]({{< relref "metadata.md#properties-4" >}}) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`. +To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav]({{< relref "metadata/#properties-4" >}}) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`. **`plugin.json`** diff --git a/docs/sources/developers/plugins/package-a-plugin.md b/docs/sources/developers/plugins/package-a-plugin.md index ae33ce3e531..ca4af12fe9e 100644 --- a/docs/sources/developers/plugins/package-a-plugin.md +++ b/docs/sources/developers/plugins/package-a-plugin.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/package-a-plugin/", "/docs/grafana/latest/developers/plugins/share-a-plugin/"] -title = "Package a plugin" -type = "docs" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/package-a-plugin/ + - /docs/grafana/latest/developers/plugins/share-a-plugin/ +title: Package a plugin +type: docs +--- # Package a plugin @@ -31,7 +33,7 @@ There are three steps needed to package a plugin: mage ``` -1. [Sign the plugin]({{< relref "sign-a-plugin.md" >}}). +1. [Sign the plugin]({{< relref "sign-a-plugin/" >}}). 1. Create a ZIP archive of the `dist` directory. diff --git a/docs/sources/developers/plugins/publishing-and-signing-criteria.md b/docs/sources/developers/plugins/publishing-and-signing-criteria.md index e9031bed87b..8e85d43abc2 100644 --- a/docs/sources/developers/plugins/publishing-and-signing-criteria.md +++ b/docs/sources/developers/plugins/publishing-and-signing-criteria.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/publishing-and-signing-criteria/"] -title = "Plugin publishing and signing criteria" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/publishing-and-signing-criteria/ +title: Plugin publishing and signing criteria +--- # Plugin publishing and signing criteria diff --git a/docs/sources/developers/plugins/sign-a-plugin.md b/docs/sources/developers/plugins/sign-a-plugin.md index dee4e2588d1..a2a6374e93a 100644 --- a/docs/sources/developers/plugins/sign-a-plugin.md +++ b/docs/sources/developers/plugins/sign-a-plugin.md @@ -1,11 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/sign-a-plugin/"] -title = "Sign a plugin" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/sign-a-plugin/ +title: Sign a plugin +--- # Sign a plugin -Signing a plugin allows Grafana to verify the authenticity of the plugin with [signature verification]({{< relref "../../plugins/plugin-signatures.md" >}}). This gives users a way to make sure plugins haven't been tampered with. All Grafana Labs-authored backend plugins, including Enterprise plugins, are signed. +Signing a plugin allows Grafana to verify the authenticity of the plugin with [signature verification]({{< relref "../../plugins/plugin-signatures/" >}}). This gives users a way to make sure plugins haven't been tampered with. All Grafana Labs-authored backend plugins, including Enterprise plugins, are signed. > **Important:** Future versions of Grafana will require all plugins to be signed. @@ -13,7 +14,7 @@ Before you can sign your plugin, you need to decide whether you want to sign it If you want to make your plugin publicly available outside of your organization, you need to sign your plugin under a _community_ or _commercial_ [signature level](#plugin-signature-levels). Public plugins are available from [grafana.com/plugins](https://grafana.com/plugins) and can be installed by anyone. -For more information on how to install public plugin, refer to [Install Grafana plugins]({{< relref "../../plugins/installation.md" >}}). +For more information on how to install public plugin, refer to [Install Grafana plugins]({{< relref "../../plugins/installation/" >}}). If you intend to only use the plugin within your organization, you can to sign it under a _private_ [signature level](#plugin-signature-levels). @@ -33,7 +34,7 @@ To verify ownership of your plugin, you need to generate an API key that you'll Public plugins need to be reviewed by the Grafana team before you can sign them. -1. Submit your plugin for [review]({{< relref "package-a-plugin.md#publishing-your-plugin-for-the-first-time" >}}) +1. Submit your plugin for [review]({{< relref "package-a-plugin/#publishing-your-plugin-for-the-first-time" >}}) 2. When your plugin is approved, you're granted a plugin signature level. **Without a plugin signature level, you won't be able to sign your plugin**. 3. In your plugin directory, sign the plugin with the API key you just created. Grafana Toolkit creates a [MANIFEST.txt](#plugin-manifest) file in the `dist` directory of your plugin. @@ -124,6 +125,6 @@ Due to an issue when signing the plugin on Windows, grafana-toolkit generates an If you're trying to sign a **public** plugin, this means that your plugin doesn't have a plugin signature level assigned to it yet. A Grafana team member will assign a signature level to your plugin once it has been reviewed and approved. For more information, refer to [Sign a public plugin](#sign-a-public-plugin). -If you're trying to sign a **private** plugin, this means that you need to add a `rootUrls` flag to the `plugin:sign` command. The `rootUrls` must match the [root_url]({{< relref "../../administration/configuration.md#root_url" >}}) configuration. For more information, refer to [Sign a private plugin](#sign-a-private-plugin). +If you're trying to sign a **private** plugin, this means that you need to add a `rootUrls` flag to the `plugin:sign` command. The `rootUrls` must match the [root_url]({{< relref "../../setup-grafana/configure-grafana/#root_url" >}}) configuration. For more information, refer to [Sign a private plugin](#sign-a-private-plugin). If you still get this error, make sure that the API key was generated by a Grafana Cloud account that matches the first part of the plugin ID. diff --git a/docs/sources/developers/plugins/working-with-data-frames.md b/docs/sources/developers/plugins/working-with-data-frames.md index 4208f0c0c3a..e47cb4ac829 100644 --- a/docs/sources/developers/plugins/working-with-data-frames.md +++ b/docs/sources/developers/plugins/working-with-data-frames.md @@ -1,7 +1,8 @@ -+++ -aliases = ["/docs/grafana/latest/developers/plugins/working-with-data-frames/"] -title = "Working with data frames" -+++ +--- +aliases: + - /docs/grafana/latest/developers/plugins/working-with-data-frames/ +title: Working with data frames +--- # Working with data frames @@ -9,7 +10,7 @@ The data frame is a columnar data structure which allows efficient querying of l The DataFrame interface contains a `name` and an array of `fields` where each field contains the name, type, and the values for the field. -> **Note:** If you're looking to migrate an existing plugin to use the data frame format, refer to [Migrate to data frames]({{< relref "migration-guide.md#migrate-to-data-frames" >}}). +> **Note:** If you're looking to migrate an existing plugin to use the data frame format, refer to [Migrate to data frames]({{< relref "migration-guide/#migrate-to-data-frames" >}}). ## Create a data frame diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md index 5450e2f4fe8..cc1aff8b765 100644 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -1,18 +1,32 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/"] -description = "Grafana Enterprise overview" -keywords = ["grafana", "documentation", "datasource", "permissions", "ldap", "licensing", "enterprise", "insights", "reporting"] -title = "Grafana Enterprise" -weight = 150 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/ +description: Grafana Enterprise overview +keywords: + - grafana + - documentation + - datasource + - permissions + - ldap + - licensing + - enterprise + - insights + - reporting +title: Grafana Enterprise +weight: 150 +--- # Grafana Enterprise Grafana Enterprise is a commercial edition of Grafana that includes additional features not found in the open source version. -Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). On top of that you get 24x7x365 support and training from the core Grafana team. +Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). You also get 24x7x365 support and training from the core Grafana team. -To learn more about Grafana Enterprise, refer to [our product page.](https://grafana.com/enterprise) +To learn more about Grafana Enterprise, refer to [our product page](https://grafana.com/enterprise). + +## Enterprise features in Grafana Cloud + +Many Grafana Enterprise features are also available in [Grafana Cloud]({{< ref "/docs/grafana-cloud" >}}) Pro and Advanced accounts. For details, refer to [the Grafana Cloud features table](https://grafana.com/pricing/#featuresTable) and [Enterprise features available to Grafana Cloud Pro and Advanced accounts]({{< ref "/docs/grafana-cloud/reference/enterprise-features" >}}). ## Authentication @@ -20,45 +34,45 @@ Grafana Enterprise includes integrations with more ways to authenticate your use ### Team sync -[Team sync]({{< relref "team-sync.md" >}}) allows you to set up synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. +[Team sync]({{< relref "../setup-grafana/configure-security/configure-team-sync/" >}}) allows you to set up synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. 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/configure-saml.md#configure-team-sync" >}}) +- [Auth Proxy]({{< relref "../setup-grafana/configure-security/configure-authentication/auth-proxy/#team-sync-enterprise-only" >}}) +- [Azure AD OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/azuread/#team-sync-enterprise-only" >}}) +- [GitHub OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/github/#team-sync-enterprise-only" >}}) +- [GitLab OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/gitlab/#team-sync-enterprise-only" >}}) +- [LDAP]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced_ldap/#ldap-group-synchronization-for-teams" >}}) +- [Okta]({{< relref "../setup-grafana/configure-security/configure-authentication/okta/#team-sync-enterprise-only" >}}) +- [SAML]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/#configure-team-sync" >}}) ### Enhanced LDAP integration -With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you can set up active LDAP synchronization. +With [enhanced LDAP integration]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced_ldap/" >}}), you can set up active LDAP synchronization. ### SAML authentication -[SAML authentication]({{< relref "./saml" >}}) enables your Grafana Enterprise users to authenticate with SAML. +[SAML authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/" >}}) enables users to authenticate with single sign-on services that use Security Assertion Markup Language (SAML). ## Enterprise features -With Grafana Enterprise, you get access to the following features: +Grafana Enterprise adds the following features: -- [Role-based access control]({{< relref "./access-control/_index.md" >}}) to control access with role-based permissions. -- [Data source permissions]({{< relref "datasource_permissions.md" >}}) to restrict query access to specific teams and users. -- [Data source query caching]({{< relref "query-caching.md" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting. -- [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/_index.md" >}}) to understand how your Grafana instance is used. -- [Vault integration]({{< relref "vault.md" >}}) to manage your configuration or provisioning secrets with Vault. -- [Auditing]({{< relref "auditing.md" >}}) tracks important changes to your Grafana instance to help you manage and mitigate suspicious activity and meet compliance requirements. -- [Request security]({{< relref "request-security.md" >}}) makes it possible to restrict outgoing requests from the Grafana server. -- [Settings updates at runtime]({{< relref "settings-updates.md" >}}) allows you to update Grafana settings at runtime without requiring a restart. +- [Role-based access control]({{< relref "access-control/" >}}) to control access with role-based permissions. +- [Data source permissions]({{< relref "datasource_permissions/" >}}) to restrict query access to specific teams and users. +- [Data source query caching]({{< relref "query-caching/" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting. +- [Reporting]({{< relref "reporting/" >}}) 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/" >}}) +- [White labeling]({{< relref "../setup-grafana/enable-custom-branding/" >}}) to customize Grafana from the brand and logo to the footer links. +- [Usage insights]({{< relref "usage-insights/" >}}) to understand how your Grafana instance is used. +- [Vault integration]({{< relref "../setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/" >}}) to manage your configuration or provisioning secrets with Vault. +- [Auditing]({{< relref "../setup-grafana/configure-security/audit-grafana/" >}}) tracks important changes to your Grafana instance to help you manage and mitigate suspicious activity and meet compliance requirements. +- [Request security]({{< relref "../setup-grafana/configure-security/configure-request-security/" >}}) makes it possible to restrict outgoing requests from the Grafana server. +- [Settings updates at runtime]({{< relref "settings-updates/" >}}) allows you to update Grafana settings at runtime without requiring a restart. ## Enterprise data sources -With a Grafana Enterprise license, you get access to premium data sources, including: +With a Grafana Enterprise license, you also get access to premium data sources, including: - [AppDynamics](https://grafana.com/grafana/plugins/dlopes7-appdynamics-datasource) - [Azure Devops](https://grafana.com/grafana/plugins/grafana-azuredevops-datasource) @@ -80,4 +94,4 @@ With a Grafana Enterprise license, you get access to premium data sources, inclu ## Try Grafana Enterprise -To purchase or obtain a trial license contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). +To purchase or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). diff --git a/docs/sources/enterprise/access-control/about-rbac.md b/docs/sources/enterprise/access-control/about-rbac.md index 4eefb2cd96e..f4abf332740 100644 --- a/docs/sources/enterprise/access-control/about-rbac.md +++ b/docs/sources/enterprise/access-control/about-rbac.md @@ -1,8 +1,8 @@ --- aliases: - /docs/grafana/latest/enterprise/access-control/ - - /docs/grafana/latest/enterprise/access-control/roles/ - /docs/grafana/latest/enterprise/access-control/about-rbac/ + - /docs/grafana/latest/enterprise/access-control/roles/ description: Role-based access control (RBAC) provides a standardized way of granting, changing, and revoking access so that users can view and modify Grafana resources, such as users and reports. @@ -58,8 +58,8 @@ You can use RBAC to modify the permissions associated with any basic role, which Note that any modification to any of these basic role is not propagated to the other basic roles. For example, if you modify Viewer basic role and grant additional permission, Editors or Admins won't have that additional grant. -For more information about the permissions associated with each basic role, refer to [Basic role definitions]({{< relref "./rbac-fixed-basic-role-definitions#basic-role-assignments" >}}). -To interact with the API and view or modify basic roles permissions, refer to [the table]({{< relref "./manage-rbac-roles#basic-role-uid-mapping" >}}) that maps basic role names to the associated UID. +For more information about the permissions associated with each basic role, refer to [Basic role definitions]({{< relref "rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}). +To interact with the API and view or modify basic roles permissions, refer to [the table]({{< relref "manage-rbac-roles/#basic-role-uid-mapping" >}}) that maps basic role names to the associated UID. ## Fixed roles @@ -67,33 +67,33 @@ Grafana Enterprise includes the ability for you to assign discrete fixed roles t Assign fixed roles when the basic roles do not meet your permission requirements. For example, you might want a user with the basic viewer role to also edit dashboards. Or, you might want anyone with the editor role to also add and manage users. Fixed roles provide users more granular access to create, view, and update the following Grafana resources: -- [Alerting]({{< relref "../../alerting/_index.md" >}}) -- [Annotations]({{< relref "../../dashboards/annotations.md" >}}) -- [API keys]({{< relref "../../administration/api-keys/_index.md" >}}) -- [Dashboards and folders]({{< relref "../../dashboards/_index.md" >}}) -- [Data sources]({{< relref "../../datasources/_index.md" >}}) -- [Explore]({{< relref "../../explore/_index.md" >}}) -- [Folders]({{< relref "../../dashboards/dashboard-folders.md" >}}) -- [LDAP]({{< relref "../../auth/ldap/_index.md" >}}) -- [Licenses]({{< relref "../license/_index.md" >}}) -- [Organizations]({{< relref "../../administration/manage-organizations/_index.md" >}}) -- [Provisioning]({{< relref "../../administration/provisioning/_index.md" >}}) -- [Reports]({{< relref "../reporting.md" >}}) -- [Roles]({{< relref "../../administration/manage-users-and-permissions/_index.md" >}}) -- [Settings]({{< relref "../settings-updates.md" >}}) -- [Service accounts]({{< relref "../../administration/service-accounts/_index.md" >}}) -- [Teams]({{< relref "../../administration/manage-users-and-permissions/manage-teams/_index.md" >}}) -- [Users]({{< relref "../../administration/manage-users-and-permissions/manage-server-users/_index.md" >}}) +- [Alerting]({{< relref "../../alerting/" >}}) +- [Annotations]({{< relref "../../dashboards/annotations/" >}}) +- [API keys]({{< relref "../../administration/api-keys/" >}}) +- [Dashboards and folders]({{< relref "../../dashboards/" >}}) +- [Data sources]({{< relref "../../datasources/" >}}) +- [Explore]({{< relref "../../explore/" >}}) +- [Folders]({{< relref "../../dashboards/dashboard-folders/" >}}) +- [LDAP]({{< relref "../../setup-grafana/configure-security/configure-authentication/ldap/" >}}) +- [Licenses]({{< relref "../license/" >}}) +- [Organizations]({{< relref "../../administration/manage-organizations/" >}}) +- [Provisioning]({{< relref "../../administration/provisioning/" >}}) +- [Reports]({{< relref "../reporting/" >}}) +- [Roles]({{< relref "../../administration/manage-users-and-permissions/" >}}) +- [Settings]({{< relref "../settings-updates/" >}}) +- [Service accounts]({{< relref "../../administration/service-accounts/" >}}) +- [Teams]({{< relref "../../administration/manage-users-and-permissions/manage-teams/" >}}) +- [Users]({{< relref "../../administration/manage-users-and-permissions/manage-server-users/" >}}) -To learn more about the permissions you can grant for each resource, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions.md" >}}). +To learn more about the permissions you can grant for each resource, refer to [RBAC role definitions]({{< relref "rbac-fixed-basic-role-definitions/" >}}). ## Custom roles If you are a Grafana Enterprise customer, you can create custom roles to manage user permissions in a way that meets your security requirements. -Custom roles contain unique combinations of permissions _actions_ and _scopes_. An action defines the action a use can perform on a Grafana resource. For example, the `teams.roles:list` action allows a user to see a list of roles associated with each team. +Custom roles contain unique combinations of permissions _actions_ and _scopes_. An action defines the action a use can perform on a Grafana resource. For example, the `teams.roles:read` action allows a user to see a list of roles associated with each team. -A scope describes where an action can be performed. For example, the `teams:id:1` scope restricts the user's action to the team with ID `1`. When paired with the `teams.roles:list` action, this permission prohibits the user from viewing the roles for teams other than team `1`. +A scope describes where an action can be performed. For example, the `teams:id:1` scope restricts the user's action to the team with ID `1`. When paired with the `teams.roles:read` action, this permission prohibits the user from viewing the roles for teams other than team `1`. Consider creating a custom role when fixed roles do not meet your permissions requirements. @@ -101,11 +101,11 @@ Consider creating a custom role when fixed roles do not meet your permissions re You can use either of the following methods to create, assign, and manage custom roles: -- Grafana provisioning: You can use a YAML file to configure roles. For more information about using provisioning to create custom roles, refer to [Manage RBAC roles]({{< relref "./manage-rbac-roles.md" >}}). For more information about using provisioning to assign RBAC roles to users or teams, refer to [Assign RBAC roles]({{< relref "./assign-rbac-roles.md" >}}). -- RBAC API: As an alternative, you can use the Grafana HTTP API to create and manage roles. For more information about the HTTP API, refer to [RBAC API]({{< relref "../../developers/http_api/access_control.md" >}}). +- Grafana provisioning: You can use a YAML file to configure roles. For more information about using provisioning to create custom roles, refer to [Manage RBAC roles]({{< relref "manage-rbac-roles/" >}}). For more information about using provisioning to assign RBAC roles to users or teams, refer to [Assign RBAC roles]({{< relref "assign-rbac-roles/" >}}). +- RBAC API: As an alternative, you can use the Grafana HTTP API to create and manage roles. For more information about the HTTP API, refer to [RBAC API]({{< relref "../../developers/http_api/access_control/" >}}). ## Limitation If you have created a folder with the name `General` or `general`, you cannot manage its permissions with RBAC. -If you set [folder permissions]({{< relref "../../administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md" >}}) for a folder named `General` or `general`, the system disregards the folder when RBAC is enabled. +If you set [folder permissions]({{< relref "../../administration/manage-users-and-permissions/manage-dashboard-permissions/" >}}) for a folder named `General` or `general`, the system disregards the folder when RBAC is enabled. diff --git a/docs/sources/enterprise/access-control/assign-rbac-roles.md b/docs/sources/enterprise/access-control/assign-rbac-roles.md index cbf100be36d..cc7bae992e7 100644 --- a/docs/sources/enterprise/access-control/assign-rbac-roles.md +++ b/docs/sources/enterprise/access-control/assign-rbac-roles.md @@ -28,10 +28,10 @@ In both cases, the assignment applies only to the user or team within the affect **Before you begin:** -- [Plan your RBAC rollout strategy]({{< relref "./plan-rbac-rollout-strategy.md" >}}). +- [Plan your RBAC rollout strategy]({{< relref "plan-rbac-rollout-strategy/" >}}). - Identify the fixed roles that you want to assign to the user or team. - For more information about available fixed roles, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions.md" >}}). + For more information about available fixed roles, refer to [RBAC role definitions]({{< relref "rbac-fixed-basic-role-definitions/" >}}). - Ensure that your own user account has the correct permissions: - If you are assigning permissions to a user or team within an organization, you must have organization administrator or server administrator permissions. @@ -69,8 +69,8 @@ Instead of using the Grafana role picker, you can use file-based provisioning to **Before you begin:** -- Refer to [Role provisioning]({{< relref "./rbac-provisioning#rbac-provisioning" >}}) -- Ensure that the team to which you are adding the fixed role exists. For more information about creating teams, refer to [Manage teams]({{< relref "../../administration/manage-users-and-permissions/manage-teams/_index.md">}}) +- Refer to [Role provisioning]({{< relref "rbac-provisioning/#rbac-provisioning" >}}) +- Ensure that the team to which you are adding the fixed role exists. For more information about creating teams, refer to [Manage teams]({{< relref "../../administration/manage-users-and-permissions/manage-teams/" >}}) **To assign a role to a team:** @@ -78,21 +78,21 @@ Instead of using the Grafana role picker, you can use file-based provisioning to 1. Refer to the following table to add attributes and values. - | Attribute | Description | - | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `roles` | Enter the custom role or custom roles you want to create/update. | - | `roles > name` | Enter the name of the custom role. | - | `roles > version` | Enter the custom role version number. Role assignments are independent of the role version number. | - | `roles > global` | Enter `true`. You can specify the `orgId` otherwise. | - | `roles > permissions` | Enter the permissions `action` and `scope` values. For more information about permissions actions and scopes, refer to [RBAC permissions, actions, and scopes]({{< relref "./custom-role-actions-scopes.md" >}}) | - | `teams` | Enter the team or teams to which you are adding the custom role. | - | `teams > orgId` | Because teams belong to organizations, you must add the `orgId` value. | - | `teams > name` | Enter the name of the team. | - | `teams > roles` | Enter the custom or fixed role or roles that you want to grant to the team. | - | `teams > roles > name` | Enter the name of the role. | - | `teams > roles > global` | Enter `true`, or specify `orgId` of the role you want to assign to the team. Fixed roles are global. | + | Attribute | Description | + | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | + | `roles` | Enter the custom role or custom roles you want to create/update. | + | `roles > name` | Enter the name of the custom role. | + | `roles > version` | Enter the custom role version number. Role assignments are independent of the role version number. | + | `roles > global` | Enter `true`. You can specify the `orgId` otherwise. | + | `roles > permissions` | Enter the permissions `action` and `scope` values. For more information about permissions actions and scopes, refer to [RBAC permissions, actions, and scopes]({{< relref "custom-role-actions-scopes/" >}}) | + | `teams` | Enter the team or teams to which you are adding the custom role. | + | `teams > orgId` | Because teams belong to organizations, you must add the `orgId` value. | + | `teams > name` | Enter the name of the team. | + | `teams > roles` | Enter the custom or fixed role or roles that you want to grant to the team. | + | `teams > roles > name` | Enter the name of the role. | + | `teams > roles > global` | Enter `true`, or specify `orgId` of the role you want to assign to the team. Fixed roles are global. | - For more information about managing custom roles, refer to [Create custom roles using provisioning]({{< relref "./manage-rbac-roles/#create-custom-roles-using-provisioning" >}}). + For more information about managing custom roles, refer to [Create custom roles using provisioning]({{< relref "manage-rbac-roles/#create-custom-roles-using-provisioning" >}}). 1. Reload the provisioning configuration file. diff --git a/docs/sources/enterprise/access-control/configure-rbac.md b/docs/sources/enterprise/access-control/configure-rbac.md index f49f2e0467f..c709c5a611d 100644 --- a/docs/sources/enterprise/access-control/configure-rbac.md +++ b/docs/sources/enterprise/access-control/configure-rbac.md @@ -1,14 +1,15 @@ --- -title: 'Configure RBAC in Grafana' -menuTitle: 'Configure RBAC' -description: 'Learn how to configure RBAC.' -aliases: [] +aliases: + - /docs/grafana/latest/enterprise/access-control/configure-rbac/ +description: Learn how to configure RBAC. +menuTitle: Configure RBAC +title: Configure RBAC in Grafana weight: 30 --- # Configure RBAC in Grafana -The table below describes all RBAC configuration options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../administration/configuration.md#configure-with-environment-variables" >}}). +The table below describes all RBAC configuration options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../setup-grafana/configure-grafana/#configure-with-environment-variables" >}}). | Setting | Required | Description | Default | | ------------------ | -------- | ---------------------------------------------------------------------------- | ------- | diff --git a/docs/sources/enterprise/access-control/custom-role-actions-scopes.md b/docs/sources/enterprise/access-control/custom-role-actions-scopes.md index 9679536f5fa..1de9b2463b3 100644 --- a/docs/sources/enterprise/access-control/custom-role-actions-scopes.md +++ b/docs/sources/enterprise/access-control/custom-role-actions-scopes.md @@ -12,7 +12,7 @@ weight: 80 A permission is comprised of an action and a scope. When creating a custom role, consider the actions the user can perform and the resource(s) on which they can perform those actions. -To learn more about the Grafana resources to which you can apply RBAC, refer to [Resources with RBAC permissions]({{< relref "./about-rbac.md#fixed-roles" >}}). +To learn more about the Grafana resources to which you can apply RBAC, refer to [Resources with RBAC permissions]({{< relref "about-rbac/#fixed-roles" >}}). - **Action:** An action describes what tasks a user can perform on a resource. - **Scope:** A scope describes where an action can be performed, such as reading a specific user profile. In this example, a permission is associated with the scope `users:` to the relevant role. @@ -27,7 +27,7 @@ The following list contains role-based access control actions. | `alert.instances.external:write` | `datasources:*`
`datasources:uid:*` | Manage alerts and silences in data sources that support alerting. | | `alert.instances:create` | n/a | Create silences in the current organization. | | `alert.instances:read` | n/a | Read alerts and silences in the current organization. | -| `alert.instances:update` | n/a | Update and expire silences in the current organization. | +| `alert.instances:write` | n/a | Update and expire silences in the current organization. | | `alert.notifications.external:read` | `datasources:*`
`datasources:uid:*` | Read templates, contact points, notification policies, and mute timings in data sources that support alerting. | | `alert.notifications.external:write` | `datasources:*`
`datasources:uid:*` | Manage templates, contact points, notification policies, and mute timings in data sources that support alerting. | | `alert.notifications:write` | n/a | Manage templates, contact points, notification policies, and mute timings in the current organization. | @@ -37,7 +37,7 @@ The following list contains role-based access control actions. | `alert.rules:create` | `folders:*`
`folders:uid:*` | Create Grafana alert rules in a folder. Combine this permission with `folders:read` in a scope that includes the folder and `datasources:query` in the scope of data sources the user can query. | | `alert.rules:delete` | `folders:*`
`folders:uid:*` | Delete Grafana alert rules in a folder. Combine this permission with `folders:read` in a scope that includes the folder and `datasources:query` in the scope of data sources the user can query. | | `alert.rules:read` | `folders:*`
`folders:uid:*` | Read Grafana alert rules in a folder. Combine this permission with `folders:read` in a scope that includes the folder and `datasources:query` in the scope of data sources the user can query. | -| `alert.rules:update` | `folders:*`
`folders:uid:*` | Update Grafana alert rules in a folder. Combine this permission with `folders:read` in a scope that includes the folder and `datasources:query` in the scope of data sources the user can query. | +| `alert.rules:write` | `folders:*`
`folders:uid:*` | Update Grafana alert rules in a folder. Combine this permission with `folders:read` in a scope that includes the folder and `datasources:query` in the scope of data sources the user can query. | | `annotations:create` | `annotations:*`
`annotations:type:*` | Create annotations. | | `annotations:delete` | `annotations:*`
`annotations:type:*` | Delete annotations. | | `annotations:read` | `annotations:*`
`annotations:type:*` | Read annotations and annotation tags. | @@ -73,8 +73,8 @@ The following list contains role-based access control actions. | `licensing.reports:read` | n/a | Get custom permission reports. | | `licensing:delete` | n/a | Delete the license token. | | `licensing:read` | n/a | Read licensing information. | -| `licensing:update` | n/a | Update the license token. | -| `org.users.role:update` | `users:*`
`users:id:*` | Update the organization role (`Viewer`, `Editor`, or `Admin`) of an organization. | +| `licensing:write` | n/a | Update the license token. | +| `org.users:write` | `users:*`
`users:id:*` | Update the organization role (`Viewer`, `Editor`, or `Admin`) of a user. | | `org.users:add` | `users:*` | Add a user to an organization. | | `org.users:read` | `users:*`
`users:id:*` | Get user profiles within an organization. | | `org.users:remove` | `users:*`
`users:id:*` | Remove a user from an organization. | @@ -87,42 +87,40 @@ The following list contains role-based access control actions. | `orgs:read` | `orgs:*`
`orgs:id:*` | Read one or more organizations. | | `orgs:write` | `orgs:*`
`orgs:id:*` | Update one or more organizations. | | `provisioning:reload` | `provisioners:*` | Reload provisioning files. To find the exact scope for specific provisioner, see [Scope definitions]({{< relref "#scope-definitions" >}}). | -| `reports.admin:create` | n/a | Create reports. | -| `reports.admin:write` | `reports:*`
`reports:id:*` | Update reports. | +| `reports:create` | n/a | Create reports. | +| `reports:write` | `reports:*`
`reports:id:*` | Update reports. | | `reports.settings:read` | n/a | Read report settings. | | `reports.settings:write` | n/a | Update report settings. | | `reports:delete` | `reports:*`
`reports:id:*` | Delete reports. | | `reports:read` | `reports:*` | List all available reports or get a specific report. | | `reports:send` | `reports:*` | Send a report email. | | `roles:delete` | `permissions:type:delegate` | Delete a custom role. | -| `roles:list` | `roles:*` | List available roles without permissions. | -| `roles:read` | `roles:*`
`roles:uid:*` | Read a specific role with its permissions. | +| `roles:read` | `roles:*`
`roles:uid:*` | List roles and read a specific with its permissions. | | `roles:write` | `permissions:type:delegate` | Create or update a custom role. | | `roles:write` | `permissions:type:escalate` | Reset basic roles to their default permissions. | | `server.stats:read` | n/a | Read Grafana instance statistics. | -| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings]({{< relref "../../administration/configuration/_index.md" >}}) | -| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime]({{< relref "../../enterprise/settings-updates/_index.md" >}}). | +| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings]({{< relref "../../setup-grafana/configure-grafana/" >}}) | +| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime]({{< relref "../settings-updates/" >}}). | | `status:accesscontrol` | `services:accesscontrol` | Get access-control enabled status. | | `teams.permissions:read` | `teams:*`
`teams:id:*` | Read members and External Group Synchronization setup for teams. | | `teams.permissions:write` | `teams:*`
`teams:id:*` | Add, remove and update members and manage External Group Synchronization setup for teams. | | `teams.roles:add` | `permissions:type:delegate` | Assign a role to a team. | -| `teams.roles:list` | `teams:*` | List roles assigned directly to a team. | +| `teams.roles:read` | `teams:*` | List roles assigned directly to a team. | | `teams.roles:remove` | `permissions:type:delegate` | Unassign a role from a team. | | `teams:create` | n/a | Create teams. | | `teams:delete` | `teams:*`
`teams:id:*` | Delete one or more teams. | | `teams:read` | `teams:*`
`teams:id:*` | Read one or more teams and team preferences. | | `teams:write` | `teams:*`
`teams:id:*` | Update one or more teams and team preferences. | -| `users.authtoken:list` | `global.users:*`
`global.users:id:*` | List authentication tokens that are assigned to a user. | -| `users.authtoken:update` | `global.users:*`
`global.users:id:*` | Update authentication tokens that are assigned to a user. | -| `users.password:update` | `global.users:*`
`global.users:id:*` | Update a user’s password. | -| `users.permissions:list` | `users:*` | List permissions of a user. | -| `users.permissions:update` | `global.users:*`
`global.users:id:*` | Update a user’s organization-level permissions. | -| `users.quotas:list` | `global.users:*`
`global.users:id:*` | List a user’s quotas. | -| `users.quotas:update` | `global.users:*`
`global.users:id:*` | Update a user’s quotas. | +| `users.authtoken:read` | `global.users:*`
`global.users:id:*` | List authentication tokens that are assigned to a user. | +| `users.authtoken:write` | `global.users:*`
`global.users:id:*` | Update authentication tokens that are assigned to a user. | +| `users.password:write` | `global.users:*`
`global.users:id:*` | Update a user’s password. | +| `users.permissions:read` | `users:*` | List permissions of a user. | +| `users.permissions:write` | `global.users:*`
`global.users:id:*` | Update a user’s organization-level permissions. | +| `users.quotas:read` | `global.users:*`
`global.users:id:*` | List a user’s quotas. | +| `users.quotas:write` | `global.users:*`
`global.users:id:*` | Update a user’s quotas. | | `users.roles:add` | `permissions:type:delegate` | Assign a role to a user. | -| `users.roles:list` | `users:*` | List roles assigned directly to a user. | +| `users.roles:read` | `users:*` | List roles assigned directly to a user. | | `users.roles:remove` | `permissions:type:delegate` | Unassign a role from a user. | -| `users.teams:read` | `global.users:*`
`global.users:id:*` | Read a user’s teams. | | `users:create` | n/a | Create a user. | | `users:delete` | `global.users:*`
`global.users:id:*` | Delete a user. | | `users:disable` | `global.users:*`
`global.users:id:*` | Disable a user. | @@ -146,7 +144,7 @@ The following list contains role-based access control scopes. | `orgs:*`
`orgs:id:*` | Restrict an action to a set of organizations. For example, `orgs:*` matches any organization and `orgs:id:1` matches the organization whose ID is `1`. | | `permissions:type:delegate` | The scope is only applicable for roles associated with the Access Control itself and indicates that you can delegate your permissions only, or a subset of it, by creating a new role or making an assignment. | | `permissions:type:escalate` | The scope is required to trigger the reset of basic roles permissions. It indicates that users might acquire additional permissions they did not previously have. | -| `provisioners:*` | Restrict an action to a set of provisioners. For example, `provisioners:*` matches any provisioner, and `provisioners:accesscontrol` matches the role-based access control [provisioner]({{< relref "./custom-role-actions-scopes" >}}). | +| `provisioners:*` | Restrict an action to a set of provisioners. For example, `provisioners:*` matches any provisioner, and `provisioners:accesscontrol` matches the role-based access control [provisioner]({{< relref "custom-role-actions-scopes/" >}}). | | `reports:*`
`reports:id:*` | Restrict an action to a set of reports. For example, `reports:*` matches any report and `reports:id:1` matches the report whose ID is `1`. | | `roles:*`
`roles:uid:*` | Restrict an action to a set of roles. For example, `roles:*` matches any role and `roles:uid:randomuid` matches only the role whose UID is `randomuid`. | | `services:accesscontrol` | Restrict an action to target only the role-based access control service. You can use this in conjunction with the `status:accesscontrol` actions. | diff --git a/docs/sources/enterprise/access-control/manage-rbac-roles.md b/docs/sources/enterprise/access-control/manage-rbac-roles.md index 3a8deebfdf4..4fca1e5095a 100644 --- a/docs/sources/enterprise/access-control/manage-rbac-roles.md +++ b/docs/sources/enterprise/access-control/manage-rbac-roles.md @@ -18,7 +18,7 @@ The following example includes the base64 username:password Basic Authorization. ### List permissions associated with roles -Use a `GET` command to see the actions and scopes associated with a role. For more information about seeing a list of permissions for each role, refer to [Get a role]({{< relref "../../developers/http_api/access_control.md#get-a-role" >}}). +Use a `GET` command to see the actions and scopes associated with a role. For more information about seeing a list of permissions for each role, refer to [Get a role]({{< relref "../../developers/http_api/access_control/#get-a-role" >}}). To see the permissions associated with basic roles, refer to the following basic role UIDs: @@ -65,7 +65,7 @@ curl --location --request GET '/api/access-control/roles/qQui_LCMk' "created": "2021-05-17T20:49:18+02:00" }, { - "action": "org.users.role:update", + "action": "org.users:write", "scope": "users:*", "updated": "2021-05-17T20:49:18+02:00", "created": "2021-05-17T20:49:18+02:00" @@ -76,7 +76,7 @@ curl --location --request GET '/api/access-control/roles/qQui_LCMk' } ``` -Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#get-a-role" >}}) for more details. +Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#get-a-role" >}}) for more details. ## Create custom roles @@ -86,9 +86,9 @@ Create a custom role when basic roles and fixed roles do not meet your permissio **Before you begin:** -- [Plan your RBAC rollout strategy]({{< relref "./plan-rbac-rollout-strategy" >}}). -- Determine which permissions you want to add to the custom role. To see a list of actions and scope, refer to [RBAC permissions actions and scopes]({{< relref "./custom-role-actions-scopes.md" >}}). -- [Enable role provisioning]({{< relref "./rbac-provisioning" >}}). +- [Plan your RBAC rollout strategy]({{< relref "plan-rbac-rollout-strategy/" >}}). +- Determine which permissions you want to add to the custom role. To see a list of actions and scope, refer to [RBAC permissions actions and scopes]({{< relref "custom-role-actions-scopes/" >}}). +- [Enable role provisioning]({{< relref "rbac-provisioning/" >}}). - Ensure that you have permissions to create a custom role. - By default, the Grafana Admin role has permission to create custom roles. - A Grafana Admin can delegate the custom role privilege to another user by creating a custom role with the relevant permissions and adding the `permissions:type:delegate` scope. @@ -101,21 +101,21 @@ File-based provisioning is one method you can use to create custom roles. 1. Refer to the following table to add attributes and values. -| Attribute | Description | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | A human-friendly identifier for the role that helps administrators understand the purpose of a role. `name` is required and cannot be longer than 190 characters. We recommend that you use ASCII characters. Role names must be unique within an organization. | -| `uid` | A unique identifier associated with the role. The UID enables you to change or delete the role. You can either generate a UID yourself, or let Grafana generate one for you. You cannot use the same UID within the same Grafana instance. | -| `orgId` | Identifies the organization to which the role belongs. The [default org ID]({{< relref "../../administration/configuration#auto_assign_org_id" >}}) is used if you do not specify `orgId`. | -| `global` | Global roles are not associated with any specific organization, which means that you can reuse them across all organizations. This setting overrides `orgId`. | -| `displayName` | Human-friendly text that is displayed in the UI. Role display name cannot be longer than 190 ASCII-based characters. For fixed roles, the display name is shown as specified. If you do not set a display name the display name replaces `':'` (a colon) with `' '` (a space). | -| `description` | Human-friendly text that describes the permissions a role provides. | -| `group` | Organizes roles in the role picker. | -| `version` | A positive integer that defines the current version of the role, which prevents overwriting newer changes. | -| `hidden` | Hidden roles do not appear in the role picker. | -| `state` | State of the role. Defaults to `present`, but if set to `absent` the role will be removed. | -| `force` | Can be used in addition to state `absent`, to force the removal of a role and all its assignments. | -| `from` | An optional list of roles from which you want to copy permissions. | -| `permissions` | Provides users access to Grafana resources. For a list of permissions, refer to [RBAC permissions actions and scopes]({{< relref "./rbac-fixed-basic-role-definitions.md" >}}). If you do not know which permissions to assign, you can create and assign roles without any permissions as a placeholder. Using the `from` attribute, you can specify additional permissions or permissions to remove by adding a `state` to your permission list. | +| Attribute | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | A human-friendly identifier for the role that helps administrators understand the purpose of a role. `name` is required and cannot be longer than 190 characters. We recommend that you use ASCII characters. Role names must be unique within an organization. | +| `uid` | A unique identifier associated with the role. The UID enables you to change or delete the role. You can either generate a UID yourself, or let Grafana generate one for you. You cannot use the same UID within the same Grafana instance. | +| `orgId` | Identifies the organization to which the role belongs. The [default org ID]({{< relref "../../setup-grafana/configure-grafana/#auto_assign_org_id" >}}) is used if you do not specify `orgId`. | +| `global` | Global roles are not associated with any specific organization, which means that you can reuse them across all organizations. This setting overrides `orgId`. | +| `displayName` | Human-friendly text that is displayed in the UI. Role display name cannot be longer than 190 ASCII-based characters. For fixed roles, the display name is shown as specified. If you do not set a display name the display name replaces `':'` (a colon) with `' '` (a space). | +| `description` | Human-friendly text that describes the permissions a role provides. | +| `group` | Organizes roles in the role picker. | +| `version` | A positive integer that defines the current version of the role, which prevents overwriting newer changes. | +| `hidden` | Hidden roles do not appear in the role picker. | +| `state` | State of the role. Defaults to `present`, but if set to `absent` the role will be removed. | +| `force` | Can be used in addition to state `absent`, to force the removal of a role and all its assignments. | +| `from` | An optional list of roles from which you want to copy permissions. | +| `permissions` | Provides users access to Grafana resources. For a list of permissions, refer to [RBAC permissions actions and scopes]({{< relref "rbac-fixed-basic-role-definitions/" >}}). If you do not know which permissions to assign, you can create and assign roles without any permissions as a placeholder. Using the `from` attribute, you can specify additional permissions or permissions to remove by adding a `state` to your permission list. | 1. Reload the provisioning configuration file. @@ -178,7 +178,7 @@ roles: - name: 'fixed:org.users:writer' global: true permissions: - - action: 'org.users.role:update' + - action: 'org.users:write' scope: 'users:*' state: 'absent' - action: 'org.users:add' @@ -188,7 +188,7 @@ roles: ### Create custom roles using the HTTP API -The following examples show you how to create a custom role using the Grafana HTTP API. For more information about the HTTP API, refer to [Create a new custom role]({{< relref "../../developers/http_api/access_control.md#create-a-new-custom-role" >}}). +The following examples show you how to create a custom role using the Grafana HTTP API. For more information about the HTTP API, refer to [Create a new custom role]({{< relref "../../developers/http_api/access_control/#create-a-new-custom-role" >}}). > **Note:** You cannot create a custom role with permissions that you do not have. For example, if you only have `users:create` permissions, then you cannot create a role that includes other permissions. @@ -237,7 +237,7 @@ curl --location --request POST '/api/access-control/roles/' \ } ``` -Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#create-a-new-custom-role" >}}) for more details. +Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#create-a-new-custom-role" >}}) for more details. ## Update basic role permissions @@ -245,7 +245,7 @@ If the default basic role definitions do not meet your requirements, you can cha **Before you begin:** -- Determine the permissions you want to add or remove from a basic role. For more information about the permissions associated with basic roles, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions#basic-role-assignments" >}}). +- Determine the permissions you want to add or remove from a basic role. For more information about the permissions associated with basic roles, refer to [RBAC role definitions]({{< relref "rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}). **To change permissions from a basic role:** @@ -283,7 +283,7 @@ roles: global: true permissions: # Permissions to remove - - action: 'teams.roles:list' + - action: 'teams.roles:read' scope: 'teams:*' state: 'absent' - action: 'teams.roles:remove' @@ -302,7 +302,7 @@ roles: > **Note**: You can add multiple `fixed`, `basic` or `custom` roles to the `from` section. Their permissions will be copied and added to the basic role. >
**Note**: Make sure to **increment** the role version for the changes to be accounted for. -You can also change basic roles' permissions using the API. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#update-a-role" >}}) for more details. +You can also change basic roles' permissions using the API. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#update-a-role" >}}) for more details. ## Reset basic roles to their default @@ -327,7 +327,7 @@ This section describes how to reset the basic roles to their default: scope: 'permissions:type:escalate' ``` -1. As a `Grafana Admin`, call the API endpoint to reset the basic roles to their default. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#reset-basic-roles-to-their-default" >}}) for more details. +1. As a `Grafana Admin`, call the API endpoint to reset the basic roles to their default. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#reset-basic-roles-to-their-default" >}}) for more details. ## Delete a custom role using Grafana provisioning @@ -368,4 +368,4 @@ roles: force: true ``` -You can also delete a custom role using the API. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#delete-a-custom-role" >}}) for more details. +You can also delete a custom role using the API. Refer to the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#delete-a-custom-role" >}}) for more details. diff --git a/docs/sources/enterprise/access-control/plan-rbac-rollout-strategy.md b/docs/sources/enterprise/access-control/plan-rbac-rollout-strategy.md index d2c07ba4ecc..cfa180ec896 100644 --- a/docs/sources/enterprise/access-control/plan-rbac-rollout-strategy.md +++ b/docs/sources/enterprise/access-control/plan-rbac-rollout-strategy.md @@ -27,8 +27,8 @@ As a first step in determining your permissions rollout strategy, we recommend t To learn more about basic roles and fixed roles, refer to the following documentation: -- [Basic role definitions]({{< relref "./rbac-fixed-basic-role-definitions#basic-role-assignments" >}}) -- [Fixed role definitions]({{< relref "./rbac-fixed-basic-role-definitions#fixed-role-definitions" >}}) +- [Basic role definitions]({{< relref "rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}) +- [Fixed role definitions]({{< relref "rbac-fixed-basic-role-definitions/#fixed-role-definitions" >}}) ## User and team considerations @@ -52,7 +52,7 @@ For example: - If a team does not exist in Grafana, team sync creates it. - If a team exists in Grafana, team sync updates its membership. - For more information about team sync, refer to [Team sync]({{< relref "../team-sync.md" >}}). + For more information about team sync, refer to [Team sync]({{< relref "../../setup-grafana/configure-security/configure-team-sync/" >}}). 3. Within Grafana, assign RBAC permissions to users and teams. @@ -62,7 +62,7 @@ Consider the following guidelines when you determine if you should modify basic - **Modify basic roles** when Grafana's definitions of what viewers, editors, and admins can do does not match your definition of these roles. You can add or remove permissions from any basic role. - > **Note:** Changes that you make to basic roles impact the role definition for all [organizations]({{< relref "../../administration/manage-organizations/_index.md" >}}) in the Grafana instance. For example, when you add the `fixed:users:writer` role's permissions to the viewer basic role, all viewers in any org in the Grafana instance can create users within that org. + > **Note:** Changes that you make to basic roles impact the role definition for all [organizations]({{< relref "../../administration/manage-organizations/" >}}) in the Grafana instance. For example, when you add the `fixed:users:writer` role's permissions to the viewer basic role, all viewers in any org in the Grafana instance can create users within that org. - **Create custom roles** when fixed role definitions don't meet you permissions requirements. For example, the `fixed:dashboards:writer` role allows users to delete dashboards. If you want some users or teams to be able to create and update but not delete dashboards, you can create a custom role with a name like `custom:dashboards:creator` that lacks the `dashboards:delete` permission. @@ -85,13 +85,13 @@ We've compiled the following permissions rollout scenarios based on current Graf 1. In Grafana, create a team with the name `Internal employees`. 1. Assign the `fixed:datasources:querier` role to the `Internal employees` team. -1. Add internal employees to the `Internal employees` team, or map them from a SAML, LDAP, or Oauth team using [Team Sync]({{< relref "../team-sync.md" >}}). +1. Add internal employees to the `Internal employees` team, or map them from a SAML, LDAP, or Oauth team using [Team Sync]({{< relref "../../setup-grafana/configure-security/configure-team-sync/" >}}). 1. Assign the viewer role to both internal employees and contractors. ### Limit viewer, editor, or admin permissions 1. Review the list of permissions associated with the basic role. -1. [Change the permissions of the basic role]({{< relref "manage-rbac-roles.md#update-basic-role-permissions" >}}). +1. [Change the permissions of the basic role]({{< relref "manage-rbac-roles/#update-basic-role-permissions" >}}). ### Allow only members of one team to manage Alerts @@ -169,11 +169,10 @@ roles: global: true ``` -- Or add the following permissions to the `basic:editor` role, using provisioning or the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#update-a-role" >}}): +- Or add the following permissions to the `basic:editor` role, using provisioning or the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#update-a-role" >}}): | action | scope | | -------------- | --------------------------- | -| `roles:list` | `roles:*` | | `roles:read` | `roles:*` | | `roles:write` | `permissions:type:delegate` | | `roles:delete` | `permissions:type:delegate` | @@ -200,16 +199,16 @@ roles: global: true ``` -> **Note:** The `fixed:reports:writer` role assigns more permissions than just creating reports. For more information about fixed role permission assignments, refer to [Fixed role definitions]({{< relref "./rbac-fixed-basic-role-definitions#fixed-role-definitions" >}}). +> **Note:** The `fixed:reports:writer` role assigns more permissions than just creating reports. For more information about fixed role permission assignments, refer to [Fixed role definitions]({{< relref "rbac-fixed-basic-role-definitions/#fixed-role-definitions" >}}). -- Add the following permissions to the `basic:viewer` role, using provisioning or the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#update-a-role" >}}): +- Add the following permissions to the `basic:viewer` role, using provisioning or the [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#update-a-role" >}}): -| Action | Scope | -| ---------------------- | ------------------------------- | -| `reports.admin:create` | n/a | -| `reports.admin:write` | `reports:*`
`reports:id:*` | -| `reports:read` | `reports:*` | -| `reports:send` | `reports:*` | +| Action | Scope | +| ---------------- | ------------------------------- | +| `reports:create` | n/a | +| `reports:write` | `reports:*`
`reports:id:*` | +| `reports:read` | `reports:*` | +| `reports:send` | `reports:*` | ### Prevent a Grafana Admin from creating and inviting users @@ -243,4 +242,4 @@ roles: state: 'absent' ``` -- Or use [RBAC HTTP API]({{< relref "../../developers/http_api/access_control.md#update-a-role" >}}). +- Or use [RBAC HTTP API]({{< relref "../../developers/http_api/access_control/#update-a-role" >}}). diff --git a/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md b/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md index 71d56c6528b..87cae925eed 100644 --- a/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md +++ b/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md @@ -15,76 +15,76 @@ The following tables list permissions associated with basic and fixed roles. ## Basic role assignments -| Basic role | Associated fixed roles | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Grafana Admin | `fixed:roles:reader`
`fixed:roles:writer`
`fixed:users:reader`
`fixed:users:writer`
`fixed:org.users:reader`
`fixed:org.users:writer`
`fixed:ldap:reader`
`fixed:ldap:writer`
`fixed:stats:reader`
`fixed:settings:reader`
`fixed:settings:writer`
`fixed:provisioning:writer`
`fixed:organization:reader`
`fixed:organization:maintainer`
`fixed:licensing:reader`
`fixed:licensing:writer` | Default [Grafana server administrator]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#grafana-server-administrators" >}}) assignments. | -| Admin | `fixed:reports:reader`
`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:folders:reader`
`fixes:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:editor`
`fixed:apikeys:reader`
`fixed:apikeys:writer` | Default [Grafana organization administrator]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}) assignments. | -| Editor | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:editor` | Default [Editor]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}) assignments. | -| Viewer | `fixed:datasources:id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader` | Default [Viewer]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#organization-users-and-permissions" >}}) assignments. | +| Basic role | Associated fixed roles | Description | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Grafana Admin | `fixed:roles:reader`
`fixed:roles:writer`
`fixed:users:reader`
`fixed:users:writer`
`fixed:org.users:reader`
`fixed:org.users:writer`
`fixed:ldap:reader`
`fixed:ldap:writer`
`fixed:stats:reader`
`fixed:settings:reader`
`fixed:settings:writer`
`fixed:provisioning:writer`
`fixed:organization:reader`
`fixed:organization:maintainer`
`fixed:licensing:reader`
`fixed:licensing:writer` | Default [Grafana server administrator]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/#grafana-server-administrators" >}}) assignments. | +| Admin | `fixed:reports:reader`
`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:folders:reader`
`fixes:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:editor`
`fixed:apikeys:reader`
`fixed:apikeys:writer` | Default [Grafana organization administrator]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/#organization-users-and-permissions" >}}) assignments. | +| Editor | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:editor` | Default [Editor]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/#organization-users-and-permissions" >}}) assignments. | +| Viewer | `fixed:datasources:id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader` | Default [Viewer]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/#organization-users-and-permissions" >}}) assignments. | ## Fixed role definitions -| Fixed role | Permissions | Description | -| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fixed:alerting.instances:editor` | All permissions from `fixed:alerting.instances:reader` and
`alert.instances:create`
`alert.instances:update` for organization scope
`alert.instances.external:write` for scope `datasources:*` | Create, update and expire all silences in the organization produced by Grafana, Mimir, and Loki.[\*](#alerting-roles) | -| `fixed:alerting.instances:reader` | `alert.instances:read` for organization scope
`alert.instances.external:read` for scope `datasources:*` | Read all alerts and silences in the organization produced by Grafana Alerts and Mimir and Loki alerts and silences.[\*](#alerting-roles) | -| `fixed:alerting.notifications:editor` | All permissions from `fixed:alerting.notifications:reader` and
`alert.notifications:write`for organization scope
`alert.notifications.external:read` for scope `datasources:*` | Create, update, and delete contact points, templates, mute timings and notification policies for Grafana and external Alertmanager.[\*](#alerting-roles) | -| `fixed:alerting.notifications:reader` | `alert.notifications:read` for organization scope
`alert.notifications.external:read` for scope `datasources:*` | Read all Grafana and Alertmanager contact points, templates, and notification policies.[\*](#alerting-roles) | -| `fixed:alerting.rules:editor` | All permissions from `fixed:alerting.rules:reader` and
`alert.rule:create`
`alert.rule:update`
`alert.rule:delete` for scope `folders:*`
`alert.rules.external:write` for scope `datasources:*` | Create, update, and delete all\* Grafana, Mimir, and Loki alert rules.[\*](#alerting-roles) | -| `fixed:alerting.rules:reader` | `alert.rule:read` for scope `folders:*`
`alert.rules.external:read` for scope `datasources:*` | Read all\* Grafana, Mimir, and Loki alert rules.[\*](#alerting-roles) | -| `fixed:alerting:editor` | All permissions from `fixed:alerting.rules:editor`
`fixed:alerting.instances:editor`
`fixed:alerting.notifications:editor` | Create, update, and delete Grafana, Mimir, Loki and Alertmanager alert rules\*, silences, contact points, templates, mute timings, and notification policies.[\*](#alerting-roles) | -| `fixed:alerting:reader` | All permissions from `fixed:alerting.rules:reader`
`fixed:alerting.instances:reader`
`fixed:alerting.notifications:reader` | Read-only permissions for all Grafana, Mimir, Loki and Alertmanager alert rules\*, alerts, contact points, and notification policies.[\*](#alerting-roles) | -| `fixed:annotations.dashboard:writer` | `annotations:write`
`annotations.create`
`annotations:delete` for scope `annotations:type:dashboard` | Create, update and delete dashboard annotations and annotation tags. | -| `fixed:annotations:reader` | `annotations:read` for scopes `annotations:type:*` | Read all annotations and annotation tags. | -| `fixed:annotations:writer` | All permissions from `fixed:annotations:reader`
`annotations:write`
`annotations.create`
`annotations:delete` for scope `annotations:type:*` | Read, create, update and delete all annotations and annotation tags. | -| `fixed:apikeys:reader` | `apikeys:read` for scope `apikeys:*` | Read all api keys. | -| `fixed:apikeys:writer` | All permissions from `fixed:apikeys:reader` and
`apikeys:create`
`apikeys:delete` for scope `apikeys:*` | Read, create, delete all api keys. | -| `fixed:dashboards.permissions:reader` | `dashboards.permissions:read` | Read all dashboard permissions. | -| `fixed:dashboards.permissions:writer` | All permissions from `fixed:dashboards.permissions:reader` and
`dashboards.permissions:write` | Read and update all dashboard permissions. | -| `fixed:dashboards:creator` | `dashboards:create`
`folders:read` | Create dashboards. | -| `fixed:dashboards:reader` | `dashboards:read` | Read all dashboards. | -| `fixed:dashboards:writer` | All permissions from `fixed:dashboards:reader` and
`dashboards:write`
`dashboards:edit`
`dashboards:delete`
`dashboards:create`
`dashboards.permissions:read`
`dashboards.permissions:write` | Read, create, update, and delete all dashboards. | -| `fixed:datasources.permissions:reader` | `datasources.permissions:read` | Read data source permissions. | -| `fixed:datasources.permissions:writer` | All permissions from `fixed:datasources.permissions:reader` and
`datasources.permissions:write` | Create, read, or delete permissions of a data source. | -| `fixed:datasources:explorer` | `datasources:explore` | Enable the Explore feature. Data source permissions still apply, you can only query data sources for which you have query permissions. | -| `fixed:datasources:id:reader` | `datasources.id:read` | Read the ID of a data source based on its name. | -| `fixed:datasources:reader` | `datasources:read`
`datasources:query` | Read and query data sources. | -| `fixed:datasources:writer` | All permissions from `fixed:datasources:reader` and
`datasources:create`
`datasources:write`
`datasources:delete` | Read, query, create, delete, or update a data source. | -| `fixed:folders.permissions:reader` | `folders.permissions:read` | Read all folder permissions. | -| `fixed:folders.permissions:writer` | All permissions from `fixed:folders.permissions:reader` and
`folders.permissions:write` | Read and update all folder permissions. | -| `fixed:folders:creator` | `folders:create` | Create folders. | -| `fixed:folders:reader` | `folders:read`
`dashboards:read` | Read all folders and dashboards. | -| `fixed:folders:writer` | All permissions from `fixed:dashboards:writer` and
`folders:read`
`folders:write`
`folders:create`
`folders:delete`
`folders.permissions:read`
`folders.permissions:write` | Read, create, update, and delete all folders and dashboards. | -| `fixed:ldap:reader` | `ldap.user:read`
`ldap.status:read` | Read the LDAP configuration and LDAP status information. | -| `fixed:ldap:writer` | All permissions from `fixed:ldap:reader` and
`ldap.user:sync`
`ldap.config:reload` | Read and update the LDAP configuration, and read LDAP status information. | -| `fixed:licensing:reader` | `licensing:read`
`licensing.reports:read` | Read licensing information and licensing reports. | -| `fixed:licensing:writer` | All permissions from `fixed:licensing:viewer` and
`licensing:update`
`licensing:delete` | Read licensing information and licensing reports, update and delete the license token. | -| `fixed:org.users:reader` | `org.users:read` | Read users within a single organization. | -| `fixed:org.users:writer` | All permissions from `fixed:org.users:reader` and
`org.users:add`
`org.users:remove`
`org.users.role:update` | Within a single organization, add a user, invite a user, read information about a user and their role, remove a user from that organization, or change the role of a user. | -| `fixed:organization:maintainer` | All permissions from `fixed:organization:reader` and
`orgs:write`
`orgs:create`
`orgs:delete`
`orgs.quotas:write` | Create, read, write, or delete an organization. Read or write its quotas. This role needs to be assigned globally. | -| `fixed:organization:reader` | `orgs:read`
`orgs.quotas:read` | Read an organization and its quotas. | -| `fixed:organization:writer` | All permissions from `fixed:organization:reader` and
`orgs:write`
`orgs.preferences:read`
`orgs.preferences:write` | Read an organization, its quotas, or its preferences. Update organization properties, or its preferences. | -| `fixed:provisioning:writer` | `provisioning:reload` | Reload provisioning. | -| `fixed:reports:reader` | `reports:read`
`reports:send`
`reports.settings:read` | Read all reports and shared report settings. | -| `fixed:reports:writer` | All permissions from `fixed:reports:reader` and
`reports.admin:write`
`reports:delete`
`reports.settings:write` | Create, read, update, or delete all reports and shared report settings. | -| `fixed:roles:reader` | `roles:read`
`roles:list`
`teams.roles:list`
`users.roles:list`
`users.permissions:list` | Read all access control roles, roles and permissions assigned to users, teams. | -| `fixed:roles:writer` | All permissions from `fixed:roles:reader` and
`roles:write`
`roles:delete`
`teams.roles:add`
`teams.roles:remove`
`users.roles:add`
`users.roles:remove` | Create, read, update, or delete all roles, assign or unassign roles to users, teams. | -| `fixed:roles:resetter` | `roles:write` with scope `permissions:type:escalate` | Reset basic roles to their default. | -| `fixed:settings:reader` | `settings:read` | Read Grafana instance settings. | -| `fixed:settings:writer` | All permissions from `fixed:settings:reader` and
`settings:write` | Read and update Grafana instance settings. | -| `fixed:stats:reader` | `server.stats:read` | Read Grafana instance statistics. | -| `fixed:teams:creator` | `teams:create`
`org.users:read` | Create a team and list organization users (required to manage the created team). | -| `fixed:teams:writer` | `teams:create`
`teams:delete`
`teams:read`
`teams:write`
`teams.permissions:read`
`teams.permissions:write` | Create, read, update and delete teams and manage team memberships. | -| `fixed:users:reader` | `users:read`
`users.quotas:list`
`users.authtoken:list`
`users.teams:read` | Read all users and their information, such as team memberships, authentication tokens, and quotas. | -| `fixed:users:writer` | All permissions from `fixed:users:reader` and
`users:write`
`users:create`
`users:delete`
`users:enable`
`users:disable`
`users.password:update`
`users.permissions:update`
`users:logout`
`users.authtoken:update`
`users.quotas:update` | Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users. | +| Fixed role | Permissions | Description | +| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fixed:alerting.instances:editor` | All permissions from `fixed:alerting.instances:reader` and
`alert.instances:create`
`alert.instances:write` for organization scope
`alert.instances.external:write` for scope `datasources:*` | Create, update and expire all silences in the organization produced by Grafana, Mimir, and Loki.[\*](#alerting-roles) | +| `fixed:alerting.instances:reader` | `alert.instances:read` for organization scope
`alert.instances.external:read` for scope `datasources:*` | Read all alerts and silences in the organization produced by Grafana Alerts and Mimir and Loki alerts and silences.[\*](#alerting-roles) | +| `fixed:alerting.notifications:editor` | All permissions from `fixed:alerting.notifications:reader` and
`alert.notifications:write`for organization scope
`alert.notifications.external:read` for scope `datasources:*` | Create, update, and delete contact points, templates, mute timings and notification policies for Grafana and external Alertmanager.[\*](#alerting-roles) | +| `fixed:alerting.notifications:reader` | `alert.notifications:read` for organization scope
`alert.notifications.external:read` for scope `datasources:*` | Read all Grafana and Alertmanager contact points, templates, and notification policies.[\*](#alerting-roles) | +| `fixed:alerting.rules:editor` | All permissions from `fixed:alerting.rules:reader` and
`alert.rule:create`
`alert.rule:write`
`alert.rule:delete` for scope `folders:*`
`alert.rules.external:write` for scope `datasources:*` | Create, update, and delete all\* Grafana, Mimir, and Loki alert rules.[\*](#alerting-roles) | +| `fixed:alerting.rules:reader` | `alert.rule:read` for scope `folders:*`
`alert.rules.external:read` for scope `datasources:*` | Read all\* Grafana, Mimir, and Loki alert rules.[\*](#alerting-roles) | +| `fixed:alerting:editor` | All permissions from `fixed:alerting.rules:editor`
`fixed:alerting.instances:editor`
`fixed:alerting.notifications:editor` | Create, update, and delete Grafana, Mimir, Loki and Alertmanager alert rules\*, silences, contact points, templates, mute timings, and notification policies.[\*](#alerting-roles) | +| `fixed:alerting:reader` | All permissions from `fixed:alerting.rules:reader`
`fixed:alerting.instances:reader`
`fixed:alerting.notifications:reader` | Read-only permissions for all Grafana, Mimir, Loki and Alertmanager alert rules\*, alerts, contact points, and notification policies.[\*](#alerting-roles) | +| `fixed:annotations.dashboard:writer` | `annotations:write`
`annotations.create`
`annotations:delete` for scope `annotations:type:dashboard` | Create, update and delete dashboard annotations and annotation tags. | +| `fixed:annotations:reader` | `annotations:read` for scopes `annotations:type:*` | Read all annotations and annotation tags. | +| `fixed:annotations:writer` | All permissions from `fixed:annotations:reader`
`annotations:write`
`annotations.create`
`annotations:delete` for scope `annotations:type:*` | Read, create, update and delete all annotations and annotation tags. | +| `fixed:apikeys:reader` | `apikeys:read` for scope `apikeys:*` | Read all api keys. | +| `fixed:apikeys:writer` | All permissions from `fixed:apikeys:reader` and
`apikeys:create`
`apikeys:delete` for scope `apikeys:*` | Read, create, delete all api keys. | +| `fixed:dashboards.permissions:reader` | `dashboards.permissions:read` | Read all dashboard permissions. | +| `fixed:dashboards.permissions:writer` | All permissions from `fixed:dashboards.permissions:reader` and
`dashboards.permissions:write` | Read and update all dashboard permissions. | +| `fixed:dashboards:creator` | `dashboards:create`
`folders:read` | Create dashboards. | +| `fixed:dashboards:reader` | `dashboards:read` | Read all dashboards. | +| `fixed:dashboards:writer` | All permissions from `fixed:dashboards:reader` and
`dashboards:write`
`dashboards:edit`
`dashboards:delete`
`dashboards:create`
`dashboards.permissions:read`
`dashboards.permissions:write` | Read, create, update, and delete all dashboards. | +| `fixed:datasources.permissions:reader` | `datasources.permissions:read` | Read data source permissions. | +| `fixed:datasources.permissions:writer` | All permissions from `fixed:datasources.permissions:reader` and
`datasources.permissions:write` | Create, read, or delete permissions of a data source. | +| `fixed:datasources:explorer` | `datasources:explore` | Enable the Explore feature. Data source permissions still apply, you can only query data sources for which you have query permissions. | +| `fixed:datasources:id:reader` | `datasources.id:read` | Read the ID of a data source based on its name. | +| `fixed:datasources:reader` | `datasources:read`
`datasources:query` | Read and query data sources. | +| `fixed:datasources:writer` | All permissions from `fixed:datasources:reader` and
`datasources:create`
`datasources:write`
`datasources:delete` | Read, query, create, delete, or update a data source. | +| `fixed:folders.permissions:reader` | `folders.permissions:read` | Read all folder permissions. | +| `fixed:folders.permissions:writer` | All permissions from `fixed:folders.permissions:reader` and
`folders.permissions:write` | Read and update all folder permissions. | +| `fixed:folders:creator` | `folders:create` | Create folders. | +| `fixed:folders:reader` | `folders:read`
`dashboards:read` | Read all folders and dashboards. | +| `fixed:folders:writer` | All permissions from `fixed:dashboards:writer` and
`folders:read`
`folders:write`
`folders:create`
`folders:delete`
`folders.permissions:read`
`folders.permissions:write` | Read, create, update, and delete all folders and dashboards. | +| `fixed:ldap:reader` | `ldap.user:read`
`ldap.status:read` | Read the LDAP configuration and LDAP status information. | +| `fixed:ldap:writer` | All permissions from `fixed:ldap:reader` and
`ldap.user:sync`
`ldap.config:reload` | Read and update the LDAP configuration, and read LDAP status information. | +| `fixed:licensing:reader` | `licensing:read`
`licensing.reports:read` | Read licensing information and licensing reports. | +| `fixed:licensing:writer` | All permissions from `fixed:licensing:viewer` and
`licensing:write`
`licensing:delete` | Read licensing information and licensing reports, update and delete the license token. | +| `fixed:org.users:reader` | `org.users:read` | Read users within a single organization. | +| `fixed:org.users:writer` | All permissions from `fixed:org.users:reader` and
`org.users:add`
`org.users:remove`
`org.users:write` | Within a single organization, add a user, invite a user, read information about a user and their role, remove a user from that organization, or change the role of a user. | +| `fixed:organization:maintainer` | All permissions from `fixed:organization:reader` and
`orgs:write`
`orgs:create`
`orgs:delete`
`orgs.quotas:write` | Create, read, write, or delete an organization. Read or write its quotas. This role needs to be assigned globally. | +| `fixed:organization:reader` | `orgs:read`
`orgs.quotas:read` | Read an organization and its quotas. | +| `fixed:organization:writer` | All permissions from `fixed:organization:reader` and
`orgs:write`
`orgs.preferences:read`
`orgs.preferences:write` | Read an organization, its quotas, or its preferences. Update organization properties, or its preferences. | +| `fixed:provisioning:writer` | `provisioning:reload` | Reload provisioning. | +| `fixed:reports:reader` | `reports:read`
`reports:send`
`reports.settings:read` | Read all reports and shared report settings. | +| `fixed:reports:writer` | All permissions from `fixed:reports:reader` and
`reports:create`
`reports:write`
`reports:delete`
`reports.settings:write` | Create, read, update, or delete all reports and shared report settings. | +| `fixed:roles:reader` | `roles:read`
`teams.roles:read`
`users.roles:read`
`users.permissions:read` | Read all access control roles, roles and permissions assigned to users, teams. | +| `fixed:roles:writer` | All permissions from `fixed:roles:reader` and
`roles:write`
`roles:delete`
`teams.roles:add`
`teams.roles:remove`
`users.roles:add`
`users.roles:remove` | Create, read, update, or delete all roles, assign or unassign roles to users, teams. | +| `fixed:roles:resetter` | `roles:write` with scope `permissions:type:escalate` | Reset basic roles to their default. | +| `fixed:settings:reader` | `settings:read` | Read Grafana instance settings. | +| `fixed:settings:writer` | All permissions from `fixed:settings:reader` and
`settings:write` | Read and update Grafana instance settings. | +| `fixed:stats:reader` | `server.stats:read` | Read Grafana instance statistics. | +| `fixed:teams:creator` | `teams:create`
`org.users:read` | Create a team and list organization users (required to manage the created team). | +| `fixed:teams:writer` | `teams:create`
`teams:delete`
`teams:read`
`teams:write`
`teams.permissions:read`
`teams.permissions:write` | Create, read, update and delete teams and manage team memberships. | +| `fixed:users:reader` | `users:read`
`users.quotas:read`
`users.authtoken:read`
` | Read all users and their information, such as team memberships, authentication tokens, and quotas. | +| `fixed:users:writer` | All permissions from `fixed:users:reader` and
`users:write`
`users:create`
`users:delete`
`users:enable`
`users:disable`
`users.password:write`
`users.permissions:write`
`users:logout`
`users.authtoken:write`
`users.quotas:write` | Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users. | ### Alerting roles -If alerting is [enabled]({{< relref "../../alerting/opt-in.md" >}}), you can use predefined roles to manage user access to alert rules, alert instances, and alert notification settings and create custom roles to limit user access to alert rules in a folder. +If alerting is [enabled]({{< relref "../../alerting/migrating-alerts/opt-out/" >}}), you can use predefined roles to manage user access to alert rules, alert instances, and alert notification settings and create custom roles to limit user access to alert rules in a folder. Access to Grafana alert rules is an intersection of many permissions: - Permission to read a folder. For example, the fixed role `fixed:folders:reader` includes the action `folders:read` and a folder scope `folders:id:`. - Permission to query **all** data sources that a given alert rule uses. If a user cannot query a given data source, they cannot see any alert rules that query that data source. -For more information about the permissions required to access alert rules, refer to [Create a custom role to access alerts in a folder]({{< relref "./plan-rbac-rollout-strategy#create-a-custom-role-to-access-alerts-in-a-folder" >}}). +For more information about the permissions required to access alert rules, refer to [Create a custom role to access alerts in a folder]({{< relref "plan-rbac-rollout-strategy/#create-a-custom-role-to-access-alerts-in-a-folder" >}}). diff --git a/docs/sources/enterprise/access-control/rbac-provisioning.md b/docs/sources/enterprise/access-control/rbac-provisioning.md index 0d767e05067..501fa4f95f8 100644 --- a/docs/sources/enterprise/access-control/rbac-provisioning.md +++ b/docs/sources/enterprise/access-control/rbac-provisioning.md @@ -1,7 +1,8 @@ --- aliases: - /docs/grafana/latest/enterprise/access-control/rbac-provisioning/ -description: Learn about RBAC provisioning and view an example YAML provisioning file that configures Grafana role assignments. +description: Learn about RBAC provisioning and view an example YAML provisioning file + that configures Grafana role assignments. menuTitle: RBAC provisioning title: Grafana RBAC provisioning weight: 60 @@ -9,7 +10,7 @@ weight: 60 # Grafana RBAC provisioning -You can create, change or remove [Custom roles]({{< relref "./manage-rbac-roles.md#create-custom-roles-using-provisioning" >}}) and create or remove [basic role assignments]({{< relref "./assign-rbac-roles.md#assign-a-fixed-role-to-a-basic-role-using-provisioning" >}}), by adding one or more YAML configuration files in the `provisioning/access-control/` directory. +You can create, change or remove [Custom roles]({{< relref "manage-rbac-roles/#create-custom-roles-using-provisioning" >}}) and create or remove [basic role assignments]({{< relref "assign-rbac-roles/#assign-a-fixed-role-to-a-basic-role-using-provisioning" >}}), by adding one or more YAML configuration files in the `provisioning/access-control/` directory. If you choose to use provisioning to assign and manage role, you must first enable it. @@ -27,11 +28,11 @@ Grafana performs provisioning during startup. After you make a change to the con 3. Create a new YAML in the following folder: **provisioning/access-control**. For example, `provisioning/access-control/custom-roles.yml` -4. Add RBAC provisioning details to the configuration file. See [manage RBAC roles]({{< relref "manage-rbac-roles.md" >}}) and [assign RBAC roles]({{< relref "assign-rbac-roles.md" >}}) for instructions, and see this [example role provisioning file]({{< relref "rbac-provisioning#example" >}}) for a complete example of a provisioning file. +4. Add RBAC provisioning details to the configuration file. See [manage RBAC roles]({{< relref "manage-rbac-roles/" >}}) and [assign RBAC roles]({{< relref "assign-rbac-roles/" >}}) for instructions, and see this [example role provisioning file]({{< relref "rbac-provisioning/#example" >}}) for a complete example of a provisioning file. 5. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../developers/http_api/admin/#reload-provisioning-configurations" >}}). ## Example role configuration file using Grafana provisioning diff --git a/docs/sources/enterprise/datasource_permissions.md b/docs/sources/enterprise/datasource_permissions.md index 76fb1c0c9e6..a4967eaa402 100644 --- a/docs/sources/enterprise/datasource_permissions.md +++ b/docs/sources/enterprise/datasource_permissions.md @@ -1,16 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/datasource_permissions/", "/docs/sources/permissions/datasource_permissions/"] -description = "Grafana Datasource Permissions Guide" -keywords = ["grafana", "configuration", "documentation", "datasource", "permissions", "users", "teams", "enterprise"] -title = "Data source permissions" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/datasource_permissions/ + - /docs/sources/permissions/datasource_permissions/ +description: Grafana Datasource Permissions Guide +keywords: + - grafana + - configuration + - documentation + - datasource + - permissions + - users + - teams + - enterprise +title: Data source permissions +weight: 500 +--- # Data source permissions Data source permissions allow you to restrict access for users to query a data source. For each data source there is a permission page that allows you to enable permissions and restrict query permissions to specific **Users** and **Teams**. -> Only available in Grafana Enterprise. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). ## Enable data source permissions diff --git a/docs/sources/enterprise/enterprise-encryption/_index.md b/docs/sources/enterprise/enterprise-encryption/_index.md deleted file mode 100644 index 87d9862f054..00000000000 --- a/docs/sources/enterprise/enterprise-encryption/_index.md +++ /dev/null @@ -1,35 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-encryption/"] -description = "Grafana Enterprise database encryption" -keywords = ["grafana", "enterprise", "database", "encryption", "documentation"] -title = "Enterprise database encryption" -weight = 130 -+++ - -# Grafana Enterprise database encryption - -If you are using Grafana Enterprise, you can integrate with a key management system (KMS) provider, and change Grafana’s cryptographic mode of operation from AES-CFB to AES-GCM. - -## Encrypting your database with a key from a Key Management System (KMS) - -You can choose to encrypt secrets stored in the Grafana database using a key from a KMS, which is a secure central storage location that is designed to help you to create and manage cryptographic keys and control their use across many services. When you integrate with a KMS, Grafana does not directly store your encryption key. Instead, Grafana stores KMS credentials and the identifier of the key, which Grafana uses to encrypt the database. - -Grafana integrates with the following key management systems: - -- [AWS KMS]({{< relref "using-aws-kms-to-encrypt-database-secrets.md" >}}) -- [Azure Key Vault]({{< relref "using-azure-key-vault-to-encrypt-database-secrets.md" >}}) -- [Google Cloud KMS]({{< relref "using-google-cloud-kms-to-encrypt-database-secrets.md" >}}) -- [Hashicorp Key Vault]({{< relref "using-hashicorp-key-vault-to-encrypt-database-secrets.md" >}}) - -Refer to [Database encryption]({{< relref "../../administration/database-encryption.md" >}}) to learn more about how Grafana encrypts secrets in the database. - -## Changing your encryption mode to AES-GCM - -Grafana encrypts secrets using Advanced Encryption Standard in Cipher -FeedBack mode (AES-CFB). You might prefer to use AES in Galois/Counter -Mode (AES-GCM) instead, to meet your company’s security requirements or -in order to maintain consistency with other services. - -To change your encryption mode, update the `algorithm` value in the -`[security.encryption]` section of your Grafana configuration file. -For details, refer to [Enterprise configuration]({{< relref "../enterprise-configuration.md#securityencryption" >}}). diff --git a/docs/sources/enterprise/export-pdf.md b/docs/sources/enterprise/export-pdf.md index c7f7b97d28a..aa593c0ccdb 100644 --- a/docs/sources/enterprise/export-pdf.md +++ b/docs/sources/enterprise/export-pdf.md @@ -1,18 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/export-pdf/"] -description = "" -keywords = ["grafana", "export", "pdf", "share"] -title = "Export dashboard as PDF" -weight = 1400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/export-pdf/ +description: '' +keywords: + - grafana + - export + - pdf + - share +title: Export dashboard as PDF +weight: 1400 +--- # Export dashboard as PDF -You can generate PDFs from any of your dashboards and save it to file. +You can generate and save PDF files from any of your dashboards. -> Only available in Grafana Enterprise v6.7+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}). 1. In the upper right corner of the dashboard that you want to export as PDF, click the **Share dashboard** icon. 1. On the PDF tab, select the layout option for exported dashboard: **Portrait** or **Landscape**. -1. Click **Save as PDF** to render dashboard as a PDF document. - Grafana opens the PDF in a new window or browser tab. +1. Click **Save as PDF** to render the dashboard as a PDF file. + Grafana opens the PDF file in a new window or browser tab. diff --git a/docs/sources/enterprise/license/_index.md b/docs/sources/enterprise/license/_index.md index 3c5324b97f9..7fb09eb5ac3 100644 --- a/docs/sources/enterprise/license/_index.md +++ b/docs/sources/enterprise/license/_index.md @@ -1,17 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/license/"] -description = "Enterprise license" -keywords = ["grafana", "licensing", "enterprise"] -title = "Grafana Enterprise license" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/license/ +description: Enterprise license +keywords: + - grafana + - licensing + - enterprise +title: Grafana Enterprise license +weight: 10 +--- # Grafana Enterprise license -When you become a Grafana Enterprise customer, you gain access to Grafana's premium observability features, including enterprise data source plugins, reporting, and role-based access control. In order to use these [enhanced features of Grafana Enterprise]({{< relref "../_index.md" >}}), you must purchase and activate a Grafana Enterprise license. +When you become a Grafana Enterprise customer, you gain access to Grafana's premium observability features, including enterprise data source plugins, reporting, and role-based access control. In order to use these [enhanced features of Grafana Enterprise]({{< relref "../" >}}), you must purchase and activate a Grafana Enterprise license. -To purchase a license directly from Grafana Labs, [Contact a Grafana Labs representative](https://grafana.com/contact?about=grafana-enterprise). To activate an Enterprise license purchased from Grafana Labs, refer to [Activate an Enterprise license]({{< relref "./activate-license.md" >}}). +To purchase a license directly from Grafana Labs, [Contact a Grafana Labs representative](https://grafana.com/contact?about=grafana-enterprise). To activate an Enterprise license purchased from Grafana Labs, refer to [Activate an Enterprise license]({{< relref "activate-license/" >}}). -You can also purchase a Grafana Enterprise license through the AWS Marketplace. To learn more about activating a license purchased through AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "../license/activate-aws-marketplace-license" >}}). +You can also purchase a Grafana Enterprise license through the AWS Marketplace. To learn more about activating a license purchased through AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "activate-aws-marketplace-license/" >}}). {{< section >}} diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/_index.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/_index.md index 65f70087e54..22e8fae35ce 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/_index.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/_index.md @@ -1,10 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/"] -description = "Activate Enterprise license purchased through AWS Marketplace" -keywords = ["grafana", "aws", "marketplace", "enterprise", "license"] -title = "Activate a Grafana Enterprise license purchased through AWS Marketplace" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/ +description: Activate Enterprise license purchased through AWS Marketplace +keywords: + - grafana + - aws + - marketplace + - enterprise + - license +title: Activate a Grafana Enterprise license purchased through AWS Marketplace +weight: 400 +--- # Activate a Grafana Enterprise license purchased through AWS Marketplace diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws.md index 38ef63d86f4..bc5d91a50e6 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/about-ge-license-through-aws/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws/"] -description = "About Grafana Enterprise licenses from AWS Marketplace" -keywords = ["grafana", "about", "enterprise", "overview", "aws", "marketplace"] -title = "About Grafana Enterprise licenses from AWS Marketplace" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/about-ge-license-through-aws/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws/ +description: About Grafana Enterprise licenses from AWS Marketplace +keywords: + - grafana + - about + - enterprise + - overview + - aws + - marketplace +title: About Grafana Enterprise licenses from AWS Marketplace +weight: 100 +--- # About Grafana Enterprise licenses from AWS Marketplace @@ -15,7 +23,7 @@ You can deploy Grafana Enterprise in the following ways: - Using AWS services like ECS, EKS or EC2. - In an instance outside AWS. -In each case, you must activate the Grafana Enterprise license purchased in AWS Marketplace to take advantage of Grafana Enterprise observability features. Grafana Enterprise licenses purchased through AWS Marketplace are subject to the same [restrictions]({{< relref "../license-restrictions.md" >}}) as Grafana Enterprise licensed purchased directly from Grafana Labs. +In each case, you must activate the Grafana Enterprise license purchased in AWS Marketplace to take advantage of Grafana Enterprise observability features. Grafana Enterprise licenses purchased through AWS Marketplace are subject to the same [restrictions]({{< relref "../license-restrictions/" >}}) as Grafana Enterprise licensed purchased directly from Grafana Labs. > To purchase a license directly from Grafana Labs or learn more about other Grafana offerings, [Contact a Grafana Labs representative](https://grafana.com/contact?about=grafana-enterprise). diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs.md index d1f2172af70..c2b51c9b07b 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-ecs/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs/"] -description = "Activate a Grafana Enterprise license from AWS Marketplace on ECS" -keywords = ["grafana", "ecs", "enterprise", "aws", "marketplace", "activate"] -title = "Activate a Grafana Enterprise license from AWS Marketplace on ECS" -weight = 250 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-ecs/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs/ +description: Activate a Grafana Enterprise license from AWS Marketplace on ECS +keywords: + - grafana + - ecs + - enterprise + - aws + - marketplace + - activate +title: Activate a Grafana Enterprise license from AWS Marketplace on ECS +weight: 250 +--- # Activate a Grafana Enterprise license from AWS Marketplace on ECS @@ -36,7 +44,7 @@ Grafana requires that you configure a database to hold dashboards, users, and ot ### Before you begin - Ensure that you have a supported Grafana database available. - - For a list of supported databases, refer to [Supported databases]({{< relref "../../../installation/requirements.md#supported-databases" >}}). + - For a list of supported databases, refer to [Supported databases]({{< relref "../../../setup-grafana/installation/#supported-databases" >}}). - For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html). - Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html). @@ -44,7 +52,7 @@ To configure Grafana for high availability: 1. In AWS ECS, use environment variables to update the `database` parameters. - For a list of database parameters, refer to [Configuration]({{< relref "../../../administration/configuration.md#database" >}}). + For a list of database parameters, refer to [Configuration]({{< relref "../../../setup-grafana/configure-grafana/#database" >}}). 1. Create a revision of the task definition for the ECS Task that runs Grafana Enterprise. diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks.md index 77084375a36..e42882af795 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-eks/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks/"] -description = "Activate a Grafana Enterprise license from AWS Marketplace on EKS" -keywords = ["grafana", "enterprise", "aws", "marketplace", "eks", "activate"] -title = "Activate a Grafana Enterprise license from AWS Marketplace on EKS" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-eks/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks/ +description: Activate a Grafana Enterprise license from AWS Marketplace on EKS +keywords: + - grafana + - enterprise + - aws + - marketplace + - eks + - activate +title: Activate a Grafana Enterprise license from AWS Marketplace on EKS +weight: 200 +--- # Activate a Grafana Enterprise license from AWS Marketplace on EKS @@ -38,7 +46,7 @@ Grafana requires that you configure a database to hold dashboards, users, and ot ### Before you begin - Ensure that you have a supported Grafana database available. - - For a list of supported databases, refer to [Supported databases]({{< relref "../../../installation/requirements.md#supported-databases" >}}). + - For a list of supported databases, refer to [Supported databases]({{< relref "../../../setup-grafana/installation/#supported-databases" >}}). - For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html). - Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html). @@ -70,7 +78,7 @@ To configure Grafana for high availability, choose **one** of the following opti value: [database password] ``` -For more information on Grafana High Availability setup, refer to [Set up Grafana for high availability]({{< relref "../../../administration/set-up-for-high-availability.md" >}}). +For more information on Grafana High Availability setup, refer to [Set up Grafana for high availability]({{< relref "../../../setup-grafana/set-up-for-high-availability/" >}}). ## Task 3: Configure Grafana Enterprise to validate its license with AWS @@ -87,7 +95,7 @@ In this task, you configure Grafana Enterprise to validate the license with AWS For more information about AWS license permissions, refer to [Actions, resources, and condition keys for AWS License Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awslicensemanager.html). -1. Choose **one** of the following options to update the [license_validation_type]({{< relref "../../enterprise-configuration.md#license_validation_type" >}}) configuration to `aws`: +1. Choose **one** of the following options to update the [license_validation_type]({{< relref "../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`: - **Option 1:** Use `kubectl edit configmap grafana` to edit `grafana.ini` add the following section to the configuration: @@ -113,6 +121,6 @@ To restart Grafana on a Kubernetes cluster, 1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to the Statistics and Licensing page to validate that your license is active. -For more information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../installation/restart-grafana" >}}). +For more information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../setup-grafana/restart-grafana/" >}}). > If you experience issues when you update the EKS cluster, refer to [Amazon EKS troubleshooting](https://docs.aws.amazon.com/eks/latest/userguide/troubleshooting.html). diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws.md index d333cecacf2..e94647f2bb4 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws.md @@ -1,10 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/"] -description = "Activate a Grafana Enterprise license from AWS on an instance deployed outside of AWS" -keywords = ["grafana", "enterprise", "aws", "marketplace", "activate"] -title = "Activate a Grafana Enterprise license from AWS on an instance deployed outside of AWS" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/ +description: Activate a Grafana Enterprise license from AWS on an instance deployed + outside of AWS +keywords: + - grafana + - enterprise + - aws + - marketplace + - activate +title: Activate a Grafana Enterprise license from AWS on an instance deployed outside + of AWS +weight: 300 +--- # Activate a Grafana Enterprise license from AWS on an instance deployed outside of AWS @@ -22,9 +31,9 @@ To activate a Grafana Enterprise license from AWS on a Grafana Enterprise instan To install Grafana, refer to the documentation specific to your implementation. -- [Install Grafana]({{< relref "../../../installation/" >}}). -- [Run Grafana Docker image]({{< relref "../../../installation/docker" >}}). -- [Deploy Grafana on Kubernetes]({{< relref "../../../installation/kubernetes/#deploy-grafana-enterprise-on-kubernetes" >}}). +- [Install Grafana]({{< relref "../../../setup-grafana/installation" >}}). +- [Run Grafana Docker image]({{< relref "../../../setup-grafana/installation/docker/" >}}). +- [Deploy Grafana on Kubernetes]({{< relref "../../../setup-grafana/installation/kubernetes/#deploy-grafana-enterprise-on-kubernetes" >}}). ## Task 2: Create an AWS IAM user with access to your Grafana Enterprise license @@ -97,7 +106,7 @@ To retrieve your license, Grafana Enterprise requires access to your AWS account In this task you configure Grafana Enterprise to validate the license with AWS instead of Grafana Labs. -Choose one of the following options to update the [license_validation_type]({{< relref "../../enterprise-configuration.md#license_validation_type" >}}) configuration to `aws`: +Choose one of the following options to update the [license_validation_type]({{< relref "../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`: - **Option 1:** In the `[enterprise]` section of the grafana.ini configuration file, add `license_validation_type=aws`. @@ -118,4 +127,4 @@ Choose one of the following options to update the [license_validation_type]({{< To activate Grafana Enterprise features, start (or restart) Grafana. -For information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../installation/restart-grafana" >}}). +For information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../setup-grafana/restart-grafana/" >}}). diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace.md index 600e9d50d35..13302b5b903 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace.md @@ -1,10 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/manage-license-in-aws-marketplace/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace/"] -description = "Manage your Grafana Enterprise license in AWS Marketplace" -keywords = ["grafana", "enterprise", "aws", "marketplace", "manage", "add", "remove", "users"] -title = "Manage your Grafana Enterprise license in AWS Marketplace" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/manage-license-in-aws-marketplace/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace/ +description: Manage your Grafana Enterprise license in AWS Marketplace +keywords: + - grafana + - enterprise + - aws + - marketplace + - manage + - add + - remove + - users +title: Manage your Grafana Enterprise license in AWS Marketplace +weight: 400 +--- ## Manage your Grafana Enterprise license in AWS Marketplace @@ -28,4 +38,4 @@ You can use AWS Marketplace to make the following modifications to your Grafana This action retrieves updated license information from AWS. -> To learn more about licensing and active users, refer to [Understanding Grafana Enterprise licensing]({{< relref "../../license/license-restrictions" >}}). +> To learn more about licensing and active users, refer to [Understanding Grafana Enterprise licensing]({{< relref "../license-restrictions/" >}}). diff --git a/docs/sources/enterprise/license/activate-aws-marketplace-license/transfer-ge-license.md b/docs/sources/enterprise/license/activate-aws-marketplace-license/transfer-ge-license.md index b0480359782..a7ec2bfc919 100644 --- a/docs/sources/enterprise/license/activate-aws-marketplace-license/transfer-ge-license.md +++ b/docs/sources/enterprise/license/activate-aws-marketplace-license/transfer-ge-license.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-aws-marketplace-license/transfer-ge-license/", "/docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/transfer-ge-license/"] -description = "Transfer your AWS Marketplace Grafana Enterprise license" -keywords = ["grafana", "enterprise", "aws", "marketplace", "transfer", "move"] -title = "Transfer your AWS Marketplace Grafana Enterprise license" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-aws-marketplace-license/transfer-ge-license/ + - /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/transfer-ge-license/ +description: Transfer your AWS Marketplace Grafana Enterprise license +keywords: + - grafana + - enterprise + - aws + - marketplace + - transfer + - move +title: Transfer your AWS Marketplace Grafana Enterprise license +weight: 400 +--- # Transfer your AWS Marketplace Grafana Enterprise license diff --git a/docs/sources/enterprise/license/activate-license.md b/docs/sources/enterprise/license/activate-license.md index c246719ad0c..4ac998c1e8c 100644 --- a/docs/sources/enterprise/license/activate-license.md +++ b/docs/sources/enterprise/license/activate-license.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/activate-license/", "/docs/grafana/latest/enterprise/license/activate-license/"] -description = "Activate an Enterprise license" -keywords = ["grafana", "licensing", "enterprise"] -title = "Activate an Enterprise license" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/activate-license/ + - /docs/grafana/latest/enterprise/license/activate-license/ +description: Activate an Enterprise license +keywords: + - grafana + - licensing + - enterprise +title: Activate an Enterprise license +weight: 100 +--- # Activate an Enterprise license @@ -59,9 +64,9 @@ environment variable. ## Step 3. Ensure that the license file's root URL matches the root_url configuration option -Update the [`root_url`]({{< relref "../../administration/configuration/#root-url" >}}) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s). +Update the [`root_url`]({{< relref "../../setup-grafana/configure-grafana/#root-url" >}}) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s). -This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`]({{< relref "../../administration/configuration/#root-url" >}}) in your configuration. +This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`]({{< relref "../../setup-grafana/configure-grafana/#root-url" >}}) in your configuration. In your configuration file: @@ -78,4 +83,4 @@ GF_SERVER_ROOT_URL=https://grafana.example.com/ ## Step 4. Restart Grafana -To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features. Refer to [restart Grafana]({{< relref "../../installation/restart-grafana.md" >}}) for more information. +To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features. Refer to [restart Grafana]({{< relref "../../setup-grafana/restart-grafana/" >}}) for more information. diff --git a/docs/sources/enterprise/license/license-expiration.md b/docs/sources/enterprise/license/license-expiration.md index 70c0939084a..924a22ae402 100644 --- a/docs/sources/enterprise/license/license-expiration.md +++ b/docs/sources/enterprise/license/license-expiration.md @@ -1,10 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/license-expiration/", "/docs/grafana/latest/enterprise/license/license-expiration/"] -description = "" -keywords = ["grafana", "licensing"] -title = "License expiration" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/license-expiration/ + - /docs/grafana/latest/enterprise/license/license-expiration/ +description: '' +keywords: + - grafana + - licensing +title: License expiration +weight: 200 +--- # License expiration @@ -14,7 +18,7 @@ If your license has expired, most of Grafana keeps working as normal. Some enter ## Update your license -1. Locate your current `license.jwt` file. In a standard installation it is stored inside the Grafana data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration]({{< relref "../../administration/configuration.md" >}}). +1. Locate your current `license.jwt` file. In a standard installation it is stored inside the Grafana data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}). ```ini [enterprise] @@ -26,7 +30,7 @@ If your license has expired, most of Grafana keeps working as normal. Some enter 2. Log in to your [Grafana Cloud Account](https://grafana.com/login) and make sure you're in the correct organization in the dropdown at the top of the page. 3. Under the **Grafana Enterprise** section in the menu bar to the left, choose licenses and download the currently valid license with which you want to run Grafana. If you cannot see a valid license on Grafana.com, please contact your account manager at Grafana Labs to renew your subscription. 4. Replace the current `license.jwt`-file with the one you've just downloaded. -5. [Restart Grafana]({{< relref "../../installation/restart-grafana.md" >}}). +5. [Restart Grafana]({{< relref "../../setup-grafana/restart-grafana/" >}}). ## If your license expires diff --git a/docs/sources/enterprise/license/license-restrictions.md b/docs/sources/enterprise/license/license-restrictions.md index 11c24828468..82b1eac4e4d 100644 --- a/docs/sources/enterprise/license/license-restrictions.md +++ b/docs/sources/enterprise/license/license-restrictions.md @@ -1,73 +1,32 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/license-restrictions/", "/docs/grafana/latest/enterprise/license/license-restrictions/"] -description = "Grafana Enterprise license restrictions" -keywords = ["grafana", "licensing", "enterprise"] -title = "License restrictions" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/license-restrictions/ + - /docs/grafana/latest/enterprise/license/license-restrictions/ +description: Grafana Enterprise license restrictions +keywords: + - grafana + - licensing + - enterprise +title: License restrictions +weight: 300 +--- -# Understanding Grafana Enterprise licensing +# Grafana Enterprise license restrictions When you become a Grafana Enterprise customer, you receive a license that governs your use of Grafana Enterprise. -You either have: +## Active users limit -- tiered licensing, or -- combined licensing - -To understand which license type you have, refer to [Determine the number of active users for each licensed role](#determine-the-number-of-active-users-for-each-licensed-role). - -## Tiered licensing - -Tiered licensing defines dashboard viewers, and dashboard editors and administrators, as two distinct user types that each have their own user limit. - -For example, your license might include 300 viewers and 50 editors or administrators. Although editors and administrators have separate permissions and can do different things, Grafana counts them together as a single licensed role. - -### Active users limit - -Your Grafana license includes a maximum number of _Viewer_ and _Editor/Admin_ active users. For example, your license can include a maximum of 500 viewers and 100 editor/admins. +Your Grafana license includes a maximum number of active users. - An _active user_ is a user who has signed in to Grafana within the last 30 days. This is a rolling window that is updated daily. -- When you reach the number of maximum active viewers or editor/admins, only currently active users can sign in; new users and non-active users cannot sign in when you reach the limit. -- Grafana applies sign-in restrictions separately for viewers and editor/admins. If your Grafana license reaches its limit of active viewers but not its limit of active editor/admins, new editors and admins can still sign in. -- The number of dashboards that a user can view or edit, and the number of organizations that they can access does not affect the active user count. A user with editor permissions for many dashboards across many different organizations counts as one editor. +- When you reach the maximum number of active users, only currently active users (users who have signed in over the past 30 days) can sign in. When a new user or a previously-inactive user tries to sign in, the user will see an error message indicating that Grafana has reached its license limit. +- The user's role, number of dashboards that a user can view or edit, and the number of organizations that they can access does not affect the active user count. - A license limit banner appears to administrators when Grafana reaches its active user limit; editors and viewers do not see the banner. - To change user roles to make better use of your licenses, refer to [Optimize your tiered license](#optimize-your-tiered-license). -### Permission domains +### Determine the number of active users -You can assign role permissions _globally_ and restrict access to a specific dashboard or set of dashboards. - -**Organization permissions**: When you create a user, you select a role on the user details page. Your selection applies to all Grafana dashboards within the Organization. For example, a user with the viewer role can see all dashboards, but cannot create or edit dashboards. For more information about user roles and permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}). - -**Dashboard permissions**: You can also assign permissions to dashboards or groups (folders) of dashboards. For example, you might want a viewer to also have editor permissions for a specific dashboard. While that user can see _all_ dashboards, they can only update one of them. For more information about dashboard permissions, refer to -[Dashboard permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#dashboard-permissions" >}}). - -When you grant editor/admin dashboard permissions to a viewer, the editor/admin active-user count increases by one as shown on the **Utilization** panel of the **Statistics and licensing** page, and the user’s licensed role changes to editor/admin. - -> The editor/admin count increases because the user can edit and save a dashboard. - -### Grant dashboard edit without save permissions - -You can grant viewers the ability to edit but not save a dashboard. This setting is useful when you have users that want to explore dashboards, but only need the generated view temporarily and do not require an editor/admin license. - -> This setting does not affect viewers’ license role billing. - -To grant dashboard edit without save permissions: - -1. Open the `grafana.ini` file that contains default configurations. - - The name and location of the file depends on your installation. For information about locating - the default configurations file, refer to [Configuration]({{< relref "../../administration/configuration.md" >}}). - -1. Change the `viewers-can-edit` setting to `true`. -1. Restart Grafana Enterprise. - -### Determine the number of active users for each licensed role - -Because you can assign a user global permissions while also enhancing (or limiting) their access to specific dashboards, it might be helpful for you to periodically check license counts. - -To determine the number of active users for each licensed role: +To determine the number of active users: 1. Sign in to Grafana Enterprise as a System Administrator. @@ -75,84 +34,27 @@ To determine the number of active users for each licensed role: 1. Click **Statistics and licensing**. -1. Review the role utilization count on the **Utilization** panel. +1. Review the utilization count on the **Utilization** panel. -> Utilization data updates when the user signs back in to Grafana after you change their permissions. +## Tiered licensing (deprecated) -### Optimize your tiered license +A tiered license defines dashboard viewers, and dashboard editors and administrators, as two distinct user types that each have their own user limit. -Grafana counts viewer users separately from editor/admin users. If you reach the limit imposed by your license for either of these user types, use the following techniques to make optimum use of the licenses you purchased. +As of Grafana Enterprise version 9.0, Grafana only counts and enforces the _total_ number of active users in your Grafana instance. For example, if you purchase 150 active users, you can have 20 admins, 70 editors, and 60 viewers, or you can have 150 admins. Grafana will enforce the total number of active users even if you use a license that grants a specific number of admins or editors and a certain number of viewers. This is a more permissive policy than before, which gives you the flexibility to change users' roles. -- **Review and update organization permissions.** You can modify organization permissions to reduce the count of one type of user. For example, if you reach the limit of editor/admin users, assign viewer permissions to one (or more) editor/admin users who agree to read-only access to dashboards. The license count updates when a user signs back in to Grafana. -- **Review and update dashboard permissions.** Because viewers can also count toward editor/admin usage, if they are granted access to edit specific dashboards, review your dashboard permissions and adjust accordingly. Remove editor or admin permissions where necessary. -- **Delete users.** Review the number of users you have for each type of permission and remove inactive users. Removing users immediately frees up space for new users. +If you are running a pre-9.0 version of Grafana Enterprise, please refer to the documentation for that version to learn more about license enforcement in your current version. -> When you delete a user you also delete their preferences, dashboard and folder permissions, and references to that user from the dashboard versions they have updated. - -Users who are synced via SAML, Oauth, or LDAP will also lose these attributes. - -### Update user permissions for dashboards - -You can change the access a user has to specific dashboards. For billing purposes, Grafana charges for the highest level permission assigned to the user. For example, if you assign editor/admin dashboard permissions to a viewer user, Grafana counts that user as an editor/admin. - -To change user permissions for dashboards: - -1. Sign in to Grafana as a system administrator. - -1. Hover your mouse over **Server Admin** (the shield icon) and click **Statistics and licensing**. - -1. In the **Dashboard and Folder Permissions** area, click the dashboard in the \*\*Resource title (URL) column. - - The **Permission** page opens. - -1. Use the dropdown list to select a role. - -The next time the user signs in, the **Utilization** panel on the **Statistics and licensing** page displays updated data. - -## Combined licensing - -As of Grafana Enterprise Version 8.3, you can purchase (or transition to) combined licensing. With combined licensing, you purchase a specific number of users, and you are free to distribute those users across all roles, in any combination. -For example, if you purchase 150 licenses, you can have 20 admins, 70 editors, and 60 viewers, or you can have 10 admins, 100 editors, and 40 viewers. This change reduces license complexity. - -### Transition to combined license model - -To transition from the tiered licensing model to the combined license model, contact your Grafana account team and request to switch to combined user pricing. Once you update your contract with the account team, they will issue you a new license token. -For instructions about how to update your license, refer to [Activate an Enterprise license]({{< relref "./activate-license.md" >}}). - -After you apply the token, Grafana Enterprise resets your license and updates the user counts on the **Utilization** panel. - -> If you are running Grafana Enterprise 8.2 or earlier, the license grants you the total number of licensed users _for each user type_. - -For example, if your current license includes 60 viewers and 40 editor/admins, the new license includes 100 viewers and 100 editor/admins. Grafana Enterprise 8.3 removes the distinction between viewers and editor/admins as shown on the **Utilization** panel. - -Before you upgrade to Grafana 8.3, ensure that the total number of active users in Grafana does not exceed the number of users in your combined license. If it does, then new users cannot sign in to Grafana 8.3 until the active user count returns below the licensed limit. - -## Determining your current license type - -You can identify your license type in Grafana 8.3 and higher. If you are running Grafana 8.2 or older, refer to your contract to determine your license type. - -To determine if you have tiered pricing or combined pricing, complete the following steps in Grafana v8.3 or higher: - -1. Sign in to Grafana as a system administrator. - -1. Hover your mouse over **Server Admin** (the shield icon), and click **Statistics and licensing**. - -1. In the **Utilization** panel, review the license count data. - - - If you see **Admins & Editors** and **Viewers**, then you have a tiered license. - - If you only see **Users**, then you have a combined license. - -## License restrictions common to both license types +## Additional license restrictions Your license is controlled by the following rules: **License expiration date:** The license includes an expiration date, which is the date when a license becomes inactive. -As the license expiration date approaches, you will see a banner in Grafana that encourages you to renew. To learn about how to renew your license and what happens in Grafana when a license expires, refer to [License expiration]({{< relref "./license-expiration.md" >}}). +As the license expiration date approaches, you will see a banner in Grafana that encourages you to renew. To learn about how to renew your license and what happens in Grafana when a license expires, refer to [License expiration]({{< relref "license-expiration/" >}}). **Grafana License URL:** Your license does not work with an instance of Grafana with a different root URL. -The License URL is the root URL of your Grafana instance. +The License URL is the complete URL of your Grafana instance, for example `https://grafana.your-company.com/`. It is defined in the [root_url]({{< relref "../../setup-grafana/configure-grafana/#root_url">}}) configuration setting. **Concurrent sessions limit**: As of Grafana Enterprise 7.5, users can initiate up to three concurrent sessions of Grafana. @@ -164,10 +66,10 @@ When a user reaches the session limit, the fourth connection succeeds and the lo You can request Grafana Labs to activate usage billing which allows an unlimited number of active users. When usage billing is enabled, Grafana does not enforce active user limits or display warning banners. Instead, you are charged for active users that exceed the limit, according to your customer contract. -Usage billing involves a contractual agreement between you and Grafana Labs, and it is only available if Grafana Enterprise is configured to [automatically refresh its license token]({{< relref "../enterprise-configuration.md#auto_refresh_license" >}}). +Usage billing involves a contractual agreement between you and Grafana Labs, and it is only available if Grafana Enterprise is configured to [automatically refresh its license token]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#auto_refresh_license" >}}). ## Request a change to your license To increase the number of licensed users within Grafana, extend a license, or change your licensed URL, contact [Grafana support](https://grafana.com/profile/org#support) or your Grafana Labs account team. They will update your license, which you can activate from within Grafana. -For instructions about how to activate your license after it is updated, refer to [Activate an Enterprise license]({{< relref "./activate-license.md" >}}). +For instructions about how to activate your license after it is updated, refer to [Activate an Enterprise license]({{< relref "activate-license/" >}}). diff --git a/docs/sources/enterprise/query-caching.md b/docs/sources/enterprise/query-caching.md index 1f62dad8eb1..42adcf9c04e 100644 --- a/docs/sources/enterprise/query-caching.md +++ b/docs/sources/enterprise/query-caching.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/query-caching/"] -description = "Grafana Enterprise data source query caching" -keywords = ["grafana", "plugins", "query", "caching"] -title = "Query caching" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/query-caching/ +description: Grafana Enterprise data source query caching +keywords: + - grafana + - plugins + - query + - caching +title: Query caching +weight: 300 +--- # Query caching @@ -12,15 +17,17 @@ When query caching is enabled, Grafana temporarily stores the results of data so Query caching works for all backend data sources, and queries sent through the data source proxy. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL). +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). + The following cache backends are available: in-memory, Redis, and Memcached. > **Note:** Storing cached queries in-memory can increase Grafana's memory footprint. In production environments, a Redis or Memcached backend is highly recommended. When a panel queries a cached data source, the time until this query fetches fresh data is determined by the panel's **interval.** This means that wider panels and dashboards with shorter time ranges fetch new data more frequently than narrower panels and dashboards with longer time ranges. -Interval is visible in a panel's [query options]({{< relref "../panels/query-options.md" >}}). It is calculated like this: `(max data points) / time range`. Max data points are calculated based on the width of the panel. For example, a full-width panel on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes. In this example, cached data for this panel will be served for up to 10 minutes before Grafana queries the data source again and returns new data. +Interval is visible in a panel's [query options]({{< relref "../panels/query-options/" >}}). It is calculated like this: `(max data points) / time range`. Max data points are calculated based on the width of the panel. For example, a full-width panel on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes. In this example, cached data for this panel will be served for up to 10 minutes before Grafana queries the data source again and returns new data. -You can make a panel retrieve fresh data more frequently by increasing the **Max data points** setting in the panel's [query options]({{< relref "../panels/query-options.md" >}}). +You can make a panel retrieve fresh data more frequently by increasing the **Max data points** setting in the panel's [query options]({{< relref "../panels/query-options/" >}}). ## Query caching benefits @@ -30,7 +37,7 @@ You can make a panel retrieve fresh data more frequently by increasing the **Max ## Data sources that work with query caching -Query caching works for all [Enterprise data sources](https://grafana.com/grafana/plugins/?type=datasource&enterprise=1), and it works for the following [built-in data sources]({{< relref "../datasources/_index.md" >}}): +Query caching works for all [Enterprise data sources](https://grafana.com/grafana/plugins/?type=datasource&enterprise=1) as well as the following [built-in data sources]({{< relref "../datasources/" >}}): - CloudWatch Metrics - Google Cloud Monitoring @@ -48,7 +55,7 @@ To tell if a data source works with query caching, follow the instructions below ## Enable and configure query caching -You must be an Org admin or Grafana admin to enable query caching for a data source. For more information on Grafana roles and permissions, refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}). +You must be an Org admin or Grafana admin to enable query caching for a data source. For more information on Grafana roles and permissions, refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). By default, data source queries are not cached. To enable query caching for a single data source: @@ -60,7 +67,7 @@ By default, data source queries are not cached. To enable query caching for a si > **Note:** If query caching is enabled and the Cache tab is not visible in a data source's settings, then query caching is not available for that data source. -To configure global settings for query caching, refer to the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#caching" >}}). +To configure global settings for query caching, refer to the [Query caching section of Enterprise Configuration]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). ## Disable query caching @@ -70,7 +77,7 @@ To disable query caching for a single data source: 1. In the data source list, click the data source that you want to turn off caching for. 1. In the Cache tab, click Disable. -To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. +To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. ## Clear cache diff --git a/docs/sources/enterprise/recorded-queries.md b/docs/sources/enterprise/recorded-queries.md index 5a178de76d1..74b55ee45cf 100644 --- a/docs/sources/enterprise/recorded-queries.md +++ b/docs/sources/enterprise/recorded-queries.md @@ -1,10 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/recorded-queries/"] -description = "Grafana Enterprise recorded queries" -keywords = ["grafana", "query", "queries", "recorded"] -title = "Recorded queries" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/recorded-queries/ +description: Grafana Enterprise recorded queries +keywords: + - grafana + - query + - queries + - recorded +title: Recorded queries +weight: 300 +--- # Recorded queries @@ -12,6 +17,8 @@ Recorded queries allow you to see trends over time by taking a snapshot of a dat For our plugins that do not return time series, it might be useful to plot historical data. For example, you might want to query ServiceNow to see a history of request response times but it can only return current point-in-time metrics. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}). + ## How recorded queries work > **Note:** An administrator must configure a Prometheus data source and associate it with a [Remote write target](#remote-write-target) before recorded queries can be used. diff --git a/docs/sources/enterprise/reporting.md b/docs/sources/enterprise/reporting.md index ed6fbe2b745..fa93d3af79f 100644 --- a/docs/sources/enterprise/reporting.md +++ b/docs/sources/enterprise/reporting.md @@ -1,16 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/administration/reports/", "/docs/grafana/latest/enterprise/reporting/"] -description = "" -keywords = ["grafana", "reporting"] -title = "Reporting" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/administration/reports/ + - /docs/grafana/latest/enterprise/reporting/ +description: '' +keywords: + - grafana + - reporting +title: Reporting +weight: 800 +--- # Reporting Reporting allows you to automatically generate PDFs from any of your dashboards and have Grafana email them to interested parties on a schedule. This is available in Grafana Cloud Pro and Advanced and in Grafana Enterprise. -> If you have [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, for some actions you would need to have relevant permissions. +> If you have [Role-based access control]({{< relref "access-control/" >}}) enabled, for some actions you would need to have relevant permissions. > Refer to specific guides to understand what permissions are required. {{< figure src="/static/img/docs/enterprise/reports_list_8.1.png" max-width="500px" class="docs-image--no-shadow" >}} @@ -19,16 +23,16 @@ 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 "../image-rendering/" >}}) for more information. +- SMTP must be configured for reports to be sent. Refer to [SMTP]({{< relref "../setup-grafana/configure-grafana/#smtp" >}}) in [Configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) for more information. +- The Image Renderer plugin must be installed or the remote rendering service must be set up. Refer to [Image rendering]({{< relref "../setup-grafana/image-rendering/" >}}) for more information. ## Access control -When [RBAC]({{< relref "../enterprise/access-control/_index.md" >}}) is enabled, you need to have the relevant [Permissions]({{< relref "../enterprise/access-control/rbac-fixed-basic-role-definitions" >}}) to create and manage reports. +When [RBAC]({{< relref "access-control/" >}}) is enabled, you need to have the relevant [Permissions]({{< relref "access-control/rbac-fixed-basic-role-definitions/" >}}) to create and manage reports. ## Create or update a report -Only organization admins can create reports by default. You can customize who can create reports with [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}). +Only organization admins can create reports by default. You can customize who can create reports with [Role-based access control]({{< relref "access-control/" >}}). 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. @@ -51,15 +55,15 @@ Only organization admins can create reports by default. You can customize who ca ### Choose template variables -> **Note:** Available in Grafana Enterprise version 7.5+ (behind `reportVariables` feature flag) and Grafana Enterprise version 8+ without a feature flag. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.5 and later behind the `reportVariables` feature flag, Grafana Enterprise version 8.0 and later without a feature flag, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). -You can configure report-specific template variables for the dashboard on the report page. The variables that you select will override the variables from the dashboard, and they are used when rendering a PDF file of the report. For detailed information about using template variables, refer to the [Templates and variables]({{< relref "../variables/_index.md" >}}) section. +You can configure report-specific template variables for the dashboard on the report page. The variables that you select will override the variables from the dashboard, and they are used when rendering a PDF file of the report. For detailed information about using template variables, refer to the [Templates and variables]({{< relref "../variables/" >}}) section. > **Note:** The query variables saved with a report might go out of date if the results of that query change. For example, if your template variable queries for a list of hostnames and a new hostname is added, then it will not be included in the report. If that happens, the selected variables will need to be manually updated in the report. If you select the `All` value for the template variable or if you keep the dashboard's original variable selection, then the report will stay up-to-date as new values are added. ### Render a report with panels or rows set to repeat by a variable -> **Note:** Available in Grafana Enterprise v8+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). You can include dynamic dashboards with panels or rows, set to repeat by a variable, into reports. For detailed information about setting up repeating panels or rows in dashboards, refer to the [Repeat panels or rows]({{< relref "../panels/add-panels-dynamically/" >}}) section. @@ -71,7 +75,7 @@ You can include dynamic dashboards with panels or rows, set to repeat by a varia ### Report time range -> Setting custom report time range is available in Grafana Enterprise v7.2+. +> **Note:** You can set custom report time ranges in [Grafana Enterprise]({{< relref "../enterprise" >}}) 7.2+ and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). By default, reports use the saved time range of the dashboard. Changing the time range of the report can be done by: @@ -80,11 +84,11 @@ By default, reports use the saved time range of the dashboard. Changing the time The page header of the report displays the time range for the dashboard's data queries. Dashboards set to use the browser's time zone will use the time zone on the Grafana server. -If the time zone is set differently between your Grafana server and its remote image renderer, then the time ranges in the report might be different between the page header and the time axes in the panels. To avoid this, set the time zone to UTC for dashboards when using a remote renderer. Each dashboard's time zone setting is visible in the [time range controls]({{< relref "../dashboards/time-range-controls.md/#dashboard-time-settings" >}}). +If the time zone is set differently between your Grafana server and its remote image renderer, then the time ranges in the report might be different between the page header and the time axes in the panels. To avoid this, set the time zone to UTC for dashboards when using a remote renderer. Each dashboard's time zone setting is visible in the [time range controls]({{< relref "../dashboards/time-range-controls/#dashboard-time-settings" >}}). ### Layout and orientation -> We're actively working on developing new report layout options. [Contact us](https://grafana.com/contact?about=grafana-enterprise&topic=design-process&value=reporting) if you would like to get involved in the design process. +> We're actively developing new report layout options. [Contact us](https://grafana.com/contact?about=grafana-enterprise&topic=design-process&value=reporting) to get involved in the design process. | Layout | Orientation | Support | Description | Preview | | ------ | ----------- | ------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -95,21 +99,22 @@ If the time zone is set differently between your Grafana server and its remote i ### CSV export -> **Note:** Only available in Grafana Enterprise v8.0+, with the [Grafana image renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) v3.0+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) 8+ with the [Grafana image renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) v3.0+, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). You can attach a CSV file to the report email for each table panel on the selected dashboard, along with the PDF report. By default, CSVs larger than 10Mb won't be sent to avoid email servers to reject the email. You can increase or decrease this limit in the [reporting configuration]({{< relref "#rendering-configuration" >}}). -This feature relies on the same plugin that supports the [image rendering]({{< relref "../image-rendering/" >}}) features. +This feature relies on the same plugin that supports the [image rendering]({{< relref "../setup-grafana/image-rendering/" >}}) features. When the CSV file is generated, it is temporarily written to the `csv` folder in the Grafana `data` folder. -A background job runs every 10 minutes and removes temporary CSV files. You can configure how long a CSV file should be stored before being removed by configuring the [temp-data-lifetime]({{< relref "../administration/configuration/#temp-data-lifetime" >}}) setting. This setting also affects how long a renderer PNG file should be stored. +A background job runs every 10 minutes and removes temporary CSV files. You can configure how long a CSV file should be stored before being removed by configuring the [temp-data-lifetime]({{< relref "../setup-grafana/configure-grafana/#temp-data-lifetime" >}}) setting. This setting also affects how long a renderer PNG file should be stored. ### Scheduling -> Note: Scheduler has been significantly changed in Grafana Enterprise v8.1. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). +> The scheduler was significantly changed in Grafana Enterprise version 8.1. -Scheduled reports can be sent once or repeatedly on an hourly, daily, weekly, or monthly basis, or at custom intervals. You can also disable scheduling by selecting **Never**: for example, if you want to send the report via the API. +Scheduled reports can be sent once, or repeated on an hourly, daily, weekly, or monthly basis, or sent at custom intervals. You can also disable scheduling by selecting **Never**, for example to send the report via the API. {{< figure src="/static/img/docs/enterprise/reports_scheduler_8.1.png" max-width="500px" class="docs-image--no-shadow" >}} @@ -129,7 +134,7 @@ When you schedule a report with a monthly frequency, and set the start date betw ### Send test email -> Only available in Grafana Enterprise v7.0+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). 1. In the report, click **Send test email**. 1. In the Email field, enter the email address or addresses that you want to test, separated by semicolon. @@ -142,13 +147,13 @@ The last saved version of the report will be sent to selected emails. You can us ## Pause report -> **Note:** Available in Grafana Enterprise v8+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). You can pause sending of reports from the report list view by clicking the pause icon. The report will not be sent according to its schedule until it is resumed by clicking the resume button on the report row. ## Send report via the API -You can send reports programmatically with the [send report]({{< relref "../developers/http_api/reporting.md#send-report" >}}) endpoint in the [HTTP APIs]({{< relref "../developers/http_api" >}}). +You can send reports programmatically with the [send report]({{< relref "../developers/http_api/reporting/#send-report" >}}) endpoint in the [HTTP APIs]({{< relref "../developers/http_api/" >}}). ## Rendering configuration @@ -158,10 +163,12 @@ To make a panel more legible, you can set a scale factor for the rendered images You can also specify custom fonts that support different Unicode scripts. The DejaVu font is the default used for PDF rendering. -These options are available in the [configuration]({{< relref "../administration/configuration.md" >}}) file. +These options are available in the [configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) file. ```ini [reporting] +# Use this option to enable or disable the reporting feature. When disabled, no reports are generated, and the UI is hidden. By default, reporting is enabled. +enabled = true # Set timeout for each panel rendering request rendering_timeout = 10s # Set maximum number of concurrent calls to the rendering service @@ -183,14 +190,15 @@ font_italic = DejaVuSansCondensed-Oblique.ttf ## Reports settings -> **Note:** Available in Grafana Enterprise v7.2+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.2 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). You can configure organization-wide report settings in the **Settings** tab on the **Reporting** page. Settings are applied to all the reports for current organization. You can customize the branding options. Report branding: -**Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo. + +- **Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo. Email branding: @@ -203,7 +211,7 @@ Email branding: ## Troubleshoot reporting -To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../administration/configuration.md#filters" >}}) for more information. +To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../setup-grafana/configure-grafana/#filters" >}}) for more information. ```bash [log] diff --git a/docs/sources/enterprise/saml/_index.md b/docs/sources/enterprise/saml/_index.md deleted file mode 100644 index a343bffb002..00000000000 --- a/docs/sources/enterprise/saml/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/auth/saml/ - - /docs/grafana/latest/enterprise/saml/ -description: Grafana SAML authentication -keywords: - - grafana - - saml - - documentation - - saml-auth - - enterprise -title: SAML authentication -weight: 10 ---- - -# SAML authentication - -SAML authentication integration enables your Grafana users to log in by using an external SAML 2.0 Identity Provider (IdP). To enable this, Grafana becomes a Service Provider (SP) in the authentication flow, interacting with the IdP to exchange user information. - -> Only available in Grafana Enterprise v6.3+. If you experience any issues with our implementation, contact our [Technical Support team](https://grafana.com/contact?plcmt=top-nav&cta=contactus) - -{{< section >}} diff --git a/docs/sources/enterprise/saml/about-saml.md b/docs/sources/enterprise/saml/about-saml.md deleted file mode 100644 index c541856d1a0..00000000000 --- a/docs/sources/enterprise/saml/about-saml.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/auth/saml/ - - /docs/grafana/latest/enterprise/saml/about-saml/ -description: SAML authentication -keywords: - - grafana - - saml - - documentation - - saml-auth - - enterprise -menuTitle: About SAML authentication -title: About SAML authentication in Grafana -weight: 20 ---- - -# About SAML authentication - -SAML authentication integration allows your Grafana users to log in by using an external SAML 2.0 Identity Provider (IdP). To enable this, Grafana becomes a Service Provider (SP) in the authentication flow, interacting with the IdP to exchange user information. - -The SAML single sign-on (SSO) standard is varied and flexible. Our implementation contains a subset of features needed to provide a smooth authentication experience into Grafana. - -> Only available in Grafana Enterprise v6.3+. If you encounter any problems with our implementation, please don't hesitate to contact us. - -## Supported SAML - -Grafana supports the following SAML 2.0 bindings: - -- 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): - - `HTTP-POST` binding - -In terms of security: - -- Grafana supports signed and encrypted assertions. -- Grafana does not support signed or encrypted requests. - -In terms of initiation, Grafana supports: - -- SP-initiated requests -- IdP-initiated requests - -By default, SP-initiated requests are enabled. For instructions on how to enable IdP-initiated logins, see https://grafana.com/docs/grafana/latest/enterprise/saml/#idp-initiated-single-sign-on-sso. - -### Edit SAML options in the Grafana config file - -Once you have enabled saml, you can configure Grafana to use it for SAML authentication. Refer to [Configuration]({{< relref "../../administration/configuration.md" >}}) to get more information about how to configure Grafana. - -**Edit SAML options in Grafana config file:** - -1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`]({{< relref ".././enterprise-configuration.md#enabled" >}}) to `true`. -1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}). -1. On the Okta application page where you have been redirected after application created, navigate to the **Sign On** tab and find **Identity Provider metadata** link in the **Settings** section. -1. Set the [`idp_metadata_url`]({{< relref ".././enterprise-configuration.md#idp-metadata-url" >}}) to the URL obtained from the previous step. The URL should look like `https://.okta.com/app//sso/saml/metadata`. -1. Set the following options to the attribute names configured at the **step 10** of the SAML integration setup. You can find this attributes on the **General** tab of the application page (**ATTRIBUTE STATEMENTS** and **GROUP ATTRIBUTE STATEMENTS** in the **SAML Settings** section). - - [`assertion_attribute_login`]({{< relref ".././enterprise-configuration.md#assertion-attribute-login" >}}) - - [`assertion_attribute_email`]({{< relref ".././enterprise-configuration.md#assertion-attribute-email" >}}) - - [`assertion_attribute_name`]({{< relref ".././enterprise-configuration.md#assertion-attribute-name" >}}) - - [`assertion_attribute_groups`]({{< relref ".././enterprise-configuration.md#assertion-attribute-groups" >}}) -1. Save the configuration file and and then restart the Grafana server. - -When you are finished, the Grafana configuration might look like this example: - -```bash -[server] -root_url = https://grafana.example.com - -[auth.saml] -enabled = true -private_key_path = "/path/to/private_key.pem" -certificate_path = "/path/to/certificate.cert" -idp_metadata_url = "https://my-org.okta.com/app/my-application/sso/saml/metadata" -assertion_attribute_name = DisplayName -assertion_attribute_login = Login -assertion_attribute_email = Email -assertion_attribute_groups = Group -``` diff --git a/docs/sources/enterprise/saml/enable-saml.md b/docs/sources/enterprise/saml/enable-saml.md deleted file mode 100644 index d6e104d7a24..00000000000 --- a/docs/sources/enterprise/saml/enable-saml.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/auth/saml/ - - /docs/grafana/latest/enterprise/saml/enable-saml/ -description: This contains information to enable SAML authentication in Grafana -keywords: - - grafana - - saml - - documentation - - saml-auth - - enterprise -menuTitle: Enable SAML authentication -title: Enable SAML authentication in Grafana -weight: 30 ---- - -# Enable SAML authentication in Grafana - -To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. - -Refer to [Configuration]({{< relref "../../administration/configuration.md" >}}) for more information about configuring Grafana. - -## Certificate and private key - -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. The private key needs to be issued in a [PKCS#8](https://en.wikipedia.org/wiki/PKCS_8) format. - -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. - -> **Note:** You can only use one form of each configuration option. Using multiple forms, such as both `certificate` and `certificate_path`, results in an error. - ---- - -### **Example** of how to generate SAML credentials: - -An example of how to generate a self-signed certificate and private key that's valid for one year: - -```sh -$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes​ -``` - -Base64-encode the cert.pem and key.pem files: -(-w0 switch is not needed on Mac, only for Linux) - -```sh -$ base64 -w0 key.pem > key.pem.base64 -$ base64 -w0 cert.pem > cert.pem.base64 -``` - -The base64-encoded values (`key.pem.base64, cert.pem.base64` files) are then used for certificate and private_key. - -The keys you provide should look like: - -``` ------BEGIN PRIVATE KEY----- -... -... ------END PRIVATE KEY----- -``` diff --git a/docs/sources/enterprise/saml/set-up-saml-with-okta.md b/docs/sources/enterprise/saml/set-up-saml-with-okta.md deleted file mode 100644 index 11e2a727d11..00000000000 --- a/docs/sources/enterprise/saml/set-up-saml-with-okta.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/enterprise/saml/set-up-saml-with-okta/ -description: This is a guide to set up SAML authentication with Okta in Grafana -keywords: - - grafana - - saml - - documentation - - saml-auth - - enterprise -menuTitle: SAML authentication with Okta -title: Set up SAML authentication with Okta in Grafana -weight: 30 ---- - -# Set up SAML with Okta - -Grafana supports user authentication through Okta, which is useful when you want your users to access Grafana using single sign on. This guide will follow you through the steps of configuring SAML authentication in Grafana with [Okta](https://okta.com/). You need to be an admin in your Okta organization to access Admin Console and create SAML integration. You also need permissions to edit Grafana config file and restart Grafana server. - -## Before you begin - -- To configure SAML integration with Okta, create integration inside the Okta organization first. [Add integration in Okta](https://help.okta.com/en/prod/Content/Topics/Apps/apps-overview-add-apps.htm) -- Ensure you have permission to administer SAML authentication. For more information about permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md#" >}}). - -**To set up SAML with Okta:** - -1. Log in to the [Okta portal](https://login.okta.com/). -1. Go to the Admin Console in your Okta organization by clicking **Admin** in the upper-right corner. If you are in the Developer Console, then click **Developer Console** in the upper-left corner and then click **Classic UI** to switch over to the Admin Console. -1. In the Admin Console, navigate to **Applications** > **Applications**. -1. Click **Add Application**. -1. Click **Create New App** to start the Application Integration Wizard. -1. Choose **Web** as a platform. -1. Select **SAML 2.0** in the Sign on method section. -1. Click **Create**. -1. On the **General Settings** tab, enter a name for your Grafana integration. You can also upload a logo. -1. On the **Configure SAML** tab, enter the SAML information related to your Grafana instance: - - - In the **Single sign on URL** field, use the `/saml/acs` endpoint URL of your Grafana instance, for example, `https://grafana.example.com/saml/acs`. - - In the **Audience URI (SP Entity ID)** field, use the `/saml/metadata` endpoint URL, for example, `https://grafana.example.com/saml/metadata`. - - Leave the default values for **Name ID format** and **Application username**. - - In the **ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter the SAML attributes to be shared with Grafana, for example: - - | Attribute name (in Grafana) | Value (in Okta profile) | - | --------------------------- | -------------------------------------- | - | Login | `user.login` | - | Email | `user.email` | - | DisplayName | `user.firstName + " " + user.lastName` | - - - In the **GROUP ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter a group attribute name (for example, `Group`) and set filter to `Matches regex .*` to return all user groups. - -1. Click **Next**. -1. On the final Feedback tab, fill out the form and then click **Finish**. diff --git a/docs/sources/enterprise/saml/troubleshoot-saml.md b/docs/sources/enterprise/saml/troubleshoot-saml.md deleted file mode 100644 index 678c105c197..00000000000 --- a/docs/sources/enterprise/saml/troubleshoot-saml.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/auth/saml/ - - /docs/grafana/latest/enterprise/saml/troubleshoot-saml/ -description: This contains information on how to troubleshoot SAML authentication - in Grafana -keywords: - - grafana - - saml - - documentation - - saml-auth - - enterprise -menuTitle: Troubleshoot SAML Authentication -title: Troubleshoot SAML Authentication in Grafana -weight: 50 ---- - -# Troubleshoot SAML authentication in Grafana - -To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration]({{< relref "../../administration/configuration.md#filters" >}}) for more information. - -```bash -[log] -filters = saml.auth:debug -``` - -## Known issues - -### SAML authentication fails with error: - -- `asn1: structure error: tags don't match` - -We only support one private key format: PKCS#8. - -The keys may be in a different format (PKCS#1 or PKCS#12); in that case, it may be necessary to convert the private key format. - -The following command creates a pkcs8 key file. - -```bash -$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes​ -``` - -#### **Convert** the private key format to base64 - -The following command converts keys to base64 format. - -Base64-encode the cert.pem and key.pem files: -(-w0 switch is not needed on Mac, only for Linux) - -```sh -$ base64 -w0 key.pem > key.pem.base64 -$ base64 -w0 cert.pem > cert.pem.base64 -``` - -The base64-encoded values (`key.pem.base64, cert.pem.base64` files) are then used for certificate and private_key. - -The keys you provide should look like: - -``` ------BEGIN PRIVATE KEY----- -... -... ------END PRIVATE KEY----- -``` diff --git a/docs/sources/enterprise/settings-updates.md b/docs/sources/enterprise/settings-updates.md index d192920b1a8..bcea881ff4d 100644 --- a/docs/sources/enterprise/settings-updates.md +++ b/docs/sources/enterprise/settings-updates.md @@ -1,16 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/settings-updates/"] -description = "Settings updates at runtime" -keywords = ["grafana", "runtime", "settings"] -title = "Settings updates at runtime" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/settings-updates/ +description: Settings updates at runtime +keywords: + - grafana + - runtime + - settings +title: Settings updates at runtime +weight: 500 +--- # Settings updates at runtime -> **Note:** Available in Grafana Enterprise v8.0+. +> **Note:** Available in Grafana Enterprise version 8.0 and later. -Settings updates at runtime allows you to update Grafana settings with no need to restart the Grafana server. +By updating settings at runtime, you can update Grafana settings without needing to restart the Grafana server. Updates that happen at runtime are stored in the database and override [settings from the other sources](https://grafana.com/docs/grafana/latest/administration/configuration/) @@ -23,7 +27,7 @@ Currently, **it only supports updates on the `auth.saml` section.** ## Update settings via the API -You can update settings through the [Admin API]({{< relref "../developers/http_api/admin.md#update-settings" >}}). +You can update settings through the [Admin API]({{< relref "../developers/http_api/admin/#update-settings" >}}). When you submit a settings update via API, Grafana verifies if the given settings updates are allowed and valid. If they are, then Grafana stores the settings in the database and reloads Grafana services with no need to restart the instance. @@ -88,5 +92,5 @@ HTTP API, then the other instances are synchronized through the database and the ## Control access with role-based access control -If you have [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, you can control who can read or update settings. -Refer to the [Admin API]({{< relref "../developers/http_api/admin.md#update-settings" >}}) for more information. +If you have [role-based access control]({{< relref "access-control/" >}}) enabled, you can control who can read or update settings. +Refer to the [Admin API]({{< relref "../developers/http_api/admin/#update-settings" >}}) for more information. diff --git a/docs/sources/enterprise/usage-insights/_index.md b/docs/sources/enterprise/usage-insights/_index.md index 9e2885baa24..54b837c9851 100644 --- a/docs/sources/enterprise/usage-insights/_index.md +++ b/docs/sources/enterprise/usage-insights/_index.md @@ -1,15 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/usage-insights/"] -description = "Understand how your Grafana instance is used" -keywords = ["grafana", "usage-insights", "enterprise"] -title = "Usage insights" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/usage-insights/ +description: Understand how your Grafana instance is used +keywords: + - grafana + - usage-insights + - enterprise +title: Usage insights +weight: 200 +--- # Usage insights Usage insights allow you to have a better understanding of how your Grafana instance is used. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). + The usage insights feature collects a number of aggregated data and stores them in the database: - Dashboard views (aggregated and per user) @@ -18,8 +24,8 @@ The usage insights feature collects a number of aggregated data and stores them These aggregated data give you access to several features: -- [Dashboard and data source insights]({{< relref "dashboard-datasource-insights.md" >}}) -- [Presence indicator]({{< relref "presence-indicator.md" >}}) -- [Sort dashboards by using insights data]({{< relref "improved-search.md" >}}) +- [Dashboard and data source insights]({{< relref "dashboard-datasource-insights/" >}}) +- [Presence indicator]({{< relref "presence-indicator/" >}}) +- [Sort dashboards by using insights data]({{< relref "improved-search/" >}}) -This feature also generates detailed logs that can be exported to Loki. Refer to [Export logs of usage insights]({{< relref "export-logs.md" >}}). +This feature also generates detailed logs that can be exported to Loki. Refer to [Export logs of usage insights]({{< relref "../../setup-grafana/configure-security/export-logs/" >}}). diff --git a/docs/sources/enterprise/usage-insights/dashboard-datasource-insights.md b/docs/sources/enterprise/usage-insights/dashboard-datasource-insights.md index ab18ad807dc..3a691a51b12 100644 --- a/docs/sources/enterprise/usage-insights/dashboard-datasource-insights.md +++ b/docs/sources/enterprise/usage-insights/dashboard-datasource-insights.md @@ -1,10 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/usage-insights/dashboard-datasource-insights/"] -description = "Understand how your dashboards and data sources are used" -keywords = ["grafana", "usage-insights", "enterprise"] -title = "Dashboard and data source insights" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/usage-insights/dashboard-datasource-insights/ +description: Understand how your dashboards and data sources are used +keywords: + - grafana + - usage-insights + - enterprise +title: Dashboard and data source insights +weight: 200 +--- # Dashboard and data source insights @@ -12,7 +16,7 @@ For every dashboard and data source, you can access usage information. ## Dashboard insights -> **Note:** Available in Grafana Enterprise v7.0+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). To see dashboard usage information, go to the top bar and click **Dashboard insights**. @@ -27,7 +31,7 @@ Dashboard insights show the following information: ## Data source insights -> **Note:** Available in Grafana Enterprise v7.3+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) version 7.3 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). Data source insights give you information about how a data source has been used in the past 30 days, such as: diff --git a/docs/sources/enterprise/usage-insights/improved-search.md b/docs/sources/enterprise/usage-insights/improved-search.md index 399e9ec0cb6..9e667a06d7f 100644 --- a/docs/sources/enterprise/usage-insights/improved-search.md +++ b/docs/sources/enterprise/usage-insights/improved-search.md @@ -1,14 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/usage-insights/improved-search/"] -description = "Sort dashboards by using insights data" -keywords = ["grafana", "search", "sort", "enterprise"] -title = "Sort dashboards by using insights data" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/usage-insights/improved-search/ +description: Sort dashboards by using insights data +keywords: + - grafana + - search + - sort + - enterprise +title: Sort dashboards by using insights data +weight: 400 +--- # Sort dashboards by using insights data -> **Note:** Available in Grafana Enterprise v7.0+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). In the search view, you can sort dashboards by using insights data. Doing so helps you find unused or broken dashboards or discover those that are most viewed. diff --git a/docs/sources/enterprise/usage-insights/presence-indicator.md b/docs/sources/enterprise/usage-insights/presence-indicator.md index 44e1603a65e..84d5faddb5b 100644 --- a/docs/sources/enterprise/usage-insights/presence-indicator.md +++ b/docs/sources/enterprise/usage-insights/presence-indicator.md @@ -1,22 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/usage-insights/presence-indicator/"] -description = "Know who is looking at the same dashboard as you are" -keywords = ["grafana", "presence-indicator", "enterprise"] -title = "Presence indicator" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/usage-insights/presence-indicator/ +description: Know who is looking at the same dashboard as you are +keywords: + - grafana + - presence-indicator + - enterprise +title: Presence indicator +weight: 300 +--- # Presence indicator -> **Note:** Available in Grafana Enterprise v7.0+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). When you are signed in and looking at any given dashboard, you can know who is looking at the same dashboard as you are via a presence indicator, which displays avatars of users who have interacted with the dashboard recently. The default time frame is within the past 10 minutes. To see the user's name, hover over the user's avatar. The avatars come from [Gravatar](https://gravatar.com) based on the user's email. -When there are more active users on a dashboard than can fit within the presence indicator, click the **+X** icon. Doing so opens [dashboard insights]({{< relref "dashboard-datasource-insights.md" >}}), which contains more details about recent user activity. +When there are more active users on a dashboard than can fit within the presence indicator, click the **+X** icon. Doing so opens [dashboard insights]({{< relref "dashboard-datasource-insights/" >}}), which contains more details about recent user activity. {{< figure src="/static/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}} -To change _recent_ to something other than the past 10 minutes, edit the [configuration]({{< relref "../../administration/configuration.md" >}}) file: +To change _recent_ to something other than the past 10 minutes, edit the [configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) file: ```ini [analytics.views] diff --git a/docs/sources/explore/_index.md b/docs/sources/explore/_index.md index 80270c3defa..abac884bc1d 100644 --- a/docs/sources/explore/_index.md +++ b/docs/sources/explore/_index.md @@ -1,28 +1,33 @@ -+++ -aliases = ["/docs/grafana/latest/explore/", "/docs/grafana/latest/features/explore/"] -keywords = ["explore", "loki", "logs"] -title = "Explore" -weight = 90 -+++ +--- +aliases: + - /docs/grafana/latest/explore/ + - /docs/grafana/latest/features/explore/ +keywords: + - explore + - loki + - logs +title: Explore +weight: 90 +--- # Explore Grafana's dashboard UI is all about building dashboards for visualization. Explore strips away the dashboard and panel options so that you can focus on the query. It helps you iterate until you have a working query and then think about building a dashboard. -> Refer to [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions. +> Refer to [Role-based access control]({{< relref "../enterprise/access-control/" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions. If you just want to explore your data and do not want to create a dashboard, then Explore makes this much easier. If your data source supports graph and table data, then Explore shows the results both as a graph and a table. This allows you to see trends in the data and more details at the same time. See also: -- [Query management in Explore]({{< relref "query-management.md" >}}) -- [Logs integration in Explore]({{< relref "logs-integration.md" >}}) -- [Trace integration in Explore]({{< relref "trace-integration.md" >}}) -- [Inspector in Explore]({{< relref "explore-inspector.md" >}}) +- [Query management in Explore]({{< relref "query-management/" >}}) +- [Logs integration in Explore]({{< relref "logs-integration/" >}}) +- [Trace integration in Explore]({{< relref "trace-integration/" >}}) +- [Inspector in Explore]({{< relref "explore-inspector/" >}}) ## Start exploring -> Refer to [Role-based access Control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can manage Explore with role-based permissions. +> Refer to [Role-based access Control]({{< relref "../enterprise/access-control/" >}}) in Grafana Enterprise to understand how you can manage Explore with role-based permissions. -In order to access Explore, you must have an editor or an administrator role, unless the [viewers_can_edit option]({{< relref "../administration/configuration/#viewers_can_edit" >}}) is enabled. Refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}) for more information on what each role has access to. +In order to access Explore, you must have an editor or an administrator role, unless the [viewers_can_edit option]({{< relref "../setup-grafana/configure-grafana/#viewers_can_edit" >}}) is enabled. Refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/" >}}) for more information on what each role has access to. To access Explore: diff --git a/docs/sources/explore/explore-inspector.md b/docs/sources/explore/explore-inspector.md index 52a06c0cd12..2a19daab3e6 100644 --- a/docs/sources/explore/explore-inspector.md +++ b/docs/sources/explore/explore-inspector.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/explore/explore-inspector/"] -title = "Inspector in Explore" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/explore/explore-inspector/ +title: Inspector in Explore +weight: 400 +--- # Inspector in Explore diff --git a/docs/sources/explore/logs-integration.md b/docs/sources/explore/logs-integration.md index ee7983b0ca4..59d8b6bda81 100644 --- a/docs/sources/explore/logs-integration.md +++ b/docs/sources/explore/logs-integration.md @@ -1,18 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/explore/logs-integration/"] -description = "Logs in Explore" -keywords = ["explore", "logs"] -title = "Logs in Explore" -weight = 15 -+++ +--- +aliases: + - /docs/grafana/latest/explore/logs-integration/ +description: Logs in Explore +keywords: + - explore + - logs +title: Logs in Explore +weight: 15 +--- # Logs in Explore Along with metrics, Explore allows you to investigate your logs in the following data sources: -- [Elasticsearch]({{< relref "../datasources/elasticsearch.md" >}}) -- [InfluxDB]({{< relref "../datasources/influxdb/_index.md" >}}) -- [Loki]({{< relref "../datasources/loki.md" >}}) +- [Elasticsearch]({{< relref "../datasources/elasticsearch/" >}}) +- [InfluxDB]({{< relref "../datasources/influxdb/" >}}) +- [Loki]({{< relref "../datasources/loki/" >}}) During an infrastructure monitoring and incident response, you can dig deeper into the metrics and logs to find the cause. Explore also allows you to correlate metrics and logs by viewing them side-by-side. This creates a new debugging workflow: @@ -26,6 +29,8 @@ Results of log queries are shown as histograms in the graph and individual logs If the data source supports a full range log volume histogram, the graph with log distribution for all entered log queries is shown automatically. This feature is currently supported by Elasticsearch and Loki data sources. +**NOTE:** In Loki, this full range log volume histogram is rendered by metric query which can be expensive depending on time range queried. This query may be particularly challenging for smaller Loki installations to process. To mitigate this, we recommend using a proxy like [nginx](https://www.nginx.com/) in front of Loki to set a custom timeout (e.g. 10 seconds) for these queries. Log volume histogram queries can be identified by looking for queries with the HTTP header `X-Query-Tags` with value `Source=logvolhist`; these headers are added by Grafana to all log volume histogram queries. + If the data source does not support loading full range log volume histogram, the logs model computes a time series based on the log row counts bucketed by an automatically calculated time interval, and the first log row's timestamp then anchors the start of the histogram from the result. The end of the time series is anchored to the time picker's **To** range. #### Log level @@ -126,7 +131,7 @@ If your logs are structured in `json` or `logfmt`, then you can show or hide det As mentioned, one of the log integrations is for the new open source log aggregation system from Grafana Labs - [Loki](https://github.com/grafana/loki). Loki is designed to be very cost effective, as it does not index the contents of the logs, but rather a set of labels for each log stream. The logs from Loki are queried in a similar way to querying with label selectors in Prometheus. It uses labels to group log streams which can be made to match up with your Prometheus labels. For more information about Grafana Loki, refer to [Grafana Loki](https://github.com/grafana/loki) or the Grafana Labs hosted variant: [Grafana Cloud Logs](https://grafana.com/loki). -For more information, refer to [Loki's data source documentation]({{< relref "../datasources/loki.md" >}}) on how to query for log data. +For more information, refer to [Loki's data source documentation]({{< relref "../datasources/loki/" >}}) on how to query for log data. #### Switch from metrics to logs diff --git a/docs/sources/explore/query-management.md b/docs/sources/explore/query-management.md index 9cbb1492d0b..068a0f035e2 100644 --- a/docs/sources/explore/query-management.md +++ b/docs/sources/explore/query-management.md @@ -1,15 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/explore/query-management/"] -keywords = ["explore", "loki", "logs"] -title = "Query management" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/explore/query-management/ +keywords: + - explore + - loki + - logs +title: Query management +weight: 10 +--- # Query management in Explore To help with debugging queries, Explore allows you to investigate query requests and responses, as well as query statistics, via the Query inspector. -This functionality is similar to the panel inspector tasks [Inspect query performance]({{< relref "../panels/query-a-data-source/inspect-query-performance.md" >}}) and -[Inspect query request and response data]({{< relref "../panels/query-a-data-source/inspect-request-and-response-data.md" >}}). +This functionality is similar to the panel inspector tasks [Inspect query performance]({{< relref "../panels/query-a-data-source/inspect-query-performance/" >}}) and +[Inspect query request and response data]({{< relref "../panels/query-a-data-source/inspect-request-and-response-data/" >}}). {{< figure src="/static/img/docs/v71/query_inspector_explore.png" class="docs-image--no-shadow" max-width= "550px" caption="Screenshot of the query inspector button in Explore" >}} diff --git a/docs/sources/explore/trace-integration.md b/docs/sources/explore/trace-integration.md index ba513ea69a3..90513dcf0a5 100644 --- a/docs/sources/explore/trace-integration.md +++ b/docs/sources/explore/trace-integration.md @@ -1,10 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/explore/trace-integration/"] -description = "Tracing in Explore" -keywords = ["explore", "trace"] -title = "Tracing in Explore" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/explore/trace-integration/ +description: Tracing in Explore +keywords: + - explore + - trace +title: Tracing in Explore +weight: 20 +--- # Tracing in Explore @@ -12,10 +15,10 @@ Explore allows you to visualize traces from tracing data sources. This is availa Supported data sources are: -- [Jaeger]({{< relref "../datasources/jaeger.md" >}}) -- [Tempo]({{< relref "../datasources/tempo.md" >}}) +- [Jaeger]({{< relref "../datasources/jaeger/" >}}) +- [Tempo]({{< relref "../datasources/tempo/" >}}) - [X-Ray](https://grafana.com/grafana/plugins/grafana-x-ray-datasource) -- [Zipkin]({{< relref "../datasources/zipkin.md" >}}) +- [Zipkin]({{< relref "../datasources/zipkin/" >}}) For information on how to configure queries for the data sources listed above, refer to the documentation for specific data source. diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 16dfe37e826..1153d685ee3 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -1,11 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/getting-started/", "/docs/grafana/latest/guides/what-is-grafana/"] -title = "Get started" -weight = 25 -+++ +--- +aliases: + - /docs/grafana/latest/getting-started/ + - /docs/grafana/latest/guides/what-is-grafana/ +title: Get started +weight: 15 +--- # Get started -This section provides guidance on how build your first dashboard after you have installed Grafana. It also provides step-by-step instructions on how to add a Prometheus, InfluxDB, or an MS SQL Server data source. Refer to [Data sources]({{< relref "../datasources/_index.md" >}}) for a list of all supported data sources. +This section provides guidance on how build your first dashboard after you have installed Grafana. It also provides step-by-step instructions on how to add a Prometheus, InfluxDB, or an MS SQL Server data source. Refer to [Data sources]({{< relref "../datasources/" >}}) for a list of all supported data sources. {{< section >}} diff --git a/docs/sources/getting-started/build-first-dashboard.md b/docs/sources/getting-started/build-first-dashboard.md index a5840e6305a..da7fd4c8cd2 100644 --- a/docs/sources/getting-started/build-first-dashboard.md +++ b/docs/sources/getting-started/build-first-dashboard.md @@ -1,9 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/getting-started/getting-started/", "/docs/grafana/latest/guides/getting_started/", "/docs/grafana/latest/guides/gettingstarted/"] -description = "Learn how to get started with Grafana by adding a preconfigured dashboard." -title = "Build your first dashboard" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/getting-started/build-first-dashboard/ + - /docs/grafana/latest/getting-started/getting-started/ + - /docs/grafana/latest/guides/getting_started/ + - /docs/grafana/latest/guides/gettingstarted/ +description: Learn how to get started with Grafana by adding a preconfigured dashboard. +title: Build your first dashboard +weight: 200 +--- # Build your first dashboard @@ -13,7 +17,7 @@ This topic helps you get started with Grafana and build your first dashboard. To #### Install Grafana -Grafana can be installed on many different operating systems. For a list of the minimum hardware and software requirements, as well as instructions on installing Grafana, refer to [Install Grafana]({{< relref "../installation/_index.md" >}}). +Grafana can be installed on many different operating systems. For a list of the minimum hardware and software requirements, as well as instructions on installing Grafana, refer to [Install Grafana]({{< relref "../setup-grafana/installation/" >}}). #### Sign in to Grafana @@ -33,7 +37,7 @@ To create your first dashboard: 1. Click the **+** icon on the side menu. 1. On the dashboard, click **Add an empty panel**. 1. In the New dashboard/Edit panel view, go to the **Query** tab. -1. Configure your [query]({{< relref "../panels/query-a-data-source/add-a-query" >}}) by selecting `-- Grafana --` from the data source selector. This generates the Random Walk dashboard. +1. Configure your [query]({{< relref "../panels/query-a-data-source/add-a-query/" >}}) by selecting `-- Grafana --` from the data source selector. This generates the Random Walk dashboard. 1. Click the **Save** icon in the top right corner of your screen to save the dashboard. 1. Add a descriptive name, and then click **Save**. @@ -41,19 +45,19 @@ Congratulations, you have created your first dashboard and it is displaying resu #### Next steps -Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/_index.md" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}). The following topics will be of interest to you: +Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources/" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources/add-a-data-source/" >}}). The following topics will be of interest to you: -- [Panels]({{< relref "../panels/_index.md" >}}) -- [Dashboards]({{< relref "../dashboards/_index.md" >}}) -- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}}) +- [Panels]({{< relref "../panels/" >}}) +- [Dashboards]({{< relref "../dashboards/" >}}) +- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts/" >}}) - [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc) ##### Admins The following topics are of interest to Grafana server admin users: -- [Grafana configuration]({{< relref "../administration/configuration.md" >}}) -- [Authentication]({{< relref "../auth/overview.md" >}}) -- [User permissions and roles]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}) -- [Provisioning]({{< relref "../administration/provisioning.md" >}}) -- [Grafana CLI]({{< relref "../administration/cli.md" >}}) +- [Grafana configuration]({{< relref "../setup-grafana/configure-grafana/" >}}) +- [Authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/" >}}) +- [User permissions and roles]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/" >}}) +- [Provisioning]({{< relref "../administration/provisioning/" >}}) +- [Grafana CLI]({{< relref "../administration/cli/" >}}) diff --git a/docs/sources/getting-started/get-started-grafana-influxdb.md b/docs/sources/getting-started/get-started-grafana-influxdb.md index ab69491c2c6..10ddb0dcd85 100644 --- a/docs/sources/getting-started/get-started-grafana-influxdb.md +++ b/docs/sources/getting-started/get-started-grafana-influxdb.md @@ -1,9 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/getting-started/getting-started-influxdb/"] -description = "Learn how to build your first InfluxDB dashboard in Grafana." -title = "Get started with Grafana and InfluxDB" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/getting-started/get-started-grafana-influxdb/ + - /docs/grafana/latest/getting-started/getting-started-influxdb/ +description: Learn how to build your first InfluxDB dashboard in Grafana. +title: Get started with Grafana and InfluxDB +weight: 400 +--- # Get started with Grafana and InfluxDB @@ -37,10 +39,10 @@ Windows users might need to make additional adjustments. Look for special instru You can have more than one InfluxDB data source defined in Grafana. -1. Follow the general instructions to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}). +1. Follow the general instructions to [add a data source]({{< relref "../datasources/add-a-data-source/" >}}). 1. Decide if you will use InfluxQL or Flux as your query language. - - For InfluxQL, refer to [InfluxDB data source]({{< relref "../datasources/influxdb/_index.md" >}}) for information about specific data source fields. - - For Flux, refer to [Flux query language in Grafana]({{< relref "../datasources/influxdb/influxdb-flux.md" >}}) for information about specific data source fields. + - For InfluxQL, refer to [InfluxDB data source]({{< relref "../datasources/influxdb/" >}}) for information about specific data source fields. + - For Flux, refer to [Flux query language in Grafana]({{< relref "../datasources/influxdb/influxdb-flux/" >}}) for information about specific data source fields. ##### InfluxDB guides @@ -99,7 +101,7 @@ You can also create Flux queries in the InfluxDB Explore view. #### Check InfluxDB metrics in Grafana Explore -In your Grafana instance, go to the [Explore]({{< relref "../explore/_index.md" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics. +In your Grafana instance, go to the [Explore]({{< relref "../explore/" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics. #### Start building dashboards @@ -107,5 +109,5 @@ There you go! Use Explore and Data Explorer to experiment with your data, and ad Here are some resources to learn more: -- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb/_index.md" >}}) +- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb/" >}}) - InfluxDB documentation: [Comparison of Flux vs InfluxQL](https://docs.influxdata.com/influxdb/v1.8/flux/flux-vs-influxql/) diff --git a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md index 147ad5f0fa3..928b6588016 100644 --- a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md +++ b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md @@ -1,9 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/getting-started/getting-started-sql/", "/docs/grafana/latest/guides/getting_started/", "/docs/grafana/latest/guides/gettingstarted/"] -description = "Learn how to build your first MS SQL Server dashboard in Grafana." -title = "Get started with Grafana and MS SQL Server" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/getting-started/get-started-grafana-ms-sql-server/ + - /docs/grafana/latest/getting-started/getting-started-sql/ + - /docs/grafana/latest/guides/getting_started/ + - /docs/grafana/latest/guides/gettingstarted/ +description: Learn how to build your first MS SQL Server dashboard in Grafana. +title: Get started with Grafana and MS SQL Server +weight: 500 +--- # Get started with Grafana and MS SQL Server @@ -54,6 +58,6 @@ Optionally, play around this dashboard and customize it to: Now that you have gained some idea of using the pre-packaged MS SQL data source and some test data, the next step is to setup your own instance of MS SQL Server database and data your development or sandbox area. In the previous steps, if you followed along the path of deploying your own instance of MS SQL Server, you are already on your way. -To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore]({{< relref "../explore/_index.md" >}}) build queries to experiment with the metrics you want to monitor. +To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore]({{< relref "../explore/" >}}) build queries to experiment with the metrics you want to monitor. -Once you have a curated list of queries, create [dashboards]({{< relref "../dashboards/_index.md" >}}) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana]({{< relref "../datasources/mssql.md" >}}). +Once you have a curated list of queries, create [dashboards]({{< relref "../dashboards/" >}}) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana]({{< relref "../datasources/mssql/" >}}). diff --git a/docs/sources/getting-started/get-started-grafana-prometheus.md b/docs/sources/getting-started/get-started-grafana-prometheus.md index 928c31606d0..8595c54eac6 100644 --- a/docs/sources/getting-started/get-started-grafana-prometheus.md +++ b/docs/sources/getting-started/get-started-grafana-prometheus.md @@ -1,9 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/getting-started/getting-started-prometheus/", "/docs/grafana/latest/guides/getting_started/", "/docs/grafana/latest/guides/gettingstarted/"] -description = "Learn how to build your first Prometheus dashboard in Grafana." -title = "Get started with Grafana and Prometheus" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/getting-started/get-started-grafana-prometheus/ + - /docs/grafana/latest/getting-started/getting-started-prometheus/ + - /docs/grafana/latest/guides/getting_started/ + - /docs/grafana/latest/guides/gettingstarted/ +description: Learn how to build your first Prometheus dashboard in Grafana. +title: Get started with Grafana and Prometheus +weight: 300 +--- # Get started with Grafana and Prometheus @@ -52,11 +56,11 @@ Prometheus node_exporter is a widely used tool that exposes system metrics. Inst #### Check Prometheus metrics in Grafana Explore view -In your Grafana instance, go to the [Explore]({{< relref "../explore/_index.md" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics from Prometheus. Pay special attention to the [Prometheus-specific features]({{< relref "../explore/_index.md#prometheus-specific-features" >}}) to avail custom querying experience for Prometheus. +In your Grafana instance, go to the [Explore]({{< relref "../explore/" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics from Prometheus. Pay special attention to the [Prometheus-specific features]({{< relref "../explore/#prometheus-specific-features" >}}) to avail custom querying experience for Prometheus. #### Start building dashboards -Now that you have a curated list of queries, create [dashboards]({{< relref "../dashboards/_index.md" >}}) to render system metrics monitored by Prometheus. When you install Prometheus and node_exporter or windows_exporter, you will find recommended dashboards for use. +Now that you have a curated list of queries, create [dashboards]({{< relref "../dashboards/" >}}) to render system metrics monitored by Prometheus. When you install Prometheus and node_exporter or windows_exporter, you will find recommended dashboards for use. The following image shows a dashboard with three panels showing some system metrics. @@ -64,5 +68,5 @@ The following image shows a dashboard with three panels showing some system metr To learn more: -- Grafana documentation: [Prometheus data source]({{< relref "../datasources/prometheus.md" >}}) +- Grafana documentation: [Prometheus data source]({{< relref "../datasources/prometheus/" >}}) - Prometheus documentation: [What is Prometheus?](https://prometheus.io/docs/introduction/overview/) diff --git a/docs/sources/installation/_index.md b/docs/sources/installation/_index.md deleted file mode 100644 index 508bc51d683..00000000000 --- a/docs/sources/installation/_index.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/install/", "/docs/grafana/latest/installation/", "/docs/grafana/latest/installation/installation/", "/docs/grafana/v2.1/installation/install/"] -description = "Installation guide for Grafana" -keywords = ["grafana", "installation", "documentation"] -title = "Installation" -weight = 30 -+++ - -# Install Grafana - -This section discusses the hardware and software requirements as well as the process of installing Grafana on different operating systems. This section has the following topics: - -- [Requirements]({{< relref "requirements" >}}) -- [Install on Debian or Ubuntu]({{< relref "debian" >}}) -- [Install on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm" >}}) -- [Install on macOS]({{< relref "mac" >}}) -- [Install on Windows]({{< relref "windows" >}}) -- [Run Docker image]({{< relref "docker" >}}) -- [Deploy Grafana on Kubernetes]({{< relref "kubernetes" >}}) - -For upgrade instructions, refer to [Upgrade Grafana]({{< relref "upgrading.md" >}}). -To restart Grafana, refer to [Restart Grafana]({{< relref "restart-grafana.md" >}}). - -To install Grafana Enterprise, refer to the instructions for installing Grafana on your system. Then, refer to [Activate an Enterprise license]({{< relref "../enterprise/license/activate-license.md" >}}). diff --git a/docs/sources/introduction/_index.md b/docs/sources/introduction/_index.md index cb0d76e9ae9..5a130f7bfa3 100644 --- a/docs/sources/introduction/_index.md +++ b/docs/sources/introduction/_index.md @@ -1,15 +1,74 @@ -+++ -aliases = ["/docs/grafana/latest/guides/what-is-grafana/", "/docs/grafana/latest/introduction/"] -title = "Introduction to Grafana" -weight = 5 -+++ +--- +aliases: + - /docs/grafana/latest/guides/what-is-grafana/ + - /docs/grafana/latest/introduction/ + - /docs/grafana/latest/introduction/oss-details/ +title: Introduction to Grafana +weight: 5 +--- -# Introduction to Grafana +# Grafana OSS -Grafana is a complete observability stack that allows you to monitor and analyze metrics, logs and traces. It allows you to query, visualize, alert on and understand your data no matter where it is stored. Create, explore, and share beautiful dashboards with your team and foster a data driven culture. For more information, refer to [Grafana overview](https://grafana.com/grafana/). Our observability stack has the following products and components. +[Grafana open source software](https://grafana.com/oss/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they are stored. Grafana OSS provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations. -{{< docs/shared "basics/what-is-grafana.md" >}} +After you have [installed Grafana]({{< relref "../setup-grafana/installation/" >}}) and set up your first dashboard using instructions in [Getting started with Grafana]({{< relref "../getting-started/build-first-dashboard.md" >}}), you will have many options to choose from depending on your requirements. For example, if you want to view weather data and statistics about your smart home, then you can create a [playlist]({{< relref "../dashboards/playlist.md" >}}). If you are the administrator for an enterprise and are managing Grafana for multiple teams, then you can set up [provisioning]({{< relref "../administration/provisioning.md" >}}) and [authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/" >}}). -{{< docs/shared "basics/grafana-cloud.md" >}} +The following sections provide an overview of Grafana features and links to product documentation to help you learn more. For more guidance and ideas, check out our [Grafana Community forums](https://community.grafana.com/). -{{< docs/shared "basics/grafana-enterprise.md" >}} +## Explore metrics, logs, and traces + +Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Refer to [Explore]({{< relref "../explore/_index.md" >}}) for more information. + +## Alerts + +If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/contact-points/_index.md#list-of-notifiers-supported-by-grafana" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. + +Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerting-rules/_index.md" >}}) for your most important metrics. + +## Annotations + +Annotate graphs with rich events from different data sources. Hover over events to see the full event metadata and tags. + +This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more information. + +## Dashboard variables + +[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. + +Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. + +## Configure Grafana + +If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../setup-grafana/configure-grafana/" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}). + +Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. + +## Import dashboards and plugins + +Discover hundreds of [dashboards](https://grafana.com/grafana/dashboards) and [plugins](https://grafana.com/grafana/plugins) in the official library. Thanks to the passion and momentum of community members, new ones are added every week. + +## Authentication + +Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview]({{< relref "../setup-grafana/configure-security/configure-authentication/" >}}) for more information. + +In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. Refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) for more information. + +## Provisioning + +While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. + +For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. Refer to [Provisioning]({{< relref "../administration/provisioning.md" >}}) for more information. + +## Permissions + +When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set permissions on [folders and dashboards]({{< relref "../administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md" >}}), and down to the [data source level]({{< relref "../enterprise/datasource_permissions.md" >}}) if you're using [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}). + +## Other Grafana Labs OSS Projects + +In addition to Grafana, Grafana Labs also provides the following open source projects: + +**Grafana Loki:** Grafana Loki is an open source, set of components that can be composed into a fully featured logging stack. For more information, refer to [Grafana Loki documentation](https://grafana.com/docs/loki/latest/). + +**Grafana Tempo:** Grafana Tempo is an open source, easy-to-use and high-volume distributed tracing backend. For more information, refer to [Grafana Tempo documentation](https://grafana.com/docs/tempo/latest/?pg=oss-tempo&plcmt=hero-txt/). + +**Grafana Mimir:** Grafana Mimir is an open source software project that provides a scalable long-term storage for Prometheus. For more information about Grafana Mimir, refer to [Grafana Mimir documentation](https://grafana.com/docs/mimir/latest/). diff --git a/docs/sources/introduction/grafana-cloud.md b/docs/sources/introduction/grafana-cloud.md new file mode 100644 index 00000000000..fae75e88c13 --- /dev/null +++ b/docs/sources/introduction/grafana-cloud.md @@ -0,0 +1,12 @@ +--- +aliases: + - /docs/grafana/latest/introduction/grafana-cloud/ +title: Grafana Cloud +weight: 300 +--- + +# Grafana Cloud + +Grafana Cloud is a highly available, fast, fully-managed OpenSaaS logging and metrics platform. It is everything you love about Grafana, hosted by Grafana Labs. + +[Learn more about Grafana Cloud](https://grafana.com/cloud/) and get started with your [free account with Grafana Cloud](https://grafana.com/signup/cloud/connect-account?pg=gsdocs) that includes a robust free tier with access to 10k metrics, 50GB logs, 50GB traces, two-week data retention, and three users. diff --git a/docs/sources/introduction/grafana-enterprise.md b/docs/sources/introduction/grafana-enterprise.md new file mode 100644 index 00000000000..e4ea2259676 --- /dev/null +++ b/docs/sources/introduction/grafana-enterprise.md @@ -0,0 +1,88 @@ +--- +aliases: + - /docs/grafana/latest/enterprise/ + - /docs/grafana/latest/introduction/grafana-enterprise/ +description: Grafana Enterprise overview +title: Grafana Enterprise +weight: 200 +--- + +# Grafana Enterprise + +Grafana Enterprise is a commercial edition of Grafana that includes additional features not found in the open source version. + +Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). You also get 24x7x365 support and training from the core Grafana team. + +To learn more about Grafana Enterprise, refer to [our product page](https://grafana.com/enterprise). + +## Enterprise features in Grafana Cloud + +Many Grafana Enterprise features are also available in [Grafana Cloud]({{< ref "/docs/grafana-cloud" >}}) Pro and Advanced accounts. For details, refer to [the Grafana Cloud features table](https://grafana.com/pricing/#featuresTable) and [Enterprise features available to Grafana Cloud Pro and Advanced accounts]({{< ref "/docs/grafana-cloud/reference/enterprise-features" >}}). + +## Authentication + +Grafana Enterprise includes integrations with more ways to authenticate your users and enhanced authentication capabilities. + +### Team sync + +[Team sync]({{< relref "../setup-grafana/configure-security/configure-team-sync/" >}}) allows you to set up synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. + +Supported auth providers: + +- [Auth Proxy]({{< relref "../setup-grafana/configure-security/configure-authentication/auth-proxy/#team-sync-enterprise-only" >}}) +- [Azure AD OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/azuread/#team-sync-enterprise-only" >}}) +- [GitHub OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/github/#team-sync-enterprise-only" >}}) +- [GitLab OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/gitlab/#team-sync-enterprise-only" >}}) +- [LDAP]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced_ldap/#ldap-group-synchronization-for-teams" >}}) +- [Okta]({{< relref "../setup-grafana/configure-security/configure-authentication/okta/#team-sync-enterprise-only" >}}) +- [SAML]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/#configure-team-sync" >}}) + +### Enhanced LDAP integration + +With [enhanced LDAP integration]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced_ldap/" >}}), you can set up active LDAP synchronization. + +### SAML authentication + +[SAML authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/" >}}) enables users to authenticate with single sign-on services that use Security Assertion Markup Language (SAML). + +## Enterprise features + +Grafana Enterprise adds the following features: + +- [Role-based access control]({{< relref "../enterprise/access-control/" >}}) to control access with role-based permissions. +- [Data source permissions]({{< relref "../enterprise/datasource_permissions.md" >}}) to restrict query access to specific teams and users. +- [Data source query caching]({{< relref "../enterprise/query-caching.md" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting. +- [Reporting]({{< relref "../enterprise/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 "../enterprise/export-pdf.md" >}}) +- [White labeling]({{< relref "../setup-grafana/enable-custom-branding/" >}}) to customize Grafana from the brand and logo to the footer links. +- [Usage insights]({{< relref "../enterprise/usage-insights/" >}}) to understand how your Grafana instance is used. +- [Vault integration]({{< relref "../setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/" >}}) to manage your configuration or provisioning secrets with Vault. +- [Auditing]({{< relref "../setup-grafana/configure-security/audit-grafana/" >}}) tracks important changes to your Grafana instance to help you manage and mitigate suspicious activity and meet compliance requirements. +- [Request security]({{< relref "../setup-grafana/configure-security/configure-request-security/" >}}) makes it possible to restrict outgoing requests from the Grafana server. +- [Settings updates at runtime]({{< relref "../enterprise/settings-updates.md" >}}) allows you to update Grafana settings at runtime without requiring a restart. + +## Enterprise data sources + +With a Grafana Enterprise license, you also get access to premium data sources, including: + +- [AppDynamics](https://grafana.com/grafana/plugins/dlopes7-appdynamics-datasource) +- [Azure Devops](https://grafana.com/grafana/plugins/grafana-azuredevops-datasource) +- [DataDog](https://grafana.com/grafana/plugins/grafana-datadog-datasource) +- [Dynatrace](https://grafana.com/grafana/plugins/grafana-dynatrace-datasource) +- [Gitlab](https://grafana.com/grafana/plugins/grafana-gitlab-datasource) +- [Honeycomb](https://grafana.com/grafana/plugins/grafana-honeycomb-datasource) +- [Jira](https://grafana.com/grafana/plugins/grafana-jira-datasource) +- [MongoDB](https://grafana.com/grafana/plugins/grafana-mongodb-datasource) +- [New Relic](https://grafana.com/grafana/plugins/grafana-newrelic-datasource) +- [Oracle Database](https://grafana.com/grafana/plugins/grafana-oracle-datasource) +- [Salesforce](https://grafana.com/grafana/plugins/grafana-salesforce-datasource) +- [SAP HANA®](https://grafana.com/grafana/plugins/grafana-saphana-datasource) +- [ServiceNow](https://grafana.com/grafana/plugins/grafana-servicenow-datasource) +- [Snowflake](https://grafana.com/grafana/plugins/grafana-snowflake-datasource) +- [Splunk](https://grafana.com/grafana/plugins/grafana-splunk-datasource) +- [Splunk Infrastructure monitoring (SignalFx)](https://grafana.com/grafana/plugins/grafana-splunk-monitoring-datasource) +- [Wavefront](https://grafana.com/grafana/plugins/grafana-wavefront-datasource) + +## Try Grafana Enterprise + +To purchase or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). diff --git a/docs/sources/introduction/oss-details.md b/docs/sources/introduction/oss-details.md deleted file mode 100644 index 67f03492e5d..00000000000 --- a/docs/sources/introduction/oss-details.md +++ /dev/null @@ -1,61 +0,0 @@ -+++ -aliases = ["/docs/grafana/latest/guides/what-is-grafana/", "/docs/grafana/latest/introduction/oss-details/"] -title = "What is Grafana OSS" -weight = 5 -+++ - -# What is Grafana OSS - -[Grafana open source software](https://grafana.com/oss/) allows you to query, visualize, alert on, and understand your data no matter where it’s stored. With Grafana you can create, explore and share all of your data through elegant, flexible dashboards. - -After you have [installed Grafana]({{< relref "../installation/_index.md" >}}) and set up your first dashboard using instructions in [Build your first dashboard]({{< relref "../getting-started/build-first-dashboard" >}}), you will have many options to choose from depending on your requirements. For example, if you want to view weather data and statistics about your smart home, then you can create a [playlist]({{< relref "../dashboards/playlist.md" >}}). If you are the administrator for an enterprise and are managing Grafana for multiple teams, then you can set up [provisioning]({{< relref "../administration/provisioning.md" >}}) and [authentication]({{< relref "../auth/_index.md" >}}). - -In the following sections, you can get an overview of the capabilities of Grafana features as well as links to the product documentation to help you learn more. For more guidance and ideas, check out our [Grafana Community forums](https://community.grafana.com/). - -## Explore metrics, logs, and traces - -Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Refer to [Explore]({{< relref "../explore/_index.md" >}}) for more information. - -## Alerts - -If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/contact-points/_index.md#list-of-notifiers-supported-by-grafana" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. - -Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerting-rules/_index.md" >}}) for your most important metrics. - -## Annotations - -Annotate graphs with rich events from different data sources. Hover over events to see the full event metadata and tags. - -This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more information. - -## Dashboard variables - -[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. - -Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. - -## Configure Grafana - -If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../administration/configuration.md" >}}) and the [Grafana CLI]({{< relref "../administration/cli.md" >}}). - -Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. - -## Import dashboards and plugins - -Discover hundreds of [dashboards](https://grafana.com/grafana/dashboards) and [plugins](https://grafana.com/grafana/plugins) in the official library. Thanks to the passion and momentum of community members, new ones are added every week. - -## Authentication - -Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview]({{< relref "../auth/overview.md" >}}) for more information. - -In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. Refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) for more information. - -## Provisioning - -While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. - -For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. Refer to [Provisioning]({{< relref "../administration/provisioning.md" >}}) for more information. - -## Permissions - -When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set permissions on [folders and dashboards]({{< relref "../administration/manage-users-and-permissions/manage-dashboard-permissions/_index.md" >}}), and down to the [data source level]({{< relref "../enterprise/datasource_permissions.md" >}}) if you're using [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}). diff --git a/docs/sources/linking/_index.md b/docs/sources/linking/_index.md index 8bfd10751e2..7dee41357b3 100644 --- a/docs/sources/linking/_index.md +++ b/docs/sources/linking/_index.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/linking/"] -title = "Linking" -weight = 120 -+++ +--- +aliases: + - /docs/grafana/latest/linking/ +title: Linking +weight: 120 +--- # Linking overview @@ -16,10 +17,10 @@ Start by figuring out how you're currently navigating between dashboards. If you The next step is to figure out which link type is right for your workflow. Even though all the link types in Grafana are used to create shortcuts to other dashboards or external websites, they work in different contexts. -- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links.md" >}}). -- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links.md" >}}). +- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links/" >}}). +- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links/" >}}). - If you want to link to an external site, you can use either a dashboard link or a panel link. -- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links.md" >}}). +- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links/" >}}). ## Controlling time range using the URL diff --git a/docs/sources/linking/dashboard-links.md b/docs/sources/linking/dashboard-links.md index 7e494d9cbee..6024b854d11 100644 --- a/docs/sources/linking/dashboard-links.md +++ b/docs/sources/linking/dashboard-links.md @@ -1,14 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/linking/dashboard-links/"] -description = "" -keywords = ["grafana", "linking", "create links", "link dashboards", "navigate"] -title = "Dashboard links" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/linking/dashboard-links/ +description: '' +keywords: + - grafana + - linking + - create links + - link dashboards + - navigate +title: Dashboard links +weight: 200 +--- # Dashboard links -When you create a dashboard link, you can include the time range and current template variables to directly jump to the same context in another dashboard. This way, you don’t have to worry whether the person you send the link to is looking at the right data. For other types of links, refer to [Data link variables]({{< relref "data-link-variables.md" >}}). +When you create a dashboard link, you can include the time range and current template variables to directly jump to the same context in another dashboard. This way, you don’t have to worry whether the person you send the link to is looking at the right data. For other types of links, refer to [Data link variables]({{< relref "data-link-variables/" >}}). Dashboard links can also be used as shortcuts to external systems, such as submitting [a GitHub issue with the current dashboard name](https://github.com/grafana/grafana/issues/new?title=Dashboard%3A%20HTTP%20Requests). diff --git a/docs/sources/linking/data-link-variables.md b/docs/sources/linking/data-link-variables.md index 41b09cfe6eb..a2f2cd07299 100644 --- a/docs/sources/linking/data-link-variables.md +++ b/docs/sources/linking/data-link-variables.md @@ -1,26 +1,34 @@ -+++ -aliases = ["/docs/grafana/latest/linking/data-link-variables/", "/docs/grafana/latest/variables/url-variables/", "/docs/grafana/latest/variables/variable-types/url-variables/"] -keywords = ["grafana", "url variables", "documentation", "variables", "data link"] -title = "URL variables" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/linking/data-link-variables/ + - /docs/grafana/latest/variables/url-variables/ + - /docs/grafana/latest/variables/variable-types/url-variables/ +keywords: + - grafana + - url variables + - documentation + - variables + - data link +title: URL variables +weight: 400 +--- # Data link variables -You can use variables in data links to refer to series fields, labels, and values. For more information about data links, refer to [Data links]({{< relref "data-links.md" >}}). +You can use variables in data links to refer to series fields, labels, and values. For more information about data links, refer to [Data links]({{< relref "data-links/" >}}). To see a list of available variables, type `$` in the data link **URL** field to see a list of variables that you can use. > **Note:** These variables changed in 6.4 so if you have an older version of Grafana, then use the version picker to select docs for an older version of Grafana. -You can also use template variables in your data links URLs, refer to [Templates and variables]({{< relref "../variables/_index.md" >}}) for more information on template variables. +You can also use template variables in your data links URLs, refer to [Templates and variables]({{< relref "../variables/" >}}) for more information on template variables. ## Time range panel variables 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" >}}). +- `$__from and $__to` - For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables/#__from-and-__to" >}}). ## Series variables diff --git a/docs/sources/linking/data-links.md b/docs/sources/linking/data-links.md index 5821fe01e5a..7a69f34eed3 100644 --- a/docs/sources/linking/data-links.md +++ b/docs/sources/linking/data-links.md @@ -1,8 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/linking/data-links/", "/docs/grafana/latest/reference/datalinks/"] -keywords = ["grafana", "data links", "documentation", "playlist"] -title = "Data links" -+++ +--- +aliases: + - /docs/grafana/latest/linking/data-links/ + - /docs/grafana/latest/reference/datalinks/ +keywords: + - grafana + - data links + - documentation + - playlist +title: Data links +--- # Data links @@ -11,7 +17,7 @@ Data links allow you to provide more granular context to your links. You can cre The link itself is accessible in different ways depending on the visualization. For the Graph you need to click on a data point or line, for a panel like Stat, Gauge, or Bar Gauge you can click anywhere on the visualization to open the context menu. -You can use variables in data links to send people to a detailed dashboard with preserved data filters. For example, you could use variables to specify a time range, series, and variable selection. For more information, refer to [Data link variables]({{< relref "data-link-variables.md" >}}). +You can use variables in data links to send people to a detailed dashboard with preserved data filters. For example, you could use variables to specify a time range, series, and variable selection. For more information, refer to [Data link variables]({{< relref "data-link-variables/" >}}). ## Typeahead suggestions @@ -27,7 +33,7 @@ When creating or updating a data link, press Cmd+Space or Ctrl+Space on your key 1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI. 1. Enter the **URL** you want to link to. - You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "data-link-variables.md" >}}). + You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "data-link-variables/" >}}). 1. If you want the link to open in a new tab, then select **Open in a new tab**. 1. Click **Save** to save changes and close the window. diff --git a/docs/sources/linking/linking-overview.md b/docs/sources/linking/linking-overview.md index c0686aa98ac..0db43ef92aa 100644 --- a/docs/sources/linking/linking-overview.md +++ b/docs/sources/linking/linking-overview.md @@ -1,9 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/features/navigation-links/", "/docs/grafana/latest/linking/linking-overview/"] -keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"] -title = "Linking overview" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/features/navigation-links/ + - /docs/grafana/latest/linking/linking-overview/ +keywords: + - grafana + - linking + - create links + - link panels + - link dashboards + - navigate +title: Linking overview +weight: 100 +--- # Linking overview @@ -17,10 +25,10 @@ Start by figuring out how you're currently navigating between dashboards. If you The next step is to figure out which link type is right for your workflow. Even though all the link types in Grafana are used to create shortcuts to other dashboards or external websites, they work in different contexts. -- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links.md" >}}). -- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links.md" >}}). +- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links/" >}}). +- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links/" >}}). - If you want to link to an external site, you can use either a dashboard link or a panel link. -- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links.md" >}}). +- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links/" >}}). ## Controlling time range using the URL diff --git a/docs/sources/linking/panel-links.md b/docs/sources/linking/panel-links.md index a0b93640130..e8db8824661 100644 --- a/docs/sources/linking/panel-links.md +++ b/docs/sources/linking/panel-links.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/features/navigation-links/", "/docs/grafana/latest/linking/panel-links/"] -description = "" -keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"] -title = "Panel links" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/features/navigation-links/ + - /docs/grafana/latest/linking/panel-links/ +description: '' +keywords: + - grafana + - linking + - create links + - link panels + - link dashboards + - navigate +title: Panel links +weight: 300 +--- # Panel links diff --git a/docs/sources/old-alerting/_index.md b/docs/sources/old-alerting/_index.md index 262b7adbb08..41379e1e94c 100644 --- a/docs/sources/old-alerting/_index.md +++ b/docs/sources/old-alerting/_index.md @@ -1,15 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/old-alerting/"] -draft = true -title = "Legacy Grafana Alerts" -weight = 114 -+++ +--- +aliases: + - /docs/grafana/latest/old-alerting/ +draft: true +title: Legacy Grafana Alerts +weight: 114 +--- # Legacy Grafana alerts -Grafana alerting is enabled by default for new OSS installations. For older installations, it is still an [opt-in]({{< relref "../unified-alerting/opt-in.md" >}}) feature. +Grafana alerting is enabled by default for new OSS installations. For older installations, it is still an [opt-in]({{< relref "../unified-alerting/opt-in/" >}}) feature. -> **Note**: Legacy dashboard alerts are deprecated and will be removed in Grafana 9. We encourage you to migrate to [Grafana alerting]({{< relref "../unified-alerting/_index.md" >}}) for all existing installations. +> **Note**: Legacy dashboard alerts are deprecated and will be removed in Grafana 9. We encourage you to migrate to [Grafana alerting]({{< relref "../unified-alerting/" >}}) for all existing installations. Legacy dashboard alerts have two main components: @@ -20,9 +21,9 @@ Legacy dashboard alerts have two main components: You can perform the following tasks for alerts: -- [Create an alert rule]({{< relref "create-alerts.md" >}}) -- [View existing alert rules and their current state]({{< relref "view-alerts.md" >}}) -- [Test alert rules and troubleshoot]({{< relref "troubleshoot-alerts.md" >}}) -- [Add or edit an alert contact point]({{< relref "notifications.md" >}}) +- [Create an alert rule]({{< relref "create-alerts/" >}}) +- [View existing alert rules and their current state]({{< relref "view-alerts/" >}}) +- [Test alert rules and troubleshoot]({{< relref "troubleshoot-alerts/" >}}) +- [Add or edit an alert contact point]({{< relref "notifications/" >}}) {{< docs/shared "alerts/grafana-managed-alerts.md" >}} diff --git a/docs/sources/old-alerting/add-notification-template.md b/docs/sources/old-alerting/add-notification-template.md index cad18d63dc7..fdbf5369096 100644 --- a/docs/sources/old-alerting/add-notification-template.md +++ b/docs/sources/old-alerting/add-notification-template.md @@ -1,10 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/add-notification-template/", "/docs/grafana/latest/old-alerting/add-notification-template/"] -draft = true -keywords = ["grafana", "documentation", "alerting", "alerts", "notification", "templating"] -title = "Alert notification templating" -weight = 110 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/add-notification-template/ + - /docs/grafana/latest/old-alerting/add-notification-template/ +draft: true +keywords: + - grafana + - documentation + - alerting + - alerts + - notification + - templating +title: Alert notification templating +weight: 110 +--- # Alert notification templating diff --git a/docs/sources/old-alerting/create-alerts.md b/docs/sources/old-alerting/create-alerts.md index 55ce84691c8..df9e5430796 100644 --- a/docs/sources/old-alerting/create-alerts.md +++ b/docs/sources/old-alerting/create-alerts.md @@ -1,11 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/create-alerts/", "/docs/grafana/latest/old-alerting/create-alerts/"] -description = "Configure alert rules" -draft = true -keywords = ["grafana", "alerting", "guide", "rules"] -title = "Create alerts" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/create-alerts/ + - /docs/grafana/latest/old-alerting/create-alerts/ +description: Configure alert rules +draft: true +keywords: + - grafana + - alerting + - guide + - rules +title: Create alerts +weight: 200 +--- # Create alerts @@ -13,7 +19,7 @@ Grafana alerting allows you to attach rules to your dashboard panels. When you s ![Alerting overview](/static/img/docs/alerting/drag_handles_gif.gif) -In the Alert tab of the graph panel you can configure how often the alert rule should be evaluated and the conditions that need to be met for the alert to change state and trigger its [notifications]({{< relref "notifications.md" >}}). +In the Alert tab of the graph panel you can configure how often the alert rule should be evaluated and the conditions that need to be met for the alert to change state and trigger its [notifications]({{< relref "notifications/" >}}). Currently only the graph panel supports alert rules. @@ -35,11 +41,11 @@ This section describes the fields you fill out to create an alert. ### Rule -- **Name -** Enter a descriptive name. The name will be displayed in the Alert Rules list. This field supports [templating]({{< relref "./add-notification-template.md" >}}). +- **Name -** Enter a descriptive name. The name will be displayed in the Alert Rules list. This field supports [templating]({{< relref "add-notification-template/" >}}). - **Evaluate every -** Specify how often the scheduler should evaluate the alert rule. This is referred to as the _evaluation interval_. - **For -** Specify how long the query needs to violate the configured thresholds before the alert notification triggers. -You can set a minimum evaluation interval in the `alerting.min_interval_seconds` configuration field, to set a minimum time between evaluations. Refer to [Configuration]({{< relref "../../administration/configuration.md" >}}#min-interval-seconds) for more information. +You can set a minimum evaluation interval in the `alerting.min_interval_seconds` configuration field, to set a minimum time between evaluations. Refer to [Configuration]({{< relref "../../administration/configuration/" >}}#min-interval-seconds) for more information. > **Caution:** Do not use `For` with the `If no data or all values are null` setting set to `No Data`. The triggering of `No Data` will trigger instantly and not take `For` into consideration. This may also result in that an OK notification not being sent if alert transitions from `No Data -> Pending -> OK`. @@ -116,10 +122,10 @@ If you have an unreliable time series store from which queries sometime timeout In alert tab you can also specify alert rule notifications along with a detailed message about the alert rule. The message can contain anything, information about how you might solve the issue, link to runbook, and so on. The actual notifications are configured and shared between multiple alerts. Read -[Alert notifications]({{< relref "notifications.md" >}}) for information on how to configure and set up notifications. +[Alert notifications]({{< relref "notifications/" >}}) for information on how to configure and set up notifications. - **Send to -** Select an alert notification channel if you have one set up. -- **Message -** Enter a text message to be sent on the notification channel. Some alert notifiers support transforming the text to HTML or other rich formats. This field supports [templating]({{< relref "./add-notification-template.md" >}}). +- **Message -** Enter a text message to be sent on the notification channel. Some alert notifiers support transforming the text to HTML or other rich formats. This field supports [templating]({{< relref "add-notification-template/" >}}). - **Tags -** Specify a list of tags (key/value) to be included in the notification. It is only supported by [some notifiers]({{< relref "notifications/#all-supported-notifiers" >}}). ## Alert state history and annotations diff --git a/docs/sources/old-alerting/notifications.md b/docs/sources/old-alerting/notifications.md index e2d8e449fd0..d5011165990 100644 --- a/docs/sources/old-alerting/notifications.md +++ b/docs/sources/old-alerting/notifications.md @@ -1,11 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/notifications/", "/docs/grafana/latest/old-alerting/notifications/"] -description = "Alerting notifications guide" -draft = true -keywords = ["Grafana", "alerting", "guide", "notifications"] -title = "Alert notifications" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/notifications/ + - /docs/grafana/latest/old-alerting/notifications/ +description: Alerting notifications guide +draft: true +keywords: + - Grafana + - alerting + - guide + - notifications +title: Alert notifications +weight: 100 +--- # Alert notifications @@ -116,12 +122,12 @@ If you are using the token for a slack bot, then you have to invite the bot to t To setup Opsgenie you will need an API Key and the Alert API Url. These can be obtained by configuring a new [Grafana Integration](https://docs.opsgenie.com/docs/grafana-integration). -| Setting | Description | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Alert API URL | The API URL for your Opsgenie instance. This will normally be either `https://api.opsgenie.com` or, for EU customers, `https://api.eu.opsgenie.com`. | -| API Key | The API Key as provided by Opsgenie for your configured Grafana integration. | -| Override priority | Configures the alert priority using the `og_priority` tag. The `og_priority` tag must have one of the following values: `P1`, `P2`, `P3`, `P4`, or `P5`. Default is `False`. | -| Send notification tags as | Specify how you would like [Notification Tags]({{< relref "create-alerts.md/#notifications" >}}) delivered to Opsgenie. They can be delivered as `Tags`, `Extra Properties` or both. Default is Tags. See note below for more information. | +| Setting | Description | +| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Alert API URL | The API URL for your Opsgenie instance. This will normally be either `https://api.opsgenie.com` or, for EU customers, `https://api.eu.opsgenie.com`. | +| API Key | The API Key as provided by Opsgenie for your configured Grafana integration. | +| Override priority | Configures the alert priority using the `og_priority` tag. The `og_priority` tag must have one of the following values: `P1`, `P2`, `P3`, `P4`, or `P5`. Default is `False`. | +| Send notification tags as | Specify how you would like [Notification Tags]({{< relref "create-alerts/#notifications" >}}) delivered to Opsgenie. They can be delivered as `Tags`, `Extra Properties` or both. Default is Tags. See note below for more information. | > **Note:** When notification tags are sent as `Tags` they are concatenated into a string with a `key:value` format. If you prefer to receive the notifications tags as key/values under Extra Properties in Opsgenie then change the `Send notification tags as` to either `Extra Properties` or `Tags & Extra Properties`. @@ -280,4 +286,4 @@ This URL is based on the [domain]({{< relref "../../administration/configuration > **Note:** Alert notification templating is only available in Grafana v7.4 and above. -The alert notification template feature allows you to take the [label]({{< relref "../../basics/timeseries-dimensions.md#labels" >}}) value from an alert query and [inject that into alert notifications]({{< relref "./add-notification-template.md" >}}). +The alert notification template feature allows you to take the [label]({{< relref "../../basics/timeseries-dimensions/#labels" >}}) value from an alert query and [inject that into alert notifications]({{< relref "add-notification-template/" >}}). diff --git a/docs/sources/old-alerting/pause-an-alert-rule.md b/docs/sources/old-alerting/pause-an-alert-rule.md index 76d6e32af9a..db049f98ba5 100644 --- a/docs/sources/old-alerting/pause-an-alert-rule.md +++ b/docs/sources/old-alerting/pause-an-alert-rule.md @@ -1,11 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/pause-an-alert-rule/", "/docs/grafana/latest/old-alerting/pause-an-alert-rule/"] -description = "Pause an existing alert rule" -draft = true -keywords = ["grafana", "alerting", "guide", "rules", "view"] -title = "Pause alert rule" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/pause-an-alert-rule/ + - /docs/grafana/latest/old-alerting/pause-an-alert-rule/ +description: Pause an existing alert rule +draft: true +keywords: + - grafana + - alerting + - guide + - rules + - view +title: Pause alert rule +weight: 400 +--- # Pause an alert rule diff --git a/docs/sources/old-alerting/troubleshoot-alerts.md b/docs/sources/old-alerting/troubleshoot-alerts.md index 5aa2c493f3a..719f6aac881 100644 --- a/docs/sources/old-alerting/troubleshoot-alerts.md +++ b/docs/sources/old-alerting/troubleshoot-alerts.md @@ -1,11 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/troubleshoot-alerts/", "/docs/grafana/latest/old-alerting/troubleshoot-alerts/"] -description = "Troubleshoot alert rules" -draft = true -keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"] -title = "Troubleshoot alerts" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/troubleshoot-alerts/ + - /docs/grafana/latest/old-alerting/troubleshoot-alerts/ +description: Troubleshoot alert rules +draft: true +keywords: + - grafana + - alerting + - guide + - rules + - troubleshoot +title: Troubleshoot alerts +weight: 500 +--- # Troubleshoot alerts diff --git a/docs/sources/old-alerting/view-alerts.md b/docs/sources/old-alerting/view-alerts.md index 08c12673903..f5e678d45d8 100644 --- a/docs/sources/old-alerting/view-alerts.md +++ b/docs/sources/old-alerting/view-alerts.md @@ -1,11 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/alerting/view-alerts/", "/docs/grafana/latest/old-alerting/view-alerts/"] -description = "View existing alert rules" -draft = true -keywords = ["grafana", "alerting", "guide", "rules", "view"] -title = "View alerts" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/alerting/view-alerts/ + - /docs/grafana/latest/old-alerting/view-alerts/ +description: View existing alert rules +draft: true +keywords: + - grafana + - alerting + - guide + - rules + - view +title: View alerts +weight: 400 +--- # View existing alert rules @@ -17,5 +24,5 @@ You can do several things while viewing alerts. - **Filter alerts by name -** Type an alert name in the **Search alerts** field. - **Filter alerts by state -** In **States**, select which alert states you want to see. All others will be hidden. -- **Pause or resume an alert -** Click the **Pause** or **Play** icon next to the alert to pause or resume evaluation. See [Pause an alert rule]({{< relref "pause-an-alert-rule.md" >}}) for more information. +- **Pause or resume an alert -** Click the **Pause** or **Play** icon next to the alert to pause or resume evaluation. See [Pause an alert rule]({{< relref "pause-an-alert-rule/" >}}) for more information. - **Access alert rule settings -** Click the alert name or the **Edit alert rule** (gear) icon. Grafana opens the Alert tab of the panel where the alert rule is defined. This is helpful when an alert is firing but you don't know which panel it is defined in. diff --git a/docs/sources/panels/_index.md b/docs/sources/panels/_index.md index 33c63d8110f..2f07a4714ad 100644 --- a/docs/sources/panels/_index.md +++ b/docs/sources/panels/_index.md @@ -1,9 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/features/panels/panels/", "/docs/grafana/latest/panels/", "/docs/sources/panels/"] -description = "Panels" -title = "Panels" -weight = 72 -+++ +--- +aliases: + - /docs/grafana/latest/features/panels/panels/ + - /docs/grafana/latest/panels/ + - /docs/sources/panels/ +description: Panels +title: Panels +weight: 72 +--- # About Grafana panels @@ -11,6 +14,6 @@ The _panel_ is the basic visualization building block in Grafana. Each panel has There are a wide variety of styling and formatting options for each panel. Panels can be dragged and dropped and rearranged on the dashboard. They can also be resized. -Before you begin, ensure that you have configured a data source. For more information about data sources, refer to [Data Sources]({{< relref "../datasources" >}}). +Before you begin, ensure that you have configured a data source. For more information about data sources, refer to [Data Sources]({{< relref "../datasources/" >}}). {{< section >}} diff --git a/docs/sources/panels/add-panels-dynamically/_index.md b/docs/sources/panels/add-panels-dynamically/_index.md index 2b8cab26f66..d7c20e7ce19 100644 --- a/docs/sources/panels/add-panels-dynamically/_index.md +++ b/docs/sources/panels/add-panels-dynamically/_index.md @@ -1,9 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/panels/add-panels-dynamically/", "/docs/grafana/latest/panels/repeat-panels-or-rows/", "/docs/sources/panels/add-panels-dynamically/"] -keywords = ["dynamic", "variable", "panel"] -title = "Enable template variables to add panels dynamically" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/panels/add-panels-dynamically/ + - /docs/grafana/latest/panels/repeat-panels-or-rows/ + - /docs/sources/panels/add-panels-dynamically/ +keywords: + - dynamic + - variable + - panel +title: Enable template variables to add panels dynamically +weight: 800 +--- # Enable template variables to add panels dynamically diff --git a/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows.md b/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows.md index 42b436c6597..c2f8ff94ca4 100644 --- a/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows.md +++ b/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/add-panels-dynamically/about-repeating-panels-rows/", "/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows/"] -title = "About repeating panels or rows" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/add-panels-dynamically/about-repeating-panels-rows/ + - /docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows/ +title: About repeating panels or rows +weight: 10 +--- # About repeating panels and rows diff --git a/docs/sources/panels/add-panels-dynamically/configure-repeating-panels.md b/docs/sources/panels/add-panels-dynamically/configure-repeating-panels.md index 7da31954724..bf326fe56cc 100644 --- a/docs/sources/panels/add-panels-dynamically/configure-repeating-panels.md +++ b/docs/sources/panels/add-panels-dynamically/configure-repeating-panels.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/add-panels-dynamically/configure-repeating-panels/", "/docs/sources/panels/add-panels-dynamically/configure-repeating-panels/"] -title = "Configure repeating panels" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/add-panels-dynamically/configure-repeating-panels/ + - /docs/sources/panels/add-panels-dynamically/configure-repeating-panels/ +title: Configure repeating panels +weight: 20 +--- # Configure repeating panels diff --git a/docs/sources/panels/add-panels-dynamically/configure-repeating-rows.md b/docs/sources/panels/add-panels-dynamically/configure-repeating-rows.md index f871eafc56d..0032abb5942 100644 --- a/docs/sources/panels/add-panels-dynamically/configure-repeating-rows.md +++ b/docs/sources/panels/add-panels-dynamically/configure-repeating-rows.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/add-panels-dynamically/configure-repeating-rows/", "/docs/sources/panels/add-panels-dynamically/configure-repeating-rows/"] -title = "Configure repeating rows" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/add-panels-dynamically/configure-repeating-rows/ + - /docs/sources/panels/add-panels-dynamically/configure-repeating-rows/ +title: Configure repeating rows +weight: 30 +--- # Configure repeating rows diff --git a/docs/sources/panels/calculation-types.md b/docs/sources/panels/calculation-types.md index b5dc6102a6d..342c0cc9b1d 100644 --- a/docs/sources/panels/calculation-types.md +++ b/docs/sources/panels/calculation-types.md @@ -1,8 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/panels/calculation-types/", "/docs/grafana/latest/panels/calculations-list/", "/docs/grafana/latest/panels/reference-calculation-types/", "/docs/sources/panels/reference-calculation-types/"] -title = "Calculation types" -weight = 1100 -+++ +--- +aliases: + - /docs/grafana/latest/panels/calculation-types/ + - /docs/grafana/latest/panels/calculations-list/ + - /docs/grafana/latest/panels/reference-calculation-types/ + - /docs/sources/panels/reference-calculation-types/ +title: Calculation types +weight: 1100 +--- # Reference: Calculation types diff --git a/docs/sources/panels/configure-thresholds/_index.md b/docs/sources/panels/configure-thresholds/_index.md index 499e5ac2647..11f2d84d2b6 100644 --- a/docs/sources/panels/configure-thresholds/_index.md +++ b/docs/sources/panels/configure-thresholds/_index.md @@ -21,17 +21,17 @@ This section includes information about using thresholds in your visualizations. A threshold is a value that you specify for a metric that is visually reflected in a dashboard when the threshold value is met or exceeded. -Thresholds provide one method for you to conditionally style and color your visualizations based on query results. You can apply thresholds to most, but not all, visualizations. For more information about visualizations, refer to [Visualization panels]({{< relref "../../visualizations" >}}). +Thresholds provide one method for you to conditionally style and color your visualizations based on query results. You can apply thresholds to most, but not all, visualizations. For more information about visualizations, refer to [Visualization panels]({{< relref "../../visualizations/" >}}). You can use thresholds to: -- Color grid lines or grid ares areas in the [Time-series visualization]({{< relref "../../visualizations/time-series" >}}) +- Color grid lines or grid ares areas in the [Time-series visualization]({{< relref "../../visualizations/time-series/" >}}) - Color lines in the [Time-series visualization]({{< relref "../../visualizations/time-series/graph-color-scheme/#from-thresholds" >}}) -- Color the background or value text in the [Stat visualization]({{< relref "../../visualizations/stat-panel" >}}) -- Color the gauge and threshold markers in the [Gauge visualization]({{< relref "../../visualizations/gauge-panel" >}}) -- Color markers in the [Geomap visualization]({{< relref "../../visualizations/geomap" >}}) -- Color cell text or background in the [Table visualization]({{< relref "../../visualizations/table" >}}) -- Define regions and region colors in the [State timeline visualization]({{< relref "../../visualizations/state-timeline" >}}) +- Color the background or value text in the [Stat visualization]({{< relref "../../visualizations/stat-panel/" >}}) +- Color the gauge and threshold markers in the [Gauge visualization]({{< relref "../../visualizations/gauge-panel/" >}}) +- Color markers in the [Geomap visualization]({{< relref "../../visualizations/geomap/" >}}) +- Color cell text or background in the [Table visualization]({{< relref "../../visualizations/table/" >}}) +- Define regions and region colors in the [State timeline visualization]({{< relref "../../visualizations/state-timeline/" >}}) There are two types of thresholds: diff --git a/docs/sources/panels/format-data/_index.md b/docs/sources/panels/format-data/_index.md index dbd9259c654..aa02d556864 100644 --- a/docs/sources/panels/format-data/_index.md +++ b/docs/sources/panels/format-data/_index.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/", "/docs/grafana/latest/panels/value-mappings/", "/docs/sources/panels/format-data/"] -title = "Format data using value mapping" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/ + - /docs/grafana/latest/panels/value-mappings/ + - /docs/sources/panels/format-data/ +title: Format data using value mapping +weight: 600 +--- # Format data using value mapping diff --git a/docs/sources/panels/format-data/about-value-mapping.md b/docs/sources/panels/format-data/about-value-mapping.md index c25589540e9..b249364e506 100644 --- a/docs/sources/panels/format-data/about-value-mapping.md +++ b/docs/sources/panels/format-data/about-value-mapping.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/about-value-mapping/", "/docs/sources/panels/format-data/about-value-mapping/"] -title = "About value mapping" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/about-value-mapping/ + - /docs/sources/panels/format-data/about-value-mapping/ +title: About value mapping +weight: 10 +--- # About value mapping diff --git a/docs/sources/panels/format-data/edit-value-mapping.md b/docs/sources/panels/format-data/edit-value-mapping.md index 81933c78a9e..4b2d3b2c13d 100644 --- a/docs/sources/panels/format-data/edit-value-mapping.md +++ b/docs/sources/panels/format-data/edit-value-mapping.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/edit-value-mapping/", "/docs/sources/panels/format-data/edit-value-mapping/"] -title = "Edit a value mapping" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/edit-value-mapping/ + - /docs/sources/panels/format-data/edit-value-mapping/ +title: Edit a value mapping +weight: 60 +--- # Edit a value mapping @@ -10,7 +12,7 @@ You can change a value mapping at any time. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). - Ensure you have an existing value mapping to edit. **To edit a value mapping**: diff --git a/docs/sources/panels/format-data/map-a-range.md b/docs/sources/panels/format-data/map-a-range.md index 9db57b69cdd..f11b22bf920 100644 --- a/docs/sources/panels/format-data/map-a-range.md +++ b/docs/sources/panels/format-data/map-a-range.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/map-a-range/", "/docs/sources/panels/format-data/map-a-range/"] -title = "Map a range" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/map-a-range/ + - /docs/sources/panels/format-data/map-a-range/ +title: Map a range +weight: 30 +--- # Map a range @@ -10,7 +12,7 @@ Map a range of values when you want to format multiple, continuous values. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To map a range**: diff --git a/docs/sources/panels/format-data/map-a-regular-expression.md b/docs/sources/panels/format-data/map-a-regular-expression.md index 99da7e9490d..6e0792b9062 100644 --- a/docs/sources/panels/format-data/map-a-regular-expression.md +++ b/docs/sources/panels/format-data/map-a-regular-expression.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/map-a-regular-expression/", "/docs/sources/panels/format-data/map-a-regular-expression/"] -title = "Map a regular expression" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/map-a-regular-expression/ + - /docs/sources/panels/format-data/map-a-regular-expression/ +title: Map a regular expression +weight: 40 +--- # Map a regular expression @@ -10,7 +12,7 @@ Map a regular expression when you want to format the text and color of a regular ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To map a regular expression**: diff --git a/docs/sources/panels/format-data/map-a-special-value.md b/docs/sources/panels/format-data/map-a-special-value.md index 9983eb72310..e7001a108a4 100644 --- a/docs/sources/panels/format-data/map-a-special-value.md +++ b/docs/sources/panels/format-data/map-a-special-value.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/map-a-special-value/", "/docs/sources/panels/format-data/map-a-special-value/"] -title = "Map a special value" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/map-a-special-value/ + - /docs/sources/panels/format-data/map-a-special-value/ +title: Map a special value +weight: 50 +--- # Map a special value @@ -10,7 +12,7 @@ Map a special value when you want to format uncommon, boolean, or empty values. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To map a special value**: diff --git a/docs/sources/panels/format-data/map-a-value.md b/docs/sources/panels/format-data/map-a-value.md index 83c36651c72..db848227bb6 100644 --- a/docs/sources/panels/format-data/map-a-value.md +++ b/docs/sources/panels/format-data/map-a-value.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/format-data/map-a-value/", "/docs/sources/panels/format-data/map-a-value/"] -title = "Map a value" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/format-data/map-a-value/ + - /docs/sources/panels/format-data/map-a-value/ +title: Map a value +weight: 20 +--- # Map a value @@ -10,7 +12,7 @@ Map a value when you want to format a single value. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To map a value**: diff --git a/docs/sources/panels/library-panels/_index.md b/docs/sources/panels/library-panels/_index.md index aebc09f8a32..7e35d457ecf 100644 --- a/docs/sources/panels/library-panels/_index.md +++ b/docs/sources/panels/library-panels/_index.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/", "/docs/grafana/latest/panels/panel-library/", "/docs/sources/panels/library-panels/"] -title = "Create reusable Grafana panels" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/ + - /docs/grafana/latest/panels/panel-library/ + - /docs/sources/panels/library-panels/ +title: Create reusable Grafana panels +weight: 700 +--- # Create reusable Grafana panels diff --git a/docs/sources/panels/library-panels/about-library-panels.md b/docs/sources/panels/library-panels/about-library-panels.md index 1a8f7a2b1dd..5a1bd2c905a 100644 --- a/docs/sources/panels/library-panels/about-library-panels.md +++ b/docs/sources/panels/library-panels/about-library-panels.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/about-library-panels/", "/docs/sources/panels/library-panels/about-library-panels/"] -title = "About Grafana library panels" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/about-library-panels/ + - /docs/sources/panels/library-panels/about-library-panels/ +title: About Grafana library panels +weight: 10 +--- # About Grafana panel libraries diff --git a/docs/sources/panels/library-panels/add-library-panel.md b/docs/sources/panels/library-panels/add-library-panel.md index 010d2545050..24be42ccf89 100644 --- a/docs/sources/panels/library-panels/add-library-panel.md +++ b/docs/sources/panels/library-panels/add-library-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/add-library-panel/", "/docs/sources/panels/library-panels/add-library-panel/"] -title = "Add a Grafana library panel to a dashboard" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/add-library-panel/ + - /docs/sources/panels/library-panels/add-library-panel/ +title: Add a Grafana library panel to a dashboard +weight: 30 +--- # Add a Grafana library panel to a dashboard @@ -10,7 +12,7 @@ Add a Grafana library panel to a dashboard when you want to provide visualizatio ## Before you begin -- [Create a library panel]({{< relref "../library-panels/create-library-panel.md" >}}). +- [Create a library panel]({{< relref "create-library-panel/" >}}). **To add a library panel to a dashboard**: diff --git a/docs/sources/panels/library-panels/create-library-panel.md b/docs/sources/panels/library-panels/create-library-panel.md index 92e4cc3c588..d8f8d18eb97 100644 --- a/docs/sources/panels/library-panels/create-library-panel.md +++ b/docs/sources/panels/library-panels/create-library-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/create-library-panel/", "/docs/sources/panels/library-panels/create-library-panel/"] -title = "Create a Grafana library panel" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/create-library-panel/ + - /docs/sources/panels/library-panels/create-library-panel/ +title: Create a Grafana library panel +weight: 20 +--- # Create a Grafana library panel @@ -10,7 +12,7 @@ When you create a library panel, the panel on the source dashboard is converted ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To create a library panel**: diff --git a/docs/sources/panels/library-panels/delete-library-panel.md b/docs/sources/panels/library-panels/delete-library-panel.md index e8213f53a0f..2d799887449 100644 --- a/docs/sources/panels/library-panels/delete-library-panel.md +++ b/docs/sources/panels/library-panels/delete-library-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/delete-library-panel/", "/docs/sources/panels/library-panels/delete-library-panel/"] -title = "Delete a Grafana library panel" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/delete-library-panel/ + - /docs/sources/panels/library-panels/delete-library-panel/ +title: Delete a Grafana library panel +weight: 60 +--- # Delete a Grafana library panel diff --git a/docs/sources/panels/library-panels/manage-library-panel.md b/docs/sources/panels/library-panels/manage-library-panel.md index 6222639f040..f15c9d4faca 100644 --- a/docs/sources/panels/library-panels/manage-library-panel.md +++ b/docs/sources/panels/library-panels/manage-library-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/manage-library-panel/", "/docs/sources/panels/library-panels/manage-library-panel/"] -title = "Manage Grafana library panels" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/manage-library-panel/ + - /docs/sources/panels/library-panels/manage-library-panel/ +title: Manage Grafana library panels +weight: 40 +--- # Manage Grafana library panels @@ -10,7 +12,7 @@ You can adjust library panel configuration at any time. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To view and manage a library panel**: diff --git a/docs/sources/panels/library-panels/unlink-library-panel.md b/docs/sources/panels/library-panels/unlink-library-panel.md index abd7c44c362..06173090d11 100644 --- a/docs/sources/panels/library-panels/unlink-library-panel.md +++ b/docs/sources/panels/library-panels/unlink-library-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/library-panels/unlink-library-panel/", "/docs/sources/panels/library-panels/unlink-library-panel/"] -title = "Unlink a Grafana library panel" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/panels/library-panels/unlink-library-panel/ + - /docs/sources/panels/library-panels/unlink-library-panel/ +title: Unlink a Grafana library panel +weight: 50 +--- # Unlink a Grafana library panel diff --git a/docs/sources/panels/override-field-values/_index.md b/docs/sources/panels/override-field-values/_index.md index 0fd419a7ec6..c4bde5b26a3 100644 --- a/docs/sources/panels/override-field-values/_index.md +++ b/docs/sources/panels/override-field-values/_index.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/panels/field-overrides/", "/docs/grafana/latest/panels/override-field-values/", "/docs/sources/panels/override-field-values/"] -title = "Override field values" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/panels/field-overrides/ + - /docs/grafana/latest/panels/override-field-values/ + - /docs/sources/panels/override-field-values/ +title: Override field values +weight: 400 +--- # Override field values diff --git a/docs/sources/panels/override-field-values/about-field-overrides.md b/docs/sources/panels/override-field-values/about-field-overrides.md index 29fe9da15e1..ba345dd9e9c 100644 --- a/docs/sources/panels/override-field-values/about-field-overrides.md +++ b/docs/sources/panels/override-field-values/about-field-overrides.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/override-field-values/about-field-overrides/", "/docs/sources/panels/override-field-values/about-field-overrides/"] -title = "About field overrides" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/override-field-values/about-field-overrides/ + - /docs/sources/panels/override-field-values/about-field-overrides/ +title: About field overrides +weight: 10 +--- # About field overrides diff --git a/docs/sources/panels/override-field-values/add-a-field-override.md b/docs/sources/panels/override-field-values/add-a-field-override.md index 64857fd825f..aa64da1546d 100644 --- a/docs/sources/panels/override-field-values/add-a-field-override.md +++ b/docs/sources/panels/override-field-values/add-a-field-override.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/override-field-values/add-a-field-override/", "/docs/sources/panels/override-field-values/add-a-field-override/"] -title = "Add a field override" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/override-field-values/add-a-field-override/ + - /docs/sources/panels/override-field-values/add-a-field-override/ +title: Add a field override +weight: 30 +--- # Add a field override @@ -10,7 +12,7 @@ You can override a field when you want to change the display of the value in the ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). **To add a field override**: diff --git a/docs/sources/panels/override-field-values/delete-a-field-override.md b/docs/sources/panels/override-field-values/delete-a-field-override.md index 1e35aea0f31..3557932847f 100644 --- a/docs/sources/panels/override-field-values/delete-a-field-override.md +++ b/docs/sources/panels/override-field-values/delete-a-field-override.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/override-field-values/delete-a-field-override/", "/docs/sources/panels/override-field-values/delete-a-field-override/"] -title = "Delete a field override" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/panels/override-field-values/delete-a-field-override/ + - /docs/sources/panels/override-field-values/delete-a-field-override/ +title: Delete a field override +weight: 50 +--- # Delete a field override @@ -12,8 +14,8 @@ When you delete an override, the appearance of value defaults to its original fo ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a field override]({{< relref "../override-field-values/add-a-field-override.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a field override]({{< relref "add-a-field-override/" >}}). **To delete a field override**: diff --git a/docs/sources/panels/override-field-values/edit-field-override.md b/docs/sources/panels/override-field-values/edit-field-override.md index bcb380403fe..87299454e9b 100644 --- a/docs/sources/panels/override-field-values/edit-field-override.md +++ b/docs/sources/panels/override-field-values/edit-field-override.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/override-field-values/edit-field-override/", "/docs/sources/panels/override-field-values/edit-field-override/"] -title = "Edit a field overrides" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/override-field-values/edit-field-override/ + - /docs/sources/panels/override-field-values/edit-field-override/ +title: Edit a field overrides +weight: 40 +--- # Edit a field override @@ -10,8 +12,8 @@ Edit a field override when you want to make changes to an override setting. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a field override]({{< relref "../override-field-values/add-a-field-override.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a field override]({{< relref "add-a-field-override/" >}}). **To edit a field override**: diff --git a/docs/sources/panels/override-field-values/view-field-override.md b/docs/sources/panels/override-field-values/view-field-override.md index 70f9ef2a650..6c8de2c741f 100644 --- a/docs/sources/panels/override-field-values/view-field-override.md +++ b/docs/sources/panels/override-field-values/view-field-override.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/override-field-values/view-field-override/", "/docs/sources/panels/override-field-values/view-field-override/"] -title = "View field overrides" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/override-field-values/view-field-override/ + - /docs/sources/panels/override-field-values/view-field-override/ +title: View field overrides +weight: 20 +--- # View field overrides @@ -10,8 +12,8 @@ You can view field overrides in the panel display options. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a field override]({{< relref "../override-field-values/add-a-field-override.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a field override]({{< relref "add-a-field-override/" >}}). **To view field overrides**: diff --git a/docs/sources/panels/query-a-data-source/_index.md b/docs/sources/panels/query-a-data-source/_index.md index 2fd11529214..40f2b205b7c 100644 --- a/docs/sources/panels/query-a-data-source/_index.md +++ b/docs/sources/panels/query-a-data-source/_index.md @@ -1,8 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/panels/expressions/", "/docs/grafana/latest/panels/inspect-panel/", "/docs/grafana/latest/panels/queries/", "/docs/grafana/latest/panels/query-a-data-source/", "/docs/grafana/latest/panels/share-query-results/", "/docs/sources/panels/query-a-data-source/_index/"] -title = "Query a data source" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/panels/expressions/ + - /docs/grafana/latest/panels/inspect-panel/ + - /docs/grafana/latest/panels/queries/ + - /docs/grafana/latest/panels/query-a-data-source/ + - /docs/grafana/latest/panels/share-query-results/ + - /docs/sources/panels/query-a-data-source/_index/ +title: Query a data source +weight: 200 +--- # Query a data source diff --git a/docs/sources/panels/query-a-data-source/about-queries.md b/docs/sources/panels/query-a-data-source/about-queries.md index f3dd392bb6f..f59246cbf65 100644 --- a/docs/sources/panels/query-a-data-source/about-queries.md +++ b/docs/sources/panels/query-a-data-source/about-queries.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/about-queries/", "/docs/sources/panels/query-a-data-source/about-queries/"] -title = "About queries" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/about-queries/ + - /docs/sources/panels/query-a-data-source/about-queries/ +title: About queries +weight: 10 +--- # About queries diff --git a/docs/sources/panels/query-a-data-source/add-a-query.md b/docs/sources/panels/query-a-data-source/add-a-query.md index e00229cb851..6fea5855c44 100644 --- a/docs/sources/panels/query-a-data-source/add-a-query.md +++ b/docs/sources/panels/query-a-data-source/add-a-query.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/add-a-query/", "/docs/sources/panels/query-a-data-source/add-a-query/"] -title = "Add a query" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/add-a-query/ + - /docs/sources/panels/query-a-data-source/add-a-query/ +title: Add a query +weight: 30 +--- # Add a query @@ -12,7 +14,7 @@ A query returns data that Grafana visualizes in dashboards. When you create a pa - [Add a data source](../../../datasources/add-a-data-source). - Ensure that you know the query language of the data source. -- [Add a panel]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel]({{< relref "../working-with-panels/add-panel/" >}}). **To add a query**: @@ -21,7 +23,7 @@ A query returns data that Grafana visualizes in dashboards. When you create a pa 1. Click the **Data source** drop-down menu and select a data source. 1. Click **Query options** to configure the maximum number of data points returned by the query and how frequently you want the query to request data from the data source. - For more information about query options, refer to [Query options]({{< relref "../query-options.md" >}}). + For more information about query options, refer to [Query options]({{< relref "../query-options/" >}}). 1. Write the query. 1. Click **Apply**. diff --git a/docs/sources/panels/query-a-data-source/download-raw-query-results.md b/docs/sources/panels/query-a-data-source/download-raw-query-results.md index fd43e9ccd18..6205539ae03 100644 --- a/docs/sources/panels/query-a-data-source/download-raw-query-results.md +++ b/docs/sources/panels/query-a-data-source/download-raw-query-results.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/download-raw-query-results/", "/docs/sources/panels/query-a-data-source/download-raw-query-results/"] -title = "Download raw query results" -weight = 70 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/download-raw-query-results/ + - /docs/sources/panels/query-a-data-source/download-raw-query-results/ +title: Download raw query results +weight: 70 +--- # Download raw query results @@ -10,8 +12,8 @@ Grafana generates a CSV file that contains your data, including any transformati ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a query]({{< relref "add-a-query/" >}}). **To download raw query results**: diff --git a/docs/sources/panels/query-a-data-source/inspect-query-performance.md b/docs/sources/panels/query-a-data-source/inspect-query-performance.md index 01d44021484..367b956254c 100644 --- a/docs/sources/panels/query-a-data-source/inspect-query-performance.md +++ b/docs/sources/panels/query-a-data-source/inspect-query-performance.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/inspect-query-performance/", "/docs/sources/panels/query-a-data-source/inspect-query-performance/"] -title = "Inspect query performance" -weight = 80 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/inspect-query-performance/ + - /docs/sources/panels/query-a-data-source/inspect-query-performance/ +title: Inspect query performance +weight: 80 +--- # Inspect query performance @@ -10,8 +12,8 @@ The **Stats** tab displays statistics that tell you how long your query takes, h ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a query]({{< relref "add-a-query/" >}}). **To inspect query performance**: diff --git a/docs/sources/panels/query-a-data-source/inspect-request-and-response-data.md b/docs/sources/panels/query-a-data-source/inspect-request-and-response-data.md index 452a5ea8b99..9b241cd61ae 100644 --- a/docs/sources/panels/query-a-data-source/inspect-request-and-response-data.md +++ b/docs/sources/panels/query-a-data-source/inspect-request-and-response-data.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/inspect-request-and-response-data/", "/docs/sources/panels/query-a-data-source/inspect-request-and-response-data/"] -title = "Inspect query request and response data" -weight = 90 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/inspect-request-and-response-data/ + - /docs/sources/panels/query-a-data-source/inspect-request-and-response-data/ +title: Inspect query request and response data +weight: 90 +--- # Inspect query request and response data @@ -10,8 +12,8 @@ Inspect query request and response data when you want to troubleshoot a query th ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). +- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). +- [Add a query]({{< relref "add-a-query/" >}}). **To inspect query request and response data**: diff --git a/docs/sources/panels/query-a-data-source/manage-queries.md b/docs/sources/panels/query-a-data-source/manage-queries.md index 27236ac3729..b87c75bfcde 100644 --- a/docs/sources/panels/query-a-data-source/manage-queries.md +++ b/docs/sources/panels/query-a-data-source/manage-queries.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/manage-queries/", "/docs/sources/panels/query-a-data-source/manage-queries/"] -title = "Manage queries" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/manage-queries/ + - /docs/sources/panels/query-a-data-source/manage-queries/ +title: Manage queries +weight: 50 +--- # Manage queries diff --git a/docs/sources/panels/query-a-data-source/navigate-query-tab.md b/docs/sources/panels/query-a-data-source/navigate-query-tab.md index c78303e84fc..d10c1982ace 100644 --- a/docs/sources/panels/query-a-data-source/navigate-query-tab.md +++ b/docs/sources/panels/query-a-data-source/navigate-query-tab.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/navigate-query-tab/", "/docs/sources/panels/query-a-data-source/navigate-query-tab/"] -title = "Navigate the query tab" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/navigate-query-tab/ + - /docs/sources/panels/query-a-data-source/navigate-query-tab/ +title: Navigate the query tab +weight: 20 +--- # Navigate the query tab diff --git a/docs/sources/panels/query-a-data-source/share-query.md b/docs/sources/panels/query-a-data-source/share-query.md index 378635ec516..13ebda3724e 100644 --- a/docs/sources/panels/query-a-data-source/share-query.md +++ b/docs/sources/panels/query-a-data-source/share-query.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/share-query/", "/docs/sources/panels/query-a-data-source/share-query/"] -title = "Share query results with another panel" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/share-query/ + - /docs/sources/panels/query-a-data-source/share-query/ +title: Share query results with another panel +weight: 60 +--- # Share query results with another panel @@ -14,9 +16,9 @@ This strategy can drastically reduce the number of queries being made when you f **To share data source queries with another panel**: -1. [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +1. [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}). 1. Change the title to "Source panel". You'll use this panel as a source for the other panels. -1. Define the [query]({{< relref "../query-a-data-source/add-a-query.md" >}}) or queries that you want share. +1. Define the [query]({{< relref "add-a-query/" >}}) or queries that you want share. If you don't have a data source available, use the **Grafana** data source, which returns a random time series that you can use for testing. diff --git a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/_index.md b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/_index.md index 8e93cd06bfa..f8518964015 100644 --- a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/_index.md +++ b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/_index.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/", "/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/"] -title = "Use expressions to manipulate data" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/ + - /docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/ +title: Use expressions to manipulate data +weight: 40 +--- # Use expressions to manipulate data diff --git a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md index d3e70d08a26..434c5dee4af 100644 --- a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md +++ b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/", "/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/"] -title = "About expressions" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/ + - /docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions/ +title: About expressions +weight: 10 +--- # About expressions @@ -12,7 +14,7 @@ Server-side expressions allow you to manipulate data returned from queries with ## Using expressions -Expressions are primarily used by [Grafana alerting]({{< relref "../../../alerting/_index.md" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization. +Expressions are primarily used by [Grafana alerting]({{< relref "../../../alerting/" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization. > **Note:** Expressions do not work with legacy dashboard alerts. @@ -20,7 +22,7 @@ Expressions are meant to augment data sources by enabling queries from different > **Note:** When possible, you should do data processing inside the data source. Copying data from storage to the Grafana server for processing is inefficient, so expressions are targeted at lightweight data processing. -Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data]({{< relref "../../../basics/timeseries-dimensions.md" >}}). For example, a query that returns multiple series, where each series is identified by labels or tags. +Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data]({{< relref "../../../basics/timeseries-dimensions/" >}}). For example, a query that returns multiple series, where each series is identified by labels or tags. An individual expression takes one or more queries or other expressions as input and adds data to the result. Each individual expression or query is represented by a variable that is a named identifier known as its RefID (e.g., the default letter `A` or `B`). @@ -33,7 +35,7 @@ Expressions work with two types of data. - A collection of time series. - A collection of numbers, where each number is an item. -Each collection is returned from a single data source query or expression and represented by the RefID. Each collection is a set, where each item in the set is uniquely identified by its dimensions which are stored as [labels]({{< relref "../../../basics/timeseries-dimensions.md#labels" >}}) or key-value pairs. +Each collection is returned from a single data source query or expression and represented by the RefID. Each collection is a set, where each item in the set is uniquely identified by its dimensions which are stored as [labels]({{< relref "../../../basics/timeseries-dimensions/#labels" >}}) or key-value pairs. ## Data source queries diff --git a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression.md b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression.md index 784f77d71cd..eec926894e4 100644 --- a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression.md +++ b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression.md @@ -1,18 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression/", "/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression/"] -title = "Write an expression" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression/ + - /docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/write-an-expression/ +title: Write an expression +weight: 20 +--- # Write an expression If your data source supports them, then Grafana displays the **Expression** button and shows any existing expressions in the query editor list. -For more information about expressions, refer to [About expressions]({{< relref "./about-expressions.md" >}}). +For more information about expressions, refer to [About expressions]({{< relref "about-expressions/" >}}). ## Before you begin -- [Add a panel]({{< relref "../../working-with-panels/add-panel.md" >}}). +- [Add a panel]({{< relref "../../working-with-panels/add-panel/" >}}). **To write an expression**: @@ -20,7 +22,7 @@ For more information about expressions, refer to [About expressions]({{< relref 1. Below the query, click **Expression**. 1. In the **Operation** field, select the type of expression you want to write. - For more information about expression operations, refer to [About expressions]({{< relref "./about-expressions.md" >}}). + For more information about expression operations, refer to [About expressions]({{< relref "about-expressions/" >}}). 1. Write the expression. 1. Click **Apply**. diff --git a/docs/sources/panels/query-options.md b/docs/sources/panels/query-options.md index 8ed869be197..358f70f09f2 100644 --- a/docs/sources/panels/query-options.md +++ b/docs/sources/panels/query-options.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/panels/query-options/", "/docs/grafana/latest/panels/reference-query-options/", "/docs/sources/panels/reference-query-options/"] -title = "Query options" -weight = 900 -+++ +--- +aliases: + - /docs/grafana/latest/panels/query-options/ + - /docs/grafana/latest/panels/reference-query-options/ + - /docs/sources/panels/reference-query-options/ +title: Query options +weight: 900 +--- # Reference: Query options @@ -28,13 +31,13 @@ Panel data source query options: This automatic interval is calculated based on the width of the graph. If the user zooms out a lot then the interval becomes greater, resulting in a more coarse grained aggregation whereas if the user zooms in then the interval decreases resulting in a more fine grained aggregation. - For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables.md" >}}). + For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables/" >}}). - **Relative time -** You can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the top right corner of the dashboard. This allows you to show metrics from different time periods or days on the same dashboard. - **Time shift -** The time shift function is another way to override the time range for individual panels. It only works with relative time ranges and allows you to adjust the time range. - For example, you could shift the time range for the panel to be two hours earlier than the dashboard time picker. For more information, refer to [Time range controls]({{< relref "../dashboards/time-range-controls.md" >}}). + For example, you could shift the time range for the panel to be two hours earlier than the dashboard time picker. For more information, refer to [Time range controls]({{< relref "../dashboards/time-range-controls/" >}}). - **Cache timeout -** (This field is only visible if available in your data source.) If your time series store has a query cache, then this option can override the default cache timeout. Specified as a numeric value in seconds. diff --git a/docs/sources/panels/standard-field-definitions.md b/docs/sources/panels/standard-field-definitions.md index 312005443f5..246681a511d 100644 --- a/docs/sources/panels/standard-field-definitions.md +++ b/docs/sources/panels/standard-field-definitions.md @@ -1,8 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/panels/reference-standard-field-definitions/", "/docs/grafana/latest/panels/standard-field-definitions/", "/docs/sources/panels/reference-standard-field-definitions/"] -title = "Standard field definitions" -weight = 1200 -+++ +--- +aliases: + - /docs/grafana/latest/panels/reference-standard-field-definitions/ + - /docs/grafana/latest/panels/standard-field-definitions/ + - /docs/sources/panels/reference-standard-field-definitions/ +title: Standard field definitions +weight: 1200 +--- # Reference: Standard field definitions @@ -24,11 +27,11 @@ To change this setting, type a number in the field and then click outside the fi Lets you control the URL to which a value or visualization link. -For more information and instructions, refer to [Data links]({{< relref "../linking/data-links.md" >}}). +For more information and instructions, refer to [Data links]({{< relref "../linking/data-links/" >}}). ## Display name -Lets you set the display title of all fields. You can use [variables]({{< relref "../variables/_index.md" >}}) in the field title. +Lets you set the display title of all fields. You can use [variables]({{< relref "../variables/" >}}) in the field title. When multiple stats, fields, or series are shown, this field controls the title in each stat. You can use expressions like `${__field.name}` to use only the series name or the field name in title. diff --git a/docs/sources/panels/transform-data/_index.md b/docs/sources/panels/transform-data/_index.md index 46b1b7d8956..fdd7afdd77f 100644 --- a/docs/sources/panels/transform-data/_index.md +++ b/docs/sources/panels/transform-data/_index.md @@ -1,8 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/panels/transform-data/", "/docs/grafana/latest/panels/transformations/", "/docs/grafana/latest/panels/transformations/apply-transformations/", "/docs/grafana/latest/panels/transformations/config-from-query/", "/docs/grafana/latest/panels/transformations/rows-to-fields/", "/docs/sources/panels/transform-data/"] -title = "Transform data" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/panels/transform-data/ + - /docs/grafana/latest/panels/transformations/ + - /docs/grafana/latest/panels/transformations/apply-transformations/ + - /docs/grafana/latest/panels/transformations/config-from-query/ + - /docs/grafana/latest/panels/transformations/rows-to-fields/ + - /docs/sources/panels/transform-data/ +title: Transform data +weight: 500 +--- # Transform data diff --git a/docs/sources/panels/transform-data/about-transformation.md b/docs/sources/panels/transform-data/about-transformation.md index ca814f06663..8d45b9df490 100644 --- a/docs/sources/panels/transform-data/about-transformation.md +++ b/docs/sources/panels/transform-data/about-transformation.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/transform-data/about-transformation/", "/docs/sources/panels/transform-data/about-transformation/"] -title = "About transformations" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/transform-data/about-transformation/ + - /docs/sources/panels/transform-data/about-transformation/ +title: About transformations +weight: 10 +--- # About transformations @@ -21,7 +23,7 @@ You can also use the output of one transformation as the input to another transf ## Transformation types -Grafana provides a number of ways that you can transform data. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). +Grafana provides a number of ways that you can transform data. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions/" >}}). ## Order of transformations diff --git a/docs/sources/panels/transform-data/add-transformation-to-data.md b/docs/sources/panels/transform-data/add-transformation-to-data.md index f5af584c5eb..ef9187bf547 100644 --- a/docs/sources/panels/transform-data/add-transformation-to-data.md +++ b/docs/sources/panels/transform-data/add-transformation-to-data.md @@ -1,16 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/panels/transform-data/add-transformation-to-data/", "/docs/grafana/latest/panels/transform-data/apply-transformation-to-data/", "/docs/sources/panels/transform-data/add-transformation-to-data/", "/docs/sources/panels/transform-data/apply-transformation-to-data/"] -title = "Add a transformation to data" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/transform-data/add-transformation-to-data/ + - /docs/grafana/latest/panels/transform-data/apply-transformation-to-data/ + - /docs/sources/panels/transform-data/add-transformation-to-data/ + - /docs/sources/panels/transform-data/apply-transformation-to-data/ +title: Add a transformation to data +weight: 20 +--- # Add a transformation function to data -The following steps guide you in adding a transformation to data. This documentation does not include steps for each type of transformation. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). +The following steps guide you in adding a transformation to data. This documentation does not include steps for each type of transformation. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions/" >}}). ## Before you begin -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). +- [Add a query]({{< relref "../query-a-data-source/add-a-query/" >}}). **To apply a transformation function to data**: @@ -19,9 +23,9 @@ The following steps guide you in adding a transformation to data. This documenta 1. Click the **Transform** tab. 1. Click a transformation. - A transformation row appears where you configure the transformation options. For more information about how to configure a transformation, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). + A transformation row appears where you configure the transformation options. For more information about how to configure a transformation, refer to [Transformation functions]({{< relref "transformation-functions/" >}}). - For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). + For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types/" >}}). 1. To apply another transformation, click **Add transformation**. diff --git a/docs/sources/panels/transform-data/debug-transformation.md b/docs/sources/panels/transform-data/debug-transformation.md index 3e0de08ac11..c809580bb46 100644 --- a/docs/sources/panels/transform-data/debug-transformation.md +++ b/docs/sources/panels/transform-data/debug-transformation.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/transform-data/debug-transformation/", "/docs/sources/panels/transform-data/debug-transformation/"] -title = "Debug a transformation" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/transform-data/debug-transformation/ + - /docs/sources/panels/transform-data/debug-transformation/ +title: Debug a transformation +weight: 30 +--- # Debug a transformation diff --git a/docs/sources/panels/transform-data/delete-transformation.md b/docs/sources/panels/transform-data/delete-transformation.md index 4543afbeb16..e0819287e0c 100644 --- a/docs/sources/panels/transform-data/delete-transformation.md +++ b/docs/sources/panels/transform-data/delete-transformation.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/transform-data/delete-transformation/", "/docs/sources/panels/transform-data/delete-transformation/"] -title = "Delete a transformation" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/transform-data/delete-transformation/ + - /docs/sources/panels/transform-data/delete-transformation/ +title: Delete a transformation +weight: 40 +--- # Delete a transformation diff --git a/docs/sources/panels/transform-data/transformation-functions.md b/docs/sources/panels/transform-data/transformation-functions.md index d11a16a741e..b478add76a7 100644 --- a/docs/sources/panels/transform-data/transformation-functions.md +++ b/docs/sources/panels/transform-data/transformation-functions.md @@ -1,8 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/panels/reference-transformation-functions/", "/docs/grafana/latest/panels/transform-data/transformation-functions/", "/docs/grafana/latest/panels/transformations/types-options/", "/docs/sources/panels/reference-transformation-functions/"] -title = "Transformation functions" -weight = 1000 -+++ +--- +aliases: + - /docs/grafana/latest/panels/reference-transformation-functions/ + - /docs/grafana/latest/panels/transform-data/transformation-functions/ + - /docs/grafana/latest/panels/transformations/types-options/ + - /docs/sources/panels/reference-transformation-functions/ +title: Transformation functions +weight: 1000 +--- # Reference: Transformation functions @@ -16,7 +20,7 @@ Use this transformation to add a new field calculated from two other fields. Eac - **Reduce row -** Apply selected calculation on each row of selected fields independently. - **Binary option -** Apply basic math operation(sum, multiply, etc) on values in a single row from two selected fields. - **Field name -** Select the names of fields you want to use in the calculation for the new field. -- **Calculation -** If you select **Reduce row** mode, then the **Calculation** field appears. Click in the field to see a list of calculation choices you can use to create the new field. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). +- **Calculation -** If you select **Reduce row** mode, then the **Calculation** field appears. Click in the field to see a list of calculation choices you can use to create the new field. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types/" >}}). - **Operation -** If you select **Binary option** mode, then the **Operation** fields appear. These fields allow you to do basic math operations on values in a single row from two selected fields. You can also use numerical values for binary operations. - **Alias -** (Optional) Enter the name of your new field. If you leave this blank, then the field will be named to match the calculation. - **Replace all fields -** (Optional) Select this option if you want to hide all other fields and display only your calculated field in the visualization. @@ -189,7 +193,7 @@ Conditions that are invalid or incompletely configured are ignored. ## Group by -This transformation groups the data by a specified field (column) value and processes calculations on each group. Click to see a list of calculation choices. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). +This transformation groups the data by a specified field (column) value and processes calculations on each group. Click to see a list of calculation choices. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types/" >}}). Here's an example of original data. @@ -323,7 +327,7 @@ After merge: ## Merge -Use this transformation to combine the result from multiple queries into one single result. This is helpful when using the table panel visualization. Values that can be merged are combined into the same row. Values are mergeable if the shared fields contain the same data. For information, refer to [Table panel]({{< relref "../../visualizations/table/_index.md" >}}). +Use this transformation to combine the result from multiple queries into one single result. This is helpful when using the table panel visualization. Values that can be merged are combined into the same row. Values are mergeable if the shared fields contain the same data. For information, refer to [Table panel]({{< relref "../../visualizations/table/" >}}). In the example below, we have two queries returning table data. It is visualized as two separate tables before applying the transformation. @@ -493,7 +497,7 @@ As you can see each row in the source data becomes a separate field. Each field > **Note:** This transformation is available in Grafana 7.5.10+ and Grafana 8.0.6+. -Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames]({{< relref "../../developers/plugins/data-frames.md" >}}). +Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames]({{< relref "../../developers/plugins/data-frames/" >}}). This transformation helps you resolve this issue by converting the time series data from either the wide format to the long format or the other way around. diff --git a/docs/sources/panels/working-with-panels/_index.md b/docs/sources/panels/working-with-panels/_index.md index 995003c52d4..858d0521d42 100644 --- a/docs/sources/panels/working-with-panels/_index.md +++ b/docs/sources/panels/working-with-panels/_index.md @@ -1,8 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/panels/add-a-panel/", "/docs/grafana/latest/panels/legend-options/", "/docs/grafana/latest/panels/panel-editor/", "/docs/grafana/latest/panels/panel-options/", "/docs/grafana/latest/panels/standard-options/", "/docs/grafana/latest/panels/working-with-panels/", "/docs/sources/panels/working-with-panels/"] -title = "Working with Grafana panels" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/panels/add-a-panel/ + - /docs/grafana/latest/panels/legend-options/ + - /docs/grafana/latest/panels/panel-editor/ + - /docs/grafana/latest/panels/panel-options/ + - /docs/grafana/latest/panels/standard-options/ + - /docs/grafana/latest/panels/working-with-panels/ + - /docs/sources/panels/working-with-panels/ +title: Working with Grafana panels +weight: 100 +--- # Working with Grafana panels diff --git a/docs/sources/panels/working-with-panels/add-link-to-panel.md b/docs/sources/panels/working-with-panels/add-link-to-panel.md index 04d9b24fd52..babe00e2900 100644 --- a/docs/sources/panels/working-with-panels/add-link-to-panel.md +++ b/docs/sources/panels/working-with-panels/add-link-to-panel.md @@ -1,11 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/add-link-to-panel/", "/docs/sources/panels/working-with-panels/add-link-to-panel/"] -title = "Add a link to a panel" -weight = 60 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/add-link-to-panel/ + - /docs/sources/panels/working-with-panels/add-link-to-panel/ +title: Add a link to a panel +weight: 60 +--- # Add a link to a panel {{< docs/shared "panels/panel-links-intro.md" >}} -For more information, refer to [Panel links]({{< relref "../../linking/panel-links.md" >}}). +For more information, refer to [Panel links]({{< relref "../../linking/panel-links/" >}}). diff --git a/docs/sources/panels/working-with-panels/add-panel.md b/docs/sources/panels/working-with-panels/add-panel.md index 0629dee8fa7..5359473e3b4 100644 --- a/docs/sources/panels/working-with-panels/add-panel.md +++ b/docs/sources/panels/working-with-panels/add-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/add-panel/", "/docs/sources/panels/working-with-panels/add-panel/"] -title = "Add a panel to a dashboard" -weight = 20 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/add-panel/ + - /docs/sources/panels/working-with-panels/add-panel/ +title: Add a panel to a dashboard +weight: 20 +--- # Add a panel to a dashboard @@ -10,10 +12,10 @@ Panels allow you to show your data in visual form. Each panel needs at least one ## Before you begin -- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}). +- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). - Identify the dashboard to which you want to add the panel. - Understand the query language of the target data source. -- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source]({{< relref "../../datasources/add-a-data-source.md" >}}) if you need instructions. +- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source]({{< relref "../../datasources/add-a-data-source/" >}}) if you need instructions. **To add a panel to a dashboard**: @@ -30,7 +32,7 @@ Panels allow you to show your data in visual form. Each panel needs at least one 1. Write or construct a query in the query language of your data source. - For more information about data sources, refer to [Data sources]({{< relref "../../datasources/_index.md" >}}) for specific guidelines. + For more information about data sources, refer to [Data sources]({{< relref "../../datasources/" >}}) for specific guidelines. 1. In the Visualization list, select a visualization type. @@ -38,17 +40,17 @@ Panels allow you to show your data in visual form. Each panel needs at least one ![](/static/img/docs/panel-editor/select-visualization-8-0.png) - For more information about individual visualizations, refer to [Visualizations options]({{< relref "../../visualizations/_index.md" >}}). + For more information about individual visualizations, refer to [Visualizations options]({{< relref "../../visualizations/" >}}). 1. Refer to the following documentation for ways you adjust panel settings. While not required, most visualizations need some adjustment before they properly display the information that you need. - - [Format data using value mapping]({{< relref "../format-data/about-value-mapping.md" >}}) - - [Visualization-specific options]({{< relref "../../visualizations/_index.md" >}}) - - [Override field values]({{< relref "../override-field-values/about-field-overrides.md" >}}) + - [Format data using value mapping]({{< relref "../format-data/about-value-mapping/" >}}) + - [Visualization-specific options]({{< relref "../../visualizations/" >}}) + - [Override field values]({{< relref "../override-field-values/about-field-overrides/" >}}) - [Configure thresholds]({{< relref "../configure-thresholds/" >}}) - - [Apply color to series and fields]({{< relref "./apply-color-to-series.md" >}}) + - [Apply color to series and fields]({{< relref "apply-color-to-series/" >}}) 1. Add a note to describe the visualization (or describe your changes) and then click **Save** in the upper-right corner of the page. diff --git a/docs/sources/panels/working-with-panels/add-title-and-description.md b/docs/sources/panels/working-with-panels/add-title-and-description.md index 39be901b3ab..f6ca5e9f76d 100644 --- a/docs/sources/panels/working-with-panels/add-title-and-description.md +++ b/docs/sources/panels/working-with-panels/add-title-and-description.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/add-title-and-description/", "/docs/sources/panels/working-with-panels/add-title-and-description/"] -title = "Add a title and description to a panel" -weight = 30 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/add-title-and-description/ + - /docs/sources/panels/working-with-panels/add-title-and-description/ +title: Add a title and description to a panel +weight: 30 +--- # Add a title and description to a panel @@ -10,7 +12,7 @@ Add a title and description to a panel to share with users any important informa ## Before you begin: -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "add-panel/" >}}). **To add a title and description to a panel**: @@ -22,12 +24,12 @@ Add a title and description to a panel to share with users any important informa Text entered in this field is displayed at the top of your panel in the panel editor and in the dashboard. - You can use [variables you have defined]({{< relref "../../variables/_index.md" >}}) in either field, but not [global variables]({{< relref "../../variables/variable-types/global-variables.md" >}}). + You can use [variables you have defined]({{< relref "../../variables/" >}}) in either field, but not [global variables]({{< relref "../../variables/variable-types/global-variables/" >}}). 1. Write a description of the panel and the data you are displaying. Text entered in this field is displayed in a tooltip in the upper left corner of the panel. - You can use [variables you have defined]({{< relref "../../variables/_index.md" >}}) in either field, but not [global variables]({{< relref "../../variables/variable-types/global-variables.md" >}}). + You can use [variables you have defined]({{< relref "../../variables/" >}}) in either field, but not [global variables]({{< relref "../../variables/variable-types/global-variables/" >}}). ![](/static/img/docs/panels/panel-options-8-0.png) diff --git a/docs/sources/panels/working-with-panels/apply-color-to-series.md b/docs/sources/panels/working-with-panels/apply-color-to-series.md index 4e3902b48bc..ba03bd60105 100644 --- a/docs/sources/panels/working-with-panels/apply-color-to-series.md +++ b/docs/sources/panels/working-with-panels/apply-color-to-series.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/apply-color-to-series/", "/docs/sources/panels/working-with-panels/apply-color-to-series/"] -title = "Apply color to series and fields" -weight = 50 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/apply-color-to-series/ + - /docs/sources/panels/working-with-panels/apply-color-to-series/ +title: Apply color to series and fields +weight: 50 +--- # Apply color to series and fields @@ -13,7 +15,7 @@ Continuous color interpolates a color using the percentage of a value relative t ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "add-panel/" >}}). **To apply color to series and fields**: diff --git a/docs/sources/panels/working-with-panels/configure-legend.md b/docs/sources/panels/working-with-panels/configure-legend.md index 89f119803dc..d34df9f4f81 100644 --- a/docs/sources/panels/working-with-panels/configure-legend.md +++ b/docs/sources/panels/working-with-panels/configure-legend.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/configure-legend/", "/docs/sources/panels/working-with-panels/configure-legend/"] -title = "Configure a legend" -weight = 70 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/configure-legend/ + - /docs/sources/panels/working-with-panels/configure-legend/ +title: Configure a legend +weight: 70 +--- # Configure a legend @@ -16,7 +18,7 @@ When you apply your changes, the visualization changes appear to all users of th ### Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "add-panel/" >}}). **To isolate series data in a visualization**: @@ -34,12 +36,12 @@ When you apply your changes, the visualization changes appear to all users of th This topic currently applies to the following visualizations: -- [Bar chart]({{< relref "../../visualizations/bar-chart.md" >}}) -- [Histogram]({{< relref "../../visualizations/histogram.md" >}}) -- [Pie chart]({{< relref "../../visualizations/pie-chart-panel.md" >}}) -- [State timeline]({{< relref "../../visualizations/state-timeline.md" >}}) -- [Status history]({{< relref "../../visualizations/status-history.md" >}}) -- [Time series]({{< relref "../../visualizations/time-series/_index.md" >}}) +- [Bar chart]({{< relref "../../visualizations/bar-chart/" >}}) +- [Histogram]({{< relref "../../visualizations/histogram/" >}}) +- [Pie chart]({{< relref "../../visualizations/pie-chart-panel/" >}}) +- [State timeline]({{< relref "../../visualizations/state-timeline/" >}}) +- [Status history]({{< relref "../../visualizations/status-history/" >}}) +- [Time series]({{< relref "../../visualizations/time-series/" >}}) ## Add values to a legend @@ -83,7 +85,7 @@ By default, Grafana specifies the color of your series data, which you can chang ## Sort series -Change legend mode to **Table** and choose [calculations]({{< relref "../calculation-types.md" >}}) to be displayed in the legend. Click the calculation name header in the legend table to sort the values in the table in ascending or descending order. +Change legend mode to **Table** and choose [calculations]({{< relref "../calculation-types/" >}}) to be displayed in the legend. Click the calculation name header in the legend table to sort the values in the table in ascending or descending order. The sort order affects the positions of the bars in the Bar chart panel as well as the order of stacked series in the Time series and Bar chart panels. diff --git a/docs/sources/panels/working-with-panels/download-query-results.md b/docs/sources/panels/working-with-panels/download-query-results.md index 524a6f3bf84..c7589a88b0f 100644 --- a/docs/sources/panels/working-with-panels/download-query-results.md +++ b/docs/sources/panels/working-with-panels/download-query-results.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/download-query-results/", "/docs/sources/panels/working-with-panels/download-query-results/"] -title = "Download query results" -weight = 110 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/download-query-results/ + - /docs/sources/panels/working-with-panels/download-query-results/ +title: Download query results +weight: 110 +--- # Download query results @@ -10,7 +12,7 @@ Grafana generates a text (.txt) file that contains the results of a query, which ## Before you begin -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). +- [Add a query]({{< relref "../query-a-data-source/add-a-query/" >}}). **To download query results**: diff --git a/docs/sources/panels/working-with-panels/format-standard-fields.md b/docs/sources/panels/working-with-panels/format-standard-fields.md index 48971fa92a6..6d83f8d9857 100644 --- a/docs/sources/panels/working-with-panels/format-standard-fields.md +++ b/docs/sources/panels/working-with-panels/format-standard-fields.md @@ -1,22 +1,24 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/format-standard-fields/", "/docs/sources/panels/working-with-panels/format-standard-fields/"] -title = "Format a standard field" -weight = 40 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/format-standard-fields/ + - /docs/sources/panels/working-with-panels/format-standard-fields/ +title: Format a standard field +weight: 40 +--- # Format a standard field -The data model used in Grafana, namely the [data frame]({{< relref "../../developers/plugins/data-frames.md" >}}), is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a _field_. A field can represent a single time series or table column. +The data model used in Grafana, namely the [data frame]({{< relref "../../developers/plugins/data-frames/" >}}), is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a _field_. A field can represent a single time series or table column. Field options allow you to change how the data is displayed in your visualizations. Options and overrides that you apply do not change the data, they change how Grafana displays the data. When you change an option, it is applied to all fields, meaning all series or columns. For example, if you change the unit to percentage, then all fields with numeric values are displayed in percentages. -For a complete list of field formatting options, refer to [Standard field definitions]({{< relref "../standard-field-definitions.md" >}}). +For a complete list of field formatting options, refer to [Standard field definitions]({{< relref "../standard-field-definitions/" >}}). > You can apply standard options to most built-in Grafana panels. Some older panels and community panels that have not updated to the new panel and data model will be missing either all or some of these field options. ## Before you begin -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "add-panel/" >}}). **To format a standard field**: @@ -26,6 +28,6 @@ For a complete list of field formatting options, refer to [Standard field defini 1. Select the standard options you want to apply. - For more information about standard options, refer to [Standard field definitions]({{< relref "../standard-field-definitions/index.md" >}}). + For more information about standard options, refer to [Standard field definitions]({{< relref "../standard-field-definitions/" >}}). 1. To preview your change, click outside of the field option box you are editing or press **Enter**. diff --git a/docs/sources/panels/working-with-panels/navigate-inspector-panel.md b/docs/sources/panels/working-with-panels/navigate-inspector-panel.md index 21f50e74fe1..f61c499c1a3 100644 --- a/docs/sources/panels/working-with-panels/navigate-inspector-panel.md +++ b/docs/sources/panels/working-with-panels/navigate-inspector-panel.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/navigate-inspector-panel/", "/docs/sources/panels/working-with-panels/navigate-inspector-panel/"] -title = "Navigate the Grafana Inspector panel" -weight = 90 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/navigate-inspector-panel/ + - /docs/sources/panels/working-with-panels/navigate-inspector-panel/ +title: Navigate the Grafana Inspector panel +weight: 90 +--- # Navigate the Grafana Inspector panel diff --git a/docs/sources/panels/working-with-panels/navigate-panel-editor.md b/docs/sources/panels/working-with-panels/navigate-panel-editor.md index aff5b4f3774..4fe5faadee2 100644 --- a/docs/sources/panels/working-with-panels/navigate-panel-editor.md +++ b/docs/sources/panels/working-with-panels/navigate-panel-editor.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/navigate-panel-editor/", "/docs/sources/panels/working-with-panels/navigate-panel-editor/"] -title = "Navigate the Grafana panel editor" -weight = 10 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/navigate-panel-editor/ + - /docs/sources/panels/working-with-panels/navigate-panel-editor/ +title: Navigate the Grafana panel editor +weight: 10 +--- # Navigate the Grafana panel editor @@ -20,20 +22,20 @@ This page describes the parts of the Grafana panel editor. - **Table view -** Convert any visualization to a table so that you can see the data. Table views are useful for troubleshooting. - **Fill -** The visualization preview fills the available space. If you change the width of the side pane or height of the bottom pane the visualization changes to fill the available space. - **Actual -** The visualization preview will have the exact size as the size on the dashboard. If not enough space is available, the visualization will scale down preserving the aspect ratio. - - **Time range controls -** For more information, refer to [Time range controls]({{< relref "../../dashboards/time-range-controls.md" >}}). + - **Time range controls -** For more information, refer to [Time range controls]({{< relref "../../dashboards/time-range-controls/" >}}). 3. Data section: The data section contains tabs where you enter queries, transform your data, and create alert rules (if applicable). - - **Query tab -** Select your data source and enter queries here. For more information, refer to [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). + - **Query tab -** Select your data source and enter queries here. For more information, refer to [Add a query]({{< relref "../query-a-data-source/add-a-query/" >}}). - - **Transform tab -** Apply data transformations. For more information, refer to [Transform data]({{< relref "../transform-data/_index.md" >}}). - - **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../../alerting/_index.md" >}}). + - **Transform tab -** Apply data transformations. For more information, refer to [Transform data]({{< relref "../transform-data/" >}}). + - **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../../alerting/" >}}). 4. Panel display options: The display options section contains tabs where you configure almost every aspect of your data visualization, including: - - [Apply color to series and fields]({{< relref "./apply-color-to-series.md" >}}) - - [Format a standard field]({{< relref "./format-standard-fields.md" >}}) - - [Add a title and description to a panel]({{< relref "./add-title-and-description.md" >}}) + - [Apply color to series and fields]({{< relref "apply-color-to-series/" >}}) + - [Format a standard field]({{< relref "format-standard-fields/" >}}) + - [Add a title and description to a panel]({{< relref "add-title-and-description/" >}}) > Not all options are available for each visualization. diff --git a/docs/sources/panels/working-with-panels/organize-dashboard.md b/docs/sources/panels/working-with-panels/organize-dashboard.md index 02465b252f5..8c615242727 100644 --- a/docs/sources/panels/working-with-panels/organize-dashboard.md +++ b/docs/sources/panels/working-with-panels/organize-dashboard.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/organize-dashboard/", "/docs/sources/panels/working-with-panels/organize-dashboard/"] -title = "Organize a dashboard" -weight = 80 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/organize-dashboard/ + - /docs/sources/panels/working-with-panels/organize-dashboard/ +title: Organize a dashboard +weight: 80 +--- # Organize a dashboard diff --git a/docs/sources/panels/working-with-panels/view-json-model.md b/docs/sources/panels/working-with-panels/view-json-model.md index 8e7afff81a0..be52a641d5b 100644 --- a/docs/sources/panels/working-with-panels/view-json-model.md +++ b/docs/sources/panels/working-with-panels/view-json-model.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/panels/working-with-panels/view-json-model/", "/docs/sources/panels/working-with-panels/view-json-model/"] -title = "View a panel JSON model" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/panels/working-with-panels/view-json-model/ + - /docs/sources/panels/working-with-panels/view-json-model/ +title: View a panel JSON model +weight: 100 +--- # View a panel JSON model @@ -10,7 +12,7 @@ Explore and export panel, panel data, and data frame JSON models. ## Before you begin: -- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}). +- [Add a panel to a dashboard]({{< relref "add-panel/" >}}). **To view a panel JSON model**: diff --git a/docs/sources/plugins/_index.md b/docs/sources/plugins/_index.md index 15f607fdcfb..92886bfaf43 100644 --- a/docs/sources/plugins/_index.md +++ b/docs/sources/plugins/_index.md @@ -1,14 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/plugins/"] -title = "Plugins" -weight = 160 -+++ +--- +aliases: + - /docs/grafana/latest/plugins/ +title: Plugins +weight: 160 +--- # Plugins Besides the wide range of visualizations and data sources that are available immediately after you install Grafana, you can extend your Grafana experience with _plugins_. -You can [install]({{< relref "installation.md" >}}) one of the plugins built by the Grafana community, or [build one yourself]({{< relref "../developers/plugins/_index.md" >}}). +You can [install]({{< relref "installation/" >}}) one of the plugins built by the Grafana community, or [build one yourself]({{< relref "../developers/plugins/" >}}). Grafana supports three types of plugins: [panels](https://grafana.com/grafana/plugins?type=panel), [data sources](https://grafana.com/grafana/plugins?type=datasource), and [apps](https://grafana.com/grafana/plugins?type=app). @@ -40,6 +41,6 @@ Use app plugins when you want to create an custom out-of-the-box monitoring expe ## Learn more -- [Install plugins]({{< relref "./installation.md" >}}) -- [Plugin signatures]({{< relref "./plugin-signatures.md" >}}) +- [Install plugins]({{< relref "installation/" >}}) +- [Plugin signatures]({{< relref "plugin-signatures/" >}}) - Browse the available [Plugins](https://grafana.com/grafana/plugins) diff --git a/docs/sources/plugins/catalog.md b/docs/sources/plugins/catalog.md index 231e5eb226a..a0193839ce1 100644 --- a/docs/sources/plugins/catalog.md +++ b/docs/sources/plugins/catalog.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/plugins/catalog/"] -title = "Plugin catalog" -weight = 1 -+++ +--- +aliases: + - /docs/grafana/latest/plugins/catalog/ +title: Plugin catalog +weight: 1 +--- # Plugin catalog @@ -23,7 +24,7 @@ The Plugin catalog allows you to browse and manage plugins from within Grafana.
-In order to be able to install / uninstall / update plugins using plugin catalog, you must enable it via the `plugin_admin_enabled` flag in the [configuration]({{< relref "../administration/configuration.md#plugin_admin_enabled" >}}) file. +In order to be able to install / uninstall / update plugins using plugin catalog, you must enable it via the `plugin_admin_enabled` flag in the [configuration]({{< relref "../setup-grafana/configure-grafana/#plugin_admin_enabled" >}}) file. Before following the steps below, make sure you are logged in as a Grafana administrator. diff --git a/docs/sources/plugins/installation.md b/docs/sources/plugins/installation.md index 56342b803df..729390907cc 100644 --- a/docs/sources/plugins/installation.md +++ b/docs/sources/plugins/installation.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/plugins/installation/"] -title = "Install plugins" -weight = 1 -+++ +--- +aliases: + - /docs/grafana/latest/plugins/installation/ +title: Install plugins +weight: 1 +--- # Install Grafana plugins @@ -23,9 +24,9 @@ If you are logged in to Grafana Cloud when you add a plugin, log out and back in Follow the instructions on the Install tab. You can either install the plugin with a Grafana CLI command or by downloading and uncompress a .zip file into the Grafana plugins directory. We recommend using Grafana CLI in most instances. The .zip option is available if your Grafana server does not have access to the internet. -For more information about Grafana CLI plugin commands, refer to [Plugin commands]({{< relref "../administration/cli.md#plugins-commands" >}}). +For more information about Grafana CLI plugin commands, refer to [Plugin commands]({{< relref "../administration/cli/#plugins-commands" >}}). -As of Grafana v8.0, a plugin catalog app was introduced in order to make managing plugins easier. For more information, refer to [Plugin catalog]({{< relref "./catalog.md" >}}). +As of Grafana v8.0, a plugin catalog app was introduced in order to make managing plugins easier. For more information, refer to [Plugin catalog]({{< relref "catalog/" >}}). ### Install a packaged plugin @@ -35,4 +36,4 @@ After the user has downloaded the archive containing the plugin assets, they can unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin ``` -The path to the plugin directory is defined in the configuration file. For more information, refer to [Configuration]({{< relref "../administration/configuration.md#plugins" >}}). +The path to the plugin directory is defined in the configuration file. For more information, refer to [Configuration]({{< relref "../setup-grafana/configure-grafana/#plugins" >}}). diff --git a/docs/sources/plugins/plugin-signatures.md b/docs/sources/plugins/plugin-signatures.md index caa406e8e40..1902ccfd2dd 100644 --- a/docs/sources/plugins/plugin-signatures.md +++ b/docs/sources/plugins/plugin-signatures.md @@ -1,8 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/plugins/plugin-signature-verification/", "/docs/grafana/latest/plugins/plugin-signatures/"] -title = "Plugin signatures" -type = "docs" -+++ +--- +aliases: + - /docs/grafana/latest/plugins/plugin-signature-verification/ + - /docs/grafana/latest/plugins/plugin-signatures/ +title: Plugin signatures +type: docs +--- # Plugin signatures @@ -16,7 +18,7 @@ Grafana also writes an error message to the server log: WARN[05-26|12:00:00] Some plugin scanning errors were found errors="plugin '' is unsigned, plugin '' has an invalid signature" ``` -If you are a plugin developer and want to know how to sign your plugin, refer to [Sign a plugin]({{< relref "../developers/plugins/sign-a-plugin.md" >}}). +If you are a plugin developer and want to know how to sign your plugin, refer to [Sign a plugin]({{< relref "../developers/plugins/sign-a-plugin/" >}}). | Signature status | Description | | ------------------ | ------------------------------------------------------------------------------- | @@ -40,7 +42,7 @@ All plugins is signed under a _signature level_. The signature level determines > **Note:** Unsigned plugins are not supported in Grafana Cloud. -We strongly recommend that you don't run unsigned plugins in your Grafana instance. If you're aware of the risks and you still want to load an unsigned plugin, refer to [Configuration]({{< relref "../administration/configuration.md#allow_loading_unsigned_plugins" >}}). +We strongly recommend that you don't run unsigned plugins in your Grafana instance. If you're aware of the risks and you still want to load an unsigned plugin, refer to [Configuration]({{< relref "../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins" >}}). If you've allowed loading of an unsigned plugin, then Grafana writes a warning message to the server log: diff --git a/docs/sources/release-notes/_index.md b/docs/sources/release-notes/_index.md index d9890a61da9..ea437b3e488 100644 --- a/docs/sources/release-notes/_index.md +++ b/docs/sources/release-notes/_index.md @@ -1,99 +1,104 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/"] -title = "Release notes" -weight = 10000 -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/ +title: Release notes +weight: 10000 +--- # Release notes Here you can find detailed release notes that list everything that is included in every release as well as notices about deprecations, breaking changes as well as changes that relate to plugin development. -- [Release notes for 9.0.0-beta1]({{< relref "release-notes-9-0-0-beta1" >}}) -- [Release notes for 8.5.3]({{< relref "release-notes-8-5-3" >}}) -- [Release notes for 8.5.2]({{< relref "release-notes-8-5-2" >}}) -- [Release notes for 8.5.1]({{< relref "release-notes-8-5-1" >}}) -- [Release notes for 8.5.0]({{< relref "release-notes-8-5-0" >}}) -- [Release notes for 8.5.0-beta1]({{< relref "release-notes-8-5-0-beta1" >}}) -- [Release notes for 8.4.7]({{< relref "release-notes-8-4-7" >}}) -- [Release notes for 8.4.6]({{< relref "release-notes-8-4-6" >}}) -- [Release notes for 8.4.5]({{< relref "release-notes-8-4-5" >}}) -- [Release notes for 8.4.4]({{< relref "release-notes-8-4-4" >}}) -- [Release notes for 8.4.3]({{< relref "release-notes-8-4-3" >}}) -- [Release notes for 8.4.2]({{< relref "release-notes-8-4-2" >}}) -- [Release notes for 8.4.1]({{< relref "release-notes-8-4-1" >}}) -- [Release notes for 8.4.0-beta1]({{< relref "release-notes-8-4-0-beta1" >}}) -- [Release notes for 8.3.7]({{< relref "release-notes-8-3-7" >}}) -- [Release notes for 8.3.6]({{< relref "release-notes-8-3-6" >}}) -- [Release notes for 8.3.5]({{< relref "release-notes-8-3-5" >}}) -- [Release notes for 8.3.4]({{< relref "release-notes-8-3-4" >}}) -- [Release notes for 8.3.3]({{< relref "release-notes-8-3-3" >}}) -- [Release notes for 8.3.2]({{< relref "release-notes-8-3-2" >}}) -- [Release notes for 8.3.1]({{< relref "release-notes-8-3-1" >}}) -- [Release notes for 8.3.0]({{< relref "release-notes-8-3-0" >}}) -- [Release notes for 8.3.0-beta2]({{< relref "release-notes-8-3-0-beta2" >}}) -- [Release notes for 8.3.0-beta1]({{< relref "release-notes-8-3-0-beta1" >}}) -- [Release notes for 8.2.7]({{< relref "release-notes-8-2-7" >}}) -- [Release notes for 8.2.6]({{< relref "release-notes-8-2-6" >}}) -- [Release notes for 8.2.5]({{< relref "release-notes-8-2-5" >}}) -- [Release notes for 8.2.4]({{< relref "release-notes-8-2-4" >}}) -- [Release notes for 8.2.3]({{< relref "release-notes-8-2-3" >}}) -- [Release notes for 8.2.2]({{< relref "release-notes-8-2-2" >}}) -- [Release notes for 8.2.1]({{< relref "release-notes-8-2-1" >}}) -- [Release notes for 8.2.0]({{< relref "release-notes-8-2-0" >}}) -- [Release notes for 8.2.0-beta2]({{< relref "release-notes-8-2-0-beta2" >}}) -- [Release notes for 8.2.0-beta1]({{< relref "release-notes-8-2-0-beta1" >}}) -- [Release notes for 8.1.8]({{< relref "release-notes-8-1-8" >}}) -- [Release notes for 8.1.7]({{< relref "release-notes-8-1-7" >}}) -- [Release notes for 8.1.6]({{< relref "release-notes-8-1-6" >}}) -- [Release notes for 8.1.5]({{< relref "release-notes-8-1-5" >}}) -- [Release notes for 8.1.4]({{< relref "release-notes-8-1-4" >}}) -- [Release notes for 8.1.3]({{< relref "release-notes-8-1-3" >}}) -- [Release notes for 8.1.2]({{< relref "release-notes-8-1-2" >}}) -- [Release notes for 8.1.1]({{< relref "release-notes-8-1-1" >}}) -- [Release notes for 8.1.0]({{< relref "release-notes-8-1-0" >}}) -- [Release notes for 8.1.0-beta3]({{< relref "release-notes-8-1-0-beta3" >}}) -- [Release notes for 8.1.0-beta2]({{< relref "release-notes-8-1-0-beta2" >}}) -- [Release notes for 8.1.0-beta1]({{< relref "release-notes-8-1-0-beta1" >}}) -- [Release notes for 8.0.7]({{< relref "release-notes-8-0-7" >}}) -- [Release notes for 8.0.6]({{< relref "release-notes-8-0-6" >}}) -- [Release notes for 8.0.5]({{< relref "release-notes-8-0-5" >}}) -- [Release notes for 8.0.4]({{< relref "release-notes-8-0-4" >}}) -- [Release notes for 8.0.3]({{< relref "release-notes-8-0-3" >}}) -- [Release notes for 8.0.2]({{< relref "release-notes-8-0-2" >}}) -- [Release notes for 8.0.1]({{< relref "release-notes-8-0-1" >}}) -- [Release notes for 8.0.0]({{< relref "release-notes-8-0-0" >}}) -- [Release notes for 8.0.0-beta3]({{< relref "release-notes-8-0-0-beta3" >}}) -- [Release notes for 8.0.0-beta2]({{< relref "release-notes-8-0-0-beta2" >}}) -- [Release notes for 8.0.0-beta1]({{< relref "release-notes-8-0-0-beta1" >}}) -- [Release notes for 7.5.15]({{< relref "release-notes-7-5-15" >}}) -- [Release notes for 7.5.13]({{< relref "release-notes-7-5-13" >}}) -- [Release notes for 7.5.12]({{< relref "release-notes-7-5-12" >}}) -- [Release notes for 7.5.11]({{< relref "release-notes-7-5-11" >}}) -- [Release notes for 7.5.10]({{< relref "release-notes-7-5-10" >}}) -- [Release notes for 7.5.9]({{< relref "release-notes-7-5-9" >}}) -- [Release notes for 7.5.8]({{< relref "release-notes-7-5-8" >}}) -- [Release notes for 7.5.7]({{< relref "release-notes-7-5-7" >}}) -- [Release notes for 7.5.6]({{< relref "release-notes-7-5-6" >}}) -- [Release notes for 7.5.5]({{< relref "release-notes-7-5-5" >}}) -- [Release notes for 7.5.4]({{< relref "release-notes-7-5-4" >}}) -- [Release notes for 7.5.3]({{< relref "release-notes-7-5-3" >}}) -- [Release notes for 7.5.2]({{< relref "release-notes-7-5-2" >}}) -- [Release notes for 7.5.1]({{< relref "release-notes-7-5-1" >}}) -- [Release notes for 7.5.0]({{< relref "release-notes-7-5-0" >}}) -- [Release notes for 7.5.0-beta2]({{< relref "release-notes-7-5-0-beta2" >}}) -- [Release notes for 7.5.0-beta1]({{< relref "release-notes-7-5-0-beta1" >}}) -- [Release notes for 7.4.5]({{< relref "release-notes-7-4-5" >}}) -- [Release notes for 7.4.3]({{< relref "release-notes-7-4-3" >}}) -- [Release notes for 7.4.2]({{< relref "release-notes-7-4-2" >}}) -- [Release notes for 7.4.1]({{< relref "release-notes-7-4-1" >}}) -- [Release notes for 7.4.0]({{< relref "release-notes-7-4-0" >}}) -- [Release notes for 7.3.10]({{< relref "release-notes-7-3-10" >}}) -- [Release notes for 7.3.7]({{< relref "release-notes-7-3-7" >}}) -- [Release notes for 7.3.6]({{< relref "release-notes-7-3-6" >}}) -- [Release notes for 7.3.5]({{< relref "release-notes-7-3-5" >}}) -- [Release notes for 7.3.4]({{< relref "release-notes-7-3-4" >}}) -- [Release notes for 7.3.3]({{< relref "release-notes-7-3-3" >}}) -- [Release notes for 7.3.2]({{< relref "release-notes-7-3-2" >}}) -- [Release notes for 7.3.1]({{< relref "release-notes-7-3-1" >}}) -- [Release notes for 7.3.0]({{< relref "release-notes-7-3-0" >}}) +- [Release notes for 9.0.0-beta3]({{< relref "release-notes-9-0-0-beta3" >}}) +- [Release notes for 9.0.0-beta2]({{< relref "release-notes-9-0-0-beta2/" >}}) +- [Release notes for 9.0.0-beta1]({{< relref "release-notes-9-0-0-beta1/" >}}) +- [Release notes for 8.5.5]({{< relref "release-notes-8-5-5" >}}) +- [Release notes for 8.5.4]({{< relref "release-notes-8-5-4/" >}}) +- [Release notes for 8.5.3]({{< relref "release-notes-8-5-3/" >}}) +- [Release notes for 8.5.2]({{< relref "release-notes-8-5-2/" >}}) +- [Release notes for 8.5.1]({{< relref "release-notes-8-5-1/" >}}) +- [Release notes for 8.5.0]({{< relref "release-notes-8-5-0/" >}}) +- [Release notes for 8.5.0-beta1]({{< relref "release-notes-8-5-0-beta1/" >}}) +- [Release notes for 8.4.7]({{< relref "release-notes-8-4-7/" >}}) +- [Release notes for 8.4.6]({{< relref "release-notes-8-4-6/" >}}) +- [Release notes for 8.4.5]({{< relref "release-notes-8-4-5/" >}}) +- [Release notes for 8.4.4]({{< relref "release-notes-8-4-4/" >}}) +- [Release notes for 8.4.3]({{< relref "release-notes-8-4-3/" >}}) +- [Release notes for 8.4.2]({{< relref "release-notes-8-4-2/" >}}) +- [Release notes for 8.4.1]({{< relref "release-notes-8-4-1/" >}}) +- [Release notes for 8.4.0-beta1]({{< relref "release-notes-8-4-0-beta1/" >}}) +- [Release notes for 8.3.7]({{< relref "release-notes-8-3-7/" >}}) +- [Release notes for 8.3.6]({{< relref "release-notes-8-3-6/" >}}) +- [Release notes for 8.3.5]({{< relref "release-notes-8-3-5/" >}}) +- [Release notes for 8.3.4]({{< relref "release-notes-8-3-4/" >}}) +- [Release notes for 8.3.3]({{< relref "release-notes-8-3-3/" >}}) +- [Release notes for 8.3.2]({{< relref "release-notes-8-3-2/" >}}) +- [Release notes for 8.3.1]({{< relref "release-notes-8-3-1/" >}}) +- [Release notes for 8.3.0]({{< relref "release-notes-8-3-0/" >}}) +- [Release notes for 8.3.0-beta2]({{< relref "release-notes-8-3-0-beta2/" >}}) +- [Release notes for 8.3.0-beta1]({{< relref "release-notes-8-3-0-beta1/" >}}) +- [Release notes for 8.2.7]({{< relref "release-notes-8-2-7/" >}}) +- [Release notes for 8.2.6]({{< relref "release-notes-8-2-6/" >}}) +- [Release notes for 8.2.5]({{< relref "release-notes-8-2-5/" >}}) +- [Release notes for 8.2.4]({{< relref "release-notes-8-2-4/" >}}) +- [Release notes for 8.2.3]({{< relref "release-notes-8-2-3/" >}}) +- [Release notes for 8.2.2]({{< relref "release-notes-8-2-2/" >}}) +- [Release notes for 8.2.1]({{< relref "release-notes-8-2-1/" >}}) +- [Release notes for 8.2.0]({{< relref "release-notes-8-2-0/" >}}) +- [Release notes for 8.2.0-beta2]({{< relref "release-notes-8-2-0-beta2/" >}}) +- [Release notes for 8.2.0-beta1]({{< relref "release-notes-8-2-0-beta1/" >}}) +- [Release notes for 8.1.8]({{< relref "release-notes-8-1-8/" >}}) +- [Release notes for 8.1.7]({{< relref "release-notes-8-1-7/" >}}) +- [Release notes for 8.1.6]({{< relref "release-notes-8-1-6/" >}}) +- [Release notes for 8.1.5]({{< relref "release-notes-8-1-5/" >}}) +- [Release notes for 8.1.4]({{< relref "release-notes-8-1-4/" >}}) +- [Release notes for 8.1.3]({{< relref "release-notes-8-1-3/" >}}) +- [Release notes for 8.1.2]({{< relref "release-notes-8-1-2/" >}}) +- [Release notes for 8.1.1]({{< relref "release-notes-8-1-1/" >}}) +- [Release notes for 8.1.0]({{< relref "release-notes-8-1-0/" >}}) +- [Release notes for 8.1.0-beta3]({{< relref "release-notes-8-1-0-beta3/" >}}) +- [Release notes for 8.1.0-beta2]({{< relref "release-notes-8-1-0-beta2/" >}}) +- [Release notes for 8.1.0-beta1]({{< relref "release-notes-8-1-0-beta1/" >}}) +- [Release notes for 8.0.7]({{< relref "release-notes-8-0-7/" >}}) +- [Release notes for 8.0.6]({{< relref "release-notes-8-0-6/" >}}) +- [Release notes for 8.0.5]({{< relref "release-notes-8-0-5/" >}}) +- [Release notes for 8.0.4]({{< relref "release-notes-8-0-4/" >}}) +- [Release notes for 8.0.3]({{< relref "release-notes-8-0-3/" >}}) +- [Release notes for 8.0.2]({{< relref "release-notes-8-0-2/" >}}) +- [Release notes for 8.0.1]({{< relref "release-notes-8-0-1/" >}}) +- [Release notes for 8.0.0]({{< relref "release-notes-8-0-0/" >}}) +- [Release notes for 8.0.0-beta3]({{< relref "release-notes-8-0-0-beta3/" >}}) +- [Release notes for 8.0.0-beta2]({{< relref "release-notes-8-0-0-beta2/" >}}) +- [Release notes for 8.0.0-beta1]({{< relref "release-notes-8-0-0-beta1/" >}}) +- [Release notes for 7.5.15]({{< relref "release-notes-7-5-15/" >}}) +- [Release notes for 7.5.13]({{< relref "release-notes-7-5-13/" >}}) +- [Release notes for 7.5.12]({{< relref "release-notes-7-5-12/" >}}) +- [Release notes for 7.5.11]({{< relref "release-notes-7-5-11/" >}}) +- [Release notes for 7.5.10]({{< relref "release-notes-7-5-10/" >}}) +- [Release notes for 7.5.9]({{< relref "release-notes-7-5-9/" >}}) +- [Release notes for 7.5.8]({{< relref "release-notes-7-5-8/" >}}) +- [Release notes for 7.5.7]({{< relref "release-notes-7-5-7/" >}}) +- [Release notes for 7.5.6]({{< relref "release-notes-7-5-6/" >}}) +- [Release notes for 7.5.5]({{< relref "release-notes-7-5-5/" >}}) +- [Release notes for 7.5.4]({{< relref "release-notes-7-5-4/" >}}) +- [Release notes for 7.5.3]({{< relref "release-notes-7-5-3/" >}}) +- [Release notes for 7.5.2]({{< relref "release-notes-7-5-2/" >}}) +- [Release notes for 7.5.1]({{< relref "release-notes-7-5-1/" >}}) +- [Release notes for 7.5.0]({{< relref "release-notes-7-5-0/" >}}) +- [Release notes for 7.5.0-beta2]({{< relref "release-notes-7-5-0-beta2/" >}}) +- [Release notes for 7.5.0-beta1]({{< relref "release-notes-7-5-0-beta1/" >}}) +- [Release notes for 7.4.5]({{< relref "release-notes-7-4-5/" >}}) +- [Release notes for 7.4.3]({{< relref "release-notes-7-4-3/" >}}) +- [Release notes for 7.4.2]({{< relref "release-notes-7-4-2/" >}}) +- [Release notes for 7.4.1]({{< relref "release-notes-7-4-1/" >}}) +- [Release notes for 7.4.0]({{< relref "release-notes-7-4-0/" >}}) +- [Release notes for 7.3.10]({{< relref "release-notes-7-3-10/" >}}) +- [Release notes for 7.3.7]({{< relref "release-notes-7-3-7/" >}}) +- [Release notes for 7.3.6]({{< relref "release-notes-7-3-6/" >}}) +- [Release notes for 7.3.5]({{< relref "release-notes-7-3-5/" >}}) +- [Release notes for 7.3.4]({{< relref "release-notes-7-3-4/" >}}) +- [Release notes for 7.3.3]({{< relref "release-notes-7-3-3/" >}}) +- [Release notes for 7.3.2]({{< relref "release-notes-7-3-2/" >}}) +- [Release notes for 7.3.1]({{< relref "release-notes-7-3-1/" >}}) +- [Release notes for 7.3.0]({{< relref "release-notes-7-3-0/" >}}) diff --git a/docs/sources/release-notes/release-notes-7-3-0.md b/docs/sources/release-notes/release-notes-7-3-0.md index 28196a06dfe..ec42dcc87fd 100644 --- a/docs/sources/release-notes/release-notes-7-3-0.md +++ b/docs/sources/release-notes/release-notes-7-3-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-0/"] -title = "Release notes for Grafana 7.3.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-0/ +title: Release notes for Grafana 7.3.0 +--- @@ -58,7 +58,7 @@ title = "Release notes for Grafana 7.3.0" ### Breaking changes -- **CloudWatch**: The AWS CloudWatch data source's authentication scheme has changed. See the [upgrade notes]{{< relref "../installation/upgrading.md#upgrading-to-v73" >}}) for details and how this may affect you. +- **CloudWatch**: The AWS CloudWatch data source's authentication scheme has changed. See the [upgrade notes]{{< relref "../setup-grafana/upgrade-grafana/#upgrading-to-v73" >}}) for details and how this may affect you. ### Features and enhancements diff --git a/docs/sources/release-notes/release-notes-7-3-1.md b/docs/sources/release-notes/release-notes-7-3-1.md index c508591d700..34f059fd314 100644 --- a/docs/sources/release-notes/release-notes-7-3-1.md +++ b/docs/sources/release-notes/release-notes-7-3-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-1/"] -title = "Release notes for Grafana 7.3.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-1/ +title: Release notes for Grafana 7.3.1 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-10.md b/docs/sources/release-notes/release-notes-7-3-10.md index 63cb399d80a..2911b5c0711 100644 --- a/docs/sources/release-notes/release-notes-7-3-10.md +++ b/docs/sources/release-notes/release-notes-7-3-10.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-10/"] -title = "Release notes for Grafana 7.3.10" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-10/ +title: Release notes for Grafana 7.3.10 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-2.md b/docs/sources/release-notes/release-notes-7-3-2.md index 5c21b426a92..deac211b8b7 100644 --- a/docs/sources/release-notes/release-notes-7-3-2.md +++ b/docs/sources/release-notes/release-notes-7-3-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-2/"] -title = "Release notes for Grafana 7.3.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-2/ +title: Release notes for Grafana 7.3.2 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-3.md b/docs/sources/release-notes/release-notes-7-3-3.md index ef90dbfbdbf..319c5cce5d9 100644 --- a/docs/sources/release-notes/release-notes-7-3-3.md +++ b/docs/sources/release-notes/release-notes-7-3-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-3/"] -title = "Release notes for Grafana 7.3.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-3/ +title: Release notes for Grafana 7.3.3 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-4.md b/docs/sources/release-notes/release-notes-7-3-4.md index 7fc37b347e2..9201b92898a 100644 --- a/docs/sources/release-notes/release-notes-7-3-4.md +++ b/docs/sources/release-notes/release-notes-7-3-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-4/"] -title = "Release notes for Grafana 7.3.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-4/ +title: Release notes for Grafana 7.3.4 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-5.md b/docs/sources/release-notes/release-notes-7-3-5.md index 2d58b758fca..916404750de 100644 --- a/docs/sources/release-notes/release-notes-7-3-5.md +++ b/docs/sources/release-notes/release-notes-7-3-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-5/"] -title = "Release notes for Grafana 7.3.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-5/ +title: Release notes for Grafana 7.3.5 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-6.md b/docs/sources/release-notes/release-notes-7-3-6.md index 642676f4e44..eb89c772902 100644 --- a/docs/sources/release-notes/release-notes-7-3-6.md +++ b/docs/sources/release-notes/release-notes-7-3-6.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-6/"] -title = "Release notes for Grafana 7.3.6" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-6/ +title: Release notes for Grafana 7.3.6 +--- diff --git a/docs/sources/release-notes/release-notes-7-3-7.md b/docs/sources/release-notes/release-notes-7-3-7.md index 87a20434abf..942a1b19ffd 100644 --- a/docs/sources/release-notes/release-notes-7-3-7.md +++ b/docs/sources/release-notes/release-notes-7-3-7.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-3-7/"] -title = "Release notes for Grafana 7.3.7" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-3-7/ +title: Release notes for Grafana 7.3.7 +--- diff --git a/docs/sources/release-notes/release-notes-7-4-0.md b/docs/sources/release-notes/release-notes-7-4-0.md index c8e5532026d..264294b3167 100644 --- a/docs/sources/release-notes/release-notes-7-4-0.md +++ b/docs/sources/release-notes/release-notes-7-4-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-4-0/"] -title = "Release notes for Grafana 7.4.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-4-0/ +title: Release notes for Grafana 7.4.0 +--- diff --git a/docs/sources/release-notes/release-notes-7-4-1.md b/docs/sources/release-notes/release-notes-7-4-1.md index b83575e6acd..288e2535585 100644 --- a/docs/sources/release-notes/release-notes-7-4-1.md +++ b/docs/sources/release-notes/release-notes-7-4-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-4-1/"] -title = "Release notes for Grafana 7.4.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-4-1/ +title: Release notes for Grafana 7.4.1 +--- diff --git a/docs/sources/release-notes/release-notes-7-4-2.md b/docs/sources/release-notes/release-notes-7-4-2.md index 8367f83fa1b..ea2bb8bfaea 100644 --- a/docs/sources/release-notes/release-notes-7-4-2.md +++ b/docs/sources/release-notes/release-notes-7-4-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-4-2/"] -title = "Release notes for Grafana 7.4.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-4-2/ +title: Release notes for Grafana 7.4.2 +--- diff --git a/docs/sources/release-notes/release-notes-7-4-3.md b/docs/sources/release-notes/release-notes-7-4-3.md index 4d9c5369e35..7e07bfe1b9e 100644 --- a/docs/sources/release-notes/release-notes-7-4-3.md +++ b/docs/sources/release-notes/release-notes-7-4-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-4-3/"] -title = "Release notes for Grafana 7.4.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-4-3/ +title: Release notes for Grafana 7.4.3 +--- diff --git a/docs/sources/release-notes/release-notes-7-4-5.md b/docs/sources/release-notes/release-notes-7-4-5.md index c6a22de30e8..88dacac1dcb 100644 --- a/docs/sources/release-notes/release-notes-7-4-5.md +++ b/docs/sources/release-notes/release-notes-7-4-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-4-5/"] -title = "Release notes for Grafana 7.4.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-4-5/ +title: Release notes for Grafana 7.4.5 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-0-beta1.md b/docs/sources/release-notes/release-notes-7-5-0-beta1.md index 6c1da4a0299..9d4ed27b3a6 100644 --- a/docs/sources/release-notes/release-notes-7-5-0-beta1.md +++ b/docs/sources/release-notes/release-notes-7-5-0-beta1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-0-beta1/"] -title = "Release notes for Grafana 7.5.0-beta1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-0-beta1/ +title: Release notes for Grafana 7.5.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-0-beta2.md b/docs/sources/release-notes/release-notes-7-5-0-beta2.md index 77c4d3534c4..5eb32436515 100644 --- a/docs/sources/release-notes/release-notes-7-5-0-beta2.md +++ b/docs/sources/release-notes/release-notes-7-5-0-beta2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-0-beta2/"] -title = "Release notes for Grafana 7.5.0-beta2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-0-beta2/ +title: Release notes for Grafana 7.5.0-beta2 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-0.md b/docs/sources/release-notes/release-notes-7-5-0.md index d244841dc83..1af41313179 100644 --- a/docs/sources/release-notes/release-notes-7-5-0.md +++ b/docs/sources/release-notes/release-notes-7-5-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-0/"] -title = "Release notes for Grafana 7.5.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-0/ +title: Release notes for Grafana 7.5.0 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-1.md b/docs/sources/release-notes/release-notes-7-5-1.md index fa349d37211..89c0165b90d 100644 --- a/docs/sources/release-notes/release-notes-7-5-1.md +++ b/docs/sources/release-notes/release-notes-7-5-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-1/"] -title = "Release notes for Grafana 7.5.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-1/ +title: Release notes for Grafana 7.5.1 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-10.md b/docs/sources/release-notes/release-notes-7-5-10.md index 2e53731daee..9de611faea5 100644 --- a/docs/sources/release-notes/release-notes-7-5-10.md +++ b/docs/sources/release-notes/release-notes-7-5-10.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-10/"] -title = "Release notes for Grafana 7.5.10" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-10/ +title: Release notes for Grafana 7.5.10 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-11.md b/docs/sources/release-notes/release-notes-7-5-11.md index 4169dc35682..696ed760aff 100644 --- a/docs/sources/release-notes/release-notes-7-5-11.md +++ b/docs/sources/release-notes/release-notes-7-5-11.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-11/"] -title = "Release notes for Grafana 7.5.11" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-11/ +title: Release notes for Grafana 7.5.11 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-12.md b/docs/sources/release-notes/release-notes-7-5-12.md index 058e0b30a0b..ce5909b0b69 100644 --- a/docs/sources/release-notes/release-notes-7-5-12.md +++ b/docs/sources/release-notes/release-notes-7-5-12.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-12/"] -title = "Release notes for Grafana 7.5.12" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-12/ +title: Release notes for Grafana 7.5.12 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-13.md b/docs/sources/release-notes/release-notes-7-5-13.md index 9bc0fa86774..aedaae6e2c2 100644 --- a/docs/sources/release-notes/release-notes-7-5-13.md +++ b/docs/sources/release-notes/release-notes-7-5-13.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-13/"] -title = "Release notes for Grafana 7.5.13" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-13/ +title: Release notes for Grafana 7.5.13 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-15.md b/docs/sources/release-notes/release-notes-7-5-15.md index fc939d7f72c..2ee4401990f 100644 --- a/docs/sources/release-notes/release-notes-7-5-15.md +++ b/docs/sources/release-notes/release-notes-7-5-15.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-15/"] -title = "Release notes for Grafana 7.5.15" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-15/ +title: Release notes for Grafana 7.5.15 +--- # Release notes for Grafana 7.5.15 diff --git a/docs/sources/release-notes/release-notes-7-5-2.md b/docs/sources/release-notes/release-notes-7-5-2.md index 4ca78051518..36da2f309c7 100644 --- a/docs/sources/release-notes/release-notes-7-5-2.md +++ b/docs/sources/release-notes/release-notes-7-5-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-2/"] -title = "Release notes for Grafana 7.5.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-2/ +title: Release notes for Grafana 7.5.2 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-3.md b/docs/sources/release-notes/release-notes-7-5-3.md index 7c7575ec0a4..0ebe05c8e2c 100644 --- a/docs/sources/release-notes/release-notes-7-5-3.md +++ b/docs/sources/release-notes/release-notes-7-5-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-3/"] -title = "Release notes for Grafana 7.5.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-3/ +title: Release notes for Grafana 7.5.3 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-4.md b/docs/sources/release-notes/release-notes-7-5-4.md index 62eec035800..3bfaa30a064 100644 --- a/docs/sources/release-notes/release-notes-7-5-4.md +++ b/docs/sources/release-notes/release-notes-7-5-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-4/"] -title = "Release notes for Grafana 7.5.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-4/ +title: Release notes for Grafana 7.5.4 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-5.md b/docs/sources/release-notes/release-notes-7-5-5.md index 0419bc4d385..3d11d2d0550 100644 --- a/docs/sources/release-notes/release-notes-7-5-5.md +++ b/docs/sources/release-notes/release-notes-7-5-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-5/"] -title = "Release notes for Grafana 7.5.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-5/ +title: Release notes for Grafana 7.5.5 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-6.md b/docs/sources/release-notes/release-notes-7-5-6.md index 29359394195..d9f28076f14 100644 --- a/docs/sources/release-notes/release-notes-7-5-6.md +++ b/docs/sources/release-notes/release-notes-7-5-6.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-6/"] -title = "Release notes for Grafana 7.5.6" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-6/ +title: Release notes for Grafana 7.5.6 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-7.md b/docs/sources/release-notes/release-notes-7-5-7.md index d1f8018dd59..eb2e4b7eaea 100644 --- a/docs/sources/release-notes/release-notes-7-5-7.md +++ b/docs/sources/release-notes/release-notes-7-5-7.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-7/"] -title = "Release notes for Grafana 7.5.7" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-7/ +title: Release notes for Grafana 7.5.7 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-8.md b/docs/sources/release-notes/release-notes-7-5-8.md index aa8fab3e0d6..558cbb6f16d 100644 --- a/docs/sources/release-notes/release-notes-7-5-8.md +++ b/docs/sources/release-notes/release-notes-7-5-8.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-8/"] -title = "Release notes for Grafana 7.5.8" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-8/ +title: Release notes for Grafana 7.5.8 +--- diff --git a/docs/sources/release-notes/release-notes-7-5-9.md b/docs/sources/release-notes/release-notes-7-5-9.md index 835a6e9535c..067585d0000 100644 --- a/docs/sources/release-notes/release-notes-7-5-9.md +++ b/docs/sources/release-notes/release-notes-7-5-9.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-7-5-9/"] -title = "Release notes for Grafana 7.5.9" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-7-5-9/ +title: Release notes for Grafana 7.5.9 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta1.md b/docs/sources/release-notes/release-notes-8-0-0-beta1.md index 2e936eed885..575c58df022 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-0-beta1/"] -title = "Release notes for Grafana 8.0.0-beta1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-0-beta1/ +title: Release notes for Grafana 8.0.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta2.md b/docs/sources/release-notes/release-notes-8-0-0-beta2.md index df009b34312..3537f0207c9 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-0-beta2/"] -title = "Release notes for Grafana 8.0.0-beta2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-0-beta2/ +title: Release notes for Grafana 8.0.0-beta2 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-0-beta3.md b/docs/sources/release-notes/release-notes-8-0-0-beta3.md index 3942bfec1ea..b3f6f95d202 100644 --- a/docs/sources/release-notes/release-notes-8-0-0-beta3.md +++ b/docs/sources/release-notes/release-notes-8-0-0-beta3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-0-beta3/"] -title = "Release notes for Grafana 8.0.0-beta3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-0-beta3/ +title: Release notes for Grafana 8.0.0-beta3 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-0.md b/docs/sources/release-notes/release-notes-8-0-0.md index ae340ebee4d..9d55ddc696c 100644 --- a/docs/sources/release-notes/release-notes-8-0-0.md +++ b/docs/sources/release-notes/release-notes-8-0-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-0/"] -title = "Release notes for Grafana 8.0.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-0/ +title: Release notes for Grafana 8.0.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-1.md b/docs/sources/release-notes/release-notes-8-0-1.md index bea4b1a7377..33134bfb0fc 100644 --- a/docs/sources/release-notes/release-notes-8-0-1.md +++ b/docs/sources/release-notes/release-notes-8-0-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-1/"] -title = "Release notes for Grafana 8.0.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-1/ +title: Release notes for Grafana 8.0.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-2.md b/docs/sources/release-notes/release-notes-8-0-2.md index 905e3f0eb49..eb1f7ca5117 100644 --- a/docs/sources/release-notes/release-notes-8-0-2.md +++ b/docs/sources/release-notes/release-notes-8-0-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-2/"] -title = "Release notes for Grafana 8.0.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-2/ +title: Release notes for Grafana 8.0.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-3.md b/docs/sources/release-notes/release-notes-8-0-3.md index b0c588f8347..a09f610584f 100644 --- a/docs/sources/release-notes/release-notes-8-0-3.md +++ b/docs/sources/release-notes/release-notes-8-0-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-3/"] -title = "Release notes for Grafana 8.0.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-3/ +title: Release notes for Grafana 8.0.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-4.md b/docs/sources/release-notes/release-notes-8-0-4.md index be7dcfb32aa..8a81795b4b2 100644 --- a/docs/sources/release-notes/release-notes-8-0-4.md +++ b/docs/sources/release-notes/release-notes-8-0-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-4/"] -title = "Release notes for Grafana 8.0.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-4/ +title: Release notes for Grafana 8.0.4 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-5.md b/docs/sources/release-notes/release-notes-8-0-5.md index 4ceb0c57575..81695de8436 100644 --- a/docs/sources/release-notes/release-notes-8-0-5.md +++ b/docs/sources/release-notes/release-notes-8-0-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-5/"] -title = "Release notes for Grafana 8.0.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-5/ +title: Release notes for Grafana 8.0.5 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-6.md b/docs/sources/release-notes/release-notes-8-0-6.md index 713b356c752..70d82510f69 100644 --- a/docs/sources/release-notes/release-notes-8-0-6.md +++ b/docs/sources/release-notes/release-notes-8-0-6.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-6/"] -title = "Release notes for Grafana 8.0.6" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-6/ +title: Release notes for Grafana 8.0.6 +--- diff --git a/docs/sources/release-notes/release-notes-8-0-7.md b/docs/sources/release-notes/release-notes-8-0-7.md index 4e62083bfc1..867dc7efaaa 100644 --- a/docs/sources/release-notes/release-notes-8-0-7.md +++ b/docs/sources/release-notes/release-notes-8-0-7.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-0-7/"] -title = "Release notes for Grafana 8.0.7" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-0-7/ +title: Release notes for Grafana 8.0.7 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta1.md b/docs/sources/release-notes/release-notes-8-1-0-beta1.md index 16b88d80b65..9d18c2d371b 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-0-beta1/"] -title = "Release notes for Grafana 8.1.0-beta1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-0-beta1/ +title: Release notes for Grafana 8.1.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta2.md b/docs/sources/release-notes/release-notes-8-1-0-beta2.md index c79ca28989f..93449985783 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-0-beta2/"] -title = "Release notes for Grafana 8.1.0-beta2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-0-beta2/ +title: Release notes for Grafana 8.1.0-beta2 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-0-beta3.md b/docs/sources/release-notes/release-notes-8-1-0-beta3.md index 0bba933564c..9b787bce3ab 100644 --- a/docs/sources/release-notes/release-notes-8-1-0-beta3.md +++ b/docs/sources/release-notes/release-notes-8-1-0-beta3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-0-beta3/"] -title = "Release notes for Grafana 8.1.0-beta3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-0-beta3/ +title: Release notes for Grafana 8.1.0-beta3 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-0.md b/docs/sources/release-notes/release-notes-8-1-0.md index 41ebe20bd9f..79e2cd18c38 100644 --- a/docs/sources/release-notes/release-notes-8-1-0.md +++ b/docs/sources/release-notes/release-notes-8-1-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-0/"] -title = "Release notes for Grafana 8.1.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-0/ +title: Release notes for Grafana 8.1.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-1.md b/docs/sources/release-notes/release-notes-8-1-1.md index b467e784828..37fd61e6c17 100644 --- a/docs/sources/release-notes/release-notes-8-1-1.md +++ b/docs/sources/release-notes/release-notes-8-1-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-1/"] -title = "Release notes for Grafana 8.1.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-1/ +title: Release notes for Grafana 8.1.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-2.md b/docs/sources/release-notes/release-notes-8-1-2.md index 410523737dd..d603be55d37 100644 --- a/docs/sources/release-notes/release-notes-8-1-2.md +++ b/docs/sources/release-notes/release-notes-8-1-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-2/"] -title = "Release notes for Grafana 8.1.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-2/ +title: Release notes for Grafana 8.1.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-3.md b/docs/sources/release-notes/release-notes-8-1-3.md index e3416c004ef..ac9195f6b54 100644 --- a/docs/sources/release-notes/release-notes-8-1-3.md +++ b/docs/sources/release-notes/release-notes-8-1-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-3/"] -title = "Release notes for Grafana 8.1.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-3/ +title: Release notes for Grafana 8.1.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-4.md b/docs/sources/release-notes/release-notes-8-1-4.md index 6f1e7e24f29..39d9a97e419 100644 --- a/docs/sources/release-notes/release-notes-8-1-4.md +++ b/docs/sources/release-notes/release-notes-8-1-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-4/"] -title = "Release notes for Grafana 8.1.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-4/ +title: Release notes for Grafana 8.1.4 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-5.md b/docs/sources/release-notes/release-notes-8-1-5.md index ffcfcf35e00..89bc8433dc8 100644 --- a/docs/sources/release-notes/release-notes-8-1-5.md +++ b/docs/sources/release-notes/release-notes-8-1-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-5/"] -title = "Release notes for Grafana 8.1.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-5/ +title: Release notes for Grafana 8.1.5 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-6.md b/docs/sources/release-notes/release-notes-8-1-6.md index 2ad4ffd7432..3552f54eede 100644 --- a/docs/sources/release-notes/release-notes-8-1-6.md +++ b/docs/sources/release-notes/release-notes-8-1-6.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-6/"] -title = "Release notes for Grafana 8.1.6" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-6/ +title: Release notes for Grafana 8.1.6 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-7.md b/docs/sources/release-notes/release-notes-8-1-7.md index d7cbfb41023..ab3d83e0f9a 100644 --- a/docs/sources/release-notes/release-notes-8-1-7.md +++ b/docs/sources/release-notes/release-notes-8-1-7.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-7/"] -title = "Release notes for Grafana 8.1.7" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-7/ +title: Release notes for Grafana 8.1.7 +--- diff --git a/docs/sources/release-notes/release-notes-8-1-8.md b/docs/sources/release-notes/release-notes-8-1-8.md index f77652aa432..dc7cd936edf 100644 --- a/docs/sources/release-notes/release-notes-8-1-8.md +++ b/docs/sources/release-notes/release-notes-8-1-8.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-1-8/"] -title = "Release notes for Grafana 8.1.8" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-1-8/ +title: Release notes for Grafana 8.1.8 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-0-beta1.md b/docs/sources/release-notes/release-notes-8-2-0-beta1.md index 7469f7b4ccc..2cb0419bb96 100644 --- a/docs/sources/release-notes/release-notes-8-2-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-2-0-beta1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-0-beta1/"] -title = "Release notes for Grafana 8.2.0-beta1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-0-beta1/ +title: Release notes for Grafana 8.2.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-0-beta2.md b/docs/sources/release-notes/release-notes-8-2-0-beta2.md index 74adee723e6..46eb5050b81 100644 --- a/docs/sources/release-notes/release-notes-8-2-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-2-0-beta2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-0-beta2/"] -title = "Release notes for Grafana 8.2.0-beta2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-0-beta2/ +title: Release notes for Grafana 8.2.0-beta2 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-0.md b/docs/sources/release-notes/release-notes-8-2-0.md index 4513de999b4..2ee72e73ca4 100644 --- a/docs/sources/release-notes/release-notes-8-2-0.md +++ b/docs/sources/release-notes/release-notes-8-2-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-0/"] -title = "Release notes for Grafana 8.2.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-0/ +title: Release notes for Grafana 8.2.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-1.md b/docs/sources/release-notes/release-notes-8-2-1.md index d1a419ab338..07dfd6dd33b 100644 --- a/docs/sources/release-notes/release-notes-8-2-1.md +++ b/docs/sources/release-notes/release-notes-8-2-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-1/"] -title = "Release notes for Grafana 8.2.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-1/ +title: Release notes for Grafana 8.2.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-2.md b/docs/sources/release-notes/release-notes-8-2-2.md index fcfb8203279..526f5761245 100644 --- a/docs/sources/release-notes/release-notes-8-2-2.md +++ b/docs/sources/release-notes/release-notes-8-2-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-2/"] -title = "Release notes for Grafana 8.2.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-2/ +title: Release notes for Grafana 8.2.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-3.md b/docs/sources/release-notes/release-notes-8-2-3.md index 121fb348db6..65de6a479e3 100644 --- a/docs/sources/release-notes/release-notes-8-2-3.md +++ b/docs/sources/release-notes/release-notes-8-2-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-3/"] -title = "Release notes for Grafana 8.2.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-3/ +title: Release notes for Grafana 8.2.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-4.md b/docs/sources/release-notes/release-notes-8-2-4.md index 52af12afe3d..3295bb09be5 100644 --- a/docs/sources/release-notes/release-notes-8-2-4.md +++ b/docs/sources/release-notes/release-notes-8-2-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-4/"] -title = "Release notes for Grafana 8.2.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-4/ +title: Release notes for Grafana 8.2.4 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-5.md b/docs/sources/release-notes/release-notes-8-2-5.md index 8be8bde4466..83cdaa52f7f 100644 --- a/docs/sources/release-notes/release-notes-8-2-5.md +++ b/docs/sources/release-notes/release-notes-8-2-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-5/"] -title = "Release notes for Grafana 8.2.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-5/ +title: Release notes for Grafana 8.2.5 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-6.md b/docs/sources/release-notes/release-notes-8-2-6.md index 0b9d60823f3..30b0f8fdbc8 100644 --- a/docs/sources/release-notes/release-notes-8-2-6.md +++ b/docs/sources/release-notes/release-notes-8-2-6.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-6/"] -title = "Release notes for Grafana 8.2.6" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-6/ +title: Release notes for Grafana 8.2.6 +--- diff --git a/docs/sources/release-notes/release-notes-8-2-7.md b/docs/sources/release-notes/release-notes-8-2-7.md index fb516ad95a6..41889816f45 100644 --- a/docs/sources/release-notes/release-notes-8-2-7.md +++ b/docs/sources/release-notes/release-notes-8-2-7.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-2-7/"] -title = "Release notes for Grafana 8.2.7" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-2-7/ +title: Release notes for Grafana 8.2.7 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-0-beta1.md b/docs/sources/release-notes/release-notes-8-3-0-beta1.md index 42d6ee5c474..005f46a6110 100644 --- a/docs/sources/release-notes/release-notes-8-3-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-3-0-beta1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-0-beta1/"] -title = "Release notes for Grafana 8.3.0-beta1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-0-beta1/ +title: Release notes for Grafana 8.3.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-0-beta2.md b/docs/sources/release-notes/release-notes-8-3-0-beta2.md index 074eb2659fe..fa148d686c5 100644 --- a/docs/sources/release-notes/release-notes-8-3-0-beta2.md +++ b/docs/sources/release-notes/release-notes-8-3-0-beta2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-0-beta2/"] -title = "Release notes for Grafana 8.3.0-beta2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-0-beta2/ +title: Release notes for Grafana 8.3.0-beta2 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-0.md b/docs/sources/release-notes/release-notes-8-3-0.md index d54e7d7f021..5d6f89e8f45 100644 --- a/docs/sources/release-notes/release-notes-8-3-0.md +++ b/docs/sources/release-notes/release-notes-8-3-0.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-0/"] -title = "Release notes for Grafana 8.3.0" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-0/ +title: Release notes for Grafana 8.3.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-1.md b/docs/sources/release-notes/release-notes-8-3-1.md index df7871cf227..b81e2ea4c12 100644 --- a/docs/sources/release-notes/release-notes-8-3-1.md +++ b/docs/sources/release-notes/release-notes-8-3-1.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-1/"] -title = "Release notes for Grafana 8.3.1" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-1/ +title: Release notes for Grafana 8.3.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-2.md b/docs/sources/release-notes/release-notes-8-3-2.md index 30de7207e48..fbef2cbe78b 100644 --- a/docs/sources/release-notes/release-notes-8-3-2.md +++ b/docs/sources/release-notes/release-notes-8-3-2.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-2/"] -title = "Release notes for Grafana 8.3.2" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-2/ +title: Release notes for Grafana 8.3.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-3.md b/docs/sources/release-notes/release-notes-8-3-3.md index 21876e9fdac..49ce9619d91 100644 --- a/docs/sources/release-notes/release-notes-8-3-3.md +++ b/docs/sources/release-notes/release-notes-8-3-3.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-3/"] -title = "Release notes for Grafana 8.3.3" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-3/ +title: Release notes for Grafana 8.3.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-4.md b/docs/sources/release-notes/release-notes-8-3-4.md index ef33f71925f..75ad4f5eeec 100644 --- a/docs/sources/release-notes/release-notes-8-3-4.md +++ b/docs/sources/release-notes/release-notes-8-3-4.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-4/"] -title = "Release notes for Grafana 8.3.4" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-4/ +title: Release notes for Grafana 8.3.4 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-5.md b/docs/sources/release-notes/release-notes-8-3-5.md index 6fa717a8de5..bad3dfeab4f 100644 --- a/docs/sources/release-notes/release-notes-8-3-5.md +++ b/docs/sources/release-notes/release-notes-8-3-5.md @@ -1,10 +1,10 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-5/"] -title = "Release notes for Grafana 8.3.5" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-5/ +title: Release notes for Grafana 8.3.5 +--- # Release notes for Grafana 8.3.5 diff --git a/docs/sources/release-notes/release-notes-8-3-6.md b/docs/sources/release-notes/release-notes-8-3-6.md index 3041aa2af50..0fe48979fd6 100644 --- a/docs/sources/release-notes/release-notes-8-3-6.md +++ b/docs/sources/release-notes/release-notes-8-3-6.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-6/"] -hide_menu = true -title = "Release notes for Grafana 8.3.6" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-6/ +hide_menu: true +title: Release notes for Grafana 8.3.6 +--- diff --git a/docs/sources/release-notes/release-notes-8-3-7.md b/docs/sources/release-notes/release-notes-8-3-7.md index 14aa73cc72d..4960d7a642f 100644 --- a/docs/sources/release-notes/release-notes-8-3-7.md +++ b/docs/sources/release-notes/release-notes-8-3-7.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-3-7/"] -hide_menu = true -title = "Release notes for Grafana 8.3.7" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-3-7/ +hide_menu: true +title: Release notes for Grafana 8.3.7 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-0-beta1.md b/docs/sources/release-notes/release-notes-8-4-0-beta1.md index a86e9f4de74..a42d02c34de 100644 --- a/docs/sources/release-notes/release-notes-8-4-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-4-0-beta1.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-0-beta1/"] -hide_menu = true -title = "Release notes for Grafana 8.4.0-beta1" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-0-beta1/ +hide_menu: true +title: Release notes for Grafana 8.4.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-0.md b/docs/sources/release-notes/release-notes-8-4-0.md index 65d4ac814b6..c36fbfeff24 100644 --- a/docs/sources/release-notes/release-notes-8-4-0.md +++ b/docs/sources/release-notes/release-notes-8-4-0.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-0/"] -hide_menu = true -title = "Release notes for Grafana 8.4.0" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-0/ +hide_menu: true +title: Release notes for Grafana 8.4.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-1.md b/docs/sources/release-notes/release-notes-8-4-1.md index ca076490932..7fc8112ec9d 100644 --- a/docs/sources/release-notes/release-notes-8-4-1.md +++ b/docs/sources/release-notes/release-notes-8-4-1.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-1/"] -hide_menu = true -title = "Release notes for Grafana 8.4.1" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-1/ +hide_menu: true +title: Release notes for Grafana 8.4.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-2.md b/docs/sources/release-notes/release-notes-8-4-2.md index 86f306ba935..7ee5e08c0ca 100644 --- a/docs/sources/release-notes/release-notes-8-4-2.md +++ b/docs/sources/release-notes/release-notes-8-4-2.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-2/"] -hide_menu = true -title = "Release notes for Grafana 8.4.2" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-2/ +hide_menu: true +title: Release notes for Grafana 8.4.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-3.md b/docs/sources/release-notes/release-notes-8-4-3.md index b0a580ed4a2..c4521f3eadd 100644 --- a/docs/sources/release-notes/release-notes-8-4-3.md +++ b/docs/sources/release-notes/release-notes-8-4-3.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-3/"] -hide_menu = true -title = "Release notes for Grafana 8.4.3" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-3/ +hide_menu: true +title: Release notes for Grafana 8.4.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-4.md b/docs/sources/release-notes/release-notes-8-4-4.md index 201f9c649b4..a9c10e8d371 100644 --- a/docs/sources/release-notes/release-notes-8-4-4.md +++ b/docs/sources/release-notes/release-notes-8-4-4.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-4/"] -hide_menu = true -title = "Release notes for Grafana 8.4.4" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-4/ +hide_menu: true +title: Release notes for Grafana 8.4.4 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-5.md b/docs/sources/release-notes/release-notes-8-4-5.md index 13948030ad8..a3849b08011 100644 --- a/docs/sources/release-notes/release-notes-8-4-5.md +++ b/docs/sources/release-notes/release-notes-8-4-5.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-5/"] -hide_menu = true -title = "Release notes for Grafana 8.4.5" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-5/ +hide_menu: true +title: Release notes for Grafana 8.4.5 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-6.md b/docs/sources/release-notes/release-notes-8-4-6.md index 75abc48d02a..660e679236c 100644 --- a/docs/sources/release-notes/release-notes-8-4-6.md +++ b/docs/sources/release-notes/release-notes-8-4-6.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-6/"] -hide_menu = true -title = "Release notes for Grafana 8.4.6" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-6/ +hide_menu: true +title: Release notes for Grafana 8.4.6 +--- diff --git a/docs/sources/release-notes/release-notes-8-4-7.md b/docs/sources/release-notes/release-notes-8-4-7.md index c2f8bb876bc..565f843bb04 100644 --- a/docs/sources/release-notes/release-notes-8-4-7.md +++ b/docs/sources/release-notes/release-notes-8-4-7.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-4-7/"] -hide_menu = true -title = "Release notes for Grafana 8.4.7" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-4-7/ +hide_menu: true +title: Release notes for Grafana 8.4.7 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-0-beta1.md b/docs/sources/release-notes/release-notes-8-5-0-beta1.md index 3020e22d0da..e5f09a3e03d 100644 --- a/docs/sources/release-notes/release-notes-8-5-0-beta1.md +++ b/docs/sources/release-notes/release-notes-8-5-0-beta1.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-5-0-beta1/"] -hide_menu = true -title = "Release notes for Grafana 8.5.0-beta1" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-5-0-beta1/ +hide_menu: true +title: Release notes for Grafana 8.5.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-0.md b/docs/sources/release-notes/release-notes-8-5-0.md index 5641e252140..3a7449518d4 100644 --- a/docs/sources/release-notes/release-notes-8-5-0.md +++ b/docs/sources/release-notes/release-notes-8-5-0.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-5-0/"] -hide_menu = true -title = "Release notes for Grafana 8.5.0" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-5-0/ +hide_menu: true +title: Release notes for Grafana 8.5.0 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-1.md b/docs/sources/release-notes/release-notes-8-5-1.md index c8b832479de..a6c3944a4c7 100644 --- a/docs/sources/release-notes/release-notes-8-5-1.md +++ b/docs/sources/release-notes/release-notes-8-5-1.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-5-1/"] -hide_menu = true -title = "Release notes for Grafana 8.5.1" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-5-1/ +hide_menu: true +title: Release notes for Grafana 8.5.1 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-2.md b/docs/sources/release-notes/release-notes-8-5-2.md index ccd4bff19a4..57f9502beaa 100644 --- a/docs/sources/release-notes/release-notes-8-5-2.md +++ b/docs/sources/release-notes/release-notes-8-5-2.md @@ -1,8 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-8-5-2/"] -hide_menu = true -title = "Release notes for Grafana 8.5.2" -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-5-2/ +hide_menu: true +title: Release notes for Grafana 8.5.2 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-3.md b/docs/sources/release-notes/release-notes-8-5-3.md index 0a3ba52b03b..f4848a27331 100644 --- a/docs/sources/release-notes/release-notes-8-5-3.md +++ b/docs/sources/release-notes/release-notes-8-5-3.md @@ -1,7 +1,9 @@ -+++ -title = "Release notes for Grafana 8.5.3" -hide_menu = true -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-8-5-3/ +hide_menu: true +title: Release notes for Grafana 8.5.3 +--- diff --git a/docs/sources/release-notes/release-notes-8-5-4.md b/docs/sources/release-notes/release-notes-8-5-4.md new file mode 100644 index 00000000000..b50c99dac13 --- /dev/null +++ b/docs/sources/release-notes/release-notes-8-5-4.md @@ -0,0 +1,65 @@ ++++ +title = "Release notes for Grafana 8.5.4" +hide_menu = true ++++ + + + +# Release notes for Grafana 8.5.4 + +### Features and enhancements + +- **Alerting:** Remove disabled flag for data source when migrating alerts. [#48559](https://github.com/grafana/grafana/pull/48559), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Show notification tab of legacy alerting only to editor. [#49624](https://github.com/grafana/grafana/pull/49624), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Update migration to migrate only alerts that belong to existing org\dashboard. [#49192](https://github.com/grafana/grafana/pull/49192), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **AzureMonitor:** Do not quote variables when a custom "All" variable option is used. [#49428](https://github.com/grafana/grafana/pull/49428), [@andresmgot](https://github.com/andresmgot) +- **AzureMonitor:** Update allowed namespaces. [#48468](https://github.com/grafana/grafana/pull/48468), [@jcolladokuri](https://github.com/jcolladokuri) +- **CloudMonitor:** Correctly encode default project response. [#49510](https://github.com/grafana/grafana/pull/49510), [@aangelisc](https://github.com/aangelisc) +- **Cloudwatch:** Add support for new AWS/RDS EBS\* metrics. [#48798](https://github.com/grafana/grafana/pull/48798), [@szymonpk](https://github.com/szymonpk) +- **InfluxDB:** Use backend for influxDB by default via feature toggle. [#48453](https://github.com/grafana/grafana/pull/48453), [@yesoreyeram](https://github.com/yesoreyeram) +- **Legend:** Use correct unit for percent and count calculations. [#49004](https://github.com/grafana/grafana/pull/49004), [@dprokop](https://github.com/dprokop) +- **LokI:** use millisecond steps in Grafana 8.5.x. [#48630](https://github.com/grafana/grafana/pull/48630), [@gabor](https://github.com/gabor) +- **Plugins:** Introduce HTTP 207 Multi Status response to api/ds/query. [#48550](https://github.com/grafana/grafana/pull/48550), [@wbrowne](https://github.com/wbrowne) +- **Reporting:** Improve PDF file size using grid layout. (Enterprise) +- **Transformations:** Add an All Unique Values Reducer. [#48653](https://github.com/grafana/grafana/pull/48653), [@josiahg](https://github.com/josiahg) +- **Transformers:** avoid error when the ExtractFields source field is missing. [#49368](https://github.com/grafana/grafana/pull/49368), [@wardbekker](https://github.com/wardbekker) +- **[v8.5.x] Alerting:** Update migration to migrate only alerts that belong to existing org\dashboard. [#49199](https://github.com/grafana/grafana/pull/49199), [@grafanabot](https://github.com/grafanabot) +- **[v8.5.x] Reporting:** Improve PDF file size using grid layout. (Enterprise) + +### Bug fixes + +- **Alerting:** Allow disabling override timings for notification policies. [#48648](https://github.com/grafana/grafana/pull/48648), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Allow serving images from custom url path. [#49022](https://github.com/grafana/grafana/pull/49022), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Apply Custom Headers to datasource queries. [#47860](https://github.com/grafana/grafana/pull/47860), [@joeblubaugh](https://github.com/joeblubaugh) +- **Alerting:** Fix RBAC actions for notification policies. [#49185](https://github.com/grafana/grafana/pull/49185), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Fix access to alerts for viewer with editor permissions when RBAC is disabled. [#49270](https://github.com/grafana/grafana/pull/49270), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** Fix anonymous access to alerting. [#49203](https://github.com/grafana/grafana/pull/49203), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **Alerting:** correctly show all alerts in a folder. [#48684](https://github.com/grafana/grafana/pull/48684), [@gillesdemey](https://github.com/gillesdemey) +- **AzureMonitor:** Fixes metric definition for Azure Storage queue/file/blob/table resources. [#49101](https://github.com/grafana/grafana/pull/49101), [@aangelisc](https://github.com/aangelisc) +- **Dashboard:** Fix dashboard update permission check. [#48746](https://github.com/grafana/grafana/pull/48746), [@IevaVasiljeva](https://github.com/IevaVasiljeva) +- **DashboardExport:** Fix exporting and importing dashboards where query data source ended up as incorrect. [#48410](https://github.com/grafana/grafana/pull/48410), [@torkelo](https://github.com/torkelo) +- **FileUpload:** clicking the `Upload file` button now opens the modal correctly. [#48766](https://github.com/grafana/grafana/pull/48766), [@ashharrison90](https://github.com/ashharrison90) +- **GrafanaUI:** Fix color of links in error Tooltips in light theme. [#49327](https://github.com/grafana/grafana/pull/49327), [@joshhunt](https://github.com/joshhunt) +- **LibraryPanels:** Fix library panels not connecting properly in imported dashboards. [#49161](https://github.com/grafana/grafana/pull/49161), [@joshhunt](https://github.com/joshhunt) +- **Loki:** Improve unpack parser handling. [#49074](https://github.com/grafana/grafana/pull/49074), [@gabor](https://github.com/gabor) +- **RolePicker:** Fix menu position on smaller screens. [#48429](https://github.com/grafana/grafana/pull/48429), [@Clarity-89](https://github.com/Clarity-89) +- **TimeRange:** Fixes updating time range from url and browser history. [#48657](https://github.com/grafana/grafana/pull/48657), [@torkelo](https://github.com/torkelo) +- **TimeSeries:** Fix detection & rendering of sparse datapoints. [#48841](https://github.com/grafana/grafana/pull/48841), [@leeoniya](https://github.com/leeoniya) +- **Timeseries:** Fix outside range stale state. [#49633](https://github.com/grafana/grafana/pull/49633), [@ryantxu](https://github.com/ryantxu) +- **Tooltip:** Fix links not legible in Tooltips when using light theme. [#48748](https://github.com/grafana/grafana/pull/48748), [@joshhunt](https://github.com/joshhunt) +- **Tooltip:** Sort decimals using standard numeric compare. [#49084](https://github.com/grafana/grafana/pull/49084), [@dprokop](https://github.com/dprokop) +- **Transforms:** Labels to fields, fix label picker layout. [#49304](https://github.com/grafana/grafana/pull/49304), [@torkelo](https://github.com/torkelo) +- **Variables:** Fixes issue with data source variables not updating queries with variable. [#49478](https://github.com/grafana/grafana/pull/49478), [@torkelo](https://github.com/torkelo) +- **[v8.5.x] Alerting:** Fix RBAC actions for notification policies (#49185). [#49348](https://github.com/grafana/grafana/pull/49348), [@yuri-tceretian](https://github.com/yuri-tceretian) +- **[v8.5.x] Alerting:** Fix access to alerts for viewer with editor permissions when RBAC is disabled. [#49427](https://github.com/grafana/grafana/pull/49427), [@konrad147](https://github.com/konrad147) +- **[v8.5.x] Alerting:** Fix anonymous access to alerting. [#49268](https://github.com/grafana/grafana/pull/49268), [@yuri-tceretian](https://github.com/yuri-tceretian) + +### Breaking changes + +For a data source query made via /api/ds/query : + +- If the `DatasourceQueryMultiStatus` feature is enabled and + - The data source response has an error set as part of the `DataResponse`, the resulting HTTP status code is now `207 Multi Status` instead of `400 Bad gateway` +- If the `DatasourceQueryMultiStatus` feature is **not** enabled and + - The data source response has an error set as part of the `DataResponse`, the resulting HTTP status code is `400 Bad Request` (no breaking change) + --> Issue [#48550](https://github.com/grafana/grafana/issues/48550) diff --git a/docs/sources/release-notes/release-notes-8-5-5.md b/docs/sources/release-notes/release-notes-8-5-5.md new file mode 100644 index 00000000000..2696a0c7237 --- /dev/null +++ b/docs/sources/release-notes/release-notes-8-5-5.md @@ -0,0 +1,19 @@ ++++ +title = "Release notes for Grafana 8.5.5" +hide_menu = true ++++ + + + +# Release notes for Grafana 8.5.5 + +### Features and enhancements + +- **Azure Monitor:** Include datasource ref when interpolating variables. [#49543](https://github.com/grafana/grafana/pull/49543), [@kevinwcyu](https://github.com/kevinwcyu) +- **CloudWatch:** Add multi-value template variable support for log group names in logs query builder. [#49737](https://github.com/grafana/grafana/pull/49737), [@kevinwcyu](https://github.com/kevinwcyu) +- **Cloudwatch:** Add template variable query function for listing log groups. [#50100](https://github.com/grafana/grafana/pull/50100), [@yaelleC](https://github.com/yaelleC) + +### Bug fixes + +- **Alerting:** Do not overwrite existing alert rule condition. [#49920](https://github.com/grafana/grafana/pull/49920), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Remove double quotes from matchers. [#50044](https://github.com/grafana/grafana/pull/50044), [@alexweav](https://github.com/alexweav) diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta1.md b/docs/sources/release-notes/release-notes-9-0-0-beta1.md index ccf304ee60a..f105c03a058 100644 --- a/docs/sources/release-notes/release-notes-9-0-0-beta1.md +++ b/docs/sources/release-notes/release-notes-9-0-0-beta1.md @@ -1,7 +1,9 @@ -+++ -title = "Release notes for Grafana 9.0.0-beta1" -hide_menu = true -+++ +--- +aliases: + - /docs/grafana/latest/release-notes/release-notes-9-0-0-beta1/ +hide_menu: true +title: Release notes for Grafana 9.0.0-beta1 +--- diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta2.md b/docs/sources/release-notes/release-notes-9-0-0-beta2.md new file mode 100644 index 00000000000..44e9e6b1080 --- /dev/null +++ b/docs/sources/release-notes/release-notes-9-0-0-beta2.md @@ -0,0 +1,135 @@ ++++ +title = "Release notes for Grafana 9.0.0-beta2" +hide_menu = true ++++ + + + +# Release notes for Grafana 9.0.0-beta2 + +### Features and enhancements + +- **Alerting:** Add legacy indicator to navbar. [#49511](https://github.com/grafana/grafana/pull/49511), [@peterholmberg](https://github.com/peterholmberg) +- **Alerting:** Add templated subject config to email notifier. [#49742](https://github.com/grafana/grafana/pull/49742), [@JacobsonMT](https://github.com/JacobsonMT) +- **Alerting:** Enable Unified Alerting for open source and enterprise. [#49834](https://github.com/grafana/grafana/pull/49834), [@grobinson-grafana](https://github.com/grobinson-grafana) +- **Alerting:** Make alertmanager datasource stable. [#49485](https://github.com/grafana/grafana/pull/49485), [@gillesdemey](https://github.com/gillesdemey) +- **Angular:** Remove deprecated angular modal support and libs. [#49781](https://github.com/grafana/grafana/pull/49781), [@torkelo](https://github.com/torkelo) +- **AuthProxy:** Remove deprecated ldap_sync_ttl setting. [#49902](https://github.com/grafana/grafana/pull/49902), [@kalleep](https://github.com/kalleep) +- **Build:** Enable long term caching for frontend assets. [#47625](https://github.com/grafana/grafana/pull/47625), [@jackw](https://github.com/jackw) +- **Chore:** Remove deprecated TextDisplayOptions export. [#49705](https://github.com/grafana/grafana/pull/49705), [@kaydelaney](https://github.com/kaydelaney) +- **Chore:** Remove deprecated `surface` prop from IconButton. [#49715](https://github.com/grafana/grafana/pull/49715), [@kaydelaney](https://github.com/kaydelaney) +- **Chore:** Remove usage of deprecated getColorForTheme function. [#49519](https://github.com/grafana/grafana/pull/49519), [@kaydelaney](https://github.com/kaydelaney) +- **DatePicker:** Add minDate prop. [#49503](https://github.com/grafana/grafana/pull/49503), [@alexanderzobnin](https://github.com/alexanderzobnin) +- **Notification history:** Enable by default. [#49502](https://github.com/grafana/grafana/pull/49502), [@ashharrison90](https://github.com/ashharrison90) +- **Prometheus:** Add pluginVersion to query. [#49414](https://github.com/grafana/grafana/pull/49414), [@toddtreece](https://github.com/toddtreece) +- **Prometheus:** Enable prometheusStreamingJSONParser by default. [#49475](https://github.com/grafana/grafana/pull/49475), [@toddtreece](https://github.com/toddtreece) +- **Prometheus:** Predefined scopes for Azure authentication. [#49557](https://github.com/grafana/grafana/pull/49557), [@kostrse](https://github.com/kostrse) +- **Prometheus:** Streaming JSON parser performance improvements. [#48792](https://github.com/grafana/grafana/pull/48792), [@toddtreece](https://github.com/toddtreece) +- **ValueMapping:** Add support for regex replacement over multiple lines. [#49607](https://github.com/grafana/grafana/pull/49607), [@ashharrison90](https://github.com/ashharrison90) + +### Bug fixes + +- **Accessibility:** Pressing escape in a Modal or DashboardSettings correctly closes the overlay. [#49500](https://github.com/grafana/grafana/pull/49500), [@ashharrison90](https://github.com/ashharrison90) +- **Alerting:** Validate alert notification UID length. [#45546](https://github.com/grafana/grafana/pull/45546), [@wbrowne](https://github.com/wbrowne) +- **BackendSrv:** Throw an error when fetching an invalid JSON. [#47493](https://github.com/grafana/grafana/pull/47493), [@leventebalogh](https://github.com/leventebalogh) +- **Fix:** Timeseries migration regex override. [#49629](https://github.com/grafana/grafana/pull/49629), [@zoltanbedi](https://github.com/zoltanbedi) +- **Loki:** Fix unwrap parsing in query builder. [#49732](https://github.com/grafana/grafana/pull/49732), [@ivanahuckova](https://github.com/ivanahuckova) +- **Navigation:** Position hamburger menu correctly in mobile view. [#49603](https://github.com/grafana/grafana/pull/49603), [@ashharrison90](https://github.com/ashharrison90) +- **PanelEditor:** Fixes issue with Table view and multi data frames. [#49854](https://github.com/grafana/grafana/pull/49854), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) +- **Preferences:** Fix updating of preferences for Navbar and Query History. [#49677](https://github.com/grafana/grafana/pull/49677), [@ivanahuckova](https://github.com/ivanahuckova) +- **TimeRange:** Fixes issue when zooming out on a timerange with timespan 0. [#49622](https://github.com/grafana/grafana/pull/49622), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) +- **Variables:** Fixes DS variables not being correctly used in panel queries. [#49323](https://github.com/grafana/grafana/pull/49323), [@JoaoSilvaGrafana](https://github.com/JoaoSilvaGrafana) + +### Breaking changes + +Drop support for deprecated setting ldap_sync_ttl under [auth.proxy] +Only sync_ttl will work from now on Issue [#49902](https://github.com/grafana/grafana/issues/49902) + +Removes support for deprecated `heading` and `description` props. Moving forward, the `Card.Heading` and `Card.Description` components should be used. Issue [#49885](https://github.com/grafana/grafana/issues/49885) + +Removes the deprecated `link` variant from the `Button` component. +To migrate, replace any usage of `variant="link"` with `fill="text"`. Issue [#49843](https://github.com/grafana/grafana/issues/49843) + +Removes the deprecated `surface` prop from the `IconButton` component. This prop hasn't actually done anything for a while, so it should be safe to just remove any instances of its usage. +Issue [#49715](https://github.com/grafana/grafana/issues/49715) + +Removes the deprecated `TextDisplayOptions` export from `@grafana/data` in favor of `VizTextDisplayOptions` from `@grafana/schema`. To migrate, just replace usage of `TextDisplayOptions` with `VizTextDisplayOptions`. Issue [#49705](https://github.com/grafana/grafana/issues/49705) + +Removed support for the deprecated `getColorForTheme(color: string, theme: GrafanaTheme)` function in favor of the +`theme.visualization.getColorByName(color: string)` method. The output of this method is identical to the removed function, so migration should just be a matter of rewriting calls of `getColorForTheme(myColor, myTheme)` to `myTheme.visualization.getColorByName(myColor)`. +Issue [#49519](https://github.com/grafana/grafana/issues/49519) + +In the Prometheus data source, for consistency and performance reasons, we changed how we represent `NaN` (not a number) values received from Prometheus. In the past versions, we converted these to `null` in the frontend (for dashboard and explore), and kept as `NaN` in the alerting path. Starting with this version, we will always keep it as `NaN`. This change should be mostly invisible for the users. Issue [#49475](https://github.com/grafana/grafana/issues/49475) + +Plugins using custom Webpack configs could potentially break due to the changes between webpack@4 and webpack@5. Please refer to the [official migration guide](https://webpack.js.org/migrate/5/) for assistance. + +Webpack 5 does not include polyfills for node.js core modules by default (e.g. `buffer`, `stream`, `os`). This can result in failed builds for plugins. If polyfills are required it is recommended to create a custom webpack config in the root of the plugin repo and add the required fallbacks: + +```js +// webpack.config.js + +module.exports.getWebpackConfig = (config, options) => ({ + ...config, + resolve: { + ...config.resolve, + fallback: { + os: require.resolve('os-browserify/browser'), + stream: require.resolve('stream-browserify'), + timers: require.resolve('timers-browserify'), + }, + }, +}); +``` + +Please refer to the webpack build error messages or the [official migration guide](https://webpack.js.org/migrate/5/) for assistance with fallbacks. + +**Which issue(s) this PR fixes**: + + + +Fixes # + +**Special notes for your reviewer**: + +It does not bump the following dependencies to the very latest due to the latest versions being ES modules: + +- ora +- globby +- execa +- chalk + Issue [#47826](https://github.com/grafana/grafana/issues/47826) + +We have changed the internals of `backendSrv.fetch()` to throw an error when the response is an incorrect JSON. + +```javascript +// PREVIOUSLY: this was returning with an empty object {} - in case the response is an invalid JSON +return await getBackendSrv().post(`${API_ROOT}/${id}/install`); + +// AFTER THIS CHANGE: the following will throw an error - in case the response is an invalid JSON +return await getBackendSrv().post(`${API_ROOT}/${id}/install`); +``` + +**When is the response handled as JSON?** + +- If the response has the `"Content-Type: application/json"` header, OR +- If the backendSrv options ([`BackendSrvRequest`](https://github.com/grafana/grafana/blob/e237ff20a996c7313632b2e28f38032012f0e340/packages/grafana-runtime/src/services/backendSrv.ts#L8)) specify the response as JSON: `{ responseType: 'json' }` + +**How does it work after this change?** + +- In case it is recognised as a JSON response and the response is empty, it returns an empty object `{}` +- In case it is recognised as a JSON response and it has formatting errors, it throws an error + +**How to migrate?** +Make sure to handle possible errors on the callsite where using `backendSrv.fetch()` (or any other `backendSrv` methods). Issue [#47493](https://github.com/grafana/grafana/issues/47493) + +### Plugin development fixes & changes + +- **UI/Card:** Remove deprecated props. [#49885](https://github.com/grafana/grafana/pull/49885), [@kaydelaney](https://github.com/kaydelaney) +- **UI/Button:** Remove deprecated "link" variant. [#49843](https://github.com/grafana/grafana/pull/49843), [@kaydelaney](https://github.com/kaydelaney) +- **Toolkit:** Bump dependencies. [#47826](https://github.com/grafana/grafana/pull/47826), [@jackw](https://github.com/jackw) diff --git a/docs/sources/release-notes/release-notes-9-0-0-beta3.md b/docs/sources/release-notes/release-notes-9-0-0-beta3.md new file mode 100644 index 00000000000..ac5374ef12c --- /dev/null +++ b/docs/sources/release-notes/release-notes-9-0-0-beta3.md @@ -0,0 +1,125 @@ ++++ +title = "Release notes for Grafana 9.0.0-beta3" +hide_menu = true ++++ + + + +# Release notes for Grafana 9.0.0-beta3 + +### Features and enhancements + +- **Alerting:** Add provenance guard to config api. [#50147](https://github.com/grafana/grafana/pull/50147), [@JohnnyQQQQ](https://github.com/JohnnyQQQQ) +- **Alerting:** Make folder filter clearable in Alert list panel. [#50093](https://github.com/grafana/grafana/pull/50093), [@peterholmberg](https://github.com/peterholmberg) +- **Alerting:** Provisioning API - Alert rules. [#47930](https://github.com/grafana/grafana/pull/47930), [@JohnnyQQQQ](https://github.com/JohnnyQQQQ) +- **Alerting:** Remove Image Upload code from Slack notifier. [#50062](https://github.com/grafana/grafana/pull/50062), [@joeblubaugh](https://github.com/joeblubaugh) +- **Alerting:** Remove double quotes from matchers. [#50038](https://github.com/grafana/grafana/pull/50038), [@gotjosh](https://github.com/gotjosh) +- **Cloudwatch:** Dynamic labels autocomplete. [#49794](https://github.com/grafana/grafana/pull/49794), [@sunker](https://github.com/sunker) +- **Datasource:** Remove deprecated max_idle_connections_per_host setting. [#49948](https://github.com/grafana/grafana/pull/49948), [@marefr](https://github.com/marefr) +- **Datasource:** Remove support for unencrypted passwords. [#49987](https://github.com/grafana/grafana/pull/49987), [@marefr](https://github.com/marefr) +- **Dependencies:** Update to Golang version `1.17.11`. [#50253](https://github.com/grafana/grafana/pull/50253), [@dsotirakis](https://github.com/dsotirakis) +- **Loki:** Run query when pressing Enter on line-filters. [#49913](https://github.com/grafana/grafana/pull/49913), [@svennergr](https://github.com/svennergr) +- **Metrics:** Remove support for using summaries instead of histogram for HTTP instrumentation. [#49985](https://github.com/grafana/grafana/pull/49985), [@bergquist](https://github.com/bergquist) +- **Plugins:** Remove deprecated /api/tsdb/query metrics endpoint. [#49916](https://github.com/grafana/grafana/pull/49916), [@wbrowne](https://github.com/wbrowne) +- **Plugins:** Support headers field for check health. [#49930](https://github.com/grafana/grafana/pull/49930), [@marefr](https://github.com/marefr) +- **Prometheus/Loki:** Add raw query and syntax highlight in explain mode. [#50070](https://github.com/grafana/grafana/pull/50070), [@aocenas](https://github.com/aocenas) +- **Prometheus:** Migrate metadata queries to use resource calls. [#49921](https://github.com/grafana/grafana/pull/49921), [@srclosson](https://github.com/srclosson) +- **RBAC:** Make RBAC action names more consistent. [#49730](https://github.com/grafana/grafana/pull/49730), [@IevaVasiljeva](https://github.com/IevaVasiljeva) +- **RBAC:** Make RBAC action names more consistent. (Enterprise) +- **Settings:** Sunset non-duration based login lifetime config. [#49944](https://github.com/grafana/grafana/pull/49944), [@sakjur](https://github.com/sakjur) +- **[9.0.x] Alerting:** Update alert rule diff to not see difference between nil and empty map. [#50198](https://github.com/grafana/grafana/pull/50198), [@yuri-tceretian](https://github.com/yuri-tceretian) + +### Bug fixes + +- **Alerting:** Fix alert list panel showing firing alerts with no instances. [#50069](https://github.com/grafana/grafana/pull/50069), [@gillesdemey](https://github.com/gillesdemey) +- **Alerting:** Fix notification policy "Override grouping" form save. [#50031](https://github.com/grafana/grafana/pull/50031), [@JacobsonMT](https://github.com/JacobsonMT) +- **Alerting:** Remove double quotes from matchers. [#50046](https://github.com/grafana/grafana/pull/50046), [@alexweav](https://github.com/alexweav) +- **Alerting:** Use correct permission scope for external AM updates. [#50159](https://github.com/grafana/grafana/pull/50159), [@gillesdemey](https://github.com/gillesdemey) +- **Datasource:** Fix allowed cookies to be forwarded as header to backend datasources. [#49541](https://github.com/grafana/grafana/pull/49541), [@marefr](https://github.com/marefr) +- **Licensing:** Fix trial expiration warning. (Enterprise) +- **Loki:** Fix uncaught errors if `labelKey` contains special characters. [#49887](https://github.com/grafana/grafana/pull/49887), [@svennergr](https://github.com/svennergr) +- **Prometheus:** Fix aligning of labels of exemplars after backend migration. [#49924](https://github.com/grafana/grafana/pull/49924), [@aocenas](https://github.com/aocenas) +- **SharePDF:** Fix repeated datasource variables in PDF. (Enterprise) +- **State Timeline:** Fix Null Value Filling and Value Transformation. [#50054](https://github.com/grafana/grafana/pull/50054), [@codeincarnate](https://github.com/codeincarnate) +- **Usage stats:** Divide collection into multiple functions to isolate failures. [#49928](https://github.com/grafana/grafana/pull/49928), [@sakjur](https://github.com/sakjur) + +### Breaking changes + +Removes support for storing/using datasource `password` and `basicAuthPassword` unencrypted which was [deprecated in Grafana v8.1.0](https://grafana.com/docs/grafana/latest/installation/upgrading/#use-of-unencrypted-passwords-for-data-sources-no-longer-supported). Please use `secureJsonData.password` and `secureJsonData.basicAuthPassword`. Issue [#49987](https://github.com/grafana/grafana/issues/49987) + +Removes the option to instrument HTTP request in Grafana using summaries instead of histograms. Issue [#49985](https://github.com/grafana/grafana/issues/49985) + +Removes support for deprecated dataproxy.max_idle_connections_per_host setting. Please use max_idle_connections instead. Issue [#49948](https://github.com/grafana/grafana/issues/49948) + +Removes the deprecated `getFormStyles` function from grafana-ui. +Prefer using `GrafanaTheme2` and the `useStyles2` hook. Issue [#49945](https://github.com/grafana/grafana/issues/49945) + +The configuration options `auth.login_maximum_inactive_lifetime_days` and `auth.login_maximum_lifetime_days` were deprecated in Grafana v7.2.0 and have now been removed. Use `login_maximum_inactive_lifetime_duration` and `login_maximum_lifetime_duration` to customize the maximum lifetime of a login session. Issue [#49944](https://github.com/grafana/grafana/issues/49944) + +Removed the deprecated `isFocused` and `isInvalid` props from the `InlineLabel` component. These props haven't done anything for a while, so migration is just a matter of removing the props. Issue [#49929](https://github.com/grafana/grafana/issues/49929) + +Removed the deprecated `onColorChange` prop from `ColorPicker`. Moving forward the `onChange` prop should be used. Issue [#49923](https://github.com/grafana/grafana/issues/49923) + +`/api/tsdb/query` API has been removed. Use [/api/ds/query](https://grafana.com/docs/grafana/latest/http_api/data_source/#query-a-data-source) instead. +Issue [#49916](https://github.com/grafana/grafana/issues/49916) + +`onClipboardCopy` and `onClipboardError` APIs have been changed such that the callback's argument is just the text that's been copied rather than the old `ClipboardEvent` interface. +Migration should just be a matter of going from + +```tsx + { + console.log(`Text "${e.text}" was copied!`); + }} +/> +``` + +to + +````tsx + { + console.log(`Text "${copiedText}" was copied!`); + }} +/> +``` Issue [#49847](https://github.com/grafana/grafana/issues/49847) + + +The following RBAC action renames have been carried out: + +* `users.authtoken:update` -> `users.authtoken:write`; +* `users.password:update` -> `users.password:write`; +* `users.permissions:update` -> `users.permissions:write`; +* `users.quotas:update` -> `users.quotas:write`; +* `org.users.role:update` -> `org.users:write`; +* `alert.instances:update` -> `alert.instances:write`; +* `alert.rules:update` -> `alert.rules:write`; +* `users.authtoken:list` -> `users.authtoken:read`; +* `users.quotas:list` -> `users.quotas:read`; +* `users.teams:read` -> replaced by `users.read` + `teams:read` + +We've added a migration from the old action names to the new names and have updated our documentation. But you will have to update any scripts and provisioning files that are using the old action names. Issue [#49730](https://github.com/grafana/grafana/issues/49730) + + +The following RBAC action renames have been carried out: + +* `reports.admin:write` -> `reports:write`; +* `reports.admin:create` -> `reports:create`; +* `licensing:update` -> `licensing:write`; +* `roles:list` -> `roles:read`; +* `teams.roles:list` -> `teams.roles:read`; +* `users.roles:list` -> `users.roles:read`; +* `users.permissions:list` -> `users.permissions:read` + +We've added a migration from the old action names to the new names and have updated our documentation. But you will have to update any scripts and provisioning files that are using the old action names. Issue [#3372](https://github.com/grafana/grafana/issues/3372) + +### Plugin development fixes & changes + +- **UI:** Remove deprecated getFormStyles function. [#49945](https://github.com/grafana/grafana/pull/49945), [@kaydelaney](https://github.com/kaydelaney) +- **InlineLabel:** Remove deprecated props. [#49929](https://github.com/grafana/grafana/pull/49929), [@kaydelaney](https://github.com/kaydelaney) +- **ColorPicker:** Remove deprecated onColorChange prop. [#49923](https://github.com/grafana/grafana/pull/49923), [@kaydelaney](https://github.com/kaydelaney) +- **ClipboardButton:** Simplify callbacks. [#49847](https://github.com/grafana/grafana/pull/49847), [@kaydelaney](https://github.com/kaydelaney) + +```` diff --git a/docs/sources/release-notes/release-notes-v7-4-2.md b/docs/sources/release-notes/release-notes-v7-4-2.md index 3db6a4bcaab..8588c9574fc 100644 --- a/docs/sources/release-notes/release-notes-v7-4-2.md +++ b/docs/sources/release-notes/release-notes-v7-4-2.md @@ -1,9 +1,9 @@ -+++ -aliases = ["/docs/grafana/latest/release-notes/release-notes-v7-4-2/"] -title = "undefined" - -[_build] - list = false -+++ +--- +_build: + list: false +aliases: + - /docs/grafana/latest/release-notes/release-notes-v7-4-2/ +title: undefined +--- diff --git a/docs/sources/setup-grafana/_index.md b/docs/sources/setup-grafana/_index.md new file mode 100644 index 00000000000..f15d7c5e474 --- /dev/null +++ b/docs/sources/setup-grafana/_index.md @@ -0,0 +1,13 @@ +--- +aliases: + - /docs/grafana/latest/setup-grafana/ +description: Includes topics for setting up a Grafana instance. +title: Setup +weight: 10 +--- + +# Setup + +This section includes information that helps you get Grafana up and running. + +{{< section >}} diff --git a/docs/sources/administration/configuration.md b/docs/sources/setup-grafana/configure-grafana/_index.md similarity index 93% rename from docs/sources/administration/configuration.md rename to docs/sources/setup-grafana/configure-grafana/_index.md index c121b89bf87..3586fa9237d 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -1,14 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/administration/configuration/", "/docs/grafana/latest/installation/configuration/"] -description = "Configuration documentation" -keywords = ["grafana", "configuration", "documentation"] -title = "Configuration" -weight = 150 -+++ +--- +aliases: + - /docs/grafana/latest/administration/configuration/ + - /docs/grafana/latest/installation/configuration/ + - /docs/grafana/latest/setup-grafana/configure-grafana/ +description: Configuration documentation +title: Configure Grafana +weight: 200 +--- -# Configuration +# Configure Grafana -Grafana has default and custom configuration files. You can customize your Grafana instance by modifying the custom configuration file or by using environment variables. To see the list of settings for a Grafana instance, refer to [View server settings]({{< relref "view-server/view-server-settings.md" >}}). +Grafana has default and custom configuration files. You can customize your Grafana instance by modifying the custom configuration file or by using environment variables. To see the list of settings for a Grafana instance, refer to [View server settings]({{< relref "../../administration/view-server/view-server-settings/" >}}). > **Note:** After you add custom options, [uncomment](#remove-comments-in-the-ini-files) the relevant sections of the configuration file. Restart Grafana for your changes to take effect. @@ -24,7 +26,7 @@ If you installed Grafana using the `deb` or `rpm` packages, then your configurat ### Docker -Refer to [Configure a Grafana Docker image]({{< relref "configure-docker.md" >}}) for information about environmental variables, persistent storage, and building custom Docker images. +Refer to [Configure a Grafana Docker image]({{< relref "../../administration/configure-docker/" >}}) for information about environmental variables, persistent storage, and building custom Docker images. ### Windows @@ -122,7 +124,7 @@ password = $__file{/etc/secrets/gf_sql_password} The `vault` provider allows you to manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault). -> Vault provider is only available in Grafana Enterprise v7.1+. For more information, refer to [Vault integration]({{< relref "../enterprise/vault.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). +> Vault provider is only available in Grafana Enterprise v7.1+. For more information, refer to [Vault integration]({{< relref "../configure-security/configure-database-encryption/integrate-with-hashicorp-vault/" >}}) in [Grafana Enterprise]({{< relref "../../enterprise/" >}}).
@@ -168,13 +170,13 @@ Override log path using the command line argument `cfg:default.paths.logs`: ### plugins -Directory where Grafana automatically scans and looks for plugins. For information about manually or automatically installing plugins, refer to [Install Grafana plugins]({{< relref "../plugins/installation.md" >}}). +Directory where Grafana automatically scans and looks for plugins. For information about manually or automatically installing plugins, refer to [Install Grafana plugins]({{< relref "../../plugins/installation/" >}}). **macOS:** By default, the Mac plugin location is: `/usr/local/var/lib/grafana/plugins`. ### provisioning -Folder that contains [provisioning]({{< relref "provisioning.md" >}}) config files that Grafana will apply on startup. Dashboards will be reloaded when the json files changes. +Folder that contains [provisioning]({{< relref "../../administration/provisioning/" >}}) config files that Grafana will apply on startup. Dashboards will be reloaded when the json files changes.
@@ -367,7 +369,7 @@ Defaults to `private`. ## [remote_cache] -Caches authentication details and session information in the configured database, Redis or Memcached. This setting does not configure [Query Caching in Grafana Enterprise]({{< relref "../enterprise/query-caching.md" >}}). +Caches authentication details and session information in the configured database, Redis or Memcached. This setting does not configure [Query Caching in Grafana Enterprise]({{< relref "../../enterprise/query-caching/" >}}). ### type @@ -429,12 +431,6 @@ For more details check the [Transport.MaxConnsPerHost](https://golang.org/pkg/ne The maximum number of idle connections that Grafana will maintain. Default is `100`. For more details check the [Transport.MaxIdleConns](https://golang.org/pkg/net/http/#Transport.MaxIdleConns) documentation. -### max_idle_connections_per_host - -[Deprecated - use max_idle_connections instead] - -The maximum number of idle connections per host that Grafana will maintain. Default is `2`. For more details check the [Transport.MaxIdleConnsPerHost](https://golang.org/pkg/net/http/#Transport.MaxIdleConnsPerHost) documentation. - ### idle_conn_timeout_seconds The length of time that Grafana maintains idle connections before closing them. Default is `90` seconds. For more details check the [Transport.IdleConnTimeout](https://golang.org/pkg/net/http/#Transport.IdleConnTimeout) documentation. @@ -668,7 +664,7 @@ Path to the default home dashboard. If this value is empty, then Grafana uses St Set to `false` to prohibit users from being able to sign up / create user accounts. Default is `false`. The admin user can still create -users. For more information about creating a user, refer to [Add a user]({{< relref "../administration/manage-users-and-permissions/manage-server-users/add-user.md" >}}). +users. For more information about creating a user, refer to [Add a user]({{< relref "../../administration/manage-users-and-permissions/manage-server-users/add-user/" >}}). ### allow_org_create @@ -721,7 +717,7 @@ If you manage users externally you can replace the user invite button for organi ### viewers_can_edit -Viewers can access and use [Explore]({{< relref "../explore/_index.md" >}}) and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. Default is `false`. +Viewers can access and use [Explore]({{< relref "../../explore/" >}}) and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. Default is `false`. ### editors_can_admin @@ -742,7 +738,7 @@ This is a comma-separated list of usernames. Users specified here are hidden in ## [auth] -Grafana provides many ways to authenticate users. Refer to the Grafana [Authentication overview]({{< relref "../auth/overview.md" >}}) and other authentication documentation for detailed instructions on how to set up and configure authentication. +Grafana provides many ways to authenticate users. Refer to the Grafana [Authentication overview]({{< relref "../configure-security/configure-authentication/" >}}) and other authentication documentation for detailed instructions on how to set up and configure authentication. ### login_cookie_name @@ -810,25 +806,25 @@ Set to `true` to enable verbose request signature logging when AWS Signature Ver ## [auth.anonymous] -Refer to [Anonymous authentication]({{< relref "../auth/grafana.md/#anonymous-authentication" >}}) for detailed instructions. +Refer to [Anonymous authentication]({{< relref "../configure-security/configure-authentication/grafana/#anonymous-authentication" >}}) for detailed instructions.
## [auth.github] -Refer to [GitHub OAuth2 authentication]({{< relref "../auth/github.md" >}}) for detailed instructions. +Refer to [GitHub OAuth2 authentication]({{< relref "../configure-security/configure-authentication/github/" >}}) for detailed instructions.
## [auth.gitlab] -Refer to [Gitlab OAuth2 authentication]({{< relref "../auth/gitlab.md" >}}) for detailed instructions. +Refer to [Gitlab OAuth2 authentication]({{< relref "../configure-security/configure-authentication/gitlab/" >}}) for detailed instructions.
## [auth.google] -Refer to [Google OAuth2 authentication]({{< relref "../auth/google.md" >}}) for detailed instructions. +Refer to [Google OAuth2 authentication]({{< relref "../configure-security/configure-authentication/google/" >}}) for detailed instructions.
@@ -846,37 +842,37 @@ Legacy key names, still in the config file so they work in env variables. ## [auth.azuread] -Refer to [Azure AD OAuth2 authentication]({{< relref "../auth/azuread.md" >}}) for detailed instructions. +Refer to [Azure AD OAuth2 authentication]({{< relref "../configure-security/configure-authentication/azuread/" >}}) for detailed instructions.
## [auth.okta] -Refer to [Okta OAuth2 authentication]({{< relref "../auth/okta.md" >}}) for detailed instructions. +Refer to [Okta OAuth2 authentication]({{< relref "../configure-security/configure-authentication/okta/" >}}) for detailed instructions.
## [auth.generic_oauth] -Refer to [Generic OAuth authentication]({{< relref "../auth/generic-oauth.md" >}}) for detailed instructions. +Refer to [Generic OAuth authentication]({{< relref "../configure-security/configure-authentication/generic-oauth/" >}}) for detailed instructions.
## [auth.basic] -Refer to [Basic authentication]({{< relref "../auth/overview.md#basic-authentication" >}}) for detailed instructions. +Refer to [Basic authentication]({{< relref "../configure-security/configure-authentication/#basic-authentication" >}}) for detailed instructions.
## [auth.proxy] -Refer to [Auth proxy authentication]({{< relref "../auth/auth-proxy.md" >}}) for detailed instructions. +Refer to [Auth proxy authentication]({{< relref "../configure-security/configure-authentication/auth-proxy/" >}}) for detailed instructions.
## [auth.ldap] -Refer to [LDAP authentication]({{< relref "../auth/ldap.md" >}}) for detailed instructions. +Refer to [LDAP authentication]({{< relref "../configure-security/configure-authentication/ldap/" >}}) for detailed instructions. ## [aws] @@ -927,7 +923,7 @@ Should be set for user-assigned identity and should be empty for system-assigned ## [auth.jwt] -Refer to [JWT authentication]({{< relref "../auth/jwt.md" >}}) for more information. +Refer to [JWT authentication]({{< relref "../configure-security/configure-authentication/jwt/" >}}) for more information.
@@ -1181,7 +1177,7 @@ Sets a global limit on number of alert rules that can be created. Default is -1 ## [unified_alerting] -For more information about the Grafana alerts, refer to [About Grafana alerting]({{< relref "../alerting/_index.md" >}}). +For more information about the Grafana alerts, refer to [About Grafana alerting]({{< relref "../../alerting/" >}}). ### enabled @@ -1265,7 +1261,7 @@ The interval string is a possibly signed sequence of decimal numbers, followed b ## [alerting] -For more information about the legacy dashboard alerting feature in Grafana, refer to [Alerts overview]({{< relref "../alerting/_index.md" >}}). +For more information about the legacy dashboard alerting feature in Grafana, refer to [Alerts overview]({{< relref "../../alerting/" >}}). ### enabled @@ -1353,7 +1349,7 @@ Configures max number of API annotations that Grafana keeps. Default value is 0, ## [explore] -For more information about this feature, refer to [Explore]({{< relref "../explore/_index.md" >}}). +For more information about this feature, refer to [Explore]({{< relref "../../explore/" >}}). ### enabled @@ -1385,7 +1381,7 @@ Enable or disable the Query history. Default is `enabled`. ## [metrics] -For detailed instructions, refer to [Internal Grafana metrics]({{< relref "view-server/internal-metrics.md" >}}). +For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../set-up-grafana-monitoring/" >}}). ### enabled @@ -1446,6 +1442,8 @@ Default is https://grafana.com. ## [tracing.jaeger] +[Deprecated - use tracing.opentelemetry.jaeger or tracing.opentelemetry.otlp instead] + Configure Grafana's Jaeger client for distributed tracing. You can also use the standard `JAEGER_*` environment variables to configure @@ -1509,6 +1507,34 @@ Setting this to `true` turns off shared RPC spans. Leaving this available is the
+## [tracing.opentelemetry.jaeger] + +Configure Grafana's Jaeger client for distributed tracing. + +### address + +The host:port destination for reporting spans. (ex: `localhost:14268/api/traces`) + +### propagation + +The propagation specifies the text map propagation format.(ex: jaeger, w3c) + +
+ +## [tracing.opentelemetry.otlp] + +Configure Grafana's otlp client for distributed tracing. + +### address + +The host:port destination for reporting spans. (ex: `localhost:4317`) + +### propagation + +The propagation specifies the text map propagation format.(ex: jaeger, w3c) + +
+ ## [external_image_storage] These options control how images should be made public so they can be shared on services like Slack or email message. @@ -1670,13 +1696,13 @@ Set to `true` if you want to test alpha plugins that are not yet ready for gener Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded. -We do _not_ recommend using this option. For more information, refer to [Plugin signatures]({{< relref "../plugins/plugin-signatures.md" >}}). +We do _not_ recommend using this option. For more information, refer to [Plugin signatures]({{< relref "../../plugins/plugin-signatures/" >}}). ### plugin_admin_enabled Available to Grafana administrators only, enables installing / uninstalling / updating plugins directly from the Grafana UI. Set to `true` by default. Setting it to `false` will hide the install / uninstall / update controls. -For more information, refer to [Plugin catalog]({{< relref "../plugins/catalog.md" >}}). +For more information, refer to [Plugin catalog]({{< relref "../../plugins/catalog/" >}}). ### plugin_admin_external_manage_enabled @@ -1700,7 +1726,7 @@ Enter a comma-separated list of plugin identifiers to hide in the plugin catalog The `max_connections` option specifies the maximum number of connections to the Grafana Live WebSocket endpoint per Grafana server instance. Default is `100`. -Refer to [Grafana Live configuration documentation]({{< relref "../live/set-up-grafana-live.md" >}}) if you specify a number higher than default since this can require some operating system and infrastructure tuning. +Refer to [Grafana Live configuration documentation]({{< relref "../set-up-grafana-live/" >}}) if you specify a number higher than default since this can require some operating system and infrastructure tuning. 0 disables Grafana Live, -1 means unlimited connections. @@ -1729,7 +1755,7 @@ allowed_origins = "https://*.example.com" The high availability (HA) engine name for Grafana Live. By default, it's not set. The only possible value is "redis". -For more information, refer to the [Configure Grafana Live HA setup]({{< relref "../live/set-up-grafana-live/#configure-grafana-live-ha-setup" >}}). +For more information, refer to the [Configure Grafana Live HA setup]({{< relref "../set-up-grafana-live/#configure-grafana-live-ha-setup" >}}). ### ha_engine_address @@ -1841,7 +1867,7 @@ Change the listening port of the gRPC server. Default port is `0` and will autom ## [enterprise] -For more information about Grafana Enterprise, refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}). +For more information about Grafana Enterprise, refer to [Grafana Enterprise]({{< relref "../../enterprise/" >}}).
@@ -1944,8 +1970,8 @@ Maximum duration of a single crawl. Default is 1h. Minimum interval between two subsequent scheduler runs. Default is 12h. -Refer to the [dashboards previews]({{< relref "../dashboards/previews.md" >}}) documentation for detailed instructions. +Refer to the [dashboards previews]({{< relref "../../dashboards/previews/" >}}) documentation for detailed instructions. ## [rbac] -Refer to [Role-based access control]({{< relref "../enterprise/access-control/about-rbac.md" >}}) for more information. +Refer to [Role-based access control]({{< relref "../../enterprise/access-control/about-rbac/" >}}) for more information. diff --git a/docs/sources/enterprise/enterprise-configuration.md b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration.md similarity index 91% rename from docs/sources/enterprise/enterprise-configuration.md rename to docs/sources/setup-grafana/configure-grafana/enterprise-configuration.md index 2ccb1e2767b..dfb0595af7b 100644 --- a/docs/sources/enterprise/enterprise-configuration.md +++ b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration.md @@ -1,14 +1,15 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-configuration/"] -description = "Enterprise configuration documentation" -keywords = ["grafana", "configuration", "documentation", "enterprise"] -title = "Enterprise configuration" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enterprise-configuration/ + - /docs/grafana/latest/setup-grafana/configure-grafana/enterprise-configuration/ +description: Learn about Grafana Enterprise configuration options that you can specify. +title: Configure Grafana Enterprise +weight: 100 +--- -# Grafana Enterprise configuration +# Configure Grafana Enterprise -This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information about available configuration options. +This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration]({{< relref "./" >}}) for more information about available configuration options. ## [enterprise] @@ -19,7 +20,7 @@ Defaults to `/license.jwt`. ### license_text -> **Note:** Available in Grafana Enterprise v7.4+. +> **Note:** Available in Grafana Enterprise version 7.4 and later. When set to the text representation (i.e. content of the license file) of the license, Grafana will evaluate and apply the given license to @@ -27,7 +28,7 @@ the instance. ### auto_refresh_license -> **Note:** Available in Grafana Enterprise v7.4+. +> **Note:** Available in Grafana Enterprise version 7.4 and later. When enabled, Grafana will send the license and usage statistics to the license issuer. If the license has been updated on the issuer's @@ -37,9 +38,9 @@ automatically. Defaults to `true`. ### license_validation_type -> **Note:** Available in Grafana Enterprise v8.3+. +> **Note:** Available in Grafana Enterprise version 8.3 and later. -When set to `aws`, Grafana will validate its license status with Amazon Web Services (AWS) instead of with Grafana Labs. Only use this setting if you purchased an Enterprise license from AWS Marketplace. Defaults to empty, which means that by default Grafana Enterprise will validate using a license issued by Grafana Labs. For details about licenses issued by AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "../enterprise/license/activate-aws-marketplace-license/" >}}). +When set to `aws`, Grafana will validate its license status with Amazon Web Services (AWS) instead of with Grafana Labs. Only use this setting if you purchased an Enterprise license from AWS Marketplace. Defaults to empty, which means that by default Grafana Enterprise will validate using a license issued by Grafana Labs. For details about licenses issued by AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "../../enterprise/license/activate-aws-marketplace-license/" >}}). ## [white_labeling] @@ -78,7 +79,7 @@ List the link IDs to use here. Grafana will look for matching link configuration ## [usage_insights.export] -By [exporting usage logs]({{< relref "usage-insights/export-logs.md" >}}), you can directly query them and create dashboards of the information that matters to you most, such as dashboard errors, most active organizations, or your top-10 most-used queries. +By [exporting usage logs]({{< relref "../configure-security/export-logs/" >}}), you can directly query them and create dashboards of the information that matters to you most, such as dashboard errors, most active organizations, or your top-10 most-used queries. ### enabled @@ -162,7 +163,7 @@ Name of the TrueType font file with italic style. ## [auditing] -[Auditing]({{< relref "auditing.md" >}}) allows you to track important changes to your Grafana instance. By default, audit logs are logged to file but the auditing feature also supports sending logs directly to Loki. +[Auditing]({{< relref "../configure-security/audit-grafana/" >}}) allows you to track important changes to your Grafana instance. By default, audit logs are logged to file but the auditing feature also supports sending logs directly to Loki. ### enabled @@ -322,7 +323,7 @@ New duration for renewed tokens. Vault may be configured to ignore this value an ## [security.egress] -> **Note:** Available in Grafana Enterprise v7.4 and later versions. +> **Note:** Available in Grafana Enterprise version 7.4 and later. Security egress makes it possible to control outgoing traffic from the Grafana server. @@ -350,7 +351,7 @@ Encryption algorithm used to encrypt secrets stored in the database and cookies. ## [caching] -> **Note:** Available in Grafana Enterprise v7.5 and later versions. +> **Note:** Available in Grafana Enterprise version 7.5 and later. When query caching is enabled, Grafana can temporarily store the results of data source queries and serve cached responses to similar requests. @@ -366,7 +367,7 @@ Setting 'enabled' to `true` allows users to configure query caching for data sou This value is `true` by default. -> **Note:** This setting enables the caching feature, but it does not turn on query caching for any data source. To turn on query caching for a data source, update the setting on the data source configuration page. For more information, refer to the [query caching docs]({{< relref "./query-caching.md#enable-and-configure-query-caching" >}}). +> **Note:** This setting enables the caching feature, but it does not turn on query caching for any data source. To turn on query caching for a data source, update the setting on the data source configuration page. For more information, refer to the [query caching docs]({{< relref "../../enterprise/query-caching/#enable-and-configure-query-caching" >}}). ### ttl diff --git a/docs/sources/administration/security.md b/docs/sources/setup-grafana/configure-security/_index.md similarity index 83% rename from docs/sources/administration/security.md rename to docs/sources/setup-grafana/configure-security/_index.md index 100afe745b9..7a2cbf26075 100644 --- a/docs/sources/administration/security.md +++ b/docs/sources/setup-grafana/configure-security/_index.md @@ -1,12 +1,14 @@ -+++ -aliases = ["/docs/grafana/latest/administration/security/", "/docs/grafana/latest/installation/security/"] -description = "Security Docs" -keywords = ["grafana", "security", "documentation"] -title = "Security" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/administration/security/ + - /docs/grafana/latest/installation/security/ + - /docs/grafana/latest/setup-grafana/configure-security/ +description: Learn how to make Grafana secure. +title: Configure security +weight: 600 +--- -# Security +# Configure security If you run non-Grafana web services on your Grafana server or within its local network, then they might be vulnerable to exploitation through the Grafana data source proxy or other methods. @@ -14,11 +16,11 @@ To prevent this type of exploitation from happening, we recommend that you apply ## Limit IP addresses/hostnames for data source URL -You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist]({{< relref "../administration/configuration/#data-source-proxy-whitelist" >}}) for usage instructions. +You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist]({{< relref "../configure-grafana/#data_source_proxy_whitelist" >}}) for usage instructions. ## Request security -The request security configuration option allows users to limit requests from the Grafana server. It targets requests that are generated by users. For more information, refer to [Request security]({{< relref "../enterprise/request-security.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). +The request security configuration option allows users to limit requests from the Grafana server. It targets requests that are generated by users. For more information, refer to [Request security]({{< relref "configure-request-security/" >}}). > **Note:** Request security is available in Grafana Enterprise v7.4 and later versions. @@ -40,7 +42,7 @@ Users with the Viewer role can enter _any possible query_ in _any_ of the data s To address this vulnerability, you can restrict data source query access in the following ways: -- Create multiple data sources with some restrictions added in data source configuration that restrict access (like database name or credentials). Then use the [Data Source Permissions]({{< relref "../enterprise/datasource_permissions.md" >}}) Enterprise feature to restrict user access to the data source in Grafana. +- Create multiple data sources with some restrictions added in data source configuration that restrict access (like database name or credentials). Then use the [Data Source Permissions]({{< relref "../../enterprise/datasource_permissions/" >}}) Enterprise feature to restrict user access to the data source in Grafana. - Create a separate Grafana organization, and in that organization, create a separate data source. Make sure the data source has some option/user/credentials setting that limits access to a subset of the data. Not all data sources have an option to limit access. ## Implications of enabling anonymous access to dashboards diff --git a/docs/sources/enterprise/auditing.md b/docs/sources/setup-grafana/configure-security/audit-grafana.md similarity index 97% rename from docs/sources/enterprise/auditing.md rename to docs/sources/setup-grafana/configure-security/audit-grafana.md index 644d974482e..f937499e631 100644 --- a/docs/sources/enterprise/auditing.md +++ b/docs/sources/setup-grafana/configure-security/audit-grafana.md @@ -1,17 +1,23 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/auditing/"] -description = "Auditing" -keywords = ["grafana", "auditing", "audit", "logs"] -title = "Auditing" -weight = 1100 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/auditing/ + - /docs/grafana/latest/setup-grafana/configure-security/audit-grafana/ +description: Auditing +keywords: + - grafana + - auditing + - audit + - logs +title: Audit a Grafana instance +weight: 800 +--- -# Auditing - -> **Note:** Only available in Grafana Enterprise v7.3+. +# Audit a Grafana instance Auditing allows you to track important changes to your Grafana instance. By default, audit logs are logged to file but the auditing feature also supports sending logs directly to Loki. +> **Note:** Available in [Grafana Enterprise]({{< relref "../../enterprise/" >}}) version 7.3 and later, and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}). + ## Audit logs Audit logs are JSON objects representing user actions like: @@ -123,7 +129,7 @@ pattern of the `requestUri` field is given. \* Where `AUTH-MODULE` is the name of the authentication module: `grafana`, `saml`, `ldap`, etc. \ -\*\* Includes manual log out, token expired/revoked, and [SAML Single Logout]({{< relref "./saml/configure-saml.md#single-logout" >}}). +\*\* Includes manual log out, token expired/revoked, and [SAML Single Logout]({{< relref "configure-authentication/saml/#single-logout" >}}). #### User management @@ -295,7 +301,7 @@ The following legacy alerting actions are still supported: > **Note:** The auditing feature is disabled by default. Audit logs can be saved into files, sent to a Loki instance or sent to the Grafana default logger. By default, only the file exporter is enabled. -You can choose which exporter to use in the [configuration file]({{< relref "../administration/configuration.md" >}}). +You can choose which exporter to use in the [configuration file]({{< relref "../configure-grafana/" >}}). Options are `file`, `loki`, and `logger`. Use spaces to separate multiple modes, such as `file loki`. @@ -331,7 +337,7 @@ max_file_size_mb = 256 Audit logs are sent to a [Loki](/oss/loki/) service, through HTTP or gRPC. -> The HTTP option for the Loki exporter is only available in Grafana Enterprise v7.4+. +> **Note:** The HTTP option for the Loki exporter is available only in Grafana Enterprise version 7.4 and later. ```ini [auditing.logs.loki] @@ -351,4 +357,4 @@ If you have multiple Grafana instances sending logs to the same Loki service or ### Console exporter -Audit logs are sent to the Grafana default logger. The audit logs use the `auditing.console` logger and are logged on `debug`-level, learn how to enable debug logging in the [log configuration]({{< relref "../administration/configuration.md#log" >}}) section of the documentation. Accessing the audit logs in this way is not recommended for production use. +Audit logs are sent to the Grafana default logger. The audit logs use the `auditing.console` logger and are logged on `debug`-level, learn how to enable debug logging in the [log configuration]({{< relref "../configure-grafana/#log" >}}) section of the documentation. Accessing the audit logs in this way is not recommended for production use. diff --git a/docs/sources/auth/overview.md b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md similarity index 66% rename from docs/sources/auth/overview.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/_index.md index 3bea4b9a030..ac6cf4a5fe8 100644 --- a/docs/sources/auth/overview.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md @@ -1,28 +1,31 @@ -+++ -aliases = ["/docs/grafana/latest/auth/overview/"] -description = "Overview for auth" -title = "Overview" -weight = 1 -+++ +--- +aliases: + - /docs/grafana/latest/auth/overview/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/ +description: Learn about all the ways in which you can configure Grafana to authenticate + users. +title: Configure authentication +weight: 100 +--- -# User Authentication Overview +# Configure authentication Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user permissions and org memberships. -The following table shows all supported authentication providers and the features available for them. [Team sync]({{< relref "../enterprise/team-sync.md" >}}) and [active sync]({{< relref "../enterprise/enhanced_ldap.md#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. +The following table shows all supported authentication providers and the features available for them. [Team sync]({{< relref "../configure-team-sync/" >}}) and [active sync]({{< relref "enhanced_ldap/#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. -| Provider | Support | Role mapping | Team sync
_(Enterprise only)_ | Active sync
_(Enterprise only)_ | -| -------------------------------------------------------------- | :-----: | :----------: | :-------------------------------: | :---------------------------------: | -| [Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - | -| [Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - | -| [Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - | -| [GitHub OAuth]({{< relref "github.md" >}}) | v2.0+ | - | v6.3+ | - | -| [GitLab OAuth]({{< relref "gitlab.md" >}}) | v5.3+ | - | v6.4+ | - | -| [Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - | -| [JWT]({{< relref "jwt.md" >}}) | v8.0+ | - | - | - | -| [LDAP]({{< relref "ldap.md" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ | -| [Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - | -| [SAML]({{< relref "../enterprise/saml/" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - | +| Provider | Support | Role mapping | Team sync
_(Enterprise only)_ | Active sync
_(Enterprise only)_ | +| ------------------------------------------------ | :-----: | :----------: | :-------------------------------: | :---------------------------------: | +| [Auth Proxy]({{< relref "auth-proxy/" >}}) | v2.1+ | - | v6.3+ | - | +| [Azure AD OAuth]({{< relref "azuread/" >}}) | v6.7+ | v6.7+ | v6.7+ | - | +| [Generic OAuth]({{< relref "generic-oauth/" >}}) | v4.0+ | v6.5+ | - | - | +| [GitHub OAuth]({{< relref "github/" >}}) | v2.0+ | - | v6.3+ | - | +| [GitLab OAuth]({{< relref "gitlab/" >}}) | v5.3+ | - | v6.4+ | - | +| [Google OAuth]({{< relref "google/" >}}) | v2.0+ | - | - | - | +| [JWT]({{< relref "jwt/" >}}) | v8.0+ | - | - | - | +| [LDAP]({{< relref "ldap/" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ | +| [Okta OAuth]({{< relref "okta/" >}}) | v7.0+ | v7.0+ | v7.0+ | - | +| [SAML]({{< relref "saml/" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - | ## Grafana Auth diff --git a/docs/sources/auth/auth-proxy.md b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy.md similarity index 93% rename from docs/sources/auth/auth-proxy.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy.md index d558098b55f..431dd0c47a4 100644 --- a/docs/sources/auth/auth-proxy.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy.md @@ -1,12 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/auth/auth-proxy/", "/docs/grafana/latest/tutorials/authproxy/"] -description = "Grafana Auth Proxy Guide " -keywords = ["grafana", "configuration", "documentation", "proxy"] -title = "Auth Proxy" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/auth/auth-proxy/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/auth-proxy/ + - /docs/grafana/latest/tutorials/authproxy/ +description: Grafana Auth Proxy Guide +keywords: + - grafana + - configuration + - documentation + - proxy +title: Configure auth proxy authentication +weight: 1300 +--- -# Auth Proxy Authentication +# Configure auth proxy authentication You can configure Grafana to let a HTTP reverse proxy handle authentication. Popular web servers have a very extensive list of pluggable authentication modules, and any of them can be used with the AuthProxy feature. @@ -234,7 +241,7 @@ headers = "Groups:X-WEBAUTH-GROUPS" You use the `X-WEBAUTH-GROUPS` header to send the team information for each user. Specifically, the set of Grafana's group IDs that the user belongs to. -First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "team-sync.md#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana. +First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "../configure-team-sync/#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana. Once that's done. You can verify your mappings by querying the API. @@ -292,7 +299,7 @@ curl -H "X-WEBAUTH-USER: leonard" -H "X-WEBAUTH-GROUPS: lokiteamOnExternalSystem With this, the user `leonard` will be automatically placed into the Loki team as part of Grafana authentication. -[Learn more about Team Sync]({{< relref "team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) ## Login token and session cookie @@ -300,5 +307,5 @@ With `enable_login_token` set to `true` Grafana will, after successful auth prox 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. -Use settings `login_maximum_inactive_lifetime_days` and `login_maximum_lifetime_days` under `[auth]` to control session -lifetime. [Read more about login tokens]({{< relref "overview/#login-and-short-lived-tokens" >}}) +Use settings `login_maximum_inactive_lifetime_duration` and `login_maximum_lifetime_duration` under `[auth]` to control session +lifetime. [Read more about login tokens]({{< relref "./#login-and-short-lived-tokens" >}}) diff --git a/docs/sources/auth/azuread.md b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread.md similarity index 89% rename from docs/sources/auth/azuread.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/azuread.md index c4eb067b675..7af69ddee48 100644 --- a/docs/sources/auth/azuread.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread.md @@ -1,12 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/auth/azuread/"] -description = "Grafana Azure AD OAuth Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "Azure AD OAuth2 authentication" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/auth/azuread/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/azuread/ +description: Grafana Azure AD OAuth Guide +keywords: + - grafana + - configuration + - documentation + - oauth +title: Configure Azure AD OAuth2 authentication +weight: 600 +--- -# Azure AD OAuth2 authentication +# Configure Azure AD OAuth2 authentication The Azure AD authentication allows you to use an Azure Active Directory tenant as an identity provider for Grafana. You can use Azure AD Application Roles to assign users and groups to Grafana roles from the Azure Portal. This topic has the following sections: @@ -96,7 +102,7 @@ To enable the Azure AD OAuth2, register your application with Azure AD. ## Enable Azure AD OAuth in Grafana -1. Add the following to the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}): +1. Add the following to the [Grafana configuration file]({{< relref "../../configure-grafana/#config-file-locations" >}}): ``` [auth.azuread] @@ -120,7 +126,7 @@ GF_AUTH_AZUREAD_CLIENT_ID GF_AUTH_AZUREAD_CLIENT_SECRET ``` -**Note:** Verify that the Grafana [root_url]({{< relref "../administration/configuration/#root-url" >}}) is set in your Azure Application Redirect URLs. +**Note:** Verify that the Grafana [root_url]({{< relref "../../configure-grafana/#root-url" >}}) is set in your Azure Application Redirect URLs. ### Configure allowed groups @@ -154,4 +160,4 @@ the correct teams. You can reference Azure AD groups by group object ID, like `8bab1c86-8fba-33e5-2089-1d1c80ec267d`. -To learn more, refer to the [Team Sync]({{< relref "team-sync.md" >}}) documentation. +To learn more, refer to the [Team Sync]({{< relref "../configure-team-sync/" >}}) documentation. diff --git a/docs/sources/enterprise/enhanced_ldap.md b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced_ldap.md similarity index 69% rename from docs/sources/enterprise/enhanced_ldap.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/enhanced_ldap.md index ca2a0972226..f934123512c 100644 --- a/docs/sources/enterprise/enhanced_ldap.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced_ldap.md @@ -1,18 +1,26 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enhanced_ldap/"] -description = "Grafana Enhanced LDAP Integration Guide " -keywords = ["grafana", "configuration", "documentation", "ldap", "active directory", "enterprise"] -title = "Enhanced LDAP Integration" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enhanced_ldap/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/enhanced_ldap/ +description: Grafana Enhanced LDAP Integration Guide +keywords: + - grafana + - configuration + - documentation + - ldap + - active directory + - enterprise +title: Configure enhanced LDAP integration +weight: 900 +--- -# Enhanced LDAP integration +# Configure enhanced LDAP integration -The enhanced LDAP integration adds additional functionality on top of the [LDAP integration]({{< relref "../auth/ldap.md" >}}) available in the open source edition of Grafana. +The enhanced LDAP integration adds additional functionality on top of the [LDAP integration]({{< relref "ldap/" >}}) available in the open source edition of Grafana. -> Enhanced LDAP integration is only available in [Grafana Cloud Advanced](https://grafana.com/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../enterprise" >}}). +> **Note:** Available in [Grafana Enterprise]({{< relref "../../../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}). -> Refer to [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions. +> To control user access with role-based permissions, refer to [role-based access control]({{< relref "../../../enterprise/access-control/" >}}). ## LDAP group synchronization for teams @@ -25,7 +33,7 @@ Grafana keeps track of all synchronized users in teams, and you can see which us This mechanism allows Grafana to remove an existing synchronized user from a team when its LDAP group membership changes. This mechanism also allows you to manually add a user as member of a team, and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships. -[Learn more about team sync.]({{< relref "team-sync.md" >}}) +[Learn more about team sync.]({{< relref "../configure-team-sync/" >}})
@@ -33,7 +41,7 @@ a user as member of a team, and it will not be removed when the user signs in. T In the open source version of Grafana, user data from LDAP is synchronized only during the login process when authenticating using LDAP. -With active LDAP synchronization, available in Grafana Enterprise v6.3+, you can configure Grafana to actively sync users with LDAP servers in the background. Only users that have logged into Grafana at least once are synchronized. +With active LDAP synchronization, available in Grafana Enterprise version 6.3 and later, you can configure Grafana to actively sync users with LDAP servers in the background. Only users that have logged into Grafana at least once are synchronized. Users with updated role and team membership will need to refresh the page to get access to the new features. @@ -58,4 +66,4 @@ sync_cron = "0 1 * * *" # This is default value (At 1 am every day) active_sync_enabled = true # enabled by default ``` -Single bind configuration (as in the [Single bind example]({{< relref "../auth/ldap.md#single-bind-example" >}})) is not supported with active LDAP synchronization because Grafana needs user information to perform LDAP searches. +Single bind configuration (as in the [Single bind example]({{< relref "ldap/#single-bind-example" >}})) is not supported with active LDAP synchronization because Grafana needs user information to perform LDAP searches. diff --git a/docs/sources/auth/generic-oauth.md b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth.md similarity index 96% rename from docs/sources/auth/generic-oauth.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth.md index 3db5506508f..6e3c5acd406 100644 --- a/docs/sources/auth/generic-oauth.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth.md @@ -1,12 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/auth/generic-oauth/"] -description = "Grafana OAuthentication Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "OAuth authentication" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/auth/generic-oauth/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/generic-oauth/ +description: Grafana OAuthentication Guide +keywords: + - grafana + - configuration + - documentation + - oauth +title: Configure generic OAuth authentication +weight: 200 +--- -# Generic OAuth authentication +# Configure generic OAuth authentication You can configure many different OAuth2 authentication services with Grafana using the generic OAuth2 feature. Examples: @@ -294,7 +300,7 @@ With Team Sync you can map your Generic OAuth groups to teams in Grafana so that Generic OAuth groups can be referenced by group ID, like `8bab1c86-8fba-33e5-2089-1d1c80ec267d` or `myteam`. -[Learn more about Team Sync]({{< relref "team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) Config: diff --git a/docs/sources/auth/github.md b/docs/sources/setup-grafana/configure-security/configure-authentication/github.md similarity index 88% rename from docs/sources/auth/github.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/github.md index 348a74886df..889768001f9 100644 --- a/docs/sources/auth/github.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/github.md @@ -1,12 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/auth/github/"] -description = "Grafana OAuthentication Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "GitHub OAuth2 Authentication" -weight = 800 -+++ +--- +aliases: + - /docs/grafana/latest/auth/github/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/github/ +description: Grafana OAuthentication Guide +keywords: + - grafana + - configuration + - documentation + - oauth +title: Configure GitHub OAuth2 Authentication +weight: 1400 +--- -# GitHub OAuth2 Authentication +# Configure GitHub OAuth2 authentication To enable the GitHub OAuth2 you must register your application with GitHub. GitHub will generate a client ID and secret key for you to use. @@ -109,4 +115,4 @@ Your GitHub teams can be referenced in two ways: Example: `@grafana/developers` -[Learn more about Team Sync]({{< relref "team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) diff --git a/docs/sources/auth/gitlab.md b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab.md similarity index 89% rename from docs/sources/auth/gitlab.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/gitlab.md index a5bd8eb1643..37a7e608933 100644 --- a/docs/sources/auth/gitlab.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab.md @@ -1,12 +1,18 @@ -+++ -aliases = ["/docs/grafana/latest/auth/gitlab/"] -description = "Grafana OAuthentication Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "GitLab OAuth2 Authentication" -weight = 900 -+++ +--- +aliases: + - /docs/grafana/latest/auth/gitlab/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/gitlab/ +description: Grafana OAuthentication Guide +keywords: + - grafana + - configuration + - documentation + - oauth +title: Configure GitLab OAuth2 Authentication +weight: 700 +--- -# GitLab OAuth2 Authentication +# Configure GitLab OAuth2 authentication To enable GitLab OAuth2 you must register the application in GitLab. GitLab will generate a client ID and secret key for you to use. @@ -116,7 +122,7 @@ role_attribute_path = is_admin && 'Admin' || 'Viewer' You can use GitLab OAuth to map roles. During mapping, Grafana checks for the presence of a role using the [JMESPath](http://jmespath.org/examples.html) specified via the `role_attribute_path` configuration option. -For the path lookup, Grafana uses JSON obtained from querying GitLab's API [`/api/v4/user`](https://docs.gitlab.com/ee/api/users.html#list-current-user-for-normal-users) endpoint. The result of evaluating the `role_attribute_path` JMESPath expression must be a valid Grafana role, for example, `Viewer`, `Editor` or `Admin`. For more information about roles and permissions in Grafana, refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}). +For the path lookup, Grafana uses JSON obtained from querying GitLab's API [`/api/v4/user`](https://docs.gitlab.com/ee/api/users.html#list-current-user-for-normal-users) endpoint. The result of evaluating the `role_attribute_path` JMESPath expression must be a valid Grafana role, for example, `Viewer`, `Editor` or `Admin`. For more information about roles and permissions in Grafana, refer to [About users and permissions]({{< relref "../../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). An example Query could look like the following: @@ -135,4 +141,4 @@ the correct teams. Your GitLab groups can be referenced in the same way as `allowed_groups`, like `example` or `foo/bar`. -[Learn more about Team Sync]({{< relref "team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) diff --git a/docs/sources/auth/google.md b/docs/sources/setup-grafana/configure-security/configure-authentication/google.md similarity index 83% rename from docs/sources/auth/google.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/google.md index 55d52e44afb..9024ecbea02 100644 --- a/docs/sources/auth/google.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/google.md @@ -1,12 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/auth/google/"] -description = "Grafana OAuthentication Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "Google OAuth2 Authentication" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/auth/google/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/google/ +description: Grafana OAuthentication Guide +title: Configure Google OAuth2 Authentication +weight: 300 +--- -# Google OAuth2 Authentication +# Configure Google OAuth2 authentication To enable Google OAuth2 you must register your application with Google. Google will generate a client ID and secret key for you to use. @@ -27,7 +28,7 @@ First, you need to create a Google OAuth Client: ## Enable Google OAuth in Grafana -Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}). For example: +Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../../configure-grafana/#config-file-locations" >}}). For example: ```bash [auth.google] diff --git a/docs/sources/auth/grafana.md b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana.md similarity index 91% rename from docs/sources/auth/grafana.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/grafana.md index 80375f5e0e0..2b574c25569 100644 --- a/docs/sources/auth/grafana.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/grafana.md @@ -1,12 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/auth/grafana/"] -description = "Grafana OAuthentication Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "Grafana Authentication" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/auth/grafana/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/grafana/ +description: Grafana OAuthentication Guide +title: Configure Grafana authentication +weight: 1000 +--- -## Grafana Auth +## Configure Grafana authentication Grafana of course has a built in user authentication system with password authentication enabled by default. You can disable authentication by enabling anonymous access. You can also hide login form and only allow login through an auth @@ -53,7 +54,7 @@ api_key_max_seconds_to_live = -1 ### Anonymous authentication -You can make Grafana accessible without any login required by enabling anonymous access in the configuration file. For more information, refer to [Implications of allowing anonymous access to dashboards]({{< relref "../administration/security.md" >}}). +You can make Grafana accessible without any login required by enabling anonymous access in the configuration file. For more information, refer to [Implications of allowing anonymous access to dashboards]({{< relref "../#implications-of-enabling-anonymous-access-to-dashboards" >}}). Example: diff --git a/docs/sources/auth/jwt.md b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt.md similarity index 88% rename from docs/sources/auth/jwt.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/jwt.md index d5507d8eef6..2a5499451e2 100644 --- a/docs/sources/auth/jwt.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt.md @@ -1,12 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/auth/jwt/"] -description = "Grafana JWT Authentication" -keywords = ["grafana", "configuration", "documentation", "jwt", "jwk"] -title = "JWT Authentication" -weight = 250 -+++ +--- +aliases: + - /docs/grafana/latest/auth/jwt/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/jwt/ +description: Grafana JWT Authentication +title: Configure JWT Authentication +weight: 500 +--- -# JWT authentication +# Configure JWT authentication You can configure Grafana to accept a JWT token provided in the HTTP header. The token is verified using any of the following: @@ -18,7 +19,7 @@ You can configure Grafana to accept a JWT token provided in the HTTP header. The To use JWT authentication: -1. Enable JWT in the [main config file]({{< relref "../administration/configuration.md" >}}). +1. Enable JWT in the [main config file]({{< relref "../../configure-grafana/" >}}). 1. Specify the header name that contains a token. ```ini diff --git a/docs/sources/auth/ldap.md b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap.md similarity index 93% rename from docs/sources/auth/ldap.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/ldap.md index 4e43e78eaf3..e3e4dfe27d3 100644 --- a/docs/sources/auth/ldap.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap.md @@ -1,19 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/auth/ldap/", "/docs/grafana/latest/installation/ldap/"] -description = "Grafana LDAP Authentication Guide " -keywords = ["grafana", "configuration", "documentation", "ldap", "active directory"] -title = "LDAP Authentication" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/auth/ldap/ + - /docs/grafana/latest/installation/ldap/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/ldap/ +description: Grafana LDAP Authentication Guide +title: Configure LDAP Authentication +weight: 800 +--- -# LDAP Authentication +# Configure LDAP authentication The LDAP integration in Grafana allows your Grafana users to login with their LDAP credentials. You can also specify mappings between LDAP group memberships and Grafana Organization user roles. -> [Enhanced LDAP authentication]({{< relref "../enterprise/enhanced_ldap.md" >}}) is available in [Grafana Cloud Advanced](https://grafana.com/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../enterprise" >}}). +> [Enhanced LDAP authentication]({{< relref "enhanced_ldap/" >}}) is available in [Grafana Cloud Advanced](https://grafana.com/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../../../enterprise/" >}}). -> Refer to [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions. +> Refer to [Role-based access control]({{< relref "../../../enterprise/access-control/" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions. ## Supported LDAP Servers @@ -23,7 +25,7 @@ This means that you should be able to configure LDAP integration using any compl ## Enable LDAP -In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../administration/configuration.md" >}}) as well as specify the path to the LDAP +In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../../configure-grafana/" >}}) as well as specify the path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`). ```bash @@ -340,7 +342,7 @@ Please inspect your Active Directory configuration and documentation to find the ## Troubleshooting -To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../administration/configuration.md" >}}). +To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../../configure-grafana/" >}}). ```bash [log] diff --git a/docs/sources/auth/okta.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta.md similarity index 80% rename from docs/sources/auth/okta.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/okta.md index ea949a3d88e..ca6846f8a9c 100644 --- a/docs/sources/auth/okta.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta.md @@ -1,12 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/auth/okta/"] -description = "Grafana Okta OAuth Guide " -keywords = ["grafana", "configuration", "documentation", "oauth"] -title = "Okta OAuth2 authentication" -weight = 1000 -+++ +--- +aliases: + - /docs/grafana/latest/auth/okta/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/okta/ +description: Grafana Okta OAuth Guide +title: Configure Okta OAuth2 authentication +weight: 1200 +--- -# Okta OAuth2 authentication +# Configure Okta OAuth2 authentication > Only available in Grafana v7.0+ @@ -34,7 +35,7 @@ Before you can sign a user in, you need to create an Okta application from the O ## Enable Okta OAuth in Grafana -1. Add the following to the [Grafana configuration file]({{< relref "../administration/configuration.md#config-file-locations" >}}): +1. Add the following to the [Grafana configuration file]({{< relref "../../configure-grafana/#config-file-locations" >}}): ```ini [auth.okta] @@ -72,9 +73,9 @@ allowed_domains = mycompany.com mycompany.org Grafana can attempt to do role mapping through Okta OAuth. In order to achieve this, Grafana checks for the presence of a role using the [JMESPath](http://jmespath.org/examples.html) specified via the `role_attribute_path` configuration option. -Grafana uses JSON obtained from querying the `/userinfo` endpoint for the path lookup. The result after evaluating the `role_attribute_path` JMESPath expression needs to be a valid Grafana role, i.e. `Viewer`, `Editor` or `Admin`. Refer to [About users and permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}) for more information about roles and permissions in Grafana. +Grafana uses JSON obtained from querying the `/userinfo` endpoint for the path lookup. The result after evaluating the `role_attribute_path` JMESPath expression needs to be a valid Grafana role, i.e. `Viewer`, `Editor` or `Admin`. Refer to [About users and permissions]({{< relref "../../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}) for more information about roles and permissions in Grafana. -Read about how to [add custom claims](https://developer.okta.com/docs/guides/customize-tokens-returned-from-okta/add-custom-claim/) to the user info in Okta. Also, check Generic OAuth page for [JMESPath examples]({{< relref "generic-oauth.md/#jmespath-examples" >}}). +Read about how to [add custom claims](https://developer.okta.com/docs/guides/customize-tokens-returned-from-okta/add-custom-claim/) to the user info in Okta. Also, check Generic OAuth page for [JMESPath examples]({{< relref "generic-oauth/#jmespath-examples" >}}). ### Team Sync (Enterprise only) @@ -83,4 +84,4 @@ the correct teams. Okta groups can be referenced by group name, like `Admins`. -[Learn more about Team Sync]({{< relref "../enterprise/team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) diff --git a/docs/sources/enterprise/saml/configure-saml.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml.md similarity index 55% rename from docs/sources/enterprise/saml/configure-saml.md rename to docs/sources/setup-grafana/configure-security/configure-authentication/saml.md index 848585e9663..3c9a1a6384b 100644 --- a/docs/sources/enterprise/saml/configure-saml.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml.md @@ -1,23 +1,169 @@ --- aliases: - /docs/grafana/latest/auth/saml/ + - /docs/grafana/latest/enterprise/configure-saml/ + - /docs/grafana/latest/enterprise/saml/ + - /docs/grafana/latest/enterprise/saml/about-saml/ - /docs/grafana/latest/enterprise/saml/configure-saml/ -description: This contains information on how to configure SAML authentication in - Grafana -keywords: - - grafana - - saml - - documentation - - saml-configuration - - enterprise -menuTitle: Configure SAML + - /docs/grafana/latest/enterprise/saml/enable-saml/ + - /docs/grafana/latest/enterprise/saml/set-up-saml-with-okta/ + - /docs/grafana/latest/enterprise/saml/troubleshoot-saml/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-authentication/saml/ +description: Learn how to configure SAML authentication in Grafana. +menuTitle: Configure SAML authentication title: Configure SAML authentication in Grafana -weight: 40 +weight: 1100 --- # Configure SAML authentication in Grafana -The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../administration/configuration.md#configure-with-environment-variables" >}}). +SAML authentication integration allows your Grafana users to log in by using an external SAML 2.0 Identity Provider (IdP). To enable this, Grafana becomes a Service Provider (SP) in the authentication flow, interacting with the IdP to exchange user information. + +The SAML single sign-on (SSO) standard is varied and flexible. Our implementation contains a subset of features needed to provide a smooth authentication experience into Grafana. + +> **Note:** Available in [Grafana Enterprise]({{< relref "../../../enterprise/" >}}) and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). + +## Supported SAML + +Grafana supports the following SAML 2.0 bindings: + +- 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): + - `HTTP-POST` binding + +In terms of security: + +- Grafana supports signed and encrypted assertions. +- Grafana does not support signed or encrypted requests. + +In terms of initiation, Grafana supports: + +- SP-initiated requests +- IdP-initiated requests + +By default, SP-initiated requests are enabled. For instructions on how to enable IdP-initiated logins, see [IdP-initiated Single Sign-On (SSO)]({{< relref "#idp-initiated-single-sign-on-sso" >}}). + +### Edit SAML options in the Grafana config file + +1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`]({{< relref "../../configure-grafana/enterprise-configuration/#enabled" >}}) to `true`. +1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}). +1. On the Okta application page where you have been redirected after application created, navigate to the **Sign On** tab and find **Identity Provider metadata** link in the **Settings** section. +1. Set the [`idp_metadata_url`]({{< relref "../../configure-grafana/enterprise-configuration/#idp_metadata_url" >}}) to the URL obtained from the previous step. The URL should look like `https://.okta.com/app//sso/saml/metadata`. +1. Set the following options to the attribute names configured at the **step 10** of the SAML integration setup. You can find this attributes on the **General** tab of the application page (**ATTRIBUTE STATEMENTS** and **GROUP ATTRIBUTE STATEMENTS** in the **SAML Settings** section). + - [`assertion_attribute_login`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-login" >}}) + - [`assertion_attribute_email`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-email" >}}) + - [`assertion_attribute_name`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-name" >}}) + - [`assertion_attribute_groups`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-groups" >}}) +1. Save the configuration file and and then restart the Grafana server. + +When you are finished, the Grafana configuration might look like this example: + +```bash +[server] +root_url = https://grafana.example.com + +[auth.saml] +enabled = true +private_key_path = "/path/to/private_key.pem" +certificate_path = "/path/to/certificate.cert" +idp_metadata_url = "https://my-org.okta.com/app/my-application/sso/saml/metadata" +assertion_attribute_name = DisplayName +assertion_attribute_login = Login +assertion_attribute_email = Email +assertion_attribute_groups = Group +``` + +## Enable SAML authentication in Grafana + +To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. + +Refer to [Configuration]({{< relref "../../configure-grafana/" >}}) for more information about configuring Grafana. + +## Certificate and private key + +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. The private key needs to be issued in a [PKCS#8](https://en.wikipedia.org/wiki/PKCS_8) format. + +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. + +> **Note:** You can only use one form of each configuration option. Using multiple forms, such as both `certificate` and `certificate_path`, results in an error. + +--- + +### **Example** of how to generate SAML credentials: + +An example of how to generate a self-signed certificate and private key that's valid for one year: + +```sh +$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes​ +``` + +Base64-encode the cert.pem and key.pem files: +(-w0 switch is not needed on Mac, only for Linux) + +```sh +$ base64 -w0 key.pem > key.pem.base64 +$ base64 -w0 cert.pem > cert.pem.base64 +``` + +The base64-encoded values (`key.pem.base64, cert.pem.base64` files) are then used for certificate and private_key. + +The keys you provide should look like: + +``` +-----BEGIN PRIVATE KEY----- +... +... +-----END PRIVATE KEY----- +``` + +## Set up SAML with Okta + +Grafana supports user authentication through Okta, which is useful when you want your users to access Grafana using single sign on. This guide will follow you through the steps of configuring SAML authentication in Grafana with [Okta](https://okta.com/). You need to be an admin in your Okta organization to access Admin Console and create SAML integration. You also need permissions to edit Grafana config file and restart Grafana server. + +**Before you begin:** + +- To configure SAML integration with Okta, create integration inside the Okta organization first. [Add integration in Okta](https://help.okta.com/en/prod/Content/Topics/Apps/apps-overview-add-apps.htm) +- Ensure you have permission to administer SAML authentication. For more information about permissions, refer to [About users and permissions]({{< relref "../../../administration/manage-users-and-permissions/about-users-and-permissions/#" >}}). + +**To set up SAML with Okta:** + +1. Log in to the [Okta portal](https://login.okta.com/). +1. Go to the Admin Console in your Okta organization by clicking **Admin** in the upper-right corner. If you are in the Developer Console, then click **Developer Console** in the upper-left corner and then click **Classic UI** to switch over to the Admin Console. +1. In the Admin Console, navigate to **Applications** > **Applications**. +1. Click **Add Application**. +1. Click **Create New App** to start the Application Integration Wizard. +1. Choose **Web** as a platform. +1. Select **SAML 2.0** in the Sign on method section. +1. Click **Create**. +1. On the **General Settings** tab, enter a name for your Grafana integration. You can also upload a logo. +1. On the **Configure SAML** tab, enter the SAML information related to your Grafana instance: + + - In the **Single sign on URL** field, use the `/saml/acs` endpoint URL of your Grafana instance, for example, `https://grafana.example.com/saml/acs`. + - In the **Audience URI (SP Entity ID)** field, use the `/saml/metadata` endpoint URL, for example, `https://grafana.example.com/saml/metadata`. + - Leave the default values for **Name ID format** and **Application username**. + - In the **ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter the SAML attributes to be shared with Grafana, for example: + + | Attribute name (in Grafana) | Value (in Okta profile) | + | --------------------------- | -------------------------------------- | + | Login | `user.login` | + | Email | `user.email` | + | DisplayName | `user.firstName + " " + user.lastName` | + + - In the **GROUP ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter a group attribute name (for example, `Group`) and set filter to `Matches regex .*` to return all user groups. + +1. Click **Next**. +1. On the final Feedback tab, fill out the form and then click **Finish**. + +## Configure SAML authentication in Grafana + +The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../configure-grafana/#override-configuration-with-environment-variables" >}}). | Setting | Required | Description | Default | | ---------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | @@ -46,7 +192,7 @@ The table below describes all SAML configuration options. Continue reading below ### Signature algorithm -> Only available in Grafana v7.3+ +> **Note:** Available in Grafana version 7.3 and later. The SAML standard recommends using a digital signature for some types of messages, like authentication or logout requests. If the `signature_algorithm` option is configured, Grafana will put a digital signature into SAML requests. Supported signature types are `rsa-sha1`, `rsa-sha256`, `rsa-sha512`. This option should match your IdP configuration, otherwise, signature validation will fail. Grafana uses key and certificate configured with `private_key` and `certificate` options for signing SAML requests. @@ -83,7 +229,7 @@ The integration provides two key endpoints as part of Grafana: ### IdP-initiated Single Sign-On (SSO) -> Only available in Grafana v7.3+ +> **Note:** Available in Grafana version 7.3 and later. By default, Grafana allows only service provider (SP) initiated logins (when the user logs in with SAML via Grafana’s login page). If you want users to log in into Grafana directly from your identity provider (IdP), set the `allow_idp_initiated` configuration option to `true` and configure `relay_state` with the same value specified in the IdP configuration. @@ -91,7 +237,7 @@ IdP-initiated SSO has some security risks, so make sure you understand the risks ### Single logout -> Only available in Grafana v7.3+ +> **Note:** Available in Grafana version 7.3 and later. SAML's single logout feature allows users to log out from all applications associated with the current IdP session established via SAML SSO. If the `single_logout` option is set to `true` and a user logs out, Grafana requests IdP to end the user session which in turn triggers logout from all other applications the user is logged into using the same IdP session (applications should support single logout). Conversely, if another application connected to the same IdP logs out using single logout, Grafana receives a logout request from IdP and ends the user session. @@ -103,7 +249,7 @@ For Grafana to map the user information, it looks at the individual attributes w Grafana provides configuration options that let you modify which keys to look at for these values. The data we need to create the user in Grafana is Name, Login handle, and email. -##### The `assertion_attribute_name` option +#### The `assertion_attribute_name` option `assertion_attribute_name` is a special assertion mapping that can either be a simple key, indicating a mapping to a single assertion attribute on the SAML response, or a complex template with variables using the `$__saml{}` syntax. If this property is misconfigured, Grafana will log an error message on startup and disallow SAML sign-ins. Grafana will also log errors after a login attempt if a variable in the template is missing from the SAML response. @@ -125,26 +271,26 @@ By default, new Grafana users using SAML authentication will have an account cre ### Configure team sync -> Team sync support for SAML only available in Grafana v7.0+ +> **Note:** Team sync support for SAML is available in Grafana version 7.0 and later. -To use SAML Team sync, set [`assertion_attribute_groups`]({{< relref ".././enterprise-configuration.md#assertion-attribute-groups" >}}) to the attribute name where you store user groups. Then Grafana will use attribute values extracted from SAML assertion to add user into the groups with the same name configured on the External group sync tab. +To use SAML Team sync, set [`assertion_attribute_groups`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-groups" >}}) to the attribute name where you store user groups. Then Grafana will use attribute values extracted from SAML assertion to add user into the groups with the same name configured on the External group sync tab. -[Learn more about Team Sync]({{< relref "../../enterprise/team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "../configure-team-sync/" >}}) ### Configure role sync -> Only available in Grafana v7.0+ +> **Note:** Available in Grafana version 7.0 and later. -Role sync allows you to map user roles from an identity provider to Grafana. To enable role sync, configure role attribute and possible values for the Editor, Admin, and Grafana Admin roles. For more information about user roles, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}). +Role sync allows you to map user roles from an identity provider to Grafana. To enable role sync, configure role attribute and possible values for the Editor, Admin, and Grafana Admin roles. For more information about user roles, refer to [About users and permissions]({{< relref "../../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). -1. In the configuration file, set [`assertion_attribute_role`]({{< relref ".././enterprise-configuration.md#assertion-attribute-role" >}}) option to the attribute name where the role information will be extracted from. -1. Set the [`role_values_editor`]({{< relref ".././enterprise-configuration.md#role-values-editor" >}}) option to the values mapped to the `Editor` role. -1. Set the [`role_values_admin`]({{< relref ".././enterprise-configuration.md#role-values-admin" >}}) option to the values mapped to the organization `Admin` role. -1. Set the [`role_values_grafana_admin`]({{< relref ".././enterprise-configuration.md#role-values-grafana-admin" >}}) option to the values mapped to the `Grafana Admin` role. +1. In the configuration file, set [`assertion_attribute_role`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-role" >}}) option to the attribute name where the role information will be extracted from. +1. Set the [`role_values_editor`]({{< relref "../../configure-grafana/enterprise-configuration/#role-values-editor" >}}) option to the values mapped to the `Editor` role. +1. Set the [`role_values_admin`]({{< relref "../../configure-grafana/enterprise-configuration/#role-values-admin" >}}) option to the values mapped to the organization `Admin` role. +1. Set the [`role_values_grafana_admin`]({{< relref "../../configure-grafana/enterprise-configuration/#role-values-grafana-admin" >}}) option to the values mapped to the `Grafana Admin` role. If a user role doesn't match any of configured values, then the `Viewer` role will be assigned. -Refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}) for more information about roles and permissions in Grafana. +Refer to [About users and permissions]({{< relref "../../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}) for more information about roles and permissions in Grafana. Example configuration: @@ -160,12 +306,12 @@ role_values_grafana_admin = superadmin ### Configure organization mapping -> Only available in Grafana v7.0+ +> **Note:** Available in Grafana version 7.0 and later. Organization mapping allows you to assign users to particular organization in Grafana depending on attribute value obtained from identity provider. -1. In configuration file, set [`assertion_attribute_org`]({{< relref ".././enterprise-configuration.md#assertion-attribute-org" >}}) to the attribute name you store organization info in. This attribute can be an array if you want a user to be in multiple organizations. -1. Set [`org_mapping`]({{< relref ".././enterprise-configuration.md#org-mapping" >}}) option to the comma-separated list of `Organization:OrgId` pairs to map organization from IdP to Grafana organization specified by id. If you want users to have different roles in multiple organizations, you can set this option to a comma-separated list of `Organization:OrgId:Role` mappings. +1. In configuration file, set [`assertion_attribute_org`]({{< relref "../../configure-grafana/enterprise-configuration/#assertion-attribute-org" >}}) to the attribute name you store organization info in. This attribute can be an array if you want a user to be in multiple organizations. +1. Set [`org_mapping`]({{< relref "../../configure-grafana/enterprise-configuration/#org-mapping" >}}) option to the comma-separated list of `Organization:OrgId` pairs to map organization from IdP to Grafana organization specified by id. If you want users to have different roles in multiple organizations, you can set this option to a comma-separated list of `Organization:OrgId:Role` mappings. For example, use following configuration to assign users from `Engineering` organization to the Grafana organization with id `2` as Editor and users from `Sales` - to the org with id `3` as Admin, based on `Org` assertion attribute value: @@ -186,11 +332,11 @@ You can use `*` as an Organization if you want all your users to be in some orga ### Configure allowed organizations -> Only available in Grafana v7.0+ +> **Note:** Available in Grafana version 7.0 and later. -With the [`allowed_organizations`]({{< relref ".././enterprise-configuration.md#allowed-organizations" >}}) option you can specify a list of organizations where the user must be a member of at least one of them to be able to log in to Grafana. +With the [`allowed_organizations`]({{< relref "../../configure-grafana/enterprise-configuration/#allowed-organizations" >}}) option you can specify a list of organizations where the user must be a member of at least one of them to be able to log in to Grafana. -## Example SAML configuration +### Example SAML configuration ```bash [auth.saml] @@ -213,3 +359,51 @@ role_values_grafana_admin = superadmin org_mapping = Engineering:2:Editor, Engineering:3:Viewer, Sales:3:Editor, *:1:Editor allowed_organizations = Engineering, Sales ``` + +## Troubleshoot SAML authentication in Grafana + +To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration]({{< relref "../../configure-grafana/#filters" >}}) for more information. + +```bash +[log] +filters = saml.auth:debug +``` + +## Known issues + +### SAML authentication fails with error: + +- `asn1: structure error: tags don't match` + +We only support one private key format: PKCS#8. + +The keys may be in a different format (PKCS#1 or PKCS#12); in that case, it may be necessary to convert the private key format. + +The following command creates a pkcs8 key file. + +```bash +$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes​ +``` + +#### **Convert** the private key format to base64 + +The following command converts keys to base64 format. + +Base64-encode the cert.pem and key.pem files: +(-w0 switch is not needed on Mac, only for Linux) + +```sh +$ base64 -w0 key.pem > key.pem.base64 +$ base64 -w0 cert.pem > cert.pem.base64 +``` + +The base64-encoded values (`key.pem.base64, cert.pem.base64` files) are then used for certificate and private_key. + +The keys you provide should look like: + +``` +-----BEGIN PRIVATE KEY----- +... +... +-----END PRIVATE KEY----- +``` diff --git a/docs/sources/administration/database-encryption.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md similarity index 65% rename from docs/sources/administration/database-encryption.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md index f88104a9880..115222e9ca2 100644 --- a/docs/sources/administration/database-encryption.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md @@ -1,33 +1,36 @@ -+++ -aliases = ["/docs/grafana/latest/administration/database-encryption/"] -description = "Grafana database encryption" -keywords = ["grafana", "database", "encryption", "envelope encryption", "documentation"] -title = "Database encryption" -weight = 450 -+++ +--- +aliases: + - /docs/grafana/latest/administration/database-encryption/ + - /docs/grafana/latest/enterprise/enterprise-encryption/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/ +description: If you have a Grafana Enterprise license, you can integrate with a variety + of key management system providers. +title: Configure database encryption +weight: 700 +--- -# Grafana database encryption +# Configure database encryption Grafana’s database contains secrets, which are used to query data sources, send alert notifications and perform other functions within Grafana. -Grafana encrypts these secrets before they are written to the database, by using a symmetric-key encryption algorithm called Advanced Encryption Standard (AES), and using a [secret key]({{< relref "../administration/configuration/#secret_key" >}}) that you can change when you configure a new Grafana instance. +Grafana encrypts these secrets before they are written to the database, by using a symmetric-key encryption algorithm called Advanced Encryption Standard (AES), and using a [secret key]({{< relref "../../configure-grafana/#secret_key" >}}) that you can change when you configure a new Grafana instance. Since Grafana v9.0, it uses [envelope encryption](#envelope-encryption) by default, which adds a layer of indirection to the encryption process that represents an [**implicit breaking change**](#implicit-breaking-change) for older versions of Grafana. -For further details about how to operate a Grafana instance with envelope encryption, see the [Operational work](#operational work) section below. +For further details about how to operate a Grafana instance with envelope encryption, see the [Operational work]({{< relref "./#operational-work" >}}) section below. -> **Note:** In Grafana Enterprise, you can also choose to [encrypt secrets in AES-GCM mode]({{< relref "../enterprise/enterprise-encryption/#changing-your-encryption-mode-to-aes-gcm" >}}) instead of AES-CFB. +> **Note:** In Grafana Enterprise, you can also choose to [encrypt secrets in AES-GCM mode]({{< relref "#changing-your-encryption-mode-to-aes-gcm" >}}) instead of AES-CFB. # Envelope encryption > **Note:** Since Grafana v9.0, you can turn it off by adding the term `disableEnvelopeEncryption` to the list of -> feature toggles in your [Grafana configuration]({{< relref "../administration/configuration/#feature_toggles" >}}). +> feature toggles in your [Grafana configuration]({{< relref "../../configure-grafana/#feature_toggles" >}}). Instead of encrypting all secrets with a single key, Grafana uses a set of keys called data encryption keys (DEKs) to encrypt them. These data encryption keys are themselves encrypted with a single key encryption key (KEK), configured through the `secret_key` attribute in your -[Grafana configuration]({{< relref "../administration/configuration/#secret_key" >}}) or with a +[Grafana configuration]({{< relref "../../configure-grafana/#secret_key" >}}) or with a [KMS integration](#kms-integration). ## Implicit breaking change @@ -43,7 +46,7 @@ Grafana administrators will be able to downgrade up to Grafana v8.3 and enable e > **Note:** In Grafana releases between v8.3 and v8.5, you can turn envelope encryption on by adding the term > `envelopeEncryption` to the list of feature toggles in your -> [Grafana configuration]({{< relref "../administration/configuration/#feature_toggles" >}}). +> [Grafana configuration]({{< relref "../../configure-grafana/#feature_toggles" >}}). # Operational work @@ -95,11 +98,29 @@ New data keys for encryption operations are generated on-demand. > those secrets still encrypted with it. Look at [secrets re-encryption](#re-encrypt-secrets) to completely stop using > rotated data keys for both encryption and decryption. -> **Note:** This operation is available through Grafana [Admin API]({{< relref "../developers/configuration/admin/#rotate-data-encryption-keys" >}}). +> **Note:** This operation is available through Grafana [Admin API]({{< relref "../../../developers/http_api/admin/#rotate-data-encryption-keys" >}}). > It's safe to run more than once. -# KMS integration +## Encrypting your database with a key from a Key Management System (KMS) -With KMS integrations, you can choose to encrypt secrets stored in the Grafana database using a key from a KMS, which is a secure central storage location that is designed to help you to create and manage cryptographic keys and control their use across many services. +If you are using Grafana Enterprise, you can integrate with a key management system (KMS) provider, and change Grafana’s cryptographic mode of operation from AES-CFB to AES-GCM. -> **Note:** KMS integration is available in Grafana Enterprise. For more information, refer to [Enterprise Encryption]({{< relref "../enterprise/enterprise-encryption/_index.md" >}}) in Grafana Enterprise. +You can choose to encrypt secrets stored in the Grafana database using a key from a KMS, which is a secure central storage location that is designed to help you to create and manage cryptographic keys and control their use across many services. When you integrate with a KMS, Grafana does not directly store your encryption key. Instead, Grafana stores KMS credentials and the identifier of the key, which Grafana uses to encrypt the database. + +Grafana integrates with the following key management systems: + +- [AWS KMS]({{< relref "encrypt-secrets-using-aws-kms/" >}}) +- [Azure Key Vault]({{< relref "encrypt-secrets-using-azure-key-vault/" >}}) +- [Google Cloud KMS]({{< relref "encrypt-secrets-using-google-cloud-kms/" >}}) +- [Hashicorp Key Vault]({{< relref "encrypt-secrets-using-hashicorp-key-vault/" >}}) + +## Changing your encryption mode to AES-GCM + +Grafana encrypts secrets using Advanced Encryption Standard in Cipher +FeedBack mode (AES-CFB). You might prefer to use AES in Galois/Counter +Mode (AES-GCM) instead, to meet your company’s security requirements or +in order to maintain consistency with other services. + +To change your encryption mode, update the `algorithm` value in the +`[security.encryption]` section of your Grafana configuration file. +For details, refer to [Enterprise configuration]({{< relref "../../configure-grafana/enterprise-configuration/#securityencryption" >}}). diff --git a/docs/sources/enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms.md similarity index 91% rename from docs/sources/enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms.md index e28e4cf8d45..edc0eb82134 100644 --- a/docs/sources/enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms.md @@ -1,19 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets/"] -description = "Using AWS KMS to encrypt database secrets" -keywords = ["grafana", "AWS KMS integration"] -title = "AMS KMS" -weight = 3 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enterprise-encryption/using-aws-kms-to-encrypt-database-secrets/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/ +description: Learn how to use AWS KMS to encrypt secrets in the Grafana database. +title: Encrypt database secrets using AWS KMS +weight: 300 +--- -# Using AWS KMS to encrypt database secrets +# Encrypt database secrets using AWS KMS You can use an encryption key from AWS Key Management Service to encrypt secrets in the Grafana database. **Prerequisites:** - An AWS account with permission to view and create KMS keys and programmatic credentials to access those keys -- Access to the Grafana [configuration]({{< relref "../../administration/configuration/#config-file-locations" >}}) file +- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file 1. Create a symmetric API key either from the AWS Management Console or by using the AWS KMS API.

For detailed instructions, refer to [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). @@ -24,7 +25,7 @@ You can use an encryption key from AWS Key Management Service to encrypt secrets 3. Create a [programmatic credential](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) (access key ID and secret access key), which has permission to view the key that you created.

In AWS, you can control access to your KMS keys by using [key policies](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html), [IAM policies](https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html), and [grants](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html). You can also create [temporary credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html), which must provide a session token along with an access key ID and a secret access key. -4. From within Grafana, turn on [envelope encryption]({{< relref "../../administration//database-encryption.md" >}}). +4. From within Grafana, turn on [envelope encryption]({{< relref "./#envelope-encryption" >}}). 5. Add your AWS KMS details to the Grafana configuration file; depending on your operating system, it is usually named `grafana.ini`:

a. Add a new section to the configuration file, with a name in the format of `[security.encryption.awskms.]`, where `` is any name that uniquely identifies this key among other provider keys.

b. Fill in the section with the following values: diff --git a/docs/sources/enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault.md similarity index 88% rename from docs/sources/enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault.md index 7d5bfe7f63f..f72cfe71a4e 100644 --- a/docs/sources/enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault.md @@ -1,19 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets/"] -description = "Using Azure Key Vault to encrypt database secrets" -keywords = ["grafana", "Azure key vault"] -title = "Azure Key Vault" -weight = 2 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enterprise-encryption/using-azure-key-vault-to-encrypt-database-secrets/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/ +description: Learn how to use Azure Key Vault to encrypt secrets in the Grafana database. +title: Encrypt database secrets using Azure Key Vault +weight: 400 +--- -# Using Azure Key Vault to encrypt database secrets +# Encrypt database secrets using Azure Key Vault You can use an encryption key from Azure Key Vault to encrypt secrets in the Grafana database. **Prerequisites:** - An Azure account with permission to view and create Key Vault keys and programmatic credentials to access those keys -- Access to the Grafana [configuration]({{< relref "../../administration/configuration/#config-file-locations" >}}) file +- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file 1. [Create a vault](https://docs.microsoft.com/en-us/azure/key-vault/general/quick-create-portal#create-a-vault). @@ -25,7 +26,7 @@ You can use an encryption key from Azure Key Vault to encrypt secrets in the Gra 5. In the Key Permissions section, set encrypt and decrypt permissions, and click **Save**. -6. From within Grafana, turn on [envelope encryption]({{< relref "../../administration/database-encryption.md" >}}). +6. From within Grafana, turn on [envelope encryption]({{< relref "./" >}}). 7. Add your Azure Key Vault details to the Grafana configuration file; depending on your operating system, is usually named `grafana.ini`:

a. Add a new section to the configuration file, with a name in the format of `[security.encryption.azurekv.]`, where `` is any name that uniquely identifies this key among other provider keys. diff --git a/docs/sources/enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms.md similarity index 86% rename from docs/sources/enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms.md index adc9bdc024e..f9ff324e3ad 100644 --- a/docs/sources/enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms.md @@ -1,19 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets/"] -description = "Using Google Cloud KMS to encrypt database secrets" -keywords = ["grafana", "Google Cloud KMS integration"] -title = "Google Cloud KMS" -weight = 3 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enterprise-encryption/using-google-cloud-kms-to-encrypt-database-secrets/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/ +description: Learn how to use Google Cloud KMS to encrypt secrets in the Grafana database. +title: Encrypt database secrets using Google Cloud KMS +weight: 100 +--- -# Using Google Cloud KMS to encrypt database secrets +# Encrypt database secrets using Google Cloud KMS You can use an encryption key from Google Cloud Key Management Service to encrypt secrets in the Grafana database. **Prerequisites:** - A Google Cloud account with permission to list and create KMS keys and service accounts to access those keys -- Access to the Grafana [configuration]({{< relref "../../administration/configuration/#config-file-locations" >}}) file +- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file 1. [Create a key ring](https://cloud.google.com/kms/docs/creating-keys#kms-create-key-ring-console) in Google Cloud KMS. @@ -23,7 +24,7 @@ You can use an encryption key from Google Cloud Key Management Service to encryp 4. [Create a service account key and save its JSON file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating) to you computer, for example, as `~/.config/gcloud/sample-project-credentials.json`. -5. From within Grafana, turn on [envelope encryption]({{< relref "../../administration/database-encryption.md" >}}). +5. From within Grafana, turn on [envelope encryption]({{< relref "./#envelope-encryption" >}}). 6. Add your Google Cloud KMS details to the Grafana configuration file; depending on your operating system, is usually named `grafana.ini`:

a. Add a new section to the configuration file, with a name in the format of `[security.encryption.azurekv.]`, where `` is any name that uniquely identifies this key among other provider keys. diff --git a/docs/sources/enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault.md similarity index 86% rename from docs/sources/enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault.md index 711d2ded059..2fdcde5e50d 100644 --- a/docs/sources/enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault.md @@ -1,19 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets/"] -description = "Using Hashicorp Vault to encrypt database secrets" -keywords = ["grafana", "Hashicorp Vault integration"] -title = "Hashicorp Vault" -weight = 3 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/enterprise-encryption/using-hashicorp-key-vault-to-encrypt-database-secrets/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/ +description: Learn how to use Hashicorp Vault to encrypt secrets in the Grafana database. +title: Encrypt database secrets using Hashicorp Vault +weight: 200 +--- -# Using Hashicorp Vault to encrypt database secrets +# Encrypt database secrets using Hashicorp Vault You can use an encryption key from Hashicorp Vault to encrypt secrets in the Grafana database. **Prerequisites:** - Permissions to manage Hashicorp Vault to enable secrets engines and issue tokens. -- Access to the Grafana [configuration]({{< relref "../../administration/configuration/#config-file-locations" >}}) file +- Access to the Grafana [configuration]({{< relref "../../configure-grafana/#config-file-locations" >}}) file 1. [Enable the transit secrets engine](https://www.vaultproject.io/docs/secrets/transit#setup) in Hashicorp Vault. @@ -21,7 +22,7 @@ You can use an encryption key from Hashicorp Vault to encrypt secrets in the Gra 3. [Create a periodic service token](https://learn.hashicorp.com/tutorials/vault/tokens#periodic-service-tokens). -4. From within Grafana, turn on [envelope encryption]({{< relref "../../administration/database-encryption.md" >}}). +4. From within Grafana, turn on [envelope encryption]({{< relref "./#envelop-encryption" >}}). 5. Add your Hashicorp Vault details to the Grafana configuration file; depending on your operating system, is usually named `grafana.ini`:

a. Add a new section to the configuration file, with a name in the format of `[security.encryption.hashicorpvault.]`, where `` is any name that uniquely identifies this key among other provider keys. diff --git a/docs/sources/enterprise/vault.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault.md similarity index 77% rename from docs/sources/enterprise/vault.md rename to docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault.md index 49e86a76e44..d0e2ae92be7 100644 --- a/docs/sources/enterprise/vault.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault.md @@ -1,19 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/vault/"] -description = "" -keywords = ["grafana", "vault", "configuration"] -title = "Vault" -weight = 1200 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/vault/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/ +description: Learn how to integrate Grafana with Hashicorp Vault so that you can use + secrets for configuration and provisioning. +title: Integrate Grafana with Hashicorp Vault +weight: 500 +--- -# Vault integration +# Integrate Grafana with Hashicorp Vault -> Only available in Grafana Enterprise v7.1+. +If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../../configure-grafana/" >}}) and [Provisioning]({{< relref "../../../administration/provisioning/" >}}). -If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../administration/configuration.md" >}}) -and [Provisioning]({{< relref "../administration/provisioning.md" >}}). +> **Note:** Available in [Grafana Enterprise]({{< relref "../../../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}). -> **Note:** If you have Grafana [set up for high availability]({{< relref "../administration/set-up-for-high-availability.md" >}}), then we advise not to use dynamic secrets for provisioning files. +> **Note:** If you have Grafana [set up for high availability]({{< relref "../../set-up-for-high-availability/" >}}), then we advise not to use dynamic secrets for provisioning files. > Each Grafana instance is responsible for renewing its own leases. Your data source leases might expire when one of your Grafana servers shuts down. ## Configuration @@ -55,7 +56,7 @@ token = s.sAZLyI0r7sFLMPq6MWtoOhAN # replace with your key ## Using the Vault expander After you configure Vault, you must set the configuration or provisioning files you wish to -use Vault. Vault configuration is an extension of configuration's [variable expansion]({{< relref "../administration/configuration.md#variable-expansion" >}}) and follows the +use Vault. Vault configuration is an extension of configuration's [variable expansion]({{< relref "../../configure-grafana/#variable-expansion" >}}) and follows the `$__vault{}` syntax. The argument to Vault consists of three parts separated by a colon: @@ -93,12 +94,12 @@ $__vault{database:database/creds/grafana:username} ### Examples -The following examples show you how to set your [configuration]({{< relref "../administration/configuration.md" >}}) or [provisioning]({{< relref "../administration/provisioning.md" >}}) files to use Vault to retrieve configuration values. +The following examples show you how to set your [configuration]({{< relref "../../configure-grafana/" >}}) or [provisioning]({{< relref "../../../administration/provisioning/" >}}) files to use Vault to retrieve configuration values. #### Configuration The following is a partial example for using Vault to set up a Grafana configuration file's email and database credentials. -Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information. +Refer to [Configuration]({{< relref "../../configure-grafana/" >}}) for more information. ```ini [smtp] @@ -119,7 +120,7 @@ password = $__vault{database:database/creds/grafana:password} The following is a full examples of a provisioning YAML file setting up a MySQL data source using Vault's database secrets engine. -Refer to [Provisioning]({{< relref "../administration/provisioning.md" >}}) for more information. +Refer to [Provisioning]({{< relref "../../../administration/provisioning/" >}}) for more information. **provisioning/custom.yaml** diff --git a/docs/sources/enterprise/request-security.md b/docs/sources/setup-grafana/configure-security/configure-request-security.md similarity index 64% rename from docs/sources/enterprise/request-security.md rename to docs/sources/setup-grafana/configure-security/configure-request-security.md index ccf6a4d3acc..90a7c6ad772 100644 --- a/docs/sources/enterprise/request-security.md +++ b/docs/sources/setup-grafana/configure-security/configure-request-security.md @@ -1,24 +1,22 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/request-security/"] -description = "Grafana Enterprise request security" -keywords = ["grafana", "security", "enterprise"] -title = "Request security" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/request-security/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-request-security/ +description: Request security enables you to limit requests from the Grafana server + by targeting requests generated by users, such as data source metric queries and + alert notifications. +title: Configure request security +weight: 1100 +--- -# Request security +# Configure request security -> **Note:** Available in Grafana Enterprise v7.4 and later versions. - -Request security makes it possible to limit requests from the Grafana server, and it targets requests that are generated by users. - -For example: - -- Data source metric queries -- Alert notifications +Request security allows you to limit requests from the Grafana server by targeting requests generated by users, such as data source metric queries and alert notifications. This can be used to limit access to internal systems that the server Grafana runs on can access but that users of Grafana should not be able to access. This feature does not affect traffic from the Grafana users browser. +> **Note:** Available in [Grafana Enterprise]({{< relref "../../enterprise/" >}}) version 7.4 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). + > **Note:** Although request security works with backend plugins, you can create a backend plugin that bypasses this security. ## IP and hostname blocking diff --git a/docs/sources/enterprise/team-sync.md b/docs/sources/setup-grafana/configure-security/configure-team-sync.md similarity index 59% rename from docs/sources/enterprise/team-sync.md rename to docs/sources/setup-grafana/configure-security/configure-team-sync.md index 708cce1470e..b993f11815b 100644 --- a/docs/sources/enterprise/team-sync.md +++ b/docs/sources/setup-grafana/configure-security/configure-team-sync.md @@ -1,18 +1,20 @@ -+++ -aliases = ["/docs/grafana/latest/auth/saml/", "/docs/grafana/latest/enterprise/team-sync/"] -description = "Grafana Team Sync" -keywords = ["grafana", "auth", "documentation"] -title = "Team sync" -weight = 1000 -+++ +--- +aliases: + - /docs/grafana/latest/auth/saml/ + - /docs/grafana/latest/auth/team-sync/ + - /docs/grafana/latest/enterprise/team-sync/ + - /docs/grafana/latest/setup-grafana/configure-security/configure-team-sync/ +description: Learn how to use Team Sync to synchronize between your authentication + provider teams and Grafana teams. +title: Configure Team Sync +weight: 1000 +--- -# Team sync - -{{< figure src="/static/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}} +# Configure Team Sync Team sync lets you set up synchronization between your auth providers teams and teams in Grafana. This enables LDAP, OAuth, or SAML users who are members of certain teams or groups to automatically be added or removed as members of certain teams in Grafana. -> Available in Grafana Cloud Pro and Advanced and in Grafana Enterprise. +> **Note:** Available in [Grafana Enterprise]({{< relref "../../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}). Grafana keeps track of all synchronized users in teams, and you can see which users have been synchronized in the team members list, see `LDAP` label in screenshot. This mechanism allows Grafana to remove an existing synchronized user from a team when its group membership changes. This mechanism also enables you to manually add a user as member of a team, and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships. @@ -23,13 +25,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/configure-saml.md#configure-team-sync" >}}) +- [Auth Proxy]({{< relref "configure-authentication/auth-proxy/#team-sync-enterprise-only" >}}) +- [Azure AD]({{< relref "configure-authentication/azuread/#team-sync-enterprise-only" >}}) +- [GitHub OAuth]({{< relref "configure-authentication/github/#team-sync-enterprise-only" >}}) +- [GitLab OAuth]({{< relref "configure-authentication/gitlab/#team-sync-enterprise-only" >}}) +- [LDAP]({{< relref "configure-authentication/enhanced_ldap/#ldap-group-synchronization-for-teams" >}}) +- [Okta]({{< relref "configure-authentication/okta/#team-sync-enterprise-only" >}}) +- [SAML]({{< relref "configure-authentication/saml/#configure-team-sync" >}}) ## Synchronize a Grafana team with an external group diff --git a/docs/sources/enterprise/usage-insights/export-logs.md b/docs/sources/setup-grafana/configure-security/export-logs.md similarity index 88% rename from docs/sources/enterprise/usage-insights/export-logs.md rename to docs/sources/setup-grafana/configure-security/export-logs.md index 53ad13afc47..719141ce5e3 100644 --- a/docs/sources/enterprise/usage-insights/export-logs.md +++ b/docs/sources/setup-grafana/configure-security/export-logs.md @@ -1,14 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/usage-insights/export-logs/"] -description = "Export logs of usage insights" -keywords = ["grafana", "export", "usage-insights", "enterprise"] -title = "Export logs of usage insights" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/usage-insights/export-logs/ +description: Export logs of usage insights +keywords: + - grafana + - export + - usage-insights + - enterprise +title: Export logs of usage insights +weight: 900 +--- # Export logs of usage insights -> **Note:** Available in Grafana Enterprise v7.4+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../" >}}) version 7.4 and later, and [Grafana Cloud Pro and Advanced]({{< ref "/docs/grafana-cloud" >}}). By exporting usage logs to Loki, you can directly query them and create dashboards of the information that matters to you most, such as dashboard errors, most active organizations, or your top-10 most-used queries. @@ -50,7 +55,7 @@ Logs of usage insights contain the following fields, where the fields followed b ## Configuration -To export your logs, enable the usage insights feature and [configure]({{< relref "../../administration/configuration.md" >}}) an export location in the configuration file: +To export your logs, enable the usage insights feature and [configure]({{< relref "../../setup-grafana/configure-grafana/" >}}) an export location in the configuration file: ```ini [usage_insights.export] @@ -77,7 +82,7 @@ url = localhost:9095 tls = true ``` -Using `logger` will print usage insights to your [Grafana server log]({{< relref "../../administration/configuration.md#log" >}}). +Using `logger` will print usage insights to your [Grafana server log]({{< relref "../../setup-grafana/configure-grafana/#log" >}}). There is no option for configuring the `logger` storage type. ## Visualize Loki usage insights in Grafana @@ -91,4 +96,4 @@ If you export logs into Loki, you can build Grafana dashboards to understand you 1. Play with usage insights to understand them: - In Explore, you can use the query `{datasource="gdev-loki",kind="usage_insights"}` to retrieve all logs related to your `gdev-loki` data source. - In a dashboard, you can build a table panel with the query `topk(10, sum by (error) (count_over_time({kind="usage_insights", datasource="gdev-prometheus"} | json | error != "" [$__interval])))` to display the 10 most common errors your users see using the `gdev-prometheus` data source. - - In a dashboard, you can build a graph panel with the queries `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error != "" [$__interval]))` and `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error = "" [$__interval]))` to show the evolution of the data request count over time. Using `by (host)` allows you to have more information for each Grafana server you have if you have set up Grafana for [high availability](<{{< relref "../../administration/set-up-for-high-availability.md" >}}>). + - In a dashboard, you can build a graph panel with the queries `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error != "" [$__interval]))` and `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error = "" [$__interval]))` to show the evolution of the data request count over time. Using `by (host)` allows you to have more information for each Grafana server you have if you have set up Grafana for [high availability](<{{< relref "../../setup-grafana/set-up-for-high-availability/" >}}>). diff --git a/docs/sources/enterprise/white-labeling.md b/docs/sources/setup-grafana/enable-custom-branding.md similarity index 75% rename from docs/sources/enterprise/white-labeling.md rename to docs/sources/setup-grafana/enable-custom-branding.md index 1eac3352f51..2b74422d41b 100644 --- a/docs/sources/enterprise/white-labeling.md +++ b/docs/sources/setup-grafana/enable-custom-branding.md @@ -1,18 +1,19 @@ -+++ -aliases = ["/docs/grafana/latest/enterprise/white-labeling/"] -description = "Change the look of Grafana to match your corporate brand" -keywords = ["grafana", "white-labeling", "enterprise"] -title = "White labeling" -weight = 1300 -+++ +--- +aliases: + - /docs/grafana/latest/enterprise/white-labeling/ + - /docs/grafana/latest/setup-grafana/enable-custom-branding/ +description: Change the look of Grafana to match your corporate brand. +title: Enable custom branding +weight: 1300 +--- -# White labeling +# Enable custom branding -White labeling allows you to replace the Grafana brand and logo with your own corporate brand and logo. +Custom branding allows you to replace the Grafana brand and logo with your own corporate brand and logo. -> Only available in Grafana Enterprise v6.6+. +> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise/" >}}) and [Grafana Cloud Advanced]({{< ref "/docs/grafana-cloud" >}}). -Grafana Enterprise has white labeling options in the `grafana.ini` file. As with all configuration options, you can also set them with environment variables. +Grafana Enterprise has custom branding options in the `grafana.ini` file. As with all configuration options, you can also set them with environment variables. You can change the following elements: @@ -27,11 +28,11 @@ You can change the following elements: - Login box background (Grafana v7.0+) - Loading logo -> You will have to host your logo and other images used by the white labeling feature separately. Make sure Grafana can access the URL where the assets are stored. +> You will have to host your logo and other images used by the custom branding feature separately. Make sure Grafana can access the URL where the assets are stored. -{{< figure src="/static/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="White labeling example" >}} +{{< figure src="/static/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="Custom branding example" >}} -The configuration file in Grafana Enterprise contains the following options. Each option is defined in the file. For more information about configuring Grafana, refer to [Configuration]({{< relref "../administration/configuration.md" >}}). +The configuration file in Grafana Enterprise contains the following options. Each option is defined in the file. For more information about configuring Grafana, refer to [Configuration]({{< relref "configure-grafana/" >}}). ```ini # Enterprise only diff --git a/docs/sources/troubleshooting/diagnostics.md b/docs/sources/setup-grafana/enable-diagnostics.md similarity index 88% rename from docs/sources/troubleshooting/diagnostics.md rename to docs/sources/setup-grafana/enable-diagnostics.md index 1deb881ae49..d8d281d5ce2 100644 --- a/docs/sources/troubleshooting/diagnostics.md +++ b/docs/sources/setup-grafana/enable-diagnostics.md @@ -1,10 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/troubleshooting/diagnostics/"] -title = "Enable diagnostics" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/setup-grafana/enable-diagnostics/ + - /docs/grafana/latest/troubleshooting/diagnostics/ +title: Enable diagnostics to troubleshoot Grafana +weight: 1200 +--- -# Enable diagnostics +# Enable diagnostics to troubleshoot Grafana You can set up the `grafana-server` process to enable certain diagnostics when it starts. This can be helpful when investigating certain performance problems. It's _not_ recommended to have these enabled by default. diff --git a/docs/sources/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md similarity index 93% rename from docs/sources/image-rendering/_index.md rename to docs/sources/setup-grafana/image-rendering/_index.md index 5c3103d5863..100f5571d13 100644 --- a/docs/sources/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -1,26 +1,33 @@ -+++ -aliases = ["/docs/grafana/latest/administration/image_rendering/", "/docs/grafana/latest/image-rendering/"] -description = "Image rendering" -keywords = ["grafana", "image", "rendering", "plugin"] -title = "Image rendering" -weight = 55 -+++ +--- +aliases: + - /docs/grafana/latest/administration/image_rendering/ + - /docs/grafana/latest/image-rendering/ + - /docs/grafana/latest/setup-grafana/image-rendering/ +description: Image rendering +keywords: + - grafana + - image + - rendering + - plugin +title: Set up image rendering +weight: 1000 +--- -# Image rendering +# Set up image rendering -Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in [alert notifications]({{< relref "../alerting/notifications/_index.md" >}}), [PDF export]({{< relref "../enterprise/export-pdf.md" >}}), and [Reporting]({{< relref "../enterprise/reporting.md" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../enterprise/" >}}). +Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in [alert notifications]({{< relref "../../alerting/notifications/" >}}), [PDF export]({{< relref "../../enterprise/export-pdf/" >}}), and [Reporting]({{< relref "../../enterprise/reporting/" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../../enterprise/" >}}). > **Note:** Image rendering of dashboards is not supported at this time. While an image is being rendered, the PNG image is temporarily written to the file system. When the image is rendered, the PNG image is temporarily written to the `png` folder in the Grafana `data` folder. -A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime]({{< relref "../administration/configuration/#temp_data_lifetime" >}}) setting. +A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime]({{< relref "../configure-grafana/#temp_data_lifetime" >}}) setting. You can also render a PNG by clicking the dropdown arrow next to a panel title, then clicking **Share > Direct link rendered image**. ## Alerting and render limits -Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [concurrent_render_limit]({{< relref "../administration/configuration/#concurrent_render_limit" >}}). +Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [concurrent_render_limit]({{< relref "../configure-grafana/#concurrent_render_limit" >}}). ## Install Grafana Image Renderer plugin @@ -32,7 +39,7 @@ To install the plugin, refer to the [Grafana Image Renderer Installation instruc The Grafana Image Renderer plugin has a number of configuration options that are used in plugin or remote rendering modes. -In plugin mode, you can specify them directly in the [Grafana configuration file]({{< relref "../administration/configuration/#plugingrafana-image-renderer" >}}). +In plugin mode, you can specify them directly in the [Grafana configuration file]({{< relref "../configure-grafana/#plugingrafana-image-renderer" >}}). In remote rendering mode, you can specify them in a `.json` [configuration file](#configuration-file) or, for some of them, you can override the configuration defaults using environment variables. @@ -104,7 +111,7 @@ In `contextPerRenderKey` mode, the plugin will reuse the same [browser context]( In the case of `contextPerRenderKey` mode, the `clustering.max_concurrency` option refers to the number of open contexts rather than the number of open pages. There is no way to limit the number of open pages in a context. -`contextPerRenderKey` was designed to improve the performance of the [dashboard previews crawler]({{< relref "../dashboards/previews.md#about-the-dashboard-previews-crawler" >}}). +`contextPerRenderKey` was designed to improve the performance of the [dashboard previews crawler]({{< relref "../../dashboards/previews/#about-the-dashboard-previews-crawler" >}}). ```json { @@ -137,7 +144,7 @@ RENDERING_MODE=reusable #### Optimize the performance, CPU and memory usage of the image renderer -The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service]({{< relref "./monitoring/" >}}). +The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service]({{< relref "monitoring/" >}}). With no concurrent requests, the different modes show very similar performance and CPU / memory usage. diff --git a/docs/sources/image-rendering/monitoring.md b/docs/sources/setup-grafana/image-rendering/monitoring.md similarity index 97% rename from docs/sources/image-rendering/monitoring.md rename to docs/sources/setup-grafana/image-rendering/monitoring.md index 3a65683fdd9..cf73246714d 100644 --- a/docs/sources/image-rendering/monitoring.md +++ b/docs/sources/setup-grafana/image-rendering/monitoring.md @@ -1,14 +1,21 @@ -+++ -aliases = ["/docs/grafana/latest/image-rendering/monitoring/"] -description = "Image rendering monitoring" -keywords = ["grafana", "image", "rendering", "plugin", "monitoring"] -title = "Monitoring the image renderer" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/image-rendering/monitoring/ + - /docs/grafana/latest/setup-grafana/image-rendering/monitoring/ +description: Image rendering monitoring +keywords: + - grafana + - image + - rendering + - plugin + - monitoring +title: Monitoring the image renderer +weight: 100 +--- # Monitoring the image renderer -Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode]({{< relref "./#rendering-mode" >}}). +Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode]({{< relref "/#rendering-mode" >}}). ## Enable Prometheus metrics endpoint diff --git a/docs/sources/image-rendering/troubleshooting.md b/docs/sources/setup-grafana/image-rendering/troubleshooting.md similarity index 94% rename from docs/sources/image-rendering/troubleshooting.md rename to docs/sources/setup-grafana/image-rendering/troubleshooting.md index f339d366334..655a4db0e36 100644 --- a/docs/sources/image-rendering/troubleshooting.md +++ b/docs/sources/setup-grafana/image-rendering/troubleshooting.md @@ -1,10 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/image-rendering/troubleshooting/"] -description = "Image rendering troubleshooting" -keywords = ["grafana", "image", "rendering", "plugin", "troubleshooting"] -title = "Troubleshooting" -weight = 115 -+++ +--- +aliases: + - /docs/grafana/latest/image-rendering/troubleshooting/ + - /docs/grafana/latest/setup-grafana/image-rendering/troubleshooting/ +description: Image rendering troubleshooting +keywords: + - grafana + - image + - rendering + - plugin + - troubleshooting +title: Troubleshooting +weight: 200 +--- # Troubleshoot image rendering @@ -23,9 +30,9 @@ filters = rendering:debug You can also enable more logs in image renderer service itself by: -- Increasing the [log level]({{< relref "./#log-level" >}}). -- Enabling [verbose logging]({{< relref "./#verbose-logging" >}}). -- [Capturing headless browser output]({{< relref "./#capture-browser-output" >}}). +- Increasing the [log level]({{< relref "/#log-level" >}}). +- Enabling [verbose logging]({{< relref "/#verbose-logging" >}}). +- [Capturing headless browser output]({{< relref "/#capture-browser-output" >}}). ## Missing libraries diff --git a/docs/sources/installation/requirements.md b/docs/sources/setup-grafana/installation/_index.md similarity index 78% rename from docs/sources/installation/requirements.md rename to docs/sources/setup-grafana/installation/_index.md index b6e64b9c6e5..eaf6f38fa63 100644 --- a/docs/sources/installation/requirements.md +++ b/docs/sources/setup-grafana/installation/_index.md @@ -1,12 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/installation/requirements/"] -description = "Requirements for Grafana" -keywords = ["grafana", "installation", "documentation"] -title = "Requirements" -weight = 100 -+++ +--- +aliases: + - /docs/grafana/latest/install/ + - /docs/grafana/latest/installation/ + - /docs/grafana/latest/installation/installation/ + - /docs/grafana/latest/installation/requirements/ + - /docs/grafana/latest/setup-grafana/installation/ + - /docs/grafana/v2.1/installation/install/ +description: Installation guide for Grafana +title: Install Grafana +weight: 100 +--- -# Grafana requirements +# Install Grafana This page lists the minimum hardware and software requirements to install Grafana. @@ -18,10 +23,10 @@ Grafana uses other open source software. Refer to [package.json](https://github. The following operating systems are supported for Grafana installation: -- [Debian / Ubuntu]({{< relref "debian" >}}) -- [RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm" >}}) -- [macOS]({{< relref "mac" >}}) -- [Windows]({{< relref "windows" >}}) +- [Debian / Ubuntu]({{< relref "debian/" >}}) +- [RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm/" >}}) +- [macOS]({{< relref "mac/" >}}) +- [Windows]({{< relref "windows/" >}}) Installation of Grafana on other operating systems is possible, but it is neither recommended nor supported. @@ -35,8 +40,8 @@ Minimum recommended CPU: 1 Some features might require more memory or CPUs. Features require more resources include: - [Server side rendering of images](https://grafana.com/grafana/plugins/grafana-image-renderer#requirements) -- [Alerting]({{< relref "../alerting" >}}) -- [Data source proxy]({{< relref "../developers/http_api/data_source" >}}) +- [Alerting]({{< relref "../../alerting/" >}}) +- [Data source proxy]({{< relref "../../developers/http_api/data_source/" >}}) ## Supported databases diff --git a/docs/sources/installation/debian.md b/docs/sources/setup-grafana/installation/debian.md similarity index 90% rename from docs/sources/installation/debian.md rename to docs/sources/setup-grafana/installation/debian.md index 35c9303a26b..18e2faedda7 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/setup-grafana/installation/debian.md @@ -1,10 +1,12 @@ -+++ -aliases = ["/docs/grafana/latest/installation/debian/", "/docs/grafana/latest/installation/installation/debian/"] -description = "Install guide for Grafana on Debian or Ubuntu" -keywords = ["grafana", "installation", "documentation"] -title = "Install on Debian/Ubuntu" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/installation/debian/ + - /docs/grafana/latest/installation/installation/debian/ + - /docs/grafana/latest/setup-grafana/installation/debian/ +description: Install guide for Grafana on Debian or Ubuntu +title: Install on Debian or Ubuntu +weight: 100 +--- # Install on Debian or Ubuntu @@ -12,7 +14,7 @@ This page explains how to install Grafana dependencies, download and install Gra ## Note on upgrading -While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing installation. +While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. > **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text). @@ -179,8 +181,8 @@ Start Grafana by running: ## Next steps -Refer to the [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../administration/configuration.md" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/installation/docker.md b/docs/sources/setup-grafana/installation/docker.md similarity index 94% rename from docs/sources/installation/docker.md rename to docs/sources/setup-grafana/installation/docker.md index c0efadb5e23..0929090977b 100644 --- a/docs/sources/installation/docker.md +++ b/docs/sources/setup-grafana/installation/docker.md @@ -1,10 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/installation/docker/"] -description = "Guide for running Grafana using Docker" -keywords = ["grafana", "configuration", "documentation", "docker"] -title = "Run Grafana Docker image" -weight = 600 -+++ +--- +aliases: + - /docs/grafana/latest/installation/docker/ + - /docs/grafana/latest/setup-grafana/installation/docker/ +description: Guide for running Grafana using Docker +title: Run Grafana Docker image +weight: 200 +--- # Run Grafana Docker image @@ -250,12 +251,12 @@ chown -R grafana:grafana /usr/share/grafana ## Next steps -Refer to the [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Docker image -Refer to [Configure a Grafana Docker image]({{< relref "../administration/configure-docker.md" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to [Configure a Grafana Docker image]({{< relref "../../administration/configure-docker/" >}}) page for details on options for customizing your environment, logging, database, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../administration/configuration.md" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/installation/kubernetes.md b/docs/sources/setup-grafana/installation/kubernetes.md similarity index 96% rename from docs/sources/installation/kubernetes.md rename to docs/sources/setup-grafana/installation/kubernetes.md index e1889eec737..656ddc2c8a3 100644 --- a/docs/sources/installation/kubernetes.md +++ b/docs/sources/setup-grafana/installation/kubernetes.md @@ -1,10 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/installation/kubernetes/"] -description = "Guide for deploying Grafana on Kubernetes" -keywords = ["grafana", "configuration", "documentation", "kubernetes"] -title = "Deploy Grafana on Kubernetes" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/installation/kubernetes/ + - /docs/grafana/latest/setup-grafana/installation/kubernetes/ +description: Guide for deploying Grafana on Kubernetes +title: Deploy Grafana on Kubernetes +weight: 300 +--- ## Deploy Grafana on Kubernetes diff --git a/docs/sources/installation/mac.md b/docs/sources/setup-grafana/installation/mac.md similarity index 77% rename from docs/sources/installation/mac.md rename to docs/sources/setup-grafana/installation/mac.md index 305038e27a0..db6c6a56945 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/setup-grafana/installation/mac.md @@ -1,16 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/installation/mac/"] -description = "Installing Grafana on macOS" -keywords = ["grafana", "configuration", "documentation", "mac", "homebrew", "osx"] -title = "Install on macOS" -weight = 500 -+++ +--- +aliases: + - /docs/grafana/latest/installation/mac/ + - /docs/grafana/latest/setup-grafana/installation/mac/ +description: Installing Grafana on macOS +title: Install on macOS +weight: 600 +--- # Install on macOS This page explains how to install Grafana and get the service running on your macOS. -**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Before you perform an upgrade, read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing installation. +**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Before you perform an upgrade, read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. ## Install with Homebrew @@ -58,7 +59,7 @@ To install a nightly build, or to install the latest version of Grafana without ## Next steps -Refer to the [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. Also, refer to the [Configuration]({{< relref "../administration/configuration.md" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. Also, refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. ## Upgrade diff --git a/docs/sources/installation/rpm.md b/docs/sources/setup-grafana/installation/rpm.md similarity index 91% rename from docs/sources/installation/rpm.md rename to docs/sources/setup-grafana/installation/rpm.md index af7ea75e389..f0958d6b243 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/setup-grafana/installation/rpm.md @@ -1,10 +1,13 @@ -+++ -aliases = ["/docs/grafana/latest/installation/installation/rpm/", "/docs/grafana/latest/installation/rpm/"] -description = "Grafana Installation guide for RPM-based Linux, such as Centos, Fedora, OpenSuse, and Red Hat." -keywords = ["grafana", "installation", "documentation", "centos", "fedora", "opensuse", "redhat"] -title = "Install on RPM-based Linux" -weight = 300 -+++ +--- +aliases: + - /docs/grafana/latest/installation/installation/rpm/ + - /docs/grafana/latest/installation/rpm/ + - /docs/grafana/latest/setup-grafana/installation/rpm/ +description: Grafana Installation guide for RPM-based Linux, such as Centos, Fedora, + OpenSuse, and Red Hat. +title: Install on RPM-based Linux +weight: 400 +--- # Install on RPM-based Linux (CentOS, Fedora, OpenSuse, Red Hat) @@ -12,7 +15,7 @@ This topic explains how to install Grafana dependencies, download and install Gr ## Note on upgrading -While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing installation. +While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. > **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid the overhead of installing, maintaining, and scaling your observability stack. The free forever plan includes Grafana, 10K Prometheus series, 50 GB logs, and more.[Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text). @@ -233,8 +236,8 @@ Start Grafana by running: ## Next steps -Refer to the [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../administration/configuration.md" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration]({{< relref "../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/installation/windows.md b/docs/sources/setup-grafana/installation/windows.md similarity index 82% rename from docs/sources/installation/windows.md rename to docs/sources/setup-grafana/installation/windows.md index 27462251cd0..11bee36e65d 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/setup-grafana/installation/windows.md @@ -1,16 +1,17 @@ -+++ -aliases = ["/docs/grafana/latest/installation/windows/"] -description = "Install Grafana on Windows" -keywords = ["grafana", "configuration", "documentation", "windows"] -title = "Install on Windows" -weight = 400 -+++ +--- +aliases: + - /docs/grafana/latest/installation/windows/ + - /docs/grafana/latest/setup-grafana/installation/windows/ +description: Install Grafana on Windows +title: Install on Windows +weight: 500 +--- # Install on Windows You can either download the Windows installer package or a standalone Windows binary file. -Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing +Read [Upgrading Grafana]({{< relref "../upgrade-grafana/" >}}) for tips and guidance on updating an existing installation. 1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows). @@ -29,7 +30,7 @@ You can either use the Windows installer or you can install a standalone Windows 1. Click **Download the installer**. 1. Open and run the installer. -To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}). +To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}). ## Install standalone Windows binary @@ -41,10 +42,10 @@ To run Grafana, open your browser and go to the Grafana port (http://localhost:3 1. Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the command line. If you want to run Grafana as a Windows service, then download [NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool. -To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../getting-started/build-first-dashboard/" >}}). +To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../getting-started/build-first-dashboard/" >}}). > **Note:** The default Grafana port is `3000`. This port might require extra permissions on Windows. If it does not appear in the default port, you can try changing to a different port. > > 1. Go into the `conf` directory and copy `sample.ini` to `custom.ini`. **Note:** You should edit `custom.ini`, never `defaults.ini`. > 1. Edit `custom.ini` and uncomment the `http_port` configuration option (`;` is the comment character in ini files) and change it to something like `8080` or similar. That port should not require extra Windows privileges. -> Read more about the [configuration options]({{< relref "../administration/configuration.md" >}}). +> Read more about the [configuration options]({{< relref "../configure-grafana/" >}}). diff --git a/docs/sources/installation/restart-grafana.md b/docs/sources/setup-grafana/restart-grafana.md similarity index 92% rename from docs/sources/installation/restart-grafana.md rename to docs/sources/setup-grafana/restart-grafana.md index 93f337559e3..9eebfd09b4b 100644 --- a/docs/sources/installation/restart-grafana.md +++ b/docs/sources/setup-grafana/restart-grafana.md @@ -1,10 +1,11 @@ -+++ -aliases = ["/docs/grafana/latest/installation/restart-grafana/"] -description = "Instructions for restarting Grafana" -keywords = ["grafana", "restart", "documentation"] -title = "Restart Grafana" -weight = 750 -+++ +--- +aliases: + - /docs/grafana/latest/installation/restart-grafana/ + - /docs/grafana/latest/setup-grafana/restart-grafana/ +description: Instructions for restarting Grafana +title: Restart Grafana +weight: 300 +--- # Restart Grafana diff --git a/docs/sources/administration/set-up-for-high-availability.md b/docs/sources/setup-grafana/set-up-for-high-availability.md similarity index 72% rename from docs/sources/administration/set-up-for-high-availability.md rename to docs/sources/setup-grafana/set-up-for-high-availability.md index fd6e03d9c14..8fac082d8cf 100644 --- a/docs/sources/administration/set-up-for-high-availability.md +++ b/docs/sources/setup-grafana/set-up-for-high-availability.md @@ -1,9 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/administration/set-up-for-high-availability/", "/docs/grafana/latest/tutorials/ha_setup/"] -keywords = ["grafana", "tutorials", "HA", "high availability"] -title = "Set up Grafana for high availability" -weight = 1200 -+++ +--- +aliases: + - /docs/grafana/latest/administration/set-up-for-high-availability/ + - /docs/grafana/latest/setup-grafana/set-up-for-high-availability/ + - /docs/grafana/latest/tutorials/ha_setup/ +keywords: + - grafana + - tutorials + - HA + - high availability +title: Set up Grafana for high availability +weight: 900 +--- # Set up Grafana for high availability @@ -17,12 +24,12 @@ and other persistent data. So the default embedded SQLite database will not work ## Configure multiple servers to use the same database First, you need to set up MySQL or Postgres on another server and configure Grafana to use that database. -You can find the configuration for doing that in the [[database]]({{< relref "../administration/configuration.md#database" >}}) section in the Grafana config. +You can find the configuration for doing that in the [[database]]({{< relref "configure-grafana/#database" >}}) section in the Grafana config. Grafana will now persist all long term data in the database. How to configure the database for high availability is out of scope for this guide. We recommend finding an expert on the database you're using. ## Alerting high availability -Grafana alerting provides a new [highly-available model]({{< relref "../alerting/high-availability/_index.md" >}}). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time. +Grafana alerting provides a new [highly-available model]({{< relref "../alerting/high-availability/" >}}). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time. For instructions on setting up alerting high availability, see [enable alerting high availability](https://grafana.com/docs/grafana/next/alerting/old-alerting/notifications/). @@ -32,7 +39,7 @@ Legacy Grafana alerting supports a limited form of high availability. In this mo ## Grafana Live -Grafana Live works with limitations in highly available setup. For details, refer to the [Configure Grafana Live HA setup]({{< relref "../live/set-up-grafana-live/#configure-grafana-live-ha-setup" >}}). +Grafana Live works with limitations in highly available setup. For details, refer to the [Configure Grafana Live HA setup]({{< relref "set-up-grafana-live/#configure-grafana-live-ha-setup" >}}). ## User sessions diff --git a/docs/sources/live/set-up-grafana-live.md b/docs/sources/setup-grafana/set-up-grafana-live.md similarity index 92% rename from docs/sources/live/set-up-grafana-live.md rename to docs/sources/setup-grafana/set-up-grafana-live.md index cffa2a5b8d6..c57f82a64c3 100644 --- a/docs/sources/live/set-up-grafana-live.md +++ b/docs/sources/setup-grafana/set-up-grafana-live.md @@ -1,17 +1,17 @@ --- -title: 'Set up Grafana Live' -menuTitle: 'Set up Grafana Live' -description: 'Grafana Live is a real-time messaging engine that pushes event data to a frontend when an event occurs.' aliases: - [ - '/docs/grafana/latest/live/live-feature-overview/', - '/docs/grafana/latest/live/', - '/docs/grafana/latest/live/configure-grafana-live/', - '/docs/grafana/latest/live/live-channel/', - '/docs/grafana/latest/live/live-ha-setup/', - '/docs/grafana/latest/live/set-up-grafana-live/', - ] -weight: 115 + - /docs/grafana/latest/live/ + - /docs/grafana/latest/live/configure-grafana-live/ + - /docs/grafana/latest/live/live-channel/ + - /docs/grafana/latest/live/live-feature-overview/ + - /docs/grafana/latest/live/live-ha-setup/ + - /docs/grafana/latest/live/set-up-grafana-live/ + - /docs/grafana/latest/setup-grafana/set-up-grafana-live/ +description: Grafana Live is a real-time messaging engine that pushes event data to + a frontend when an event occurs. +menuTitle: Set up Grafana Live +title: Set up Grafana Live +weight: 1100 --- # Set up Grafana Live @@ -96,7 +96,7 @@ Grafana Live uses persistent connections (WebSocket at the moment) to deliver re WebSocket is a persistent connection that starts with an HTTP Upgrade request (using the same HTTP port as the rest of Grafana) and then switches to a TCP mode where WebSocket frames can travel in both directions between a client and a server. Each logged-in user opens a WebSocket connection – one per browser tab. -The number of maximum WebSocket connections users can establish with Grafana is limited to 100 by default. See [max_connections]({{< relref "../administration/configuration.md#max_connections" >}}) option. +The number of maximum WebSocket connections users can establish with Grafana is limited to 100 by default. See [max_connections]({{< relref "configure-grafana/#max_connections" >}}) option. In case you want to increase this limit, ensure that your server and infrastructure allow handling more connections. The following sections discuss several common problems which could happen when managing persistent connections, in particular WebSocket connections. @@ -104,9 +104,9 @@ In case you want to increase this limit, ensure that your server and infrastruct To avoid hijacking of WebSocket connection Grafana Live checks the Origin request header sent by a client in an HTTP Upgrade request. Requests without Origin header pass through without any origin check. -By default, Live accepts connections with Origin header that matches configured [root_url]({{< relref "../administration/configuration.md#root_url" >}}) (which is a public Grafana URL). +By default, Live accepts connections with Origin header that matches configured [root_url]({{< relref "configure-grafana/#root_url" >}}) (which is a public Grafana URL). -It is possible to provide a list of additional origin patterns to allow WebSocket connections from. This can be achieved using the [allowed_origins]({{< relref "../administration/configuration.md#allowed_origins" >}}) option of Grafana Live configuration. +It is possible to provide a list of additional origin patterns to allow WebSocket connections from. This can be achieved using the [allowed_origins]({{< relref "configure-grafana/#allowed_origins" >}}) option of Grafana Live configuration. #### Resource usage @@ -212,7 +212,7 @@ ha_engine = redis ha_engine_address = 127.0.0.1:6379 ``` -For additional information, refer to the [ha_engine]({{< relref "../administration/configuration.md#ha_engine" >}}) and [ha_engine_address]({{< relref "../administration/configuration.md#ha_engine_address" >}}) options. +For additional information, refer to the [ha_engine]({{< relref "configure-grafana/#ha_engine" >}}) and [ha_engine_address]({{< relref "configure-grafana/#ha_engine_address" >}}) options. After running: diff --git a/docs/sources/administration/view-server/internal-metrics.md b/docs/sources/setup-grafana/set-up-grafana-monitoring.md similarity index 75% rename from docs/sources/administration/view-server/internal-metrics.md rename to docs/sources/setup-grafana/set-up-grafana-monitoring.md index e8c63990ad6..b813c84bae8 100644 --- a/docs/sources/administration/view-server/internal-metrics.md +++ b/docs/sources/setup-grafana/set-up-grafana-monitoring.md @@ -1,18 +1,35 @@ -+++ -aliases = ["/docs/grafana/latest/admin/metrics/", "/docs/grafana/latest/administration/view-server/internal-metrics/"] -description = "Internal metrics exposed by Grafana" -keywords = ["grafana", "metrics", "internal metrics"] -title = "Internal Grafana metrics" -weight = 200 -+++ +--- +aliases: + - /docs/grafana/latest/admin/metrics/ + - /docs/grafana/latest/administration/jaeger-instrumentation/ + - /docs/grafana/latest/administration/view-server/internal-metrics/ + - /docs/grafana/latest/setup-grafana/set-up-grafana-monitoring/ +description: Jaeger traces emitted and propagation by Grafana +keywords: + - grafana + - jaeger + - tracing +title: Set up Grafana monitoring +weight: 800 +--- -# Internal Grafana metrics +# Set up Grafana monitoring + +Grafana supports [Jaeger tracing](https://www.jaegertracing.io/). + +Grafana can emit Jaeger traces for its HTTP API endpoints and propagate Jaeger trace information to data sources. +All HTTP endpoints are logged evenly (annotations, dashboard, tags, and so on). +When a trace ID is propagated, it is reported with operation 'HTTP /datasources/proxy/:id/\*'. + +Refer to [Configuration]({{< relref "configure-grafana/#tracingjaeger" >}}) for information about enabling Jaeger tracing. + +## View Grafana internal metrics Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus. -For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../../administration/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../../administration/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../../administration/configuration.md" >}}). +For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "configure-grafana/#metrics" >}}) and [metrics.graphite]({{< relref "configure-grafana/#metricsgraphite" >}}) in [Configuration]({{< relref "configure-grafana/" >}}). -## Available metrics +### Available metrics When enabled, Grafana exposes a number of metrics, including: @@ -23,7 +40,7 @@ When enabled, Grafana exposes a number of metrics, including: - Grafana active alerts - Grafana performance -## Pull metrics from Grafana into Prometheus +### Pull metrics from Grafana into Prometheus These instructions assume you have already added Prometheus as a data source in Grafana. @@ -65,7 +82,7 @@ These instructions assume you have already added Prometheus as a data source in 1. Select the **Prometheus** data source. 1. On the Dashboards tab, **Import** the Grafana metrics dashboard. All scraped Grafana metrics are available in the dashboard. -## View Grafana metrics in Graphite +### View Grafana metrics in Graphite These instructions assume you have already added Graphite as a data source in Grafana. @@ -93,9 +110,9 @@ These instructions assume you have already added Graphite as a data source in Gr 1. Restart Grafana. Grafana now exposes metrics at http://localhost:3000/metrics and sends them to the Graphite location you specified. -## Pull metrics from Grafana backend plugin into Prometheus +### Pull metrics from Grafana backend plugin into Prometheus -Any installed [backend plugin]({{< relref "../../developers/plugins/backend/_index.md" >}}) exposes a metrics endpoint through Grafana that you can configure Prometheus to scrape. +Any installed [backend plugin]({{< relref "../developers/plugins/backend/" >}}) exposes a metrics endpoint through Grafana that you can configure Prometheus to scrape. These instructions assume you have already added Prometheus as a data source in Grafana. diff --git a/docs/sources/setup-grafana/sign-in-to-grafana.md b/docs/sources/setup-grafana/sign-in-to-grafana.md new file mode 100644 index 00000000000..1dc87b19a6a --- /dev/null +++ b/docs/sources/setup-grafana/sign-in-to-grafana.md @@ -0,0 +1,18 @@ +--- +aliases: + - /docs/grafana/latest/setup-grafana/sign-in-to-grafana/ +description: Learn how to sign in to Grafana +title: Sign in to Grafana +weight: 400 +--- + +# Sign in to Grafana + +To sign in to Grafana for the first time: + +1. Open your web browser and go to http://localhost:3000/. The default HTTP port that Grafana listens to is `3000` unless you have configured a different port. +1. On the signin page, enter `admin` for username and password. +1. Click **Sign in**. If successful, you will see a prompt to change the password. +1. Click **OK** on the prompt and change your password. + +> **Note:** We strongly recommend that you change the default administrator password. diff --git a/docs/sources/installation/upgrading.md b/docs/sources/setup-grafana/upgrade-grafana.md similarity index 89% rename from docs/sources/installation/upgrading.md rename to docs/sources/setup-grafana/upgrade-grafana.md index fb0d2dc4aa5..91c532bba91 100644 --- a/docs/sources/installation/upgrading.md +++ b/docs/sources/setup-grafana/upgrade-grafana.md @@ -1,10 +1,16 @@ -+++ -aliases = ["/docs/grafana/latest/installation/upgrading/"] -description = "Guide for upgrading Grafana" -keywords = ["grafana", "configuration", "documentation", "upgrade"] -title = "Upgrade Grafana" -weight = 700 -+++ +--- +aliases: + - /docs/grafana/latest/installation/upgrading/ + - /docs/grafana/latest/setup-grafana/upgrade-grafana/ +description: Guide for upgrading Grafana +keywords: + - grafana + - configuration + - documentation + - upgrade +title: Upgrade Grafana +weight: 500 +--- # Upgrade Grafana @@ -123,7 +129,7 @@ grafana-cli plugins update-all The dashboard grid layout engine has changed. All dashboards will be automatically upgraded to new positioning system when you load them in v5. Dashboards saved in v5 will not work in older versions of Grafana. Some external panel plugins might need to be updated to work properly. -For more details on the new panel positioning system, refer to [panel size position]({{< relref "../dashboards/json-model.md#panel-size-position" >}}) +For more details on the new panel positioning system, refer to [panel size position]({{< relref "../dashboards/json-model/#panel-size-position" >}}) ## Upgrading to v5.2 @@ -136,7 +142,7 @@ If you're using systemd and have a large amount of annotations consider temporar ## Upgrading to v6.0 If you have text panels with script tags they will no longer work due to a new setting that per default disallow unsanitized HTML. -For more information about the new setting, refer to [disable sanitize html]({{< relref "../administration/configuration/#disable-sanitize-html" >}}). +For more information about the new setting, refer to [disable sanitize html]({{< relref "configure-grafana/#disable-sanitize-html" >}}). ### Authentication and security @@ -152,14 +158,16 @@ cookie_secure = true cookie_secure = true ``` -The `login_remember_days`, `cookie_username` and `cookie_remember_name` settings in the `security` section are no longer being used so they're safe to remove. +The `login_remember_days`, `login_maximum_inactive_lifetime_days`, `login_maximum_lifetime_days`, `cookie_username` and `cookie_remember_name` settings in the `security` section are no longer being used so they're safe to remove. + +If you have `login_maximum_lifetime_days` or `login_maximum_inactive_lifetime_days` configured, you need to change it to `login_maximum_lifetime_duration` or `login_maximum_inactive_lifetime_duration` and append `d` to the configuration value to retain the previous behavior. If you have `login_remember_days` configured to 0 (zero) you should change your configuration to this to accomplish similar behavior, i.e. a logged in user will maximum be logged in for 1 day until being forced to login again: ```ini [auth] -login_maximum_inactive_lifetime_days = 1 -login_maximum_lifetime_days = 1 +login_maximum_inactive_lifetime_duration = 1d +login_maximum_lifetime_duration = 1d ``` The default cookie name for storing the auth token is `grafana_session`. you can configure this with `login_cookie_name` in `[auth]` settings. @@ -175,13 +183,13 @@ you can do that by: - For data sources created through UI, you need to go to data source config, re-enter the password or basic auth password and save the data source. - For data sources created by provisioning, you need to update your config file and use secureJsonData.password or - secureJsonData.basicAuthPassword field. See [provisioning docs]({{< relref "../administration/provisioning" >}}) for example of current + secureJsonData.basicAuthPassword field. See [provisioning docs]({{< relref "../administration/provisioning/" >}}) for example of current configuration. ### Embedding Grafana If you're embedding Grafana in a ``, `