mirror of
https://github.com/grafana/grafana.git
synced 2025-12-20 16:54:59 +08:00
Compare commits
55 Commits
docs/updat
...
v7.0.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ef5b586d7d | ||
|
|
03306f1220 | ||
|
|
b6cb31a4de | ||
|
|
0b627672ba | ||
|
|
205b7685a8 | ||
|
|
c0a2aceac5 | ||
|
|
63c6284b94 | ||
|
|
bb2201c35e | ||
|
|
820d382e8f | ||
|
|
5310fe837b | ||
|
|
23a42e801f | ||
|
|
2c42ac5df9 | ||
|
|
10c9543038 | ||
|
|
40d7234d02 | ||
|
|
fa0670e734 | ||
|
|
43b65f7d67 | ||
|
|
037b6a45ca | ||
|
|
7b9650ba81 | ||
|
|
28253bb62e | ||
|
|
2fc13ac853 | ||
|
|
e929eab87c | ||
|
|
c1ab56fd8e | ||
|
|
4541dee9e1 | ||
|
|
4ac745ac55 | ||
|
|
4ba0377511 | ||
|
|
298f8b0028 | ||
|
|
fe890a0708 | ||
|
|
a930cba373 | ||
|
|
045b8629a4 | ||
|
|
3b3fbb551d | ||
|
|
9e4d9bed2a | ||
|
|
1ee5fc893c | ||
|
|
f2df0cedd4 | ||
|
|
3256fb87c5 | ||
|
|
f098b4049d | ||
|
|
21f7a9ed1e | ||
|
|
f235cd697d | ||
|
|
0b27b1fb17 | ||
|
|
2d6faa6d99 | ||
|
|
72c7731c42 | ||
|
|
cd507df860 | ||
|
|
afa9aef76a | ||
|
|
aee1438ff2 | ||
|
|
0167f43d74 | ||
|
|
2169fc1a3f | ||
|
|
ca077f31f5 | ||
|
|
2a0138d1d0 | ||
|
|
908af75083 | ||
|
|
575d898955 | ||
|
|
10bf03b221 | ||
|
|
fbd3b4b969 | ||
|
|
91824e2bfa | ||
|
|
014fc0f3f5 | ||
|
|
2422fd7e26 | ||
|
|
01b5032fbc |
@@ -15,7 +15,9 @@ aliases:
|
||||
tags:
|
||||
ignore: /^v[0-9]+(\.[0-9]+){2}(-.+|[^-.]*)$/
|
||||
branches:
|
||||
ignore: master
|
||||
ignore:
|
||||
- master
|
||||
- chore/test-release-pipeline
|
||||
- &filter-only-master
|
||||
branches:
|
||||
only: master
|
||||
@@ -54,7 +56,7 @@ commands:
|
||||
- run:
|
||||
name: "Install Grafana build pipeline tool"
|
||||
command: |
|
||||
VERSION=0.4.4
|
||||
VERSION=0.4.9
|
||||
curl -fLO https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v${VERSION}/grabpl
|
||||
chmod +x grabpl
|
||||
mv grabpl /tmp
|
||||
@@ -91,7 +93,7 @@ jobs:
|
||||
elif [[ $CIRCLE_BRANCH == "chore/test-release-pipeline" ]]; then
|
||||
# We're testing the release pipeline
|
||||
/tmp/grabpl build-backend --edition << parameters.edition >> \
|
||||
--variants << parameters.variant >> v6.7.0-beta1
|
||||
--variants << parameters.variant >> v7.0.0-test
|
||||
else
|
||||
# A master or PR build
|
||||
/tmp/grabpl build-backend --edition << parameters.edition >> \
|
||||
@@ -153,7 +155,17 @@ jobs:
|
||||
- node_modules
|
||||
- run:
|
||||
name: Build Grafana frontend
|
||||
command: /tmp/grabpl build-frontend --edition << parameters.edition >>
|
||||
command: |
|
||||
if [[ -n $CIRCLE_TAG ]]; then
|
||||
# A release build
|
||||
/tmp/grabpl build-frontend --edition << parameters.edition >> $CIRCLE_TAG
|
||||
elif [[ $CIRCLE_BRANCH == "chore/test-release-pipeline" ]]; then
|
||||
# We're testing the release pipeline
|
||||
/tmp/grabpl build-frontend --edition << parameters.edition >> 7.0.0-test
|
||||
else
|
||||
# A master or PR build
|
||||
/tmp/grabpl build-frontend --edition << parameters.edition >> --build-id $CIRCLE_WORKFLOW_ID
|
||||
fi
|
||||
- run:
|
||||
name: Move artifacts
|
||||
command: mkdir << parameters.edition >> && cp -r public << parameters.edition >>/
|
||||
@@ -398,19 +410,25 @@ jobs:
|
||||
source scripts/build/gpg-test-vars.sh
|
||||
fi
|
||||
|
||||
# Necessary for signing bundled plugins
|
||||
export GRAFANA_API_KEY=$GRAFANA_COM_API_KEY
|
||||
if [[ -n $CIRCLE_TAG ]]; then
|
||||
# A release build
|
||||
/tmp/grabpl package --jobs 2 --edition oss $CIRCLE_TAG
|
||||
/tmp/grabpl package --jobs 2 --edition oss --sign $CIRCLE_TAG
|
||||
elif [[ $CIRCLE_BRANCH == "chore/test-release-pipeline" ]]; then
|
||||
# We're testing the release pipeline
|
||||
/tmp/grabpl package --jobs 2 --edition oss v6.7.0-beta1
|
||||
/tmp/grabpl package --jobs 2 --edition oss --sign v7.0.0-test
|
||||
elif [[ $CIRCLE_BRANCH == "master" ]]; then
|
||||
# A master build
|
||||
/tmp/grabpl package --jobs 2 --edition oss --build-id $CIRCLE_WORKFLOW_ID
|
||||
else
|
||||
# A PR build
|
||||
/tmp/grabpl package --jobs 2 --edition oss --sign --build-id $CIRCLE_WORKFLOW_ID
|
||||
elif [[ -n "$CIRCLE_PR_NUMBER" ]]; then
|
||||
# A forked PR build, don't sign as it requires an API secret
|
||||
/tmp/grabpl package --jobs 2 --edition oss --build-id $CIRCLE_WORKFLOW_ID --variants \
|
||||
linux-x64,linux-x64-musl,osx64,win64
|
||||
else
|
||||
# A non-forked PR build
|
||||
/tmp/grabpl package --jobs 2 --edition oss --sign --build-id $CIRCLE_WORKFLOW_ID --variants \
|
||||
linux-x64,linux-x64-musl,osx64,win64
|
||||
fi
|
||||
- run:
|
||||
name: Move artifacts
|
||||
@@ -453,18 +471,25 @@ jobs:
|
||||
- run:
|
||||
name: Package Grafana
|
||||
command: |
|
||||
# Necessary for signing bundled plugins
|
||||
export GRAFANA_API_KEY=$GRAFANA_COM_API_KEY
|
||||
|
||||
if [[ -n $CIRCLE_TAG ]]; then
|
||||
# A release build
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise $CIRCLE_TAG
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --sign $CIRCLE_TAG
|
||||
elif [[ $CIRCLE_BRANCH == "chore/test-release-pipeline" ]]; then
|
||||
# We're testing the release pipeline
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise v6.7.0-beta1
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --sign v7.0.0-test
|
||||
elif [[ $CIRCLE_BRANCH == "master" ]]; then
|
||||
# A master build
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --build-id $CIRCLE_WORKFLOW_ID
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --sign --build-id $CIRCLE_WORKFLOW_ID
|
||||
elif [[ -n "$CIRCLE_PR_NUMBER" ]]; then
|
||||
# A forked PR build, don't sign as it requires an API secret
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --build-id $CIRCLE_WORKFLOW_ID --variants \
|
||||
linux-x64,linux-x64-musl,osx64,win64
|
||||
else
|
||||
# A PR build
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --build-id $CIRCLE_WORKFLOW_ID --variants \
|
||||
/tmp/grabpl package --jobs 2 --edition enterprise --sign --build-id $CIRCLE_WORKFLOW_ID --variants \
|
||||
linux-x64,linux-x64-musl,osx64,win64
|
||||
fi
|
||||
- run:
|
||||
@@ -597,6 +622,14 @@ jobs:
|
||||
# This version is necessary for building cross-platform images
|
||||
version: 18.09.3
|
||||
- install-grabpl
|
||||
- run:
|
||||
name: Install gcloud SDK
|
||||
command: |
|
||||
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | \
|
||||
sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
|
||||
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | \
|
||||
sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
|
||||
sudo apt-get update && sudo apt-get install google-cloud-sdk
|
||||
# XXX: Is this necessary?
|
||||
- run: docker run --privileged linuxkit/binfmt:v0.6
|
||||
- run:
|
||||
@@ -760,7 +793,7 @@ jobs:
|
||||
- run:
|
||||
# Important: all words have to be in lowercase, and separated by "\n".
|
||||
name: exclude known exceptions
|
||||
command: 'echo -e "unknwon\nreferer\nerrorstring\neror" > words_to_ignore.txt'
|
||||
command: 'echo -e "unknwon\nreferer\nerrorstring\neror\niam" > words_to_ignore.txt'
|
||||
- run:
|
||||
name: check documentation spelling errors
|
||||
command: "codespell -I ./words_to_ignore.txt docs/"
|
||||
@@ -919,6 +952,14 @@ jobs:
|
||||
- run:
|
||||
name: npm - Prepare auth token
|
||||
command: "echo //registry.npmjs.org/:_authToken=$NPM_TOKEN >> ~/.npmrc"
|
||||
- run:
|
||||
name: Exit if release pipeline test
|
||||
command: |
|
||||
if [[ $CIRCLE_BRANCH == "chore/test-release-pipeline" ]]; then
|
||||
# We're testing the release pipeline
|
||||
echo "We're testing the release pipeline, so stopping before publishing"
|
||||
circleci step halt
|
||||
fi
|
||||
- run:
|
||||
name: Release packages
|
||||
command: ./scripts/build/release-packages.sh "${CIRCLE_TAG}"
|
||||
@@ -991,172 +1032,146 @@ workflows:
|
||||
variant: armv6
|
||||
name: build-oss-backend-armv6
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
edition: oss
|
||||
variant: armv7
|
||||
name: build-oss-backend-armv7
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
edition: oss
|
||||
variant: armv7-musl
|
||||
name: build-oss-backend-armv7-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
edition: oss
|
||||
variant: arm64
|
||||
name: build-oss-backend-arm64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
edition: oss
|
||||
variant: arm64-musl
|
||||
name: build-oss-backend-arm64-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
edition: oss
|
||||
variant: osx64
|
||||
name: build-oss-backend-osx64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
edition: oss
|
||||
variant: win64
|
||||
name: build-oss-backend-win64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
edition: oss
|
||||
variant: linux-x64
|
||||
name: build-oss-backend-linux-x64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
edition: oss
|
||||
variant: linux-x64-musl
|
||||
name: build-oss-backend-linux-x64-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-frontend:
|
||||
filters: *filter-all
|
||||
name: build-oss-frontend
|
||||
edition: oss
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- build-plugins:
|
||||
filters: *filter-all
|
||||
name: build-oss-plugins
|
||||
edition: oss
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
name: build-enterprise-backend-armv6
|
||||
edition: enterprise
|
||||
variant: armv6
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
name: build-enterprise-backend-armv7
|
||||
edition: enterprise
|
||||
variant: armv7
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
name: build-enterprise-backend-armv7-musl
|
||||
edition: enterprise
|
||||
variant: armv7-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
name: build-enterprise-backend-arm64
|
||||
edition: enterprise
|
||||
variant: arm64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-master-or-release
|
||||
name: build-enterprise-backend-arm64-musl
|
||||
edition: enterprise
|
||||
variant: arm64-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-backend-osx64
|
||||
edition: enterprise
|
||||
variant: osx64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-backend-win64
|
||||
edition: enterprise
|
||||
variant: win64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-backend-linux-x64
|
||||
edition: enterprise
|
||||
variant: linux-x64
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-backend:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-backend-linux-x64-musl
|
||||
edition: enterprise
|
||||
variant: linux-x64-musl
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-frontend:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-frontend
|
||||
edition: enterprise
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- build-plugins:
|
||||
filters: *filter-all
|
||||
name: build-enterprise-plugins
|
||||
edition: enterprise
|
||||
requires:
|
||||
- test-backend
|
||||
- test-frontend
|
||||
- lint-go
|
||||
- build-release-publisher:
|
||||
filters: *filter-master-or-release
|
||||
- codespell:
|
||||
|
||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -111,9 +111,9 @@ compilation-stats.json
|
||||
/packages/grafana-e2e/cypress/videos
|
||||
/packages/grafana-e2e/cypress/logs
|
||||
/e2e/server.log
|
||||
/e2e/suite1/screenshots
|
||||
!/e2e/suite1/screenshots/expeced/*
|
||||
/e2e/suite1/videos/*
|
||||
/e2e/**/screenshots
|
||||
!/e2e/**/screenshots/expeced/*
|
||||
/e2e/**/videos/*
|
||||
|
||||
# report dumping the whole system env
|
||||
/report.*.json
|
||||
|
||||
88
CHANGELOG.md
88
CHANGELOG.md
@@ -6,12 +6,14 @@
|
||||
- **Docker**: Our Ubuntu based images have been upgraded to Ubuntu [20.04 LTS](https://releases.ubuntu.com/20.04/).
|
||||
- **Dashboard**: A global minimum dashboard refresh interval is now enforced and defaults to 5 seconds.
|
||||
- **@grafana/ui**: Forms migration notice, see [@grafana/ui changelog](https://github.com/grafana/grafana/blob/master/packages/grafana-ui/CHANGELOG.md)
|
||||
- **@grafana/ui**: Select API change for creating custom values, see [@grafana/ui changelog](https://github.com/grafana/grafana/blob/master/packages/grafana-ui/CHANGELOG.md)
|
||||
- **Interval calculation**: There is now a new option `Max data points` that controls the auto interval `$__interval` calculation. Interval was previously calculated by dividing the panel width by the time range. With the new max data points option it is now easy to set `$__interval` to a dynamic value that is time range agnostic. For example if you set `Max data points` to 10 Grafana will dynamically set `$__interval` by dividing the current time range by 10.
|
||||
- **Datasource/Loki**: Support for [deprecated Loki endpoints](https://github.com/grafana/loki/blob/master/docs/api.md#lokis-http-api) has been removed.
|
||||
|
||||
**Deprecation warnings**
|
||||
|
||||
- Scripted dashboards is now deprecated. The feature is not removed but will be in a future release. We hope to address the underlying requirement of dynamic dashboards in a different way. [#24059](https://github.com/grafana/grafana/issues/24059)
|
||||
- The unofficial first version of backend plugins together with usage of [grafana/grafana-plugin-model](https://github.com/grafana/grafana-plugin-model) is now deprecated and support for that will be removed in a future release. Please refer to [backend plugins documentation](https://grafana.com/docs/grafana/latest/developers/plugins/backend/) for information about the new officially supported backend plugins.
|
||||
|
||||
## 7.0 Feature highlights
|
||||
|
||||
@@ -43,10 +45,14 @@ This new option architecture and UI will make all panels have a consistent set o
|
||||
|
||||
We have yet to migrate all core panels to this new architecture so in 7.0 there will sadly be some big inconsistencies in the UI between panels. Hopefully this will be fixed soon in future releases as we update all the core panels and help the community update the community panel plugins.
|
||||
|
||||
### New tabel panel
|
||||
### New table panel
|
||||
|
||||
Grafana 7.0 comes with a new table panel (and deprecates the old one). This new table panel supports horizontal scrolling and column resize. Paired with the new `Organize fields` transformation detailed above you can reorder, hide & rename columns. This new panel also supports new cell display modes, like showing a bar gauge inside a cell.
|
||||
|
||||
### Panel inspector
|
||||
|
||||
The panel inspector is a feature that every panel will support, including internal as well as external community plugins. In this new panel inspector, you can view the raw data in a table format, apply some pre-defined transformations, and download as CSV. You can find the __Inspect__ setting in the panel menu. Use the keyboard shortcut `i` when hovering over a panel to get the panel inspector to appear.
|
||||
|
||||
### Improved time zone support
|
||||
|
||||
Starting in version 7.0, you can override the time zone used to display date and time values in a dashboard.
|
||||
@@ -55,6 +61,19 @@ With this feature, you can specify the local time zone of the service or system
|
||||
|
||||
We have also extended the time zone options so you can select any of the standard [ISO 8601 time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
||||
|
||||
# 7.0.0-beta3 (2020-05-08)
|
||||
|
||||
### Features / Enhancements
|
||||
|
||||
- **Docker**: Upgrade to Alpine 3.11. [#24056](https://github.com/grafana/grafana/pull/24056), [@aknuds1](https://github.com/aknuds1)
|
||||
- **Forms**: Remove Forms namespace [BREAKING]. Will cause all `Forms` imports to stop working. See migration guide in [@grafana/ui changelog](https://github.com/grafana/grafana/blob/master/packages/grafana-ui/CHANGELOG.md)[#24378](https://github.com/grafana/grafana/pull/24378), [@tskarhed](https://github.com/tskarhed)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **CloudWatch**: Fix error with expression only query. [#24362](https://github.com/grafana/grafana/pull/24362), [@aocenas](https://github.com/aocenas)
|
||||
- **Elasticsearch**: Fix building of raw document queries resulting in error Unknown BaseAggregationBuilder error. [#24403](https://github.com/grafana/grafana/pull/24403), [@ivanahuckova](https://github.com/ivanahuckova)
|
||||
- **Prometheus**: Fix for prometheus legend formats for instant time series queries. [#24407](https://github.com/grafana/grafana/pull/24407), [@torkelo](https://github.com/torkelo)
|
||||
|
||||
# 7.0.0-beta2 (2020-05-07)
|
||||
|
||||
## Breaking changes
|
||||
@@ -72,42 +91,42 @@ We have also extended the time zone options so you can select any of the standar
|
||||
|
||||
### Features / Enhancements
|
||||
|
||||
* **CloudWatch**: Adds more examples to CloudWatch Logs cheatsheet. [#24288](https://github.com/grafana/grafana/pull/24288), [@kaydelaney](https://github.com/kaydelaney)
|
||||
* **Elasticsearch**: Changes terms min_doc_count default from 1 to 0. [#24204](https://github.com/grafana/grafana/pull/24204), [@Estrax](https://github.com/Estrax)
|
||||
* **Login Page**: New design. [#23892](https://github.com/grafana/grafana/pull/23892), [@torkelo](https://github.com/torkelo)
|
||||
* **Logs**: Add log level Fatal. [#24185](https://github.com/grafana/grafana/pull/24185), [@davkal](https://github.com/davkal)
|
||||
* **Loki**: Show loki datasource stats in panel inspector. [#24190](https://github.com/grafana/grafana/pull/24190), [@davkal](https://github.com/davkal)
|
||||
* **Migration**: Dashboard links. [#23553](https://github.com/grafana/grafana/pull/23553), [@peterholmberg](https://github.com/peterholmberg)
|
||||
* **Plugins**: Require signing of external back-end plugins. [#24075](https://github.com/grafana/grafana/pull/24075), [@aknuds1](https://github.com/aknuds1)
|
||||
* **Prometheus**: Add off switch for metric/label name lookup. [#24034](https://github.com/grafana/grafana/pull/24034), [@s-h-a-d-o-w](https://github.com/s-h-a-d-o-w)
|
||||
* **Search**: Bring back open search by clicking dashboard name. [#24151](https://github.com/grafana/grafana/pull/24151), [@torkelo](https://github.com/torkelo)
|
||||
* **Tracing**: Header updates. [#24153](https://github.com/grafana/grafana/pull/24153), [@aocenas](https://github.com/aocenas)
|
||||
* **Transformations**: Improve time series support. [#23978](https://github.com/grafana/grafana/pull/23978), [@ryantxu](https://github.com/ryantxu)
|
||||
- **CloudWatch**: Adds more examples to CloudWatch Logs cheatsheet. [#24288](https://github.com/grafana/grafana/pull/24288), [@kaydelaney](https://github.com/kaydelaney)
|
||||
- **Elasticsearch**: Changes terms min_doc_count default from 1 to 0. [#24204](https://github.com/grafana/grafana/pull/24204), [@Estrax](https://github.com/Estrax)
|
||||
- **Login Page**: New design. [#23892](https://github.com/grafana/grafana/pull/23892), [@torkelo](https://github.com/torkelo)
|
||||
- **Logs**: Add log level Fatal. [#24185](https://github.com/grafana/grafana/pull/24185), [@davkal](https://github.com/davkal)
|
||||
- **Loki**: Show loki datasource stats in panel inspector. [#24190](https://github.com/grafana/grafana/pull/24190), [@davkal](https://github.com/davkal)
|
||||
- **Migration**: Dashboard links. [#23553](https://github.com/grafana/grafana/pull/23553), [@peterholmberg](https://github.com/peterholmberg)
|
||||
- **Plugins**: Require signing of external back-end plugins. [#24075](https://github.com/grafana/grafana/pull/24075), [@aknuds1](https://github.com/aknuds1)
|
||||
- **Prometheus**: Add off switch for metric/label name lookup. [#24034](https://github.com/grafana/grafana/pull/24034), [@s-h-a-d-o-w](https://github.com/s-h-a-d-o-w)
|
||||
- **Search**: Bring back open search by clicking dashboard name. [#24151](https://github.com/grafana/grafana/pull/24151), [@torkelo](https://github.com/torkelo)
|
||||
- **Tracing**: Header updates. [#24153](https://github.com/grafana/grafana/pull/24153), [@aocenas](https://github.com/aocenas)
|
||||
- **Transformations**: Improve time series support. [#23978](https://github.com/grafana/grafana/pull/23978), [@ryantxu](https://github.com/ryantxu)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **CloudWatch logs**: Fix default region interpolation and reset log groups on region change. [#24346](https://github.com/grafana/grafana/pull/24346), [@aocenas](https://github.com/aocenas)
|
||||
* **Dashboard**: Fix for folder picker menu not being visible outside modal when saving dashboard. [#24296](https://github.com/grafana/grafana/pull/24296), [@tskarhed](https://github.com/tskarhed)
|
||||
* **Dashboard**: Go to explore now works even after discarding dashboard changes. [#24149](https://github.com/grafana/grafana/pull/24149), [@torkelo](https://github.com/torkelo)
|
||||
* **Dashboard**: Only show cache timeout option in panel edit if enabled in data source plugin json. [#24095](https://github.com/grafana/grafana/pull/24095), [@peterholmberg](https://github.com/peterholmberg)
|
||||
* **Dashboard**: Propagate unhandled errors when saving dashboard. [#24081](https://github.com/grafana/grafana/pull/24081), [@peterholmberg](https://github.com/peterholmberg)
|
||||
* **Dashboard**: Variable without a current value in json model causes crash on load. [#24261](https://github.com/grafana/grafana/pull/24261), [@torkelo](https://github.com/torkelo)
|
||||
* **DashboardManager**: Disable editing if there are no folder permissions. [#24237](https://github.com/grafana/grafana/pull/24237), [@tskarhed](https://github.com/tskarhed)
|
||||
* **DataLinks**: Do not add empty links. [#24088](https://github.com/grafana/grafana/pull/24088), [@dprokop](https://github.com/dprokop)
|
||||
* **Explore/Loki**: Removes old query syntax support for regex filter. [#24281](https://github.com/grafana/grafana/pull/24281), [@Estrax](https://github.com/Estrax)
|
||||
* **Explore**: Fix showing of results of queries in table. [#24018](https://github.com/grafana/grafana/pull/24018), [@ivanahuckova](https://github.com/ivanahuckova)
|
||||
* **Field options**: show field name when title option config is empty. [#24335](https://github.com/grafana/grafana/pull/24335), [@dprokop](https://github.com/dprokop)
|
||||
* **Graph**: Fixed graph tooltip getting stuck / not being cleared when leaving dashboard. [#24162](https://github.com/grafana/grafana/pull/24162), [@torkelo](https://github.com/torkelo)
|
||||
* **Graph**: Fixed issue with x-axis labels showing "MM/DD" after viewing dashboard with pie chart. [#24341](https://github.com/grafana/grafana/pull/24341), [@mckn](https://github.com/mckn)
|
||||
* **Jaeger**: Fix how label is created in cascader. [#24164](https://github.com/grafana/grafana/pull/24164), [@aocenas](https://github.com/aocenas)
|
||||
* **Loki**: Fix label matcher for log metrics queries. [#24238](https://github.com/grafana/grafana/pull/24238), [@ivanahuckova](https://github.com/ivanahuckova)
|
||||
* **Panel inspect**: hides Query tab for plugins without Query ability. [#24216](https://github.com/grafana/grafana/pull/24216), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
* **Prometheus**: Refresh query field metrics on data source change. [#24116](https://github.com/grafana/grafana/pull/24116), [@s-h-a-d-o-w](https://github.com/s-h-a-d-o-w)
|
||||
* **Select**: Fixes so component loses focus on selecting value or pressing outside of input. [#24008](https://github.com/grafana/grafana/pull/24008), [@mckn](https://github.com/mckn)
|
||||
* **Stat/Gauge/BarGauge**: Shows default cursor when missing links. [#24284](https://github.com/grafana/grafana/pull/24284), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
* **Tracing**: Fix view bounds after trace change. [#23994](https://github.com/grafana/grafana/pull/23994), [@aocenas](https://github.com/aocenas)
|
||||
* **Variables**: Migrates old tags format for consistency. [#24276](https://github.com/grafana/grafana/pull/24276), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
* **Reporting**: Update report schedule as soon as a report is updated (Enterprise)
|
||||
- **CloudWatch logs**: Fix default region interpolation and reset log groups on region change. [#24346](https://github.com/grafana/grafana/pull/24346), [@aocenas](https://github.com/aocenas)
|
||||
- **Dashboard**: Fix for folder picker menu not being visible outside modal when saving dashboard. [#24296](https://github.com/grafana/grafana/pull/24296), [@tskarhed](https://github.com/tskarhed)
|
||||
- **Dashboard**: Go to explore now works even after discarding dashboard changes. [#24149](https://github.com/grafana/grafana/pull/24149), [@torkelo](https://github.com/torkelo)
|
||||
- **Dashboard**: Only show cache timeout option in panel edit if enabled in data source plugin json. [#24095](https://github.com/grafana/grafana/pull/24095), [@peterholmberg](https://github.com/peterholmberg)
|
||||
- **Dashboard**: Propagate unhandled errors when saving dashboard. [#24081](https://github.com/grafana/grafana/pull/24081), [@peterholmberg](https://github.com/peterholmberg)
|
||||
- **Dashboard**: Variable without a current value in json model causes crash on load. [#24261](https://github.com/grafana/grafana/pull/24261), [@torkelo](https://github.com/torkelo)
|
||||
- **DashboardManager**: Disable editing if there are no folder permissions. [#24237](https://github.com/grafana/grafana/pull/24237), [@tskarhed](https://github.com/tskarhed)
|
||||
- **DataLinks**: Do not add empty links. [#24088](https://github.com/grafana/grafana/pull/24088), [@dprokop](https://github.com/dprokop)
|
||||
- **Explore/Loki**: Removes old query syntax support for regex filter. [#24281](https://github.com/grafana/grafana/pull/24281), [@Estrax](https://github.com/Estrax)
|
||||
- **Explore**: Fix showing of results of queries in table. [#24018](https://github.com/grafana/grafana/pull/24018), [@ivanahuckova](https://github.com/ivanahuckova)
|
||||
- **Field options**: show field name when title option config is empty. [#24335](https://github.com/grafana/grafana/pull/24335), [@dprokop](https://github.com/dprokop)
|
||||
- **Graph**: Fixed graph tooltip getting stuck / not being cleared when leaving dashboard. [#24162](https://github.com/grafana/grafana/pull/24162), [@torkelo](https://github.com/torkelo)
|
||||
- **Graph**: Fixed issue with x-axis labels showing "MM/DD" after viewing dashboard with pie chart. [#24341](https://github.com/grafana/grafana/pull/24341), [@mckn](https://github.com/mckn)
|
||||
- **Jaeger**: Fix how label is created in cascader. [#24164](https://github.com/grafana/grafana/pull/24164), [@aocenas](https://github.com/aocenas)
|
||||
- **Loki**: Fix label matcher for log metrics queries. [#24238](https://github.com/grafana/grafana/pull/24238), [@ivanahuckova](https://github.com/ivanahuckova)
|
||||
- **Panel inspect**: hides Query tab for plugins without Query ability. [#24216](https://github.com/grafana/grafana/pull/24216), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
- **Prometheus**: Refresh query field metrics on data source change. [#24116](https://github.com/grafana/grafana/pull/24116), [@s-h-a-d-o-w](https://github.com/s-h-a-d-o-w)
|
||||
- **Select**: Fixes so component loses focus on selecting value or pressing outside of input. [#24008](https://github.com/grafana/grafana/pull/24008), [@mckn](https://github.com/mckn)
|
||||
- **Stat/Gauge/BarGauge**: Shows default cursor when missing links. [#24284](https://github.com/grafana/grafana/pull/24284), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
- **Tracing**: Fix view bounds after trace change. [#23994](https://github.com/grafana/grafana/pull/23994), [@aocenas](https://github.com/aocenas)
|
||||
- **Variables**: Migrates old tags format for consistency. [#24276](https://github.com/grafana/grafana/pull/24276), [@hugohaggmark](https://github.com/hugohaggmark)
|
||||
- **Reporting**: Update report schedule as soon as a report is updated (Enterprise)
|
||||
|
||||
# 7.0.0-beta1 (2020-04-28)
|
||||
|
||||
@@ -117,6 +136,7 @@ We have also extended the time zone options so you can select any of the standar
|
||||
- **Docker**: Our Ubuntu based images have been upgraded to Ubuntu [20.04 LTS](https://releases.ubuntu.com/20.04/).
|
||||
- **Dashboard**: A global minimum dashboard refresh interval is now enforced and defaults to 5 seconds.
|
||||
- **@grafana/ui**: Forms migration notice, see [@grafana/ui changelog](https://github.com/grafana/grafana/blob/master/packages/grafana-ui/CHANGELOG.md)
|
||||
- **@grafana/ui**: Select API change for creating custom values, see [@grafana/ui changelog](https://github.com/grafana/grafana/blob/master/packages/grafana-ui/CHANGELOG.md)
|
||||
- **Interval calculation**: There is now a new option `Max data points` that controls the auto interval `$__interval` calculation. Interval was previously calculated by dividing the panel width by the time range. With the new max data points option it is now easy to set `$__interval` to a dynamic value that is time range agnostic. For example if you set `Max data points` to 10 Grafana will dynamically set `$__interval` by dividing the current time range by 10.
|
||||
- **Datasource/Loki**: Support for [deprecated Loki endpoints](https://github.com/grafana/loki/blob/master/docs/api.md#lokis-http-api) has been removed.
|
||||
|
||||
|
||||
602
devenv/dev-dashboards/panel-table/table_tests_new.json
Normal file
602
devenv/dev-dashboards/panel-table/table_tests_new.json
Normal file
@@ -0,0 +1,602 @@
|
||||
{
|
||||
"annotations": {
|
||||
"list": [
|
||||
{
|
||||
"builtIn": 1,
|
||||
"datasource": "-- Grafana --",
|
||||
"enable": true,
|
||||
"hide": true,
|
||||
"iconColor": "rgba(0, 211, 255, 1)",
|
||||
"name": "Annotations & Alerts",
|
||||
"type": "dashboard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"editable": true,
|
||||
"gnetId": null,
|
||||
"graphTooltip": 0,
|
||||
"links": [],
|
||||
"panels": [
|
||||
{
|
||||
"datasource": null,
|
||||
"gridPos": {
|
||||
"h": 1,
|
||||
"w": 24,
|
||||
"x": 0,
|
||||
"y": 0
|
||||
},
|
||||
"id": 7,
|
||||
"title": "Cell styles",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": "gdev-testdata",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {
|
||||
"align": "center",
|
||||
"displayMode": "color-background"
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "percentage",
|
||||
"steps": [
|
||||
{
|
||||
"color": "green",
|
||||
"value": null
|
||||
},
|
||||
{
|
||||
"color": "blue",
|
||||
"value": 20
|
||||
},
|
||||
{
|
||||
"color": "orange",
|
||||
"value": 60
|
||||
},
|
||||
{
|
||||
"color": "red",
|
||||
"value": 70
|
||||
}
|
||||
]
|
||||
},
|
||||
"unit": "degree"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Max"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 84
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Last"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 78
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Mean"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 74
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Field"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.align",
|
||||
"value": "left"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"gridPos": {
|
||||
"h": 16,
|
||||
"w": 7,
|
||||
"x": 0,
|
||||
"y": 1
|
||||
},
|
||||
"id": 4,
|
||||
"options": {
|
||||
"showHeader": true,
|
||||
"sortBy": [
|
||||
{
|
||||
"desc": true,
|
||||
"displayName": "Last"
|
||||
}
|
||||
]
|
||||
},
|
||||
"pluginVersion": "7.1.0-pre",
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "random_walk",
|
||||
"seriesCount": 15,
|
||||
"stringInput": ""
|
||||
}
|
||||
],
|
||||
"timeFrom": null,
|
||||
"timeShift": null,
|
||||
"title": "Colored background",
|
||||
"transformations": [
|
||||
{
|
||||
"id": "reduce",
|
||||
"options": {
|
||||
"reducers": ["max", "mean", "last"]
|
||||
}
|
||||
}
|
||||
],
|
||||
"type": "table"
|
||||
},
|
||||
{
|
||||
"datasource": "gdev-testdata",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {
|
||||
"align": null
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "percentage",
|
||||
"steps": [
|
||||
{
|
||||
"color": "orange",
|
||||
"value": null
|
||||
},
|
||||
{
|
||||
"color": "red",
|
||||
"value": 50
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Value"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.displayMode",
|
||||
"value": "gradient-gauge"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Info"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 92
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Min"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 76
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Max"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 89
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Time"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.width",
|
||||
"value": 165
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"gridPos": {
|
||||
"h": 16,
|
||||
"w": 8,
|
||||
"x": 7,
|
||||
"y": 1
|
||||
},
|
||||
"id": 2,
|
||||
"options": {
|
||||
"showHeader": true,
|
||||
"sortBy": [
|
||||
{
|
||||
"desc": false,
|
||||
"displayName": "Min"
|
||||
}
|
||||
]
|
||||
},
|
||||
"pluginVersion": "7.1.0-pre",
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "random_walk_table",
|
||||
"stringInput": ""
|
||||
}
|
||||
],
|
||||
"timeFrom": null,
|
||||
"timeShift": null,
|
||||
"title": "Bar gauge cells",
|
||||
"transformations": [
|
||||
{
|
||||
"id": "organize",
|
||||
"options": {
|
||||
"excludeByName": {
|
||||
"Time": true
|
||||
},
|
||||
"indexByName": {
|
||||
"Info": 1,
|
||||
"Max": 3,
|
||||
"Min": 2,
|
||||
"Time": 0,
|
||||
"Value": 4
|
||||
},
|
||||
"renameByName": {}
|
||||
}
|
||||
}
|
||||
],
|
||||
"type": "table"
|
||||
},
|
||||
{
|
||||
"datasource": "gdev-testdata",
|
||||
"description": "",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {
|
||||
"align": null
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "percentage",
|
||||
"steps": [
|
||||
{
|
||||
"color": "blue",
|
||||
"value": null
|
||||
},
|
||||
{
|
||||
"color": "green",
|
||||
"value": 50
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Value"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.displayMode",
|
||||
"value": "lcd-gauge"
|
||||
},
|
||||
{
|
||||
"id": "custom.align",
|
||||
"value": "center"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"gridPos": {
|
||||
"h": 16,
|
||||
"w": 9,
|
||||
"x": 15,
|
||||
"y": 1
|
||||
},
|
||||
"id": 5,
|
||||
"options": {
|
||||
"showHeader": true,
|
||||
"sortBy": []
|
||||
},
|
||||
"pluginVersion": "7.1.0-pre",
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "random_walk_table",
|
||||
"stringInput": ""
|
||||
}
|
||||
],
|
||||
"timeFrom": null,
|
||||
"timeShift": null,
|
||||
"title": "Retro LCD cell",
|
||||
"transformations": [
|
||||
{
|
||||
"id": "organize",
|
||||
"options": {
|
||||
"excludeByName": {
|
||||
"Info": false,
|
||||
"Max": true,
|
||||
"Min": true,
|
||||
"Time": false
|
||||
},
|
||||
"indexByName": {
|
||||
"Info": 1,
|
||||
"Max": 3,
|
||||
"Min": 2,
|
||||
"Time": 0,
|
||||
"Value": 4
|
||||
},
|
||||
"renameByName": {}
|
||||
}
|
||||
}
|
||||
],
|
||||
"type": "table"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"datasource": null,
|
||||
"gridPos": {
|
||||
"h": 1,
|
||||
"w": 24,
|
||||
"x": 0,
|
||||
"y": 17
|
||||
},
|
||||
"id": 9,
|
||||
"panels": [],
|
||||
"title": "Data links",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": "gdev-testdata",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {
|
||||
"align": "center",
|
||||
"displayMode": "color-text"
|
||||
},
|
||||
"decimals": 2,
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "percentage",
|
||||
"steps": [
|
||||
{
|
||||
"color": "green",
|
||||
"value": null
|
||||
},
|
||||
{
|
||||
"color": "blue",
|
||||
"value": 20
|
||||
},
|
||||
{
|
||||
"color": "orange",
|
||||
"value": 50
|
||||
},
|
||||
{
|
||||
"color": "red",
|
||||
"value": 70
|
||||
}
|
||||
]
|
||||
},
|
||||
"unit": "percent"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "Time"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "custom.align",
|
||||
"value": null
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"matcher": {
|
||||
"id": "byName",
|
||||
"options": "{name=\"S1\", server=\"A\"}"
|
||||
},
|
||||
"properties": [
|
||||
{
|
||||
"id": "links",
|
||||
"value": [
|
||||
{
|
||||
"title": "Details",
|
||||
"url": "http://detail?serverLabel=${__field.labels.server}&valueNumeric=${__value.numeric}"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"gridPos": {
|
||||
"h": 8,
|
||||
"w": 12,
|
||||
"x": 0,
|
||||
"y": 18
|
||||
},
|
||||
"id": 3,
|
||||
"maxDataPoints": "10",
|
||||
"options": {
|
||||
"showHeader": true
|
||||
},
|
||||
"pluginVersion": "7.1.0-pre",
|
||||
"targets": [
|
||||
{
|
||||
"alias": "S1",
|
||||
"labels": "server=A",
|
||||
"refId": "A",
|
||||
"scenarioId": "random_walk",
|
||||
"seriesCount": 1,
|
||||
"stringInput": ""
|
||||
},
|
||||
{
|
||||
"alias": "S2",
|
||||
"labels": "server=B",
|
||||
"refId": "B",
|
||||
"scenarioId": "random_walk",
|
||||
"seriesCount": 1,
|
||||
"stringInput": ""
|
||||
},
|
||||
{
|
||||
"alias": "S3",
|
||||
"labels": "server=C",
|
||||
"refId": "C",
|
||||
"scenarioId": "random_walk",
|
||||
"seriesCount": 1,
|
||||
"stringInput": ""
|
||||
}
|
||||
],
|
||||
"timeFrom": null,
|
||||
"timeShift": null,
|
||||
"title": "Data link with labels and numeric value",
|
||||
"transformations": [
|
||||
{
|
||||
"id": "seriesToColumns",
|
||||
"options": {}
|
||||
}
|
||||
],
|
||||
"type": "table"
|
||||
},
|
||||
{
|
||||
"datasource": "gdev-testdata",
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {
|
||||
"align": "center",
|
||||
"displayMode": "auto"
|
||||
},
|
||||
"mappings": [],
|
||||
"thresholds": {
|
||||
"mode": "percentage",
|
||||
"steps": [
|
||||
{
|
||||
"color": "green",
|
||||
"value": null
|
||||
},
|
||||
{
|
||||
"color": "blue",
|
||||
"value": 20
|
||||
},
|
||||
{
|
||||
"color": "orange",
|
||||
"value": 60
|
||||
},
|
||||
{
|
||||
"color": "red",
|
||||
"value": 70
|
||||
}
|
||||
]
|
||||
},
|
||||
"unit": "degree"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": {
|
||||
"h": 8,
|
||||
"w": 5,
|
||||
"x": 12,
|
||||
"y": 18
|
||||
},
|
||||
"id": 10,
|
||||
"options": {
|
||||
"showHeader": false,
|
||||
"sortBy": [
|
||||
{
|
||||
"desc": true,
|
||||
"displayName": "Last"
|
||||
}
|
||||
]
|
||||
},
|
||||
"pluginVersion": "7.1.0-pre",
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "random_walk_table",
|
||||
"seriesCount": 5,
|
||||
"stringInput": ""
|
||||
}
|
||||
],
|
||||
"timeFrom": null,
|
||||
"timeShift": null,
|
||||
"title": "No header",
|
||||
"transformations": [
|
||||
{
|
||||
"id": "organize",
|
||||
"options": {
|
||||
"excludeByName": {
|
||||
"Min": true,
|
||||
"Time": true,
|
||||
"Value": true
|
||||
},
|
||||
"indexByName": {
|
||||
"Info": 2,
|
||||
"Max": 4,
|
||||
"Min": 3,
|
||||
"Time": 0,
|
||||
"Value": 1
|
||||
},
|
||||
"renameByName": {}
|
||||
}
|
||||
}
|
||||
],
|
||||
"type": "table"
|
||||
}
|
||||
],
|
||||
"schemaVersion": 25,
|
||||
"style": "dark",
|
||||
"tags": ["gdev", "panel-tests"],
|
||||
"templating": {
|
||||
"list": []
|
||||
},
|
||||
"time": {
|
||||
"from": "now-6h",
|
||||
"to": "now"
|
||||
},
|
||||
"timepicker": {
|
||||
"refresh_intervals": ["10s", "30s", "1m", "5m", "15m", "30m", "1h", "2h", "1d"]
|
||||
},
|
||||
"timezone": "",
|
||||
"title": "Panel Tests - React Table",
|
||||
"uid": "U_bZIMRMk",
|
||||
"version": 17
|
||||
}
|
||||
695
devenv/dev-dashboards/scenarios/time_zone_support.json
Normal file
695
devenv/dev-dashboards/scenarios/time_zone_support.json
Normal file
@@ -0,0 +1,695 @@
|
||||
{
|
||||
"annotations": {
|
||||
"list": [
|
||||
{
|
||||
"builtIn": 1,
|
||||
"datasource": "-- Grafana --",
|
||||
"enable": true,
|
||||
"hide": true,
|
||||
"iconColor": "rgba(0, 211, 255, 1)",
|
||||
"name": "Annotations & Alerts",
|
||||
"type": "dashboard"
|
||||
}
|
||||
]
|
||||
},
|
||||
"editable": true,
|
||||
"gnetId": null,
|
||||
"graphTooltip": 0,
|
||||
"id": 28,
|
||||
"links": [],
|
||||
"panels": [
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"editable": true,
|
||||
"error": false,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 1,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 7,
|
||||
"w": 12,
|
||||
"x": 0,
|
||||
"y": 0
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 4,
|
||||
"legend": {
|
||||
"avg": false,
|
||||
"current": false,
|
||||
"max": false,
|
||||
"min": false,
|
||||
"show": true,
|
||||
"total": false,
|
||||
"values": false
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 2,
|
||||
"links": [],
|
||||
"nullPointMode": "connected",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [],
|
||||
"spaceLength": 10,
|
||||
"stack": false,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenario": "random_walk",
|
||||
"scenarioId": "random_walk",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": "2s",
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "Millisecond res x-axis and tooltip",
|
||||
"tooltip": {
|
||||
"msResolution": false,
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "cumulative"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"editable": true,
|
||||
"error": false,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 1,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 7,
|
||||
"w": 12,
|
||||
"x": 12,
|
||||
"y": 0
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 3,
|
||||
"legend": {
|
||||
"avg": false,
|
||||
"current": false,
|
||||
"max": false,
|
||||
"min": false,
|
||||
"show": true,
|
||||
"total": false,
|
||||
"values": false
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 2,
|
||||
"links": [],
|
||||
"nullPointMode": "connected",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [],
|
||||
"spaceLength": 10,
|
||||
"stack": false,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenario": "random_walk",
|
||||
"scenarioId": "random_walk",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": null,
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "Random walk series",
|
||||
"tooltip": {
|
||||
"msResolution": false,
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "cumulative"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"editable": true,
|
||||
"error": false,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 1,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 8,
|
||||
"w": 12,
|
||||
"x": 0,
|
||||
"y": 7
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 5,
|
||||
"legend": {
|
||||
"avg": false,
|
||||
"current": false,
|
||||
"max": false,
|
||||
"min": false,
|
||||
"show": true,
|
||||
"total": false,
|
||||
"values": false
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 2,
|
||||
"links": [],
|
||||
"nullPointMode": "connected",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [
|
||||
{
|
||||
"alias": "B-series",
|
||||
"yaxis": 2
|
||||
}
|
||||
],
|
||||
"spaceLength": 10,
|
||||
"stack": false,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,0",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"refId": "B",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "2000,3000,4000,1000,3000,10000",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": null,
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "2 yaxis and axis labels",
|
||||
"tooltip": {
|
||||
"msResolution": false,
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "cumulative"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "percent",
|
||||
"label": "Perecent",
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": "Pressure",
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"editable": true,
|
||||
"error": false,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 1,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 8,
|
||||
"w": 12,
|
||||
"x": 12,
|
||||
"y": 7
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 9,
|
||||
"legend": {
|
||||
"avg": false,
|
||||
"current": false,
|
||||
"max": false,
|
||||
"min": false,
|
||||
"show": true,
|
||||
"total": false,
|
||||
"values": false
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 2,
|
||||
"links": [],
|
||||
"nullPointMode": "null",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [
|
||||
{
|
||||
"alias": "B-series",
|
||||
"zindex": -3
|
||||
}
|
||||
],
|
||||
"spaceLength": 10,
|
||||
"stack": true,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"hide": false,
|
||||
"refId": "B",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,null,null,null,null,null,null,100,10,10,20,30,40,10",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"alias": "",
|
||||
"hide": false,
|
||||
"refId": "A",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,10,20,30,40,40,40,100,10,20,20",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"alias": "",
|
||||
"hide": false,
|
||||
"refId": "C",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,10,20,30,40,40,40,100,10,20,20",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": null,
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "Stacking value ontop of nulls",
|
||||
"tooltip": {
|
||||
"msResolution": false,
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "cumulative"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"editable": true,
|
||||
"error": false,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 0,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 7,
|
||||
"w": 12,
|
||||
"x": 0,
|
||||
"y": 15
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 21,
|
||||
"legend": {
|
||||
"avg": false,
|
||||
"current": false,
|
||||
"max": false,
|
||||
"min": false,
|
||||
"show": true,
|
||||
"total": false,
|
||||
"values": false
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 2,
|
||||
"links": [],
|
||||
"nullPointMode": "null",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [
|
||||
{
|
||||
"alias": "C-series",
|
||||
"steppedLine": true
|
||||
}
|
||||
],
|
||||
"spaceLength": 10,
|
||||
"stack": false,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"alias": "",
|
||||
"hide": false,
|
||||
"refId": "B",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,null,40,null,90,null,null,100,null,null,100,null,null,80,null",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"alias": "",
|
||||
"hide": false,
|
||||
"refId": "C",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "20,null40,null,null,50,null,70,null,100,null,10,null,30,null",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": null,
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "Null between points",
|
||||
"tooltip": {
|
||||
"msResolution": false,
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "cumulative"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"aliasColors": {},
|
||||
"bars": false,
|
||||
"dashLength": 10,
|
||||
"dashes": false,
|
||||
"datasource": "gdev-testdata",
|
||||
"decimals": 3,
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"custom": {}
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"fill": 1,
|
||||
"fillGradient": 0,
|
||||
"gridPos": {
|
||||
"h": 7,
|
||||
"w": 12,
|
||||
"x": 12,
|
||||
"y": 15
|
||||
},
|
||||
"hiddenSeries": false,
|
||||
"id": 16,
|
||||
"legend": {
|
||||
"alignAsTable": true,
|
||||
"avg": true,
|
||||
"current": true,
|
||||
"max": true,
|
||||
"min": true,
|
||||
"show": true,
|
||||
"total": true,
|
||||
"values": true
|
||||
},
|
||||
"lines": true,
|
||||
"linewidth": 1,
|
||||
"links": [],
|
||||
"nullPointMode": "null",
|
||||
"options": {
|
||||
"dataLinks": []
|
||||
},
|
||||
"percentage": false,
|
||||
"pointradius": 5,
|
||||
"points": false,
|
||||
"renderer": "flot",
|
||||
"seriesOverrides": [],
|
||||
"spaceLength": 10,
|
||||
"stack": false,
|
||||
"steppedLine": false,
|
||||
"targets": [
|
||||
{
|
||||
"refId": "A",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,0",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"refId": "B",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,0",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"refId": "C",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,0",
|
||||
"target": ""
|
||||
},
|
||||
{
|
||||
"refId": "D",
|
||||
"scenarioId": "csv_metric_values",
|
||||
"stringInput": "1,20,90,30,5,0",
|
||||
"target": ""
|
||||
}
|
||||
],
|
||||
"thresholds": [],
|
||||
"timeFrom": null,
|
||||
"timeRegions": [],
|
||||
"timeShift": null,
|
||||
"title": "Legend Table No Scroll Visible",
|
||||
"tooltip": {
|
||||
"shared": true,
|
||||
"sort": 0,
|
||||
"value_type": "individual"
|
||||
},
|
||||
"type": "graph",
|
||||
"xaxis": {
|
||||
"buckets": null,
|
||||
"mode": "time",
|
||||
"name": null,
|
||||
"show": true,
|
||||
"values": []
|
||||
},
|
||||
"yaxes": [
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
},
|
||||
{
|
||||
"format": "short",
|
||||
"label": null,
|
||||
"logBase": 1,
|
||||
"max": null,
|
||||
"min": null,
|
||||
"show": true
|
||||
}
|
||||
],
|
||||
"yaxis": {
|
||||
"align": false,
|
||||
"alignLevel": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"refresh": false,
|
||||
"revision": 8,
|
||||
"schemaVersion": 25,
|
||||
"style": "dark",
|
||||
"tags": ["gdev", "panel-tests", "graph", "table"],
|
||||
"templating": {
|
||||
"list": []
|
||||
},
|
||||
"time": {
|
||||
"from": "now-1h",
|
||||
"to": "now"
|
||||
},
|
||||
"timepicker": {
|
||||
"refresh_intervals": ["10s", "30s", "1m", "5m", "15m", "30m", "1h", "2h", "1d"],
|
||||
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
|
||||
},
|
||||
"timezone": "utc",
|
||||
"title": "Panel Tests - Time zone support",
|
||||
"uid": "5SdHCasdf",
|
||||
"version": 1
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
FROM prom/prometheus:v2.7.2
|
||||
ADD prometheus.yml /etc/prometheus/
|
||||
ADD alert.rules /etc/prometheus/
|
||||
ADD recording.yml /etc/prometheus/
|
||||
ADD alert.yml /etc/prometheus/
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
# Alert Rules
|
||||
|
||||
ALERT AppCrash
|
||||
IF process_open_fds > 0
|
||||
FOR 15s
|
||||
LABELS { severity="critical" }
|
||||
ANNOTATIONS {
|
||||
summary = "Number of open fds > 0",
|
||||
description = "Just testing"
|
||||
}
|
||||
11
devenv/docker/blocks/prometheus2/alert.yml
Normal file
11
devenv/docker/blocks/prometheus2/alert.yml
Normal file
@@ -0,0 +1,11 @@
|
||||
groups:
|
||||
- name: ALERT
|
||||
rules:
|
||||
- alert: AppCrash
|
||||
expr: process_open_fds > 0
|
||||
for: 15s
|
||||
labels:
|
||||
severity: critical
|
||||
annotations:
|
||||
summary: Number of open fds > 0
|
||||
description: Just testing
|
||||
@@ -5,17 +5,17 @@ global:
|
||||
# scrape_timeout is set to the global default (10s).
|
||||
|
||||
# Load and evaluate rules in this file every 'evaluation_interval' seconds.
|
||||
#rule_files:
|
||||
# - "alert.rules"
|
||||
# - "first.rules"
|
||||
rule_files:
|
||||
- "alert.yml"
|
||||
- "recording.yml"
|
||||
# - "second.rules"
|
||||
|
||||
# alerting:
|
||||
# alertmanagers:
|
||||
# - scheme: http
|
||||
# static_configs:
|
||||
# - targets:
|
||||
# - "127.0.0.1:9093"
|
||||
alerting:
|
||||
alertmanagers:
|
||||
- scheme: http
|
||||
static_configs:
|
||||
- targets:
|
||||
- "alertmanager:9093"
|
||||
|
||||
scrape_configs:
|
||||
- job_name: 'prometheus'
|
||||
|
||||
16
devenv/docker/blocks/prometheus2/recording.yml
Normal file
16
devenv/docker/blocks/prometheus2/recording.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
groups:
|
||||
- name: RECORDING_RULES
|
||||
rules:
|
||||
- record: instance_path:requests:rate5m
|
||||
expr: rate(prometheus_http_requests_total{job="prometheus"}[5m])
|
||||
- record: path:requests:rate5m
|
||||
expr: sum without (instance)(instance_path:requests:rate5m{job="prometheus"})
|
||||
- record: instance_path:reloads_failures:rate5m
|
||||
expr: rate(prometheus_tsdb_reloads_failures_total{job="prometheus"}[5m])
|
||||
- record: instance_path:reloads:rate5m
|
||||
expr: rate(prometheus_tsdb_reloads_total{job="prometheus"}[5m])
|
||||
- record: instance_path:request_failures_per_requests:ratio_rate5m
|
||||
expr: |2
|
||||
instance_path:reloads_failures:rate5m{job="prometheus"}
|
||||
/
|
||||
instance_path:reloads:rate5m{job="prometheus"}
|
||||
@@ -1,9 +1,4 @@
|
||||
+++
|
||||
title = "Contribute"
|
||||
description = "Contribute"
|
||||
title = "Developers"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Contribute"
|
||||
identifier = "contribute"
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
@@ -3,9 +3,6 @@ title = "Contributor License Agreement (CLA)"
|
||||
description = "Contributor License Agreement (CLA)"
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/project/cla", "docs/contributing/cla.html"]
|
||||
[menu.docs]
|
||||
parent = "contribute"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
# Grafana Labs Contributor License Agreement
|
||||
|
||||
@@ -1,19 +1,14 @@
|
||||
+++
|
||||
title = "Developer resources"
|
||||
description = "Resources for Grafana developers"
|
||||
title = "Contribute to Grafana"
|
||||
keywords = ["grafana", "documentation", "developers", "resources"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Grafana resources"
|
||||
identifier = "Developer resources"
|
||||
weight = 30
|
||||
+++
|
||||
|
||||
# Developer resources
|
||||
# Contribute to Grafana
|
||||
|
||||
This page lists resources for developers who want to contribute to the Grafana software ecosystem or build plugins for Grafana.
|
||||
|
||||
##
|
||||
##
|
||||
General resources
|
||||
These resources are useful for all developers.
|
||||
|
||||
@@ -1,21 +1,17 @@
|
||||
+++
|
||||
title = "Build a plugin"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
parent = "developers"
|
||||
identifier = "plugins"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
# 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/_index.md" >}}).
|
||||
|
||||
## 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 "../installation/configuration/_index.md#plugins" >}}):
|
||||
Open the terminal, and run the following command in your [plugin directory]({{< relref "../../installation/configuration/_index.md#plugins" >}}):
|
||||
|
||||
```bash
|
||||
npx @grafana/toolkit plugin:create my-grafana-plugin
|
||||
@@ -23,8 +19,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]({{< relref "../../../../../tutorials/build-a-panel-plugin.md" >}})
|
||||
- [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}})
|
||||
|
||||
## Go further
|
||||
|
||||
@@ -34,8 +30,8 @@ Learn more about specific areas of plugin development.
|
||||
|
||||
Deepen your knowledge through a series of high-level overviews of plugin concepts.
|
||||
|
||||
- [Data frames]({{< relref "../plugins/developing/dataframe.md" >}})
|
||||
- [Authentication for data source plugins]({{< relref "../plugins/developing/auth-for-datasources.md" >}})
|
||||
- [Data frames]({{< relref "data-frames.md" >}})
|
||||
- [Authentication for data source plugins]({{< relref "authentication.md" >}})
|
||||
|
||||
### UI library
|
||||
|
||||
@@ -45,12 +41,12 @@ Explore the many UI components in our [Grafana UI library](https://developers.gr
|
||||
|
||||
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 panel plugin]({{< relref "../../../../../tutorials/build-a-panel-plugin.md" >}})
|
||||
- [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}})
|
||||
|
||||
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]({{< relref "../../../../../tutorials/build-a-panel-plugin-with-d3.md" >}})
|
||||
|
||||
### API reference
|
||||
|
||||
@@ -58,13 +54,13 @@ Learn more about Grafana options and packages.
|
||||
|
||||
#### Metadata
|
||||
|
||||
- [Plugin metadata]({{< relref "../plugins/developing/plugin.json.md" >}})
|
||||
- [Plugin metadata]({{< relref "metadata.md" >}})
|
||||
|
||||
#### Typescript
|
||||
|
||||
- [Grafana Data]({{< relref "../packages_api/data/_index.md" >}})
|
||||
- [Grafana Runtime]({{< relref "../packages_api/runtime/_index.md" >}})
|
||||
- [Grafana UI]({{< relref "../packages_api/ui/_index.md" >}})
|
||||
- [Grafana Data]({{< relref "../../packages_api/data/_index.md" >}})
|
||||
- [Grafana Runtime]({{< relref "../../packages_api/runtime/_index.md" >}})
|
||||
- [Grafana UI]({{< relref "../../packages_api/ui/_index.md" >}})
|
||||
|
||||
#### Go
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Authentication for Datasource Plugins"
|
||||
title = "Authentication for data source plugins"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Authentication for Datasource Plugins"
|
||||
parent = "developing"
|
||||
weight = 3
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/auth-for-datasources/"]
|
||||
+++
|
||||
|
||||
# Authentication for data source plugins
|
||||
@@ -1,14 +1,11 @@
|
||||
+++
|
||||
title = "Developing Backend Plugins"
|
||||
title = "Backend plugins"
|
||||
keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Developing Backend Plugins"
|
||||
parent = "developing"
|
||||
weight = 5
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/backend-plugins-guide/"]
|
||||
+++
|
||||
|
||||
# Backend Plugins
|
||||
# Backend plugins
|
||||
|
||||
Grafana added support for plugins in Grafana 3.0 and this enabled the Grafana community to create panel plugins and data source plugins. It was wildly successful and has made Grafana much more useful as you can integrate it with anything and do any type of custom visualization that you want. However, these plugin hooks are on the frontend only and we also want to provide hooks into the Grafana backend to allow the community to extend and improve Grafana in new ways.
|
||||
|
||||
@@ -1,13 +1,9 @@
|
||||
+++
|
||||
title = "Introduction Data frames"
|
||||
title = "Data frames"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Data frames"
|
||||
parent = "developing"
|
||||
weight = 9
|
||||
+++
|
||||
|
||||
## Introduction to data frames
|
||||
# Data frames
|
||||
|
||||
Grafana supports a variety of different data sources, each with its own data model. To make this possible, Grafana consolidates the query results from each of these data sources into one unified data structure called a _data frame_.
|
||||
|
||||
@@ -17,7 +13,7 @@ The data frame structure is a concept that's borrowed from data analysis tools l
|
||||
|
||||
This document gives an overview of the data frame structure, and of how data is handled within Grafana.
|
||||
|
||||
### The data frame
|
||||
## The data frame
|
||||
|
||||
A data frame is a columnar-oriented table structure, which means it stores data by column and not by row. To understand what this means, let’s look at the TypeScript definition used by Grafana:
|
||||
|
||||
@@ -61,25 +57,25 @@ Each field has three values, and each value in a field must share the same type.
|
||||
|
||||
One restriction on data frames is that all fields in the frame must be of the same length to be a valid data frame.
|
||||
|
||||
#### Field configuration
|
||||
### Field configuration
|
||||
|
||||
Each field in a data frame contains optional information about the values in the field, such as units, scaling, and so on.
|
||||
|
||||
By adding field configurations to a data frame, Grafana can configure visualizations automatically. For example, you could configure Grafana to automatically set the unit provided by the data source.
|
||||
|
||||
### Transformations
|
||||
## Transformations
|
||||
|
||||
Along with the type information, field configs enables _data transformations_ within Grafana.
|
||||
|
||||
A data transformation is any function that accepts a data frame as input, and returns another data frame as output. By using data frames in your plugin, you get a range of transformations for free.
|
||||
|
||||
### Data frames as time series
|
||||
## Data frames as time series
|
||||
|
||||
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](https://grafana.com/docs/grafana/latest/guides/timeseries/).
|
||||
|
||||
#### Wide format
|
||||
### Wide format
|
||||
|
||||
When a collection of time series share the same _time index_—the time fields in each time series are identical—they can be stored together, in a _wide_ format. By reusing the time field, we can reduce the amount of data being sent to the browser.
|
||||
|
||||
@@ -126,7 +122,7 @@ Dimensions: 2 fields by 2 rows
|
||||
|
||||
The wide format can typically be used when multiple time series are collected by the same process. In this case, every measurement is made at the same interval and will therefore share the same time values.
|
||||
|
||||
#### Long format
|
||||
### Long format
|
||||
|
||||
Some data sources return data in a _long_ format (also called _narrow_ format). This is common format returned by, for example, SQL databases.
|
||||
|
||||
@@ -1,14 +1,12 @@
|
||||
+++
|
||||
title = "Developer Guide"
|
||||
title = "Legacy plugins"
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/plugins/development/", "/docs/grafana/latest/plugins/datasources/", "/docs/grafana/latest/plugins/apps/", "/docs/grafana/latest/plugins/panels/"]
|
||||
[menu.docs]
|
||||
name = "Developer Guide"
|
||||
parent = "developing"
|
||||
weight = 1
|
||||
aliases = ["/docs/grafana/latest/plugins/development/", "/docs/grafana/latest/plugins/datasources/", "/docs/grafana/latest/plugins/apps/", "/docs/grafana/latest/plugins/panels/", "/docs/grafana/latest/plugins/developing/development/"]
|
||||
+++
|
||||
|
||||
# Developer Guide
|
||||
# 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" >}}).
|
||||
|
||||
You can extend Grafana by writing your own plugins and then share them with other users in [our plugin repository](https://grafana.com/plugins).
|
||||
|
||||
@@ -47,20 +45,20 @@ Grafana that can impact your plugin.
|
||||
|
||||
## Metadata
|
||||
|
||||
See the [coding styleguide]({{< relref "code-styleguide.md" >}}) for details on the metadata.
|
||||
See the [coding styleguide]({{< relref "style-guide.md" >}}) 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 "datasources.md" >}}), [panels]({{< relref "panels.md" >}})
|
||||
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.
|
||||
|
||||
The Grafana SDK is quite small so far and can be found here:
|
||||
|
||||
- [SDK file in Grafana](https://github.com/grafana/grafana/blob/master/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 "datasources.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.md" >}}).
|
||||
|
||||
Example:
|
||||
|
||||
@@ -128,7 +126,7 @@ We have three different examples that you can fork/download to get started devel
|
||||
|
||||
- [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 "code-styleguide.md" >}})
|
||||
- [Grafana Plugin Code Styleguide]({{< relref "style-guide.md" >}})
|
||||
- [Grafana Apps]({{< relref "apps.md" >}})
|
||||
- [Grafana Data Sources]({{< relref "datasources.md" >}})
|
||||
- [plugin.json Schema]({{< relref "plugin.json.md" >}})
|
||||
- [Grafana Data Sources]({{< relref "data-sources.md" >}})
|
||||
- [plugin.json Schema]({{< relref "metadata.md" >}})
|
||||
@@ -1,14 +1,11 @@
|
||||
+++
|
||||
title = "Developing App Plugins"
|
||||
title = "Legacy app plugins"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Developing App Plugins"
|
||||
parent = "developing"
|
||||
weight = 4
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/apps/"]
|
||||
+++
|
||||
|
||||
# Grafana Apps
|
||||
# Legacy app plugins
|
||||
|
||||
App plugins are a Grafana plugin that can bundle data source and panel plugins within one package. They also enable the plugin author to create custom pages within Grafana. The custom pages enable the plugin author to include things like documentation, sign-up forms, or to control other services with HTTP requests.
|
||||
|
||||
@@ -1,14 +1,11 @@
|
||||
+++
|
||||
title = "Developing Datasource Plugins"
|
||||
title = "Legacy data source plugins"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Developing Datasource Plugins"
|
||||
parent = "developing"
|
||||
weight = 5
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/datasources/"]
|
||||
+++
|
||||
|
||||
# Data Sources
|
||||
# Legacy data source plugins
|
||||
|
||||
Data source plugins enable people to develop plugins for any database that
|
||||
communicates over HTTP. Its up to the plugin to transform the data into
|
||||
@@ -1,13 +1,10 @@
|
||||
+++
|
||||
title = "Plugin Defaults and Editor Mode"
|
||||
title = "Legacy defaults and editor mode"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Plugin Defaults and Editor Mode"
|
||||
parent = "developing"
|
||||
weight = 3
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/defaults-and-editor-mode/"]
|
||||
+++
|
||||
|
||||
# Plugin Defaults and Editor Mode
|
||||
# Legacy defaults and editor mode
|
||||
|
||||
Most plugins allow users to customize the behavior by changing settings on an editor tab. These setting fields are saved in the dashboard json.
|
||||
|
||||
@@ -59,7 +56,7 @@ If you want your users to be able to change these panel values then you need to
|
||||
|
||||
## Editor Mode
|
||||
|
||||
Editor mode is when a user clicks Edit on a panel. Every panel has a general tab where you change the title and width and some panels have more inbuilt tabs like the Metrics tab or Time Range tab. A panel plugin can add its own tab(s) so that a user can customize the panel.
|
||||
Editor mode is when a user clicks Edit on a panel. Every panel has a general tab where you change the title and width and some panels have more inbuilt tabs like the Metrics tab or Time Range tab. A panel plugin can add its own tab(s) so that a user can customize the panel.
|
||||
|
||||
Grafana conventions mean all you need to do is to hook up an Angular template with input fields and Grafana will automatically save the values to the dashboard json and load them on dashboard load.
|
||||
|
||||
@@ -1,21 +1,16 @@
|
||||
+++
|
||||
title = "Developing Panel Plugins"
|
||||
title = "Legacy panel plugins"
|
||||
keywords = ["grafana", "plugins", "panel", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Developing Panel Plugins"
|
||||
parent = "developing"
|
||||
weight = 4
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/panels/"]
|
||||
+++
|
||||
|
||||
|
||||
# Panels
|
||||
# Legacy panel plugins
|
||||
|
||||
Panels are the main building blocks of dashboards.
|
||||
|
||||
## Panel development
|
||||
|
||||
|
||||
### Scrolling
|
||||
The grafana dashboard framework controls the panel height. To enable a scrollbar within the panel the PanelCtrl needs to set the scrollable static variable:
|
||||
|
||||
@@ -27,10 +22,7 @@ export class MyPanelCtrl extends PanelCtrl {
|
||||
|
||||
In this case, make sure the template has a single `<div>...</div>` root. The plugin loader will modify that element adding a scrollbar.
|
||||
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
- [clock-panel](https://github.com/grafana/clock-panel)
|
||||
- [singlestat-panel](https://github.com/grafana/grafana/tree/master/public/app/plugins/panel/singlestat)
|
||||
|
||||
@@ -1,13 +1,10 @@
|
||||
+++
|
||||
title = "Plugin Review Guidelines"
|
||||
title = "Legacy review guidelines"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Plugin Review Guidelines"
|
||||
parent = "developing"
|
||||
weight = 2
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin-review-guidelines/"]
|
||||
+++
|
||||
|
||||
# Plugin Review Guidelines
|
||||
# Legacy review guidelines
|
||||
|
||||
The Grafana team reviews all plugins that are published on Grafana.com. There are two areas we review, the metadata for the plugin and the plugin functionality.
|
||||
|
||||
@@ -157,7 +154,7 @@ A basic guide for data sources can be found [here](http://docs.grafana.org/plugi
|
||||
|
||||
If possible, any passwords or secrets should be 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 "auth-for-datasources.md" >}}) works.
|
||||
Read more here about how [authentication for data sources]({{< relref "../authentication.md" >}}) works.
|
||||
|
||||
If using the proxy feature, the Config page should use the `secureJsonData` blob like this:
|
||||
|
||||
@@ -1,17 +1,14 @@
|
||||
+++
|
||||
title = "Snapshot Mode"
|
||||
title = "Legacy snapshot mode"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Snapshot Mode"
|
||||
parent = "developing"
|
||||
weight = 6
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/snapshot-mode/"]
|
||||
+++
|
||||
|
||||
# Getting Plugins to work in Snapshot Mode
|
||||
# Legacy snapshot mode
|
||||
|
||||
{{< imgbox img="/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 "../../reference/share_dashboard.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](http://snapshot.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 "../../../reference/share_dashboard.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](http://snapshot.raintank.io/) if you want to send the snapshot to someone who does not have access to your Grafana server.
|
||||
|
||||
{{< imgbox img="/img/docs/animated_gifs/snapshots.gif" caption="Selecting a snapshot" >}}
|
||||
|
||||
@@ -1,13 +1,10 @@
|
||||
+++
|
||||
title = "Plugin Code Styleguide"
|
||||
title = "Legacy code style guide"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Plugin Code Styleguide"
|
||||
parent = "developing"
|
||||
weight = 2
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/code-styleguide/"]
|
||||
+++
|
||||
|
||||
# Grafana Plugin Code Styleguide
|
||||
# Legacy code style guide
|
||||
|
||||
This guide has two parts. The first part describes the metadata and the second part is a styleguide for HTML/CSS and JavaScript in Grafana plugins and applies if you are using ES6 in your plugin. If using TypeScript then the [Angular TypeScript styleguide](https://angular.io/styleguide) is recommended.
|
||||
|
||||
@@ -30,7 +27,7 @@ grafana-piechart-panel
|
||||
mtanda-histogram-panel
|
||||
```
|
||||
|
||||
The full file format for plugin.json is described [here]({{< relref "plugin.json.md" >}}).
|
||||
The full file format for plugin.json is described [here]({{< relref "metadata.md" >}}).
|
||||
|
||||
Minimal plugin.json:
|
||||
|
||||
@@ -1,22 +1,19 @@
|
||||
+++
|
||||
title = "plugin.json Schema"
|
||||
title = "plugin.json"
|
||||
keywords = ["grafana", "plugins", "documentation"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "plugin.json Schema"
|
||||
parent = "developing"
|
||||
weight = 8
|
||||
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
|
||||
+++
|
||||
|
||||
# Plugin.json
|
||||
# plugin.json
|
||||
|
||||
The plugin.json file is mandatory for all plugins. When Grafana starts it will scan the plugin folders and mount every folder that contains a plugin.json file unless the folder contains a subfolder named `dist`. In that case grafana will mount the `dist` folder instead.
|
||||
|
||||
## Plugin.json Schema
|
||||
## Schema
|
||||
|
||||
| Property | Description |
|
||||
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| id | Unique name of the plugin. See [naming conventions described in styleguide]({{< relref "code-styleguide.md" >}}) |
|
||||
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|
|
||||
| id | Unique name of the plugin. |
|
||||
| type | One of `app`, `datasource`, `panel` |
|
||||
| name | Human-readable name of the plugin |
|
||||
| dependencies.grafanaVersion | Required Grafana version for this plugin |
|
||||
@@ -26,11 +23,11 @@ The plugin.json file is mandatory for all plugins. When Grafana starts it will s
|
||||
| info.description | Description of plugin. Used for search on grafana.com |
|
||||
| info.keywords | Array of plugin keywords. Used for search on grafana.com |
|
||||
| info.links | An array of link objects to be displayed on this plugin's project page in the form `{name: 'foo', url: 'http://example.com'}` |
|
||||
| info.logos.small | Link to the "small" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
|
||||
| info.logos.large | Link to the "large" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
|
||||
| info.logos.small | Link to the "small" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
|
||||
| info.logos.large | Link to the "large" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
|
||||
| info.screenshots | An array of screenshot objects in the form `{name: 'bar', path: 'img/screenshot.png'}` |
|
||||
| info.updated | Date when this plugin was built. Use `%TODAY%` for Grafana to autopopulate this value. |
|
||||
| info.version | Project version of this commit. Use `%VERSION%` for Grafana to autopopulate this value. |
|
||||
| info.version | Project version of this commit. Use `%VERSION%` for Grafana to autopopulate this value. |
|
||||
|
||||
## Plugin.json Example
|
||||
|
||||
@@ -79,7 +79,7 @@ In the query editor for a panel, after choosing your Azure Monitor data source,
|
||||
|
||||
The query editor will change depending on which one you pick. Azure Monitor is the default.
|
||||
|
||||
## Querying the Azure Monitor Service
|
||||
## Querying the Azure Monitor service
|
||||
|
||||
The Azure Monitor service provides metrics for all the Azure services that you have running. It helps you understand how your applications on Azure are performing and to proactively find issues affecting your applications.
|
||||
|
||||
@@ -93,7 +93,7 @@ Examples of metrics that you can get from the service are:
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v60/azuremonitor-service-query-editor.png" class="docs-image--no-shadow" caption="Azure Monitor Query Editor" >}}
|
||||
|
||||
### Formatting Legend Keys with Aliases for the Azure Monitor Service
|
||||
### Formatting legend keys with aliases for Azure Monitor
|
||||
|
||||
The default legend formatting for the Azure Monitor API is:
|
||||
|
||||
@@ -106,7 +106,7 @@ Azure Monitor Examples:
|
||||
- `dimension: {{dimensionvalue}}`
|
||||
- `{{resourcegroup}} - {{resourcename}}`
|
||||
|
||||
### Alias Patterns for Azure Monitor
|
||||
### Alias patterns for Azure Monitor
|
||||
|
||||
- `{{resourcegroup}}` = replaced with the value of the Resource Group
|
||||
- `{{namespace}}` = replaced with the value of the Namespace (e.g. Microsoft.Compute/virtualMachines)
|
||||
@@ -115,7 +115,7 @@ Azure Monitor Examples:
|
||||
- `{{dimensionname}}` = replaced with dimension key/label (e.g. blobtype)
|
||||
- `{{dimensionvalue}}` = replaced with dimension value (e.g. BlockBlob)
|
||||
|
||||
### Templating with Variables for the Azure Monitor Service
|
||||
### Templating with variables for Azure Monitor
|
||||
|
||||
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.
|
||||
|
||||
@@ -149,11 +149,11 @@ Examples:
|
||||
Check out the [Templating]({{< relref "../../variables/templates-and-variables.md" >}}) documentation for an introduction to the templating feature and the different
|
||||
types of template variables.
|
||||
|
||||
### Azure Monitor Metrics Whitelist
|
||||
### Azure Monitor metrics whitelist
|
||||
|
||||
Not all metrics returned by the Azure Monitor API have values. The Grafana data source has a whitelist to only return metric names if it is possible they might have values. This whitelist is updated regularly as new services and metrics are added to the Azure cloud. You can find the current whitelist [here](https://github.com/grafana/grafana/blob/master/public/app/plugins/datasource/grafana-azure-monitor-datasource/azure_monitor/supported_namespaces.ts).
|
||||
|
||||
### Azure Monitor Alerting
|
||||
### Azure Monitor alerting
|
||||
|
||||
Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}).
|
||||
|
||||
@@ -163,7 +163,7 @@ Grafana alerting is supported for the Azure Monitor service. This is not Azure A
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v60/appinsights-service-query-editor.png" class="docs-image--no-shadow" caption="Application Insights Query Editor" >}}
|
||||
|
||||
### Formatting Legend Keys with Aliases for the Application Insights Service
|
||||
### Formatting legend keys with aliases for Application Insights
|
||||
|
||||
The default legend formatting is:
|
||||
|
||||
@@ -177,13 +177,13 @@ Application Insights Examples:
|
||||
- `city: {{groupbyvalue}}`
|
||||
- `{{groupbyname}}: {{groupbyvalue}}`
|
||||
|
||||
### Alias Patterns for Application Insights
|
||||
### Alias patterns for Application Insights
|
||||
|
||||
- `{{groupbyvalue}}` = replaced with the value of the group by
|
||||
- `{{groupbyname}}` = replaced with the name/label of the group by
|
||||
- `{{metric}}` = replaced with metric name (e.g. requests/count)
|
||||
|
||||
### Filter Expressions for Application Insights
|
||||
### Filter expressions for Application Insights
|
||||
|
||||
The filter field takes an OData filter expression.
|
||||
|
||||
@@ -194,7 +194,7 @@ Examples:
|
||||
- `client/city ne 'Boydton' and client/city ne 'Dublin'`
|
||||
- `client/city eq 'Boydton' or client/city eq 'Dublin'`
|
||||
|
||||
### Templating with Variables for Application Insights
|
||||
### Templating with variables for Application Insights
|
||||
|
||||
Use the one of the following queries in the `Query` field in the Variable edit view.
|
||||
|
||||
@@ -214,13 +214,13 @@ Examples:
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v60/appinsights-service-variables.png" class="docs-image--no-shadow" caption="Nested Application Insights Template Variables" >}}
|
||||
|
||||
### Application Insights Alerting
|
||||
### Application Insights alerting
|
||||
|
||||
Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}).
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}}
|
||||
|
||||
## Querying the Azure Log Analytics Service
|
||||
## Querying the Azure Log Analytics service
|
||||
|
||||
Queries are written in the new [Azure Log Analytics (or KustoDB) Query Language](https://docs.loganalytics.io/index). A Log Analytics Query can be formatted as Time Series data or as Table data.
|
||||
|
||||
@@ -246,7 +246,7 @@ If your credentials give you access to multiple subscriptions then choose the ap
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v60/azureloganalytics-service-query-editor.png" class="docs-image--no-shadow" caption="Azure Log Analytics Query Editor" >}}
|
||||
|
||||
### Azure Log Analytics Macros
|
||||
### Azure Log Analytics macros
|
||||
|
||||
To make writing queries easier there are several Grafana macros that can be used in the where clause of a query:
|
||||
|
||||
@@ -268,13 +268,13 @@ To make writing queries easier there are several Grafana macros that can be used
|
||||
|
||||
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.
|
||||
|
||||
### Azure Log Analytics Builtin Variables
|
||||
### Azure Log Analytics builtin variables
|
||||
|
||||
There are also some Grafana variables that can be used in Azure Log Analytics queries:
|
||||
|
||||
- `$__interval` - Grafana calculates the minimum time grain that can be used to group by time in queries. More details on how it works [here]({{< relref "../../variables/templates-and-variables.md#interval-variables" >}}). It returns a time grain like `5m` or `1h` that can be used in the bin function. E.g. `summarize count() by bin(TimeGenerated, $__interval)`
|
||||
|
||||
### Templating with Variables for Azure Log Analytics
|
||||
### Templating with variables for Azure Log Analytics
|
||||
|
||||
Any Log Analytics query that returns a list of values can be used in the `Query` field in the Variable edit view. There is also one Grafana function for Log Analytics that returns a list of workspaces.
|
||||
|
||||
@@ -313,11 +313,25 @@ Perf
|
||||
| order by TimeGenerated asc
|
||||
```
|
||||
|
||||
### Azure Log Analytics Alerting
|
||||
### Deep linking from Grafana panels to the Log Analytics query editor in Azure Portal
|
||||
|
||||
Not implemented yet.
|
||||
> Only available in Grafana v7.0+.
|
||||
|
||||
### Writing Analytics Queries For the Application Insights Service
|
||||
{{< docs-imagebox img="/img/docs/v70/azure-log-analytics-deep-linking.png" max-width="500px" class="docs-image--right" caption="Azure Log Analytics deep linking" >}}
|
||||
|
||||
Click on a time series in the panel to see a context menu with a link to `View in Azure Portal`. Clicking that link opens the Azure Log Analytics query editor in the Azure Portal and runs the query from the Grafana panel there.
|
||||
|
||||
If you're not currently logged in to the Azure Portal, then the link opens the login page. The provided link is valid for any account, but it only displays the query if your account has access to the Azure Log Analytics workspace specified in the query.
|
||||
|
||||
<div class="clearfix"></div>
|
||||
|
||||
### Azure Log Analytics alerting
|
||||
|
||||
> Only available in Grafana v7.0+.
|
||||
|
||||
Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works in [Alerting rules]({{< relref "../../alerting/rules.md" >}}).
|
||||
|
||||
### Writing analytics queries For the Application Insights service
|
||||
|
||||
If you change the service type to "Application Insights", the menu icon to the right adds another option, "Toggle Edit Mode". Once clicked, the query edit mode changes to give you a full text area in which to write log analytics queries. (This is identical to how the InfluxDB data source lets you write raw queries.)
|
||||
|
||||
@@ -362,4 +376,4 @@ datasources:
|
||||
appInsightsApiKey: <app-insights-api-key>
|
||||
logAnalyticsClientSecret: <log-analytics-client-secret>
|
||||
version: 1
|
||||
```
|
||||
```
|
||||
|
||||
@@ -149,7 +149,7 @@ Depending on the cardinality of the data and the time range MetricTank may retur
|
||||
|
||||
Since then we have been working towards removing PhantomJS. In October 2019, when Grafana v6.4 was released, we [announced](https://grafana.com/blog/2019/10/02/grafana-v6.4-released/#phantomjs-deprecation) the deprecation of PhantomJS. Grafana v7.0 removes all PhantomJS support which means that Grafana distribution no longer will include a built-in image renderer.
|
||||
|
||||
As a replacement for PhantomJS we’ve developed the [Grafana Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) which is a plugin that runs on the backend and handles rendering panels and dashboards as PNG images using headless Chromium/Chrome. The [Grafana Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) can either be installed as a Grafana plugin running in its own process side-by-side with Grafana. or run as an external HTTP service, hosted using Docker or as a standalone application.
|
||||
As a replacement for PhantomJS we’ve developed the [Grafana Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) which is a plugin that runs on the backend and handles rendering panels and dashboards as PNG images using headless Chromium/Chrome. The [Grafana Image Renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) can either be installed as a Grafana plugin running in its own process side-by-side with Grafana. or runs as an external HTTP service, hosted using Docker or as a standalone application.
|
||||
|
||||
Read more about [Image Rendering]({{< relref "../administration/image_rendering/" >}}) in the documentation for further instructions.
|
||||
|
||||
|
||||
@@ -226,7 +226,7 @@ Content-Type: application/json
|
||||
}
|
||||
```
|
||||
|
||||
> NOTE: `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../plugins/developing/auth-for-datasources.md/#encrypting-sensitive-data">}}) documentation for more details.
|
||||
> NOTE: `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../developers/plugins/authentication.md/#encrypting-sensitive-data">}}) documentation for more details.
|
||||
|
||||
**Example Graphite Request with basic auth enabled**:
|
||||
|
||||
@@ -376,7 +376,7 @@ Content-Type: application/json
|
||||
}
|
||||
```
|
||||
|
||||
> NOTE: Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../plugins/developing/auth-for-datasources.md/#encrypting-sensitive-data">}}) documentation for more details.
|
||||
> NOTE: Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../developers/plugins/authentication.md/#encrypting-sensitive-data">}}) documentation for more details.
|
||||
|
||||
## Delete an existing data source by id
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ For more on the query inspector read the Grafana Community article [Using Grafan
|
||||
|
||||
## Logging
|
||||
|
||||
If you encounter an error or problem, then you can check the Grafana server log. Usually located at `/var/log/grafana/grafana.log` on Unix systems or in `<grafana_install_dir>/data/log` on other platforms and manual installs.
|
||||
If you encounter an error or problem, then you can check the Grafana server log. Usually located at `/var/log/grafana/grafana.log` on Unix systems or in `<grafana_install_dir>/data/log` on other platforms and manual installations.
|
||||
|
||||
You can enable more logging by changing log level in the Grafana configuration file.
|
||||
|
||||
|
||||
@@ -31,166 +31,166 @@
|
||||
- name: Administration
|
||||
link: /administration/
|
||||
children:
|
||||
- name: Configuration
|
||||
link: /installation/configuration/
|
||||
- name: Configure Docker image
|
||||
link: /installation/configure-docker/
|
||||
- name: Security
|
||||
link: /installation/security/
|
||||
- name: Authentication
|
||||
link: /auth/
|
||||
children:
|
||||
- link: /auth/overview/
|
||||
name: Overview
|
||||
- link: /auth/auth-proxy/
|
||||
name: Auth Proxy
|
||||
- link: /auth/ldap/
|
||||
name: LDAP
|
||||
- link: /auth/enhanced_ldap/
|
||||
name: Enhanced LDAP
|
||||
- link: /auth/generic-oauth/
|
||||
name: Generic OAuth
|
||||
- link: /auth/google/
|
||||
name: Google
|
||||
- link: /auth/azuread/
|
||||
name: Azure AD
|
||||
- link: /auth/github/
|
||||
name: GitHub
|
||||
- link: /auth/gitlab/
|
||||
name: GitLab
|
||||
- link: /auth/okta/
|
||||
name: Okta
|
||||
- link: /auth/saml/
|
||||
name: SAML
|
||||
- link: /auth/team-sync/
|
||||
name: Team Sync
|
||||
- name: Permissions
|
||||
link: /permissions/
|
||||
children:
|
||||
- link: /permissions/overview/
|
||||
name: Overview
|
||||
- link: /permissions/organization_roles/
|
||||
name: Organization Roles
|
||||
- link: /permissions/dashboard_folder_permissions/
|
||||
name: Dashboard and Folder
|
||||
- link: /permissions/datasource_permissions/
|
||||
name: Data source
|
||||
- name: Grafana CLI
|
||||
link: /administration/cli/
|
||||
- name: Internal metrics
|
||||
link: /administration/metrics/
|
||||
- name: Provisioning
|
||||
link: /administration/provisioning/
|
||||
- name: Set up Grafana for high availability
|
||||
link: /tutorials/ha_setup/
|
||||
- name: Troubleshooting
|
||||
link: /installation/troubleshooting/
|
||||
- name: Configuration
|
||||
link: /installation/configuration/
|
||||
- name: Configure Docker image
|
||||
link: /installation/configure-docker/
|
||||
- name: Security
|
||||
link: /installation/security/
|
||||
- name: Authentication
|
||||
link: /auth/
|
||||
children:
|
||||
- link: /auth/overview/
|
||||
name: Overview
|
||||
- link: /auth/auth-proxy/
|
||||
name: Auth Proxy
|
||||
- link: /auth/ldap/
|
||||
name: LDAP
|
||||
- link: /auth/enhanced_ldap/
|
||||
name: Enhanced LDAP
|
||||
- link: /auth/generic-oauth/
|
||||
name: Generic OAuth
|
||||
- link: /auth/google/
|
||||
name: Google
|
||||
- link: /auth/azuread/
|
||||
name: Azure AD
|
||||
- link: /auth/github/
|
||||
name: GitHub
|
||||
- link: /auth/gitlab/
|
||||
name: GitLab
|
||||
- link: /auth/okta/
|
||||
name: Okta
|
||||
- link: /auth/saml/
|
||||
name: SAML
|
||||
- link: /auth/team-sync/
|
||||
name: Team Sync
|
||||
- name: Permissions
|
||||
link: /permissions/
|
||||
children:
|
||||
- link: /permissions/overview/
|
||||
name: Overview
|
||||
- link: /permissions/organization_roles/
|
||||
name: Organization Roles
|
||||
- link: /permissions/dashboard_folder_permissions/
|
||||
name: Dashboard and Folder
|
||||
- link: /permissions/datasource_permissions/
|
||||
name: Data source
|
||||
- name: Grafana CLI
|
||||
link: /administration/cli/
|
||||
- name: Internal metrics
|
||||
link: /administration/metrics/
|
||||
- name: Provisioning
|
||||
link: /administration/provisioning/
|
||||
- name: Set up Grafana for high availability
|
||||
link: /tutorials/ha_setup/
|
||||
- name: Troubleshooting
|
||||
link: /installation/troubleshooting/
|
||||
- name: Panels
|
||||
link: /features/panels/
|
||||
children:
|
||||
- link: /features/panels/panels/
|
||||
name: Overview
|
||||
- link: /features/panels/graph/
|
||||
name: Graph
|
||||
- link: /features/panels/table_panel/
|
||||
name: Table
|
||||
- link: /features/panels/stat/
|
||||
name: Stat
|
||||
- link: /features/panels/gauge/
|
||||
name: Gauge
|
||||
- link: /features/panels/bar_gauge/
|
||||
name: Bar gauge
|
||||
- link: /features/panels/logs/
|
||||
name: Logs
|
||||
- link: /features/panels/singlestat/
|
||||
name: Singlestat
|
||||
- link: /features/panels/heatmap/
|
||||
name: Heatmap
|
||||
- link: /features/panels/alertlist/
|
||||
name: Alert list
|
||||
- link: /features/panels/dashlist/
|
||||
name: Dashboard list
|
||||
- link: /features/panels/text/
|
||||
name: Text
|
||||
- link: /features/panels/panels/
|
||||
name: Overview
|
||||
- link: /features/panels/graph/
|
||||
name: Graph
|
||||
- link: /features/panels/table_panel/
|
||||
name: Table
|
||||
- link: /features/panels/stat/
|
||||
name: Stat
|
||||
- link: /features/panels/gauge/
|
||||
name: Gauge
|
||||
- link: /features/panels/bar_gauge/
|
||||
name: Bar gauge
|
||||
- link: /features/panels/logs/
|
||||
name: Logs
|
||||
- link: /features/panels/singlestat/
|
||||
name: Singlestat
|
||||
- link: /features/panels/heatmap/
|
||||
name: Heatmap
|
||||
- link: /features/panels/alertlist/
|
||||
name: Alert list
|
||||
- link: /features/panels/dashlist/
|
||||
name: Dashboard list
|
||||
- link: /features/panels/text/
|
||||
name: Text
|
||||
- name: Dashboards
|
||||
link: /features/dashboard/
|
||||
children:
|
||||
- link: /features/dashboard/dashboards/
|
||||
name: Overview
|
||||
- link: /reference/annotations/
|
||||
name: Annotations
|
||||
- link: /reference/dashboard_folders/
|
||||
name: Folders
|
||||
- link: /reference/playlist/
|
||||
name: Playlist
|
||||
- link: /reference/search/
|
||||
name: Search
|
||||
- link: /reference/share_dashboard/
|
||||
name: Sharing a dashboard
|
||||
- link: /reference/share_panel/
|
||||
name: Sharing a panel
|
||||
- link: /reference/timerange/
|
||||
name: Time range
|
||||
- link: /reference/export_import/
|
||||
name: Export and import
|
||||
- link: /features/dashboard/links/
|
||||
name: Navigation links
|
||||
- link: /reference/datalinks/
|
||||
name: Data links
|
||||
- link: /reference/dashboard_history/
|
||||
name: Dashboard version history
|
||||
- name: Keyboard Shortcuts
|
||||
link: /features/shortcuts/
|
||||
- name: Reporting
|
||||
link: /features/reporting/
|
||||
- link: /reference/dashboard/
|
||||
name: JSON Model
|
||||
- link: /reference/scripting/
|
||||
name: Scripted dashboards
|
||||
- link: /features/dashboard/dashboards/
|
||||
name: Overview
|
||||
- link: /reference/annotations/
|
||||
name: Annotations
|
||||
- link: /reference/dashboard_folders/
|
||||
name: Folders
|
||||
- link: /reference/playlist/
|
||||
name: Playlist
|
||||
- link: /reference/search/
|
||||
name: Search
|
||||
- link: /reference/share_dashboard/
|
||||
name: Sharing a dashboard
|
||||
- link: /reference/share_panel/
|
||||
name: Sharing a panel
|
||||
- link: /reference/timerange/
|
||||
name: Time range
|
||||
- link: /reference/export_import/
|
||||
name: Export and import
|
||||
- link: /features/dashboard/links/
|
||||
name: Navigation links
|
||||
- link: /reference/datalinks/
|
||||
name: Data links
|
||||
- link: /reference/dashboard_history/
|
||||
name: Dashboard version history
|
||||
- name: Keyboard Shortcuts
|
||||
link: /features/shortcuts/
|
||||
- name: Reporting
|
||||
link: /features/reporting/
|
||||
- link: /reference/dashboard/
|
||||
name: JSON Model
|
||||
- link: /reference/scripting/
|
||||
name: Scripted dashboards
|
||||
- name: Data sources
|
||||
link: /features/datasources/
|
||||
children:
|
||||
- link: /features/datasources/add-a-data-source/
|
||||
name: Add data source
|
||||
- link: /features/datasources/cloudwatch/
|
||||
name: AWS Cloudwatch
|
||||
- link: /features/datasources/azuremonitor/
|
||||
name: Azure Monitor
|
||||
- link: /features/datasources/elasticsearch/
|
||||
name: Elasticsearch
|
||||
- link: /features/datasources/stackdriver/
|
||||
name: Google Stackdriver
|
||||
- link: /features/datasources/graphite/
|
||||
name: Graphite
|
||||
- link: /features/datasources/influxdb/
|
||||
name: InfluxDB
|
||||
- link: /features/datasources/loki/
|
||||
name: Loki
|
||||
- link: /features/datasources/mssql/
|
||||
name: Microsoft SQL Server
|
||||
- link: /features/datasources/mixed/
|
||||
name: MixedData
|
||||
- link: /features/datasources/mysql/
|
||||
name: MySQL
|
||||
- link: /features/datasources/opentsdb/
|
||||
name: OpenTSDB
|
||||
- link: /features/datasources/postgres/
|
||||
name: PostgreSQL
|
||||
- link: /features/datasources/prometheus/
|
||||
name: Prometheus
|
||||
- link: /features/datasources/testdata/
|
||||
name: TestData DB
|
||||
- link: /features/datasources/add-a-data-source/
|
||||
name: Add data source
|
||||
- link: /features/datasources/cloudwatch/
|
||||
name: AWS Cloudwatch
|
||||
- link: /features/datasources/azuremonitor/
|
||||
name: Azure Monitor
|
||||
- link: /features/datasources/elasticsearch/
|
||||
name: Elasticsearch
|
||||
- link: /features/datasources/stackdriver/
|
||||
name: Google Stackdriver
|
||||
- link: /features/datasources/graphite/
|
||||
name: Graphite
|
||||
- link: /features/datasources/influxdb/
|
||||
name: InfluxDB
|
||||
- link: /features/datasources/loki/
|
||||
name: Loki
|
||||
- link: /features/datasources/mssql/
|
||||
name: Microsoft SQL Server
|
||||
- link: /features/datasources/mixed/
|
||||
name: MixedData
|
||||
- link: /features/datasources/mysql/
|
||||
name: MySQL
|
||||
- link: /features/datasources/opentsdb/
|
||||
name: OpenTSDB
|
||||
- link: /features/datasources/postgres/
|
||||
name: PostgreSQL
|
||||
- link: /features/datasources/prometheus/
|
||||
name: Prometheus
|
||||
- link: /features/datasources/testdata/
|
||||
name: TestData DB
|
||||
- name: Explore
|
||||
link: /features/explore/
|
||||
- name: Alerting
|
||||
link: /alerting/
|
||||
children:
|
||||
- link: /alerting/rules/
|
||||
name: Engine and Rules
|
||||
- link: /alerting/metrics/
|
||||
name: Metrics
|
||||
- link: /alerting/notifications/
|
||||
name: Notifications
|
||||
- link: /alerting/rules/
|
||||
name: Engine and Rules
|
||||
- link: /alerting/metrics/
|
||||
name: Metrics
|
||||
- link: /alerting/notifications/
|
||||
name: Notifications
|
||||
- name: Image rendering
|
||||
link: /administration/image_rendering/
|
||||
- name: Templates and variables
|
||||
@@ -286,33 +286,6 @@
|
||||
link: /plugins/
|
||||
- name: Install plugins
|
||||
link: /plugins/installation/
|
||||
- name: Develop plugins
|
||||
link: /plugins/developing/
|
||||
children:
|
||||
- link: /plugins/developing/development/
|
||||
name: Developer Guide
|
||||
- link: /plugins/developing/dataframe/
|
||||
name: Introduction to data frames
|
||||
- link: /plugins/developing/code-styleguide/
|
||||
name: Plugin Code Styleguide
|
||||
- link: /plugins/developing/plugin-review-guidelines/
|
||||
name: Plugin Review Guidelines
|
||||
- link: /plugins/developing/auth-for-datasources/
|
||||
name: Authentication for Datasource Plugins
|
||||
- link: /plugins/developing/defaults-and-editor-mode/
|
||||
name: Plugin Defaults and Editor Mode
|
||||
- link: /plugins/developing/apps/
|
||||
name: Developing App Plugins
|
||||
- link: /plugins/developing/panels/
|
||||
name: Developing Panel Plugins
|
||||
- link: /plugins/developing/backend-plugins-guide/
|
||||
name: Developing Backend Plugins
|
||||
- link: /plugins/developing/datasources/
|
||||
name: Developing Datasource Plugins
|
||||
- link: /plugins/developing/snapshot-mode/
|
||||
name: Snapshot Mode
|
||||
- link: /plugins/developing/plugin.json/
|
||||
name: plugin.json Schema
|
||||
- name: HTTP APIs
|
||||
link: /http_api/
|
||||
children:
|
||||
@@ -363,14 +336,39 @@
|
||||
- name: Users API
|
||||
link: /http_api/user/
|
||||
- name: Developers
|
||||
link: /developers/
|
||||
children:
|
||||
- name: Developer resources
|
||||
link: /developers/developer-resources/
|
||||
- link: /developers/plugins/
|
||||
name: Plugins
|
||||
- name: Packages reference
|
||||
- name: Plugins
|
||||
children:
|
||||
- name: Overview
|
||||
link: /developers/plugins/
|
||||
- name: plugin.json
|
||||
link: /developers/plugins/metadata/
|
||||
- name: Data frames
|
||||
link: /developers/plugins/data-frames/
|
||||
- name: Authentication
|
||||
link: /developers/plugins/authentication/
|
||||
- name: Backend plugins
|
||||
link: /developers/plugins/backend/
|
||||
- name: Legacy plugins
|
||||
children:
|
||||
- link: /developers/plugins/legacy/
|
||||
name: Overview
|
||||
- link: /developers/plugins/legacy/style-guide/
|
||||
name: Code style guide
|
||||
- link: /developers/plugins/legacy/review-guidelines/
|
||||
name: Review guidelines
|
||||
- link: /developers/plugins/legacy/defaults-and-editor-mode/
|
||||
name: Defaults and editor mode
|
||||
- link: /developers/plugins/legacy/apps/
|
||||
name: App plugins
|
||||
- link: /developers/plugins/legacy/data-sources/
|
||||
name: Data source plugins
|
||||
- link: /developers/plugins/legacy/snapshot-mode/
|
||||
name: Snapshot mode
|
||||
- name: API reference
|
||||
link: /packages_api/
|
||||
- name: Contribute
|
||||
link: /developers/contribute/
|
||||
- name: Contributor License Agreement (CLA)
|
||||
link: /developers/cla/
|
||||
- name: Docs Archive
|
||||
|
||||
@@ -18,6 +18,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [AppendedVectors](./appendedvectors/) | This may be more trouble than it is worth. This trades some computation time for RAM -- rather than allocate a new array the size of all previous arrays, this just points the correct index to their original array values |
|
||||
| [AppPlugin](./appplugin/) | |
|
||||
| [ArrayVector](./arrayvector/) | |
|
||||
| [BinaryOperationVector](./binaryoperationvector/) | |
|
||||
| [CircularDataFrame](./circulardataframe/) | This dataframe can have values constantly added, and will never exceed the given capacity |
|
||||
| [CircularVector](./circularvector/) | Circular vector uses a single buffer to capture a stream of values overwriting the oldest value on add.<!-- -->This supports addting to the 'head' or 'tail' and will grow the buffer to match a configured capacity. |
|
||||
| [ConstantVector](./constantvector/) | |
|
||||
@@ -34,13 +35,13 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [PanelOptionsEditorBuilder](./paneloptionseditorbuilder/) | Fluent API for declarative creation of panel options |
|
||||
| [PanelPlugin](./panelplugin/) | |
|
||||
| [Registry](./registry/) | |
|
||||
| [ScaledVector](./scaledvector/) | |
|
||||
| [SortedVector](./sortedvector/) | Values are returned in the order defined by the input parameter |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [BinaryOperationID](./binaryoperationid/) | |
|
||||
| [ColorScheme](./colorscheme/) | |
|
||||
| [CoreApp](./coreapp/) | |
|
||||
| [CSVHeaderStyle](./csvheaderstyle/) | |
|
||||
@@ -96,9 +97,11 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [getDecimalsForValue(value, decimalOverride)](./getdecimalsforvalue/) | |
|
||||
| [getDisplayProcessor(options)](./getdisplayprocessor/) | |
|
||||
| [getDisplayValueAlignmentFactors(values)](./getdisplayvaluealignmentfactors/) | |
|
||||
| [getFieldDisplayName(field, frame, allFrames)](./getfielddisplayname/) | |
|
||||
| [getFieldMatcher(config)](./getfieldmatcher/) | |
|
||||
| [getFlotPairs({ xField, yField, nullValueMode })](./getflotpairs/) | |
|
||||
| [getFlotPairsConstant(seriesData, range)](./getflotpairsconstant/) | Returns a constant series based on the first value from the provide series. |
|
||||
| [getFrameDisplayName(frame, index)](./getframedisplayname/) | Get an appropriate display title |
|
||||
| [getFrameMatchers(config)](./getframematchers/) | |
|
||||
| [getLogLevel(line)](./getloglevel/) | Returns the log level of a log line. Parse the line for level words. If no level is found, it returns <code>LogLevel.unknown</code>.<!-- -->Example: <code>getLogLevel('WARN 1999-12-31 this is great') // LogLevel.warn</code> |
|
||||
| [getLogLevelFromKey(key)](./getloglevelfromkey/) | |
|
||||
@@ -111,13 +114,13 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [guessFieldTypeForField(field)](./guessfieldtypeforfield/) | Looks at the data to guess the column type. This ignores any existing setting |
|
||||
| [guessFieldTypeFromNameAndValue(name, v)](./guessfieldtypefromnameandvalue/) | Given a name and value, this will pick a reasonable field type |
|
||||
| [guessFieldTypeFromValue(v)](./guessfieldtypefromvalue/) | Given a value this will guess the best column type<!-- -->TODO: better Date/Time support! Look for standard date strings? |
|
||||
| [hasLinks(field)](./haslinks/) | |
|
||||
| [locale(value, decimals)](./locale/) | |
|
||||
| [parseFlags(text)](./parseflags/) | Converts any mode modifiers in the text to the Javascript equivalent flag |
|
||||
| [parseLabels(labels)](./parselabels/) | Returns a map of label keys to value from an input selector string.<!-- -->Example: <code>parseLabels('{job="foo", instance="bar"}) // {job: "foo", instance: "bar"}</code> |
|
||||
| [readCSV(csv, options)](./readcsv/) | |
|
||||
| [reduceField(options)](./reducefield/) | |
|
||||
| [renderMarkdown(str)](./rendermarkdown/) | |
|
||||
| [resultsToDataFrames(rsp)](./resultstodataframes/) | |
|
||||
| [reverseDataFrame(data)](./reversedataframe/) | Returns a copy with all values reversed |
|
||||
| [scaledUnits(factor, extArray)](./scaledunits/) | |
|
||||
| [setMarkdownOptions(optionsOverride)](./setmarkdownoptions/) | |
|
||||
@@ -128,6 +131,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [stringToJsRegex(str)](./stringtojsregex/) | |
|
||||
| [stringToMs(str)](./stringtoms/) | |
|
||||
| [toCSV(data, config)](./tocsv/) | |
|
||||
| [toDataFrame(data)](./todataframe/) | Inspect any object and return the results as a DataFrame |
|
||||
| [toDataFrameDTO(data)](./todataframedto/) | Returns a copy that does not include functions |
|
||||
| [toFixed(value, decimals)](./tofixed/) | |
|
||||
| [toFixedScaled(value, decimals, scaledDecimals, additionalDecimals, ext)](./tofixedscaled/) | |
|
||||
@@ -153,7 +157,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [AppRootProps](./approotprops/) | |
|
||||
| [ArrowDataFrame](./arrowdataframe/) | |
|
||||
| [BuildInfo](./buildinfo/) | Describes the build information that will be available via the Grafana configuration. |
|
||||
| [CalculateFieldTransformerOptions](./calculatefieldtransformeroptions/) | |
|
||||
| [ColorFieldConfigSettings](./colorfieldconfigsettings/) | |
|
||||
| [Column](./column/) | |
|
||||
| [ConfigOverrideRule](./configoverriderule/) | |
|
||||
@@ -186,9 +189,9 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [DateTimeBuiltinFormat](./datetimebuiltinformat/) | |
|
||||
| [DateTimeDuration](./datetimeduration/) | |
|
||||
| [DateTimeLocale](./datetimelocale/) | |
|
||||
| [DateTimeOptions](./datetimeoptions/) | |
|
||||
| [DateTimeOptionsWhenParsing](./datetimeoptionswhenparsing/) | |
|
||||
| [DateTimeOptionsWithFormat](./datetimeoptionswithformat/) | |
|
||||
| [DateTimeOptions](./datetimeoptions/) | The type describing date and time options. Used for all the helper functions available to parse or format date and time values. |
|
||||
| [DateTimeOptionsWhenParsing](./datetimeoptionswhenparsing/) | The type that describes options that can be passed when parsing a date and time value. |
|
||||
| [DateTimeOptionsWithFormat](./datetimeoptionswithformat/) | The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted. |
|
||||
| [DecimalInfo](./decimalinfo/) | |
|
||||
| [Dimension](./dimension/) | |
|
||||
| [DisplayValue](./displayvalue/) | |
|
||||
@@ -211,9 +214,8 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [FieldOverrideContext](./fieldoverridecontext/) | |
|
||||
| [FieldOverrideEditorProps](./fieldoverrideeditorprops/) | |
|
||||
| [FieldReducerInfo](./fieldreducerinfo/) | |
|
||||
| [FieldState](./fieldstate/) | |
|
||||
| [FieldWithIndex](./fieldwithindex/) | |
|
||||
| [FilterFieldsByNameTransformerOptions](./filterfieldsbynametransformeroptions/) | |
|
||||
| [FilterFramesByRefIdTransformerOptions](./filterframesbyrefidtransformeroptions/) | |
|
||||
| [FlotDataPoint](./flotdatapoint/) | |
|
||||
| [FormattedValue](./formattedvalue/) | |
|
||||
| [FrameMatcherInfo](./framematcherinfo/) | |
|
||||
@@ -242,7 +244,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [NavModelBreadcrumb](./navmodelbreadcrumb/) | |
|
||||
| [NavModelItem](./navmodelitem/) | |
|
||||
| [NumberFieldConfigSettings](./numberfieldconfigsettings/) | |
|
||||
| [OrganizeFieldsTransformerOptions](./organizefieldstransformeroptions/) | |
|
||||
| [PanelData](./paneldata/) | |
|
||||
| [PanelEditorProps](./paneleditorprops/) | |
|
||||
| [PanelModel](./panelmodel/) | |
|
||||
@@ -270,7 +271,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [RawTimeRange](./rawtimerange/) | |
|
||||
| [ReadWriteVector](./readwritevector/) | Apache arrow vectors are Read/Write |
|
||||
| [ReduceDataOptions](./reducedataoptions/) | Options for how to turn DataFrames into an array of display values |
|
||||
| [ReduceTransformerOptions](./reducetransformeroptions/) | |
|
||||
| [RegexpOrNamesMatcherOptions](./regexpornamesmatcheroptions/) | |
|
||||
| [RegistryItem](./registryitem/) | |
|
||||
| [RegistryItemWithOptions](./registryitemwithoptions/) | |
|
||||
| [ScaledValue](./scaledvalue/) | |
|
||||
@@ -279,7 +280,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [ScreenshotInfo](./screenshotinfo/) | |
|
||||
| [SelectableValue](./selectablevalue/) | Used in select elements |
|
||||
| [SelectFieldConfigSettings](./selectfieldconfigsettings/) | |
|
||||
| [SeriesToColumnsOptions](./seriestocolumnsoptions/) | |
|
||||
| [StandardEditorProps](./standardeditorprops/) | |
|
||||
| [StandardEditorsRegistryItem](./standardeditorsregistryitem/) | |
|
||||
| [StringFieldConfigSettings](./stringfieldconfigsettings/) | |
|
||||
@@ -319,19 +319,19 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [binaryOperators](./binaryoperators/) | |
|
||||
| [booleanOverrideProcessor](./booleanoverrideprocessor/) | |
|
||||
| [createDimension](./createdimension/) | |
|
||||
| [createOrderFieldsComparer](./createorderfieldscomparer/) | |
|
||||
| [DataLinkBuiltInVars](./datalinkbuiltinvars/) | |
|
||||
| [dataLinksOverrideProcessor](./datalinksoverrideprocessor/) | |
|
||||
| [dateTime](./datetime/) | |
|
||||
| [dateTimeAsMoment](./datetimeasmoment/) | |
|
||||
| [dateTimeFormat](./datetimeformat/) | |
|
||||
| [dateTimeFormatISO](./datetimeformatiso/) | |
|
||||
| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | |
|
||||
| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | |
|
||||
| [dateTimeFormat](./datetimeformat/) | Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->. |
|
||||
| [dateTimeFormatISO](./datetimeformatiso/) | Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->. |
|
||||
| [dateTimeFormatTimeAgo](./datetimeformattimeago/) | Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [dateTimeFormatWithAbbrevation](./datetimeformatwithabbrevation/) | Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [dateTimeForTimeZone](./datetimefortimezone/) | |
|
||||
| [dateTimeParse](./datetimeparse/) | |
|
||||
| [dateTimeParse](./datetimeparse/) | Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings.<!-- -->It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value.<!-- -->If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [DEFAULT\_DATE\_TIME\_FORMAT](./default_date_time_format/) | |
|
||||
| [DEFAULT\_FIELD\_DISPLAY\_VALUES\_LIMIT](./default_field_display_values_limit/) | |
|
||||
| [DefaultTimeRange](./defaulttimerange/) | |
|
||||
@@ -381,7 +381,6 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [onUpdateDatasourceSecureJsonDataOptionSelect](./onupdatedatasourcesecurejsondataoptionselect/) | |
|
||||
| [selectOverrideProcessor](./selectoverrideprocessor/) | |
|
||||
| [setLocale](./setlocale/) | |
|
||||
| [setTimeZoneResolver](./settimezoneresolver/) | |
|
||||
| [standardEditorsRegistry](./standardeditorsregistry/) | |
|
||||
| [standardFieldConfigEditorRegistry](./standardfieldconfigeditorregistry/) | |
|
||||
| [standardTransformers](./standardtransformers/) | |
|
||||
@@ -390,8 +389,10 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [textUtil](./textutil/) | |
|
||||
| [thresholdsOverrideProcessor](./thresholdsoverrideprocessor/) | |
|
||||
| [TIME\_FORMAT](./time_format/) | |
|
||||
| [timeZoneAbbrevation](./timezoneabbrevation/) | |
|
||||
| [toDataFrame](./todataframe/) | |
|
||||
| [TIME\_SERIES\_TIME\_FIELD\_NAME](./time_series_time_field_name/) | |
|
||||
| [TIME\_SERIES\_VALUE\_FIELD\_NAME](./time_series_value_field_name/) | |
|
||||
| [timeZoneAbbrevation](./timezoneabbrevation/) | Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->. |
|
||||
| [timeZoneFormatUserFriendly](./timezoneformatuserfriendly/) | |
|
||||
| [toDuration](./toduration/) | |
|
||||
| [toLegacyResponseData](./tolegacyresponsedata/) | |
|
||||
| [toPascalCase](./topascalcase/) | |
|
||||
@@ -405,6 +406,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [valueMappingsOverrideProcessor](./valuemappingsoverrideprocessor/) | |
|
||||
| [VAR\_CALC](./var_calc/) | |
|
||||
| [VAR\_CELL\_PREFIX](./var_cell_prefix/) | |
|
||||
| [VAR\_FIELD\_LABELS](./var_field_labels/) | |
|
||||
| [VAR\_FIELD\_NAME](./var_field_name/) | |
|
||||
| [VAR\_SERIES\_NAME](./var_series_name/) | |
|
||||
|
||||
@@ -412,15 +414,14 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [BinaryOperation](./binaryoperation/) | |
|
||||
| [Color](./color/) | |
|
||||
| [ColorDefinition](./colordefinition/) | |
|
||||
| [DataQueryResponseData](./dataqueryresponsedata/) | |
|
||||
| [DataSourceOptionsType](./datasourceoptionstype/) | |
|
||||
| [DataSourceQueryType](./datasourcequerytype/) | |
|
||||
| [DataTransformer](./datatransformer/) | Function that transform data frames (AKA transformer) |
|
||||
| [DateTimeFormatter](./datetimeformatter/) | |
|
||||
| [DateTimeInput](./datetimeinput/) | |
|
||||
| [DateTimeParser](./datetimeparser/) | |
|
||||
| [DecimalCount](./decimalcount/) | |
|
||||
| [Dimensions](./dimensions/) | |
|
||||
| [DisplayProcessor](./displayprocessor/) | |
|
||||
@@ -440,6 +441,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [PanelMigrationHandler](./panelmigrationhandler/) | Called when a panel is first loaded with current panel model |
|
||||
| [PanelOptionEditorsRegistry](./paneloptioneditorsregistry/) | |
|
||||
| [PanelTypeChangedHandler](./paneltypechangedhandler/) | Called before a panel is initialized. Allows panel inspection for any updates before changing the panel type. |
|
||||
| [PreferredVisualisationType](./preferredvisualisationtype/) | |
|
||||
| [ScaleCalculator](./scalecalculator/) | |
|
||||
| [Subtract](./subtract/) | |
|
||||
| [TimeFragment](./timefragment/) | |
|
||||
@@ -447,7 +449,7 @@ A library containing most of the core functionality and data types used in Grafa
|
||||
| [TimeSeriesValue](./timeseriesvalue/) | |
|
||||
| [TimeZone](./timezone/) | |
|
||||
| [TimeZoneBrowser](./timezonebrowser/) | |
|
||||
| [TimeZoneResolver](./timezoneresolver/) | |
|
||||
| [TimeZoneResolver](./timezoneresolver/) | The type to describe the time zone resolver function that will be used to access the default time zone of a user. |
|
||||
| [TimeZoneUtc](./timezoneutc/) | |
|
||||
| [UrlQueryMap](./urlquerymap/) | Type to represent the values parsed from the query string. |
|
||||
| [UrlQueryValue](./urlqueryvalue/) | Type to represent the value of a single query variable. |
|
||||
|
||||
@@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setTimeZoneResolver"
|
||||
title = "BinaryOperation"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## setTimeZoneResolver variable
|
||||
## BinaryOperation type
|
||||
|
||||
### setTimeZoneResolver variable
|
||||
### BinaryOperation type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setTimeZoneResolver: (resolver: TimeZoneResolver) => void
|
||||
export declare type BinaryOperation = (left: number, right: number) => number;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setTimeZoneResolver } from '@grafana/data';
|
||||
import { BinaryOperation } from '@grafana/data';
|
||||
```
|
||||
33
docs/sources/packages_api/data/binaryoperationid.md
Normal file
33
docs/sources/packages_api/data/binaryoperationid.md
Normal file
@@ -0,0 +1,33 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BinaryOperationID"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## BinaryOperationID enum
|
||||
|
||||
### BinaryOperationID enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum BinaryOperationID
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BinaryOperationID } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Add | <code>"+"</code> | |
|
||||
| Divide | <code>"/"</code> | |
|
||||
| Multiply | <code>"*"</code> | |
|
||||
| Subtract | <code>"-"</code> | |
|
||||
|
||||
@@ -2,28 +2,28 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ScaledVector"
|
||||
title = "BinaryOperationVector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## ScaledVector class
|
||||
## BinaryOperationVector class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class ScaledVector implements Vector<number>
|
||||
export declare class BinaryOperationVector implements Vector<number>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ScaledVector } from '@grafana/data';
|
||||
import { BinaryOperationVector } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(source, scale)](#constructor-sourcescale) | | Constructs a new instance of the <code>ScaledVector</code> class |
|
||||
| [constructor(left, right, operation)](#constructor-leftrightoperation) | | Constructs a new instance of the <code>BinaryOperationVector</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
@@ -39,21 +39,22 @@ import { ScaledVector } from '@grafana/data';
|
||||
| [toArray()](#toarray-method) | | |
|
||||
| [toJSON()](#tojson-method) | | |
|
||||
|
||||
### constructor(source, scale)
|
||||
### constructor(left, right, operation)
|
||||
|
||||
Constructs a new instance of the `ScaledVector` class
|
||||
Constructs a new instance of the `BinaryOperationVector` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(source: Vector<number>, scale: number);
|
||||
constructor(left: Vector<number>, right: Vector<number>, operation: BinaryOperation);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| source | <code>Vector<number></code> | |
|
||||
| scale | <code>number</code> | |
|
||||
| left | <code>Vector<number></code> | |
|
||||
| right | <code>Vector<number></code> | |
|
||||
| operation | <code>BinaryOperation</code> | |
|
||||
|
||||
### length property
|
||||
|
||||
@@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeParser"
|
||||
title = "binaryOperators"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## DateTimeParser type
|
||||
## binaryOperators variable
|
||||
|
||||
### DateTimeParser type
|
||||
### binaryOperators variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DateTimeParser<T extends DateTimeOptions = DateTimeOptions> = (value: DateTimeInput, options?: T) => DateTime;
|
||||
binaryOperators: Registry<BinaryOperatorInfo>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeParser } from '@grafana/data';
|
||||
import { binaryOperators } from '@grafana/data';
|
||||
```
|
||||
@@ -1,70 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "CalculateFieldTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## CalculateFieldTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface CalculateFieldTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { CalculateFieldTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [alias](#alias-property) | <code>string</code> | |
|
||||
| [include](#include-property) | <code>string</code> | |
|
||||
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | |
|
||||
| [reducer](#reducer-property) | <code>ReducerID</code> | |
|
||||
| [replaceFields](#replacefields-property) | <code>boolean</code> | |
|
||||
|
||||
### alias property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alias?: string;
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string;
|
||||
```
|
||||
|
||||
### nullValueMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
nullValueMode?: NullValueMode;
|
||||
```
|
||||
|
||||
### reducer property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reducer: ReducerID;
|
||||
```
|
||||
|
||||
### replaceFields property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
replaceFields?: boolean;
|
||||
```
|
||||
@@ -23,10 +23,19 @@ import { Column } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [custom](#custom-property) | <code>Record<string, any></code> | |
|
||||
| [filterable](#filterable-property) | <code>boolean</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### custom property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
custom?: Record<string, any>;
|
||||
```
|
||||
|
||||
### filterable property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -28,6 +28,7 @@ import { DataTransformerID } from '@grafana/data';
|
||||
| --- | --- | --- |
|
||||
| append | <code>"append"</code> | |
|
||||
| calculateField | <code>"calculateField"</code> | |
|
||||
| ensureColumns | <code>"ensureColumns"</code> | |
|
||||
| filterByRefId | <code>"filterByRefId"</code> | |
|
||||
| filterFields | <code>"filterFields"</code> | |
|
||||
| filterFieldsByName | <code>"filterFieldsByName"</code> | |
|
||||
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormat variable
|
||||
|
||||
Helper function to format date and time according to the specified options. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatISO variable
|
||||
|
||||
Helper function to format date and time according to the standard ISO format e.g. 2013-02-04T22:44:30.652Z. If no options are supplied, then default values are used. For more details, see [DateTimeOptionsWithFormat](./data/datetimeoptionswithformat.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatTimeAgo variable
|
||||
|
||||
Helper function to return elapsed time since passed date. The returned value will be formatted in a human readable format e.g. 4 years ago. If no options are supplied, then default values are used. For more details, see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### dateTimeFormatWithAbbrevation variable
|
||||
|
||||
Helper function to format date and time according to the Grafana default formatting, but it also appends the time zone abbreviation at the end e.g. 2020-05-20 13:37:00 CET. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptions interface
|
||||
|
||||
The type describing date and time options. Used for all the helper functions available to parse or format date and time values.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -23,10 +25,12 @@ import { DateTimeOptions } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [timeZone](#timezone-property) | <code>TimeZone</code> | |
|
||||
| [timeZone](#timezone-property) | <code>TimeZone</code> | Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used. |
|
||||
|
||||
### timeZone property
|
||||
|
||||
Specify this if you want to override the timeZone used when parsing or formatting a date and time value. If no timeZone is set, the default timeZone for the current user is used.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptionsWhenParsing interface
|
||||
|
||||
The type that describes options that can be passed when parsing a date and time value.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -23,10 +25,14 @@ import { DateTimeOptionsWhenParsing } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [roundUp](#roundup-property) | <code>boolean</code> | |
|
||||
| [roundUp](#roundup-property) | <code>boolean</code> | If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.<!-- -->Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00. |
|
||||
|
||||
### roundUp property
|
||||
|
||||
If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.
|
||||
|
||||
Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -9,6 +9,8 @@ type = "docs"
|
||||
|
||||
## DateTimeOptionsWithFormat interface
|
||||
|
||||
The type describing the options that can be passed to the [dateTimeFormat](./data/datetimeformat.md) helper function to control how the date and time value passed to the function is formatted.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -23,11 +25,13 @@ import { DateTimeOptionsWithFormat } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [defaultWithMS](#defaultwithms-property) | <code>boolean</code> | |
|
||||
| [format](#format-property) | <code>string</code> | |
|
||||
| [defaultWithMS](#defaultwithms-property) | <code>boolean</code> | Set this value to <code>true</code> if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format. |
|
||||
| [format](#format-property) | <code>string</code> | Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used. |
|
||||
|
||||
### defaultWithMS property
|
||||
|
||||
Set this value to `true` if you want to include milliseconds when formatting date and time values in the default [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) format.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -36,6 +40,8 @@ defaultWithMS?: boolean;
|
||||
|
||||
### format property
|
||||
|
||||
Specify a [momentjs](https://momentjs.com/docs/#/displaying/format) format to use a custom formatting pattern of the date and time value. If no format is set, then [DEFAULT\_DATE\_TIME\_FORMAT](./data/default_date_time_format.md) is used.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -11,6 +11,12 @@ type = "docs"
|
||||
|
||||
### dateTimeParse variable
|
||||
|
||||
Helper function to parse a number, text or Date to a DateTime value. If a timeZone is supplied the incoming value is parsed with that timeZone as a base. The only exception to this is if the passed value is in a UTC-based format. Then it will use UTC as the base. Examples on UTC-based values are Unix epoch and ISO formatted strings.
|
||||
|
||||
It can also parse the Grafana quick date and time format, e.g. now-6h will be parsed as Date.now() - 6 hours and returned as a valid DateTime value.
|
||||
|
||||
If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -24,6 +24,7 @@ import { ExploreStartPageProps } from '@grafana/data';
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [datasource](#datasource-property) | <code>DataSourceApi</code> | |
|
||||
| [exploreId](#exploreid-property) | <code>any</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [onClickExample](#onclickexample-property) | <code>(query: DataQuery) => void</code> | |
|
||||
|
||||
@@ -35,6 +36,14 @@ import { ExploreStartPageProps } from '@grafana/data';
|
||||
datasource?: DataSourceApi;
|
||||
```
|
||||
|
||||
### exploreId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exploreId?: any;
|
||||
```
|
||||
|
||||
### exploreMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -23,26 +23,16 @@ import { Field } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
|
||||
| [config](#config-property) | <code>FieldConfig</code> | Meta info about how field and how to display it |
|
||||
| [display](#display-property) | <code>DisplayProcessor</code> | Convert a value for display |
|
||||
| [getLinks](#getlinks-property) | <code>(config: ValueLinkConfig) => Array<LinkModel<Field>></code> | Get value data links with variables interpolated |
|
||||
| [labels](#labels-property) | <code>Labels</code> | |
|
||||
| [name](#name-property) | <code>string</code> | Name of the field (column) |
|
||||
| [parse](#parse-property) | <code>(value: any) => T</code> | Convert text to the field value |
|
||||
| [state](#state-property) | <code>FieldState | null</code> | Cached values with appropriate display and id values |
|
||||
| [type](#type-property) | <code>FieldType</code> | Field value type (string, number, etc) |
|
||||
| [values](#values-property) | <code>V</code> | |
|
||||
|
||||
### calcs property
|
||||
|
||||
Cache of reduced values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
calcs?: FieldCalcs;
|
||||
```
|
||||
|
||||
### config property
|
||||
|
||||
Meta info about how field and how to display it
|
||||
@@ -101,6 +91,16 @@ Convert text to the field value
|
||||
parse?: (value: any) => T;
|
||||
```
|
||||
|
||||
### state property
|
||||
|
||||
Cached values with appropriate display and id values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
state?: FieldState | null;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
Field value type (string, number, etc)
|
||||
|
||||
@@ -37,9 +37,10 @@ import { FieldCache } from '@grafana/data';
|
||||
| --- | --- | --- |
|
||||
| [getFieldByName(name)](#getfieldbyname-method) | | Returns the first field with the given name. |
|
||||
| [getFields(type)](#getfields-method) | | |
|
||||
| [getFirstFieldOfType(type)](#getfirstfieldoftype-method) | | |
|
||||
| [getFirstFieldOfType(type, includeHidden)](#getfirstfieldoftype-method) | | |
|
||||
| [hasFieldNamed(name)](#hasfieldnamed-method) | | |
|
||||
| [hasFieldOfType(type)](#hasfieldoftype-method) | | |
|
||||
| [hasFieldWithNameAndType(name, type)](#hasfieldwithnameandtype-method) | | |
|
||||
|
||||
### constructor(data)
|
||||
|
||||
@@ -105,13 +106,14 @@ getFields(type?: FieldType): FieldWithIndex[];
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFirstFieldOfType(type: FieldType): FieldWithIndex | undefined;
|
||||
getFirstFieldOfType(type: FieldType, includeHidden?: boolean): FieldWithIndex | undefined;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| type | <code>FieldType</code> | |
|
||||
| includeHidden | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
@@ -151,3 +153,21 @@ hasFieldOfType(type: FieldType): boolean;
|
||||
|
||||
`boolean`
|
||||
|
||||
### hasFieldWithNameAndType method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasFieldWithNameAndType(name: string, type: FieldType): boolean;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | <code>string</code> | |
|
||||
| type | <code>FieldType</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FieldCalcs
|
||||
export interface FieldCalcs extends Record<string, any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@@ -30,6 +30,7 @@ import { FieldConfig } from '@grafana/data';
|
||||
| [color](#color-property) | <code>FieldColor</code> | |
|
||||
| [custom](#custom-property) | <code>TOptions</code> | |
|
||||
| [decimals](#decimals-property) | <code>number | null</code> | |
|
||||
| [displayName](#displayname-property) | <code>string</code> | |
|
||||
| [filterable](#filterable-property) | <code>boolean</code> | |
|
||||
| [links](#links-property) | <code>DataLink[]</code> | |
|
||||
| [mappings](#mappings-property) | <code>ValueMapping[]</code> | |
|
||||
@@ -37,9 +38,7 @@ import { FieldConfig } from '@grafana/data';
|
||||
| [min](#min-property) | <code>number | null</code> | |
|
||||
| [noValue](#novalue-property) | <code>string</code> | |
|
||||
| [nullValueMode](#nullvaluemode-property) | <code>NullValueMode</code> | |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
||||
| [thresholds](#thresholds-property) | <code>ThresholdsConfig</code> | |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### color property
|
||||
@@ -66,6 +65,14 @@ custom?: TOptions;
|
||||
decimals?: number | null;
|
||||
```
|
||||
|
||||
### displayName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
displayName?: string;
|
||||
```
|
||||
|
||||
### filterable property
|
||||
|
||||
<b>Signature</b>
|
||||
@@ -122,14 +129,6 @@ noValue?: string;
|
||||
nullValueMode?: NullValueMode;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars?: ScopedVars;
|
||||
```
|
||||
|
||||
### thresholds property
|
||||
|
||||
<b>Signature</b>
|
||||
@@ -138,14 +137,6 @@ scopedVars?: ScopedVars;
|
||||
thresholds?: ThresholdsConfig;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
||||
### unit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -27,6 +27,7 @@ import { FieldDisplay } from '@grafana/data';
|
||||
| [display](#display-property) | <code>DisplayValue</code> | |
|
||||
| [field](#field-property) | <code>FieldConfig</code> | |
|
||||
| [getLinks](#getlinks-property) | <code>() => LinkModel[]</code> | |
|
||||
| [hasLinks](#haslinks-property) | <code>boolean</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [rowIndex](#rowindex-property) | <code>number</code> | |
|
||||
| [sparkline](#sparkline-property) | <code>GraphSeriesValue[][]</code> | |
|
||||
@@ -64,6 +65,14 @@ field: FieldConfig;
|
||||
getLinks?: () => LinkModel[];
|
||||
```
|
||||
|
||||
### hasLinks property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasLinks: boolean;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type FieldMatcher = (field: Field) => boolean;
|
||||
export declare type FieldMatcher = (field: Field, frame: DataFrame, allFrames: DataFrame[]) => boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@@ -27,6 +27,9 @@ import { FieldMatcherID } from '@grafana/data';
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| byName | <code>"byName"</code> | |
|
||||
| byNames | <code>"byNames"</code> | |
|
||||
| byRegexp | <code>"byRegexp"</code> | |
|
||||
| byRegexpOrNames | <code>"byRegexpOrNames"</code> | |
|
||||
| byType | <code>"byType"</code> | |
|
||||
| numeric | <code>"numeric"</code> | |
|
||||
| time | <code>"time"</code> | |
|
||||
|
||||
58
docs/sources/packages_api/data/fieldstate.md
Normal file
58
docs/sources/packages_api/data/fieldstate.md
Normal file
@@ -0,0 +1,58 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FieldState"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FieldState interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FieldState
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FieldState } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [calcs](#calcs-property) | <code>FieldCalcs</code> | Cache of reduced values |
|
||||
| [displayName](#displayname-property) | <code>string | null</code> | An appropriate name for the field (does not include frame info) |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | Appropriate values for templating |
|
||||
|
||||
### calcs property
|
||||
|
||||
Cache of reduced values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
calcs?: FieldCalcs;
|
||||
```
|
||||
|
||||
### displayName property
|
||||
|
||||
An appropriate name for the field (does not include frame info)
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
displayName?: string | null;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
Appropriate values for templating
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars?: ScopedVars;
|
||||
```
|
||||
@@ -1,43 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterFieldsByNameTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterFieldsByNameTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterFieldsByNameTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterFieldsByNameTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exclude](#exclude-property) | <code>string[]</code> | |
|
||||
| [include](#include-property) | <code>string[]</code> | |
|
||||
|
||||
### exclude property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exclude?: string[];
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string[];
|
||||
```
|
||||
@@ -1,43 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterFramesByRefIdTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterFramesByRefIdTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterFramesByRefIdTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterFramesByRefIdTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exclude](#exclude-property) | <code>string</code> | |
|
||||
| [include](#include-property) | <code>string</code> | |
|
||||
|
||||
### exclude property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exclude?: string;
|
||||
```
|
||||
|
||||
### include property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
include?: string;
|
||||
```
|
||||
35
docs/sources/packages_api/data/getfielddisplayname.md
Normal file
35
docs/sources/packages_api/data/getfielddisplayname.md
Normal file
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getFieldDisplayName"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getFieldDisplayName() function
|
||||
|
||||
### getFieldDisplayName() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getFieldDisplayName(field: Field, frame?: DataFrame, allFrames?: DataFrame[]): string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getFieldDisplayName } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| field | <code>Field</code> | |
|
||||
| frame | <code>DataFrame</code> | |
|
||||
| allFrames | <code>DataFrame[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
36
docs/sources/packages_api/data/getframedisplayname.md
Normal file
36
docs/sources/packages_api/data/getframedisplayname.md
Normal file
@@ -0,0 +1,36 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getFrameDisplayName"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getFrameDisplayName() function
|
||||
|
||||
### getFrameDisplayName() function
|
||||
|
||||
Get an appropriate display title
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getFrameDisplayName(frame: DataFrame, index?: number): string;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getFrameDisplayName } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| frame | <code>DataFrame</code> | |
|
||||
| index | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
@@ -24,7 +24,7 @@ import { GrafanaThemeCommons } from '@grafana/data';
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [border](#border-property) | <code>{</code><br/><code> radius: {</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> };</code><br/><code> width: {</code><br/><code> sm: string;</code><br/><code> };</code><br/><code> }</code> | |
|
||||
| [breakpoints](#breakpoints-property) | <code>{</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> }</code> | |
|
||||
| [breakpoints](#breakpoints-property) | <code>{</code><br/><code> xs: string;</code><br/><code> sm: string;</code><br/><code> md: string;</code><br/><code> lg: string;</code><br/><code> xl: string;</code><br/><code> xxl: string;</code><br/><code> }</code> | |
|
||||
| [height](#height-property) | <code>{</code><br/><code> sm: number;</code><br/><code> md: number;</code><br/><code> lg: number;</code><br/><code> }</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [panelHeaderHeight](#panelheaderheight-property) | <code>number</code> | |
|
||||
@@ -61,6 +61,7 @@ breakpoints: {
|
||||
md: string;
|
||||
lg: string;
|
||||
xl: string;
|
||||
xxl: string;
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -2,32 +2,32 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "resultsToDataFrames"
|
||||
title = "hasLinks"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## resultsToDataFrames() function
|
||||
## hasLinks() function
|
||||
|
||||
### resultsToDataFrames() function
|
||||
### hasLinks() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function resultsToDataFrames(rsp: any): DataFrame[];
|
||||
export declare function hasLinks(field: Field): boolean;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { resultsToDataFrames } from '@grafana/data';
|
||||
import { hasLinks } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rsp | <code>any</code> | |
|
||||
| field | <code>Field</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame[]`
|
||||
`boolean`
|
||||
|
||||
@@ -37,7 +37,9 @@ import { LogLevel } from '@grafana/data';
|
||||
| eror | <code>"error"</code> | |
|
||||
| err | <code>"error"</code> | |
|
||||
| error | <code>"error"</code> | |
|
||||
| fatal | <code>"critical"</code> | |
|
||||
| info | <code>"info"</code> | |
|
||||
| information | <code>"info"</code> | |
|
||||
| notice | <code>"info"</code> | |
|
||||
| trace | <code>"trace"</code> | |
|
||||
| unknown | <code>"unknown"</code> | |
|
||||
|
||||
@@ -34,6 +34,7 @@ import { LogRowModel } from '@grafana/data';
|
||||
| [rowIndex](#rowindex-property) | <code>number</code> | |
|
||||
| [searchWords](#searchwords-property) | <code>string[]</code> | |
|
||||
| [timeEpochMs](#timeepochms-property) | <code>number</code> | |
|
||||
| [timeEpochNs](#timeepochns-property) | <code>string</code> | |
|
||||
| [timeFromNow](#timefromnow-property) | <code>string</code> | |
|
||||
| [timeLocal](#timelocal-property) | <code>string</code> | |
|
||||
| [timeUtc](#timeutc-property) | <code>string</code> | |
|
||||
@@ -128,6 +129,14 @@ searchWords?: string[];
|
||||
timeEpochMs: number;
|
||||
```
|
||||
|
||||
### timeEpochNs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeEpochNs: string;
|
||||
```
|
||||
|
||||
### timeFromNow property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "OrganizeFieldsTransformerOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## OrganizeFieldsTransformerOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface OrganizeFieldsTransformerOptions extends OrderFieldsTransformerOptions, RenameFieldsTransformerOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { OrganizeFieldsTransformerOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [excludeByName](#excludebyname-property) | <code>Record<string, boolean></code> | |
|
||||
|
||||
### excludeByName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
excludeByName: Record<string, boolean>;
|
||||
```
|
||||
@@ -32,6 +32,7 @@ import { PanelEvents } from '@grafana/data';
|
||||
| --- | --- |
|
||||
| [componentDidMount](./componentdidmount/) | |
|
||||
| [dataError](./dataerror/) | |
|
||||
| [dataFramesReceived](./dataframesreceived/) | |
|
||||
| [dataReceived](./datareceived/) | |
|
||||
| [dataSnapshotLoad](./datasnapshotload/) | |
|
||||
| [editModeInitialized](./editmodeinitialized/) | |
|
||||
|
||||
@@ -2,22 +2,23 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "createOrderFieldsComparer"
|
||||
title = "dataFramesReceived"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## createOrderFieldsComparer variable
|
||||
## PanelEvents.dataFramesReceived variable
|
||||
|
||||
### createOrderFieldsComparer variable
|
||||
### PanelEvents.dataFramesReceived variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
createOrderFieldsComparer: (indexByName: Record<string, number>) => (a: string, b: string) => number
|
||||
dataFramesReceived: import("./appEvents").AppEvent<DataFrame[]>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { createOrderFieldsComparer } from '@grafana/data';
|
||||
import { PanelEvents } from '@grafana/data';
|
||||
const { dataFramesReceived } = PanelEvents;
|
||||
```
|
||||
@@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DateTimeFormatter"
|
||||
title = "PreferredVisualisationType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## DateTimeFormatter type
|
||||
## PreferredVisualisationType type
|
||||
|
||||
### DateTimeFormatter type
|
||||
### PreferredVisualisationType type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type DateTimeFormatter<T extends DateTimeOptions = DateTimeOptions> = (dateInUtc: DateTimeInput, options?: T) => string;
|
||||
export declare type PreferredVisualisationType = 'graph' | 'table';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DateTimeFormatter } from '@grafana/data';
|
||||
import { PreferredVisualisationType } from '@grafana/data';
|
||||
```
|
||||
@@ -27,6 +27,8 @@ import { QueryEditorProps } from '@grafana/data';
|
||||
| [datasource](#datasource-property) | <code>DSType</code> | |
|
||||
| [exploreId](#exploreid-property) | <code>any</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [history](#history-property) | <code>HistoryItem[]</code> | |
|
||||
| [onBlur](#onblur-property) | <code>() => void</code> | |
|
||||
| [onChange](#onchange-property) | <code>(value: TQuery) => void</code> | |
|
||||
| [onRunQuery](#onrunquery-property) | <code>() => void</code> | |
|
||||
| [query](#query-property) | <code>TQuery</code> | |
|
||||
@@ -65,6 +67,22 @@ exploreId?: any;
|
||||
exploreMode?: ExploreMode;
|
||||
```
|
||||
|
||||
### history property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
history?: HistoryItem[];
|
||||
```
|
||||
|
||||
### onBlur property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
onBlur?: () => void;
|
||||
```
|
||||
|
||||
### onChange property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -29,6 +29,7 @@ import { QueryResultMeta } from '@grafana/data';
|
||||
| [json](#json-property) | <code>boolean</code> | |
|
||||
| [limit](#limit-property) | <code>number</code> | |
|
||||
| [notices](#notices-property) | <code>QueryResultMetaNotice[]</code> | Meta Notices |
|
||||
| [preferredVisualisationType](#preferredvisualisationtype-property) | <code>PreferredVisualisationType</code> | Currently used to show results in Explore only in preferred visualisation option |
|
||||
| [query](#query-property) | <code>string</code> | |
|
||||
| [rawQuery](#rawquery-property) | <code>string</code> | |
|
||||
| [searchWords](#searchwords-property) | <code>string[]</code> | |
|
||||
@@ -89,6 +90,16 @@ Meta Notices
|
||||
notices?: QueryResultMetaNotice[];
|
||||
```
|
||||
|
||||
### preferredVisualisationType property
|
||||
|
||||
Currently used to show results in Explore only in preferred visualisation option
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
preferredVisualisationType?: PreferredVisualisationType;
|
||||
```
|
||||
|
||||
### query property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -23,15 +23,15 @@ import { QueryResultMetaStat } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [title](#title-property) | <code>string</code> | |
|
||||
| [displayName](#displayname-property) | <code>string</code> | |
|
||||
| [value](#value-property) | <code>number</code> | |
|
||||
|
||||
### title property
|
||||
### displayName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title: string;
|
||||
displayName: string;
|
||||
```
|
||||
|
||||
### value property
|
||||
|
||||
@@ -14,7 +14,7 @@ type = "docs"
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
convertRawToRange: (raw: RawTimeRange) => TimeRange
|
||||
convertRawToRange: (raw: RawTimeRange, timeZone?: string | undefined) => TimeRange
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
@@ -2,42 +2,42 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "ReduceTransformerOptions"
|
||||
title = "RegexpOrNamesMatcherOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## ReduceTransformerOptions interface
|
||||
## RegexpOrNamesMatcherOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface ReduceTransformerOptions
|
||||
export interface RegexpOrNamesMatcherOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { ReduceTransformerOptions } from '@grafana/data';
|
||||
import { RegexpOrNamesMatcherOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [fields](#fields-property) | <code>MatcherConfig</code> | |
|
||||
| [reducers](#reducers-property) | <code>ReducerID[]</code> | |
|
||||
| [names](#names-property) | <code>string[]</code> | |
|
||||
| [pattern](#pattern-property) | <code>string</code> | |
|
||||
|
||||
### fields property
|
||||
### names property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
fields?: MatcherConfig;
|
||||
names?: string[];
|
||||
```
|
||||
|
||||
### reducers property
|
||||
### pattern property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reducers: ReducerID[];
|
||||
pattern?: string;
|
||||
```
|
||||
@@ -1,34 +0,0 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "SeriesToColumnsOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## SeriesToColumnsOptions interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface SeriesToColumnsOptions
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { SeriesToColumnsOptions } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [byField](#byfield-property) | <code>string</code> | |
|
||||
|
||||
### byField property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
byField?: string;
|
||||
```
|
||||
@@ -28,6 +28,7 @@ standardTransformers: {
|
||||
seriesToColumnsTransformer: import("..").DataTransformerInfo<import("./transformers/seriesToColumns").SeriesToColumnsOptions>;
|
||||
renameFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/rename").RenameFieldsTransformerOptions>;
|
||||
labelsToFieldsTransformer: import("..").DataTransformerInfo<import("./transformers/labelsToFields").LabelsToFieldsOptions>;
|
||||
ensureColumnsTransformer: import("..").DataTransformerInfo<any>;
|
||||
}
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "TIME_SERIES_TIME_FIELD_NAME"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## TIME\_SERIES\_TIME\_FIELD\_NAME variable
|
||||
|
||||
### TIME\_SERIES\_TIME\_FIELD\_NAME variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
TIME_SERIES_TIME_FIELD_NAME = "Time"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { TIME_SERIES_TIME_FIELD_NAME } from '@grafana/data';
|
||||
```
|
||||
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "TIME_SERIES_VALUE_FIELD_NAME"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## TIME\_SERIES\_VALUE\_FIELD\_NAME variable
|
||||
|
||||
### TIME\_SERIES\_VALUE\_FIELD\_NAME variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
TIME_SERIES_VALUE_FIELD_NAME = "Value"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { TIME_SERIES_VALUE_FIELD_NAME } from '@grafana/data';
|
||||
```
|
||||
@@ -26,6 +26,7 @@ import { TimeSeries } from '@grafana/data';
|
||||
| [datapoints](#datapoints-property) | <code>TimeSeriesPoints</code> | |
|
||||
| [tags](#tags-property) | <code>Labels</code> | |
|
||||
| [target](#target-property) | <code>string</code> | |
|
||||
| [title](#title-property) | <code>string</code> | If name is manually configured via an alias / legend pattern |
|
||||
| [unit](#unit-property) | <code>string</code> | |
|
||||
|
||||
### datapoints property
|
||||
@@ -52,6 +53,16 @@ tags?: Labels;
|
||||
target: string;
|
||||
```
|
||||
|
||||
### title property
|
||||
|
||||
If name is manually configured via an alias / legend pattern
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
||||
### unit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### timeZoneAbbrevation variable
|
||||
|
||||
Helper function to return only the time zone abbreviation for a given date and time value. If no options are supplied, then default values are used. For more details please see [DateTimeOptions](./data/datetimeoptions.md)<!-- -->.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
23
docs/sources/packages_api/data/timezoneformatuserfriendly.md
Normal file
23
docs/sources/packages_api/data/timezoneformatuserfriendly.md
Normal file
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "timeZoneFormatUserFriendly"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## timeZoneFormatUserFriendly variable
|
||||
|
||||
### timeZoneFormatUserFriendly variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeZoneFormatUserFriendly: (timeZone: string | undefined) => string | undefined
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { timeZoneFormatUserFriendly } from '@grafana/data';
|
||||
```
|
||||
@@ -11,6 +11,8 @@ type = "docs"
|
||||
|
||||
### TimeZoneResolver type
|
||||
|
||||
The type to describe the time zone resolver function that will be used to access the default time zone of a user.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
|
||||
@@ -7,17 +7,29 @@ keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataFrame variable
|
||||
## toDataFrame() function
|
||||
|
||||
### toDataFrame variable
|
||||
### toDataFrame() function
|
||||
|
||||
Inspect any object and return the results as a DataFrame
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toDataFrame: (data: any) => DataFrame
|
||||
export declare function toDataFrame(data: any): DataFrame;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataFrame } from '@grafana/data';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| data | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataFrame`
|
||||
|
||||
|
||||
23
docs/sources/packages_api/data/var_field_labels.md
Normal file
23
docs/sources/packages_api/data/var_field_labels.md
Normal file
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "VAR_FIELD_LABELS"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## VAR\_FIELD\_LABELS variable
|
||||
|
||||
### VAR\_FIELD\_LABELS variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
VAR_FIELD_LABELS = "__field.labels"
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { VAR_FIELD_LABELS } from '@grafana/data';
|
||||
```
|
||||
@@ -35,6 +35,8 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| [getEchoSrv()](./getechosrv/) | Used to retrieve the [EchoSrv](./runtime/echosrv.md) that can be used to report events to registered echo backends. |
|
||||
| [getLocationSrv()](./getlocationsrv/) | Used to retrieve the [LocationSrv](./runtime/locationsrv.md) that can be used to automatically navigate the user to a new place in Grafana. |
|
||||
| [loadPluginCss(options)](./loadplugincss/) | Use this to load css for a Grafana plugin by specifying a [PluginCssOptions](./runtime/plugincssoptions.md) containing styling for the dark and the light theme. |
|
||||
| [toDataQueryError(err)](./todataqueryerror/) | Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error filds |
|
||||
| [toDataQueryResponse(res)](./todataqueryresponse/) | Parse the results from \`<!-- -->/api/ds/query |
|
||||
|
||||
## Interfaces
|
||||
|
||||
@@ -58,7 +60,7 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| [MetaAnalyticsEvent](./metaanalyticsevent/) | Describes meta analytics event with predefined [EchoEventType.MetaAnalytics](./runtime/echoeventtype/metaanalytics.md) type. |
|
||||
| [PluginCssOptions](./plugincssoptions/) | Option to specify a plugin css that should be applied for the dark and the light theme. |
|
||||
| [SizeMeta](./sizemeta/) | Describes a size with width/height |
|
||||
| [TemplateSrv](./templatesrv/) | Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.<!-- -->For a more in-depth description visit: https://grafana.com/docs/grafana/latest/variables/templates-and-variables |
|
||||
| [TemplateSrv](./templatesrv/) | Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.<!-- -->For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating |
|
||||
|
||||
## Variables
|
||||
|
||||
@@ -66,6 +68,7 @@ A library containing services, configurations etc. used to interact with the Gra
|
||||
| --- | --- |
|
||||
| [config](./config/) | Use this to access the [GrafanaBootConfig](./runtime/grafanabootconfig.md) for the current running Grafana instance. |
|
||||
| [getBackendSrv](./getbackendsrv/) | Used to retrieve the [BackendSrv](./runtime/backendsrv.md) that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. |
|
||||
| [getLegacyAngularInjector](./getlegacyangularinjector/) | <b><i>(BETA)</i></b> WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future. |
|
||||
| [getTemplateSrv](./gettemplatesrv/) | Used to retrieve the [TemplateSrv](./runtime/templatesrv.md) that can be used to fetch available template variables. |
|
||||
| [registerEchoBackend](./registerechobackend/) | Used to register echo backends that will receive Grafana echo events during application runtime. |
|
||||
| [reportMetaAnalytics](./reportmetaanalytics/) | Helper function to report meta analytics to the [EchoSrv](./runtime/echosrv.md)<!-- -->. |
|
||||
|
||||
@@ -37,7 +37,6 @@ import { DataSourceWithBackend } from '@grafana/runtime';
|
||||
| [postResource(path, body)](#postresource-method) | | Send a POST request to the datasource resource path |
|
||||
| [query(request)](#query-method) | | Ideally final -- any other implementation may not work as expected |
|
||||
| [testDatasource()](#testdatasource-method) | | Checks the plugin health |
|
||||
| [toDataQueryResponse(rsp)](#todataqueryresponse-method) | | This makes the arrow library loading async. |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
|
||||
@@ -159,22 +158,3 @@ testDatasource(): Promise<any>;
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### toDataQueryResponse method
|
||||
|
||||
This makes the arrow library loading async.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toDataQueryResponse(rsp: any): Promise<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rsp | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataQueryResponse>`
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getLegacyAngularInjector"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getLegacyAngularInjector variable
|
||||
|
||||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
||||
>
|
||||
|
||||
### getLegacyAngularInjector variable
|
||||
|
||||
WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getLegacyAngularInjector: () => auto.IInjectorService
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getLegacyAngularInjector } from '@grafana/runtime';
|
||||
```
|
||||
@@ -11,7 +11,7 @@ type = "docs"
|
||||
|
||||
Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.
|
||||
|
||||
For a more in-depth description visit: https://grafana.com/docs/grafana/latest/variables/templates-and-variables
|
||||
For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -27,10 +27,13 @@ import { TemplateSrv } from '@grafana/runtime';
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getVariables()](#getvariables-method) | |
|
||||
| [getVariables()](#getvariables-method) | List the dashboard variables |
|
||||
| [replace(target, scopedVars, format)](#replace-method) | Replace the values within the target string. See also |
|
||||
|
||||
### getVariables method
|
||||
|
||||
List the dashboard variables
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -40,3 +43,24 @@ getVariables(): VariableModel[];
|
||||
|
||||
`VariableModel[]`
|
||||
|
||||
### replace method
|
||||
|
||||
Replace the values within the target string. See also
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
replace(target: string, scopedVars?: ScopedVars, format?: string | Function): string;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| target | <code>string</code> | |
|
||||
| scopedVars | <code>ScopedVars</code> | |
|
||||
| format | <code>string | Function</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
|
||||
35
docs/sources/packages_api/runtime/todataqueryerror.md
Normal file
35
docs/sources/packages_api/runtime/todataqueryerror.md
Normal file
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "toDataQueryError"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataQueryError() function
|
||||
|
||||
### toDataQueryError() function
|
||||
|
||||
Convert an object into a DataQueryError -- if this is an HTTP response, it will put the correct values in the error filds
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function toDataQueryError(err: any): DataQueryError;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataQueryError } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| err | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataQueryError`
|
||||
|
||||
35
docs/sources/packages_api/runtime/todataqueryresponse.md
Normal file
35
docs/sources/packages_api/runtime/todataqueryresponse.md
Normal file
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "toDataQueryResponse"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## toDataQueryResponse() function
|
||||
|
||||
### toDataQueryResponse() function
|
||||
|
||||
Parse the results from \`<!-- -->/api/ds/query
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function toDataQueryResponse(res: any): DataQueryResponse;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { toDataQueryResponse } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| res | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataQueryResponse`
|
||||
|
||||
@@ -97,12 +97,13 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [stylesFactory(stylesCreator)](./stylesfactory/) | Creates memoized version of styles creator |
|
||||
| [SuggestionsPlugin({ onTypeahead, cleanText, onWillApplySuggestion, portalOrigin, })](./suggestionsplugin/) | |
|
||||
| [useTheme()](./usetheme/) | |
|
||||
| [ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, })](./valuepicker/) | |
|
||||
| [ValuePicker({ label, icon, options, onChange, variant, size, isFullWidth, menuPlacement, })](./valuepicker/) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [BadgeProps](./badgeprops/) | |
|
||||
| [BigValueSparkline](./bigvaluesparkline/) | |
|
||||
| [CascaderOption](./cascaderoption/) | |
|
||||
| [CompletionItem](./completionitem/) | |
|
||||
@@ -142,6 +143,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [Alert](./alert/) | |
|
||||
| [ALERTING\_COLOR](./alerting_color/) | |
|
||||
| [AlphaNotice](./alphanotice/) | |
|
||||
| [Badge](./badge/) | |
|
||||
| [Button](./button/) | |
|
||||
| [ButtonCascader](./buttoncascader/) | |
|
||||
| [CallToActionCard](./calltoactioncard/) | |
|
||||
@@ -165,10 +167,11 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [Drawer](./drawer/) | |
|
||||
| [EmptySearchResult](./emptysearchresult/) | |
|
||||
| [ErrorWithStack](./errorwithstack/) | |
|
||||
| [FeatureInfoBox](./featureinfobox/) | |
|
||||
| [Field](./field/) | |
|
||||
| [FieldConfigItemHeaderTitle](./fieldconfigitemheadertitle/) | |
|
||||
| [fieldMatchersUI](./fieldmatchersui/) | |
|
||||
| [Forms](./forms/) | |
|
||||
| [FilterPill](./filterpill/) | |
|
||||
| [FullWidthButtonContainer](./fullwidthbuttoncontainer/) | |
|
||||
| [getAvailableIcons](./getavailableicons/) | |
|
||||
| [getButtonStyles](./getbuttonstyles/) | |
|
||||
@@ -176,12 +179,11 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [getLogRowStyles](./getlogrowstyles/) | |
|
||||
| [getStandardFieldConfigs](./getstandardfieldconfigs/) | Returns collection of common field config properties definitions |
|
||||
| [getStandardOptionEditors](./getstandardoptioneditors/) | Returns collection of standard option editors definitions |
|
||||
| [getStandardTransformers](./getstandardtransformers/) | |
|
||||
| [getTheme](./gettheme/) | |
|
||||
| [GraphContextMenu](./graphcontextmenu/) | |
|
||||
| [GraphLegend](./graphlegend/) | |
|
||||
| [graphTickFormatter](./graphtickformatter/) | |
|
||||
| [graphTimeFormat](./graphtimeformat/) | |
|
||||
| [graphTimeFormatter](./graphtimeformatter/) | |
|
||||
| [GraphWithLegend](./graphwithlegend/) | |
|
||||
| [hasValidationEvent](./hasvalidationevent/) | |
|
||||
| [HorizontalGroup](./horizontalgroup/) | |
|
||||
@@ -244,6 +246,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| [TimeRangePicker](./timerangepicker/) | |
|
||||
| [ToggleButton](./togglebutton/) | |
|
||||
| [Tooltip](./tooltip/) | |
|
||||
| [useStyles](./usestyles/) | Hook for using memoized styles with access to the theme. |
|
||||
| [validate](./validate/) | |
|
||||
| [VerticalGroup](./verticalgroup/) | |
|
||||
| [withTheme](./withtheme/) | |
|
||||
@@ -253,6 +256,7 @@ A library containing the different design components of the Grafana ecosystem.
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [AlertVariant](./alertvariant/) | |
|
||||
| [BadgeColor](./badgecolor/) | |
|
||||
| [ButtonProps](./buttonprops/) | |
|
||||
| [ButtonVariant](./buttonvariant/) | |
|
||||
| [FormAPI](./formapi/) | |
|
||||
|
||||
@@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getStandardTransformers"
|
||||
title = "Badge"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## getStandardTransformers variable
|
||||
## Badge variable
|
||||
|
||||
### getStandardTransformers variable
|
||||
### Badge variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getStandardTransformers: () => TransformerRegistyItem<any>[]
|
||||
Badge: React.NamedExoticComponent<BadgeProps>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getStandardTransformers } from '@grafana/ui';
|
||||
import { Badge } from '@grafana/ui';
|
||||
```
|
||||
@@ -2,22 +2,22 @@
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "graphTimeFormatter"
|
||||
title = "BadgeColor"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## graphTimeFormatter variable
|
||||
## BadgeColor type
|
||||
|
||||
### graphTimeFormatter variable
|
||||
### BadgeColor type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
graphTimeFormatter: (timeZone?: string | undefined) => (epoch: number, format: string) => string
|
||||
export declare type BadgeColor = 'blue' | 'red' | 'green' | 'orange' | 'purple';
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { graphTimeFormatter } from '@grafana/ui';
|
||||
import { BadgeColor } from '@grafana/ui';
|
||||
```
|
||||
61
docs/sources/packages_api/ui/badgeprops.md
Normal file
61
docs/sources/packages_api/ui/badgeprops.md
Normal file
@@ -0,0 +1,61 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BadgeProps"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## BadgeProps interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface BadgeProps
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BadgeProps } from '@grafana/ui';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [color](#color-property) | <code>BadgeColor</code> | |
|
||||
| [icon](#icon-property) | <code>IconName</code> | |
|
||||
| [text](#text-property) | <code>string</code> | |
|
||||
| [tooltip](#tooltip-property) | <code>string</code> | |
|
||||
|
||||
### color property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
color: BadgeColor;
|
||||
```
|
||||
|
||||
### icon property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
icon?: IconName;
|
||||
```
|
||||
|
||||
### text property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
text: string;
|
||||
```
|
||||
|
||||
### tooltip property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
tooltip?: string;
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@@ -16,7 +16,7 @@ type = "docs"
|
||||
```typescript
|
||||
ColorPicker: React.FunctionComponent<Pick<import("./ColorPickerPopover").Props<import("./ColorPickerPopover").CustomPickersDescriptor> & {
|
||||
children?: ColorPickerTriggerRenderer | undefined;
|
||||
}, "onChange" | "color" | "children" | "customPickers" | "onColorChange" | "enableNamedColors" | "updatePopperPosition">>
|
||||
}, "onChange" | "color" | "children" | "onColorChange" | "enableNamedColors" | "customPickers" | "updatePopperPosition">>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
|
||||
23
docs/sources/packages_api/ui/featureinfobox.md
Normal file
23
docs/sources/packages_api/ui/featureinfobox.md
Normal file
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FeatureInfoBox"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FeatureInfoBox variable
|
||||
|
||||
### FeatureInfoBox variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
FeatureInfoBox: React.MemoExoticComponent<React.ForwardRefExoticComponent<FeatureInfoBox & React.RefAttributes<HTMLDivElement>>>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FeatureInfoBox } from '@grafana/ui';
|
||||
```
|
||||
23
docs/sources/packages_api/ui/filterpill.md
Normal file
23
docs/sources/packages_api/ui/filterpill.md
Normal file
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "FilterPill"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## FilterPill variable
|
||||
|
||||
### FilterPill variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
FilterPill: React.FC<FilterPillProps>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { FilterPill } from '@grafana/ui';
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@@ -35,7 +35,7 @@ import { Gauge } from '@grafana/ui';
|
||||
| [componentDidUpdate()](#componentdidupdate-method) | | |
|
||||
| [draw()](#draw-method) | | |
|
||||
| [getFontScale(length)](#getfontscale-method) | | |
|
||||
| [getFormattedThresholds()](#getformattedthresholds-method) | | |
|
||||
| [getFormattedThresholds(decimals)](#getformattedthresholds-method) | | |
|
||||
| [render()](#render-method) | | |
|
||||
|
||||
### canvasElement property
|
||||
@@ -117,8 +117,14 @@ getFontScale(length: number): number;
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getFormattedThresholds(): Threshold[];
|
||||
getFormattedThresholds(decimals: number): Threshold[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| decimals | <code>number</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Threshold[]`
|
||||
|
||||
23
docs/sources/packages_api/ui/graphtickformatter.md
Normal file
23
docs/sources/packages_api/ui/graphtickformatter.md
Normal file
@@ -0,0 +1,23 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "graphTickFormatter"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
||||
type = "docs"
|
||||
+++
|
||||
|
||||
## graphTickFormatter variable
|
||||
|
||||
### graphTickFormatter variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
graphTickFormatter: (epoch: number, axis: any) => string
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { graphTickFormatter } from '@grafana/ui';
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user