mirror of https://github.com/grafana/grafana
drew08t
4 months ago
commit
6c98e8ca7b
@ -0,0 +1,44 @@ |
||||
name: 'Setup Grafana Bench' |
||||
description: 'Sets up and installs Grafana Bench' |
||||
|
||||
inputs: |
||||
github-app-name: |
||||
description: 'Name of the GitHub App in Vault' |
||||
required: false |
||||
default: 'grafana-ci-bot' |
||||
branch: |
||||
description: 'The branch to install from' |
||||
required: false |
||||
default: 'main' |
||||
|
||||
runs: |
||||
using: "composite" |
||||
steps: |
||||
- name: Retrieve GitHub App secrets |
||||
id: get-secrets |
||||
uses: grafana/shared-workflows/actions/get-vault-secrets@get-vault-secrets-v1.0.1 |
||||
with: |
||||
repo_secrets: | |
||||
APP_ID=${{ inputs.github-app-name }}:app-id |
||||
APP_INSTALLATION_ID=${{ inputs.github-app-name }}:app-installation-id |
||||
PRIVATE_KEY=${{ inputs.github-app-name }}:private-key |
||||
|
||||
- name: Generate GitHub App token |
||||
id: generate_token |
||||
uses: actions/create-github-app-token@v1 |
||||
with: |
||||
app-id: ${{ env.APP_ID }} |
||||
private-key: ${{ env.PRIVATE_KEY }} |
||||
repositories: "grafana-bench" |
||||
owner: "grafana" |
||||
|
||||
- name: Setup Bench |
||||
shell: bash |
||||
env: |
||||
GH_TOKEN: ${{ steps.generate_token.outputs.token }} |
||||
run: | |
||||
git clone https://x-access-token:${GH_TOKEN}@github.com/grafana/grafana-bench.git ../grafana-bench |
||||
|
||||
cd ../grafana-bench |
||||
git switch ${{ inputs.branch }} |
||||
go install . |
||||
@ -0,0 +1,48 @@ |
||||
name: 'Go Coverage Processor' |
||||
description: 'Process Go test coverage files and generate reports' |
||||
|
||||
inputs: |
||||
test-type: |
||||
description: 'Type of test (e.g., be-unit, be-integration)' |
||||
required: true |
||||
type: string |
||||
coverage-file: |
||||
description: 'Path to the Go coverage file (.cov)' |
||||
required: true |
||||
type: string |
||||
codecov-token: |
||||
description: 'Token for CodeCov (required for CodeCov reporting)' |
||||
required: false |
||||
default: '' |
||||
codecov-flag: |
||||
description: 'Flag to categorize the upload to CodeCov' |
||||
required: false |
||||
default: '' |
||||
codecov-name: |
||||
description: 'Custom name for the upload to CodeCov' |
||||
required: false |
||||
default: '' |
||||
|
||||
runs: |
||||
using: 'composite' |
||||
steps: |
||||
- name: Process Go coverage output |
||||
shell: bash |
||||
run: | |
||||
# Ensure valid coverage file even if empty |
||||
if [ ! -s ${{ inputs.coverage-file }} ]; then |
||||
echo "Coverage file is empty, creating a minimal valid file" |
||||
echo "mode: set" > ${{ inputs.coverage-file }} |
||||
fi |
||||
|
||||
- name: Report coverage to CodeCov |
||||
uses: codecov/codecov-action@v5 |
||||
if: inputs.codecov-token != '' |
||||
with: |
||||
files: ${{ inputs.coverage-file }} |
||||
flags: ${{ inputs.codecov-flag || inputs.test-type }} |
||||
name: ${{ inputs.codecov-name || inputs.test-type }} |
||||
slug: grafana/grafana |
||||
# This URL doesn't use the Google auth, but is much more locked down. As such, it requires OIDC or a CodeCov-provided token to do anything. |
||||
url: https://codecov-webhook.grafana-dev.net |
||||
token: ${{ inputs.codecov-token }} |
||||
@ -0,0 +1,23 @@ |
||||
name: Analytics Events Report |
||||
|
||||
on: |
||||
workflow_dispatch: |
||||
|
||||
jobs: |
||||
generate-report: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: Checkout repository |
||||
uses: actions/checkout@v4 |
||||
|
||||
- name: Setup Node.js |
||||
uses: actions/setup-node@v4 |
||||
with: |
||||
node-version-file: '.nvmrc' |
||||
cache: 'yarn' |
||||
|
||||
- name: Install dependencies |
||||
run: yarn install --frozen-lockfile |
||||
|
||||
- name: Generate analytics report |
||||
run: yarn analytics-report |
||||
@ -1,109 +0,0 @@ |
||||
name: Backend Coverage (OSS) |
||||
on: |
||||
push: |
||||
paths: |
||||
- pkg/** |
||||
- .github/workflows/backend-coverage.yml |
||||
- go.* |
||||
branches: |
||||
- main |
||||
pull_request: |
||||
|
||||
jobs: |
||||
unit-tests: |
||||
name: Run unit tests (OSS) |
||||
runs-on: ubuntu-latest |
||||
if: github.repository == 'grafana/grafana' |
||||
steps: |
||||
- name: Check out repository |
||||
uses: actions/checkout@v4.2.2 |
||||
- name: Setup Go environment |
||||
uses: actions/setup-go@v5.3.0 |
||||
with: |
||||
go-version-file: go.work |
||||
- name: Run tests |
||||
run: make gen-go test-go-unit |
||||
- name: Upload coverage file |
||||
uses: actions/upload-artifact@v4 |
||||
if: success() || failure() |
||||
with: |
||||
name: unit-cov |
||||
path: unit.cov |
||||
retention-days: 1 |
||||
compression-level: 9 # this is raw text, and includes a _lot_ of repetition. compressing it should yield pretty good results. |
||||
integration-tests: |
||||
name: Run integration tests (OSS) |
||||
runs-on: ubuntu-latest |
||||
if: github.repository == 'grafana/grafana' |
||||
steps: |
||||
- name: Check out repository |
||||
uses: actions/checkout@v4.2.2 |
||||
- name: Setup Go environment |
||||
uses: actions/setup-go@v5.3.0 |
||||
with: |
||||
go-version-file: go.work |
||||
- name: Run tests |
||||
run: make gen-go test-go-integration |
||||
- name: Upload coverage file |
||||
uses: actions/upload-artifact@v4 |
||||
if: success() || failure() |
||||
with: |
||||
name: integration-cov |
||||
path: integration.cov |
||||
retention-days: 1 |
||||
compression-level: 9 # this is raw text, and includes a _lot_ of repetition. compressing it should yield pretty good results. |
||||
report-coverage: |
||||
name: Report coverage from unit and integration tests (OSS) |
||||
needs: [unit-tests, integration-tests] |
||||
runs-on: ubuntu-latest |
||||
# we don't do always() so as to not run even if the workflow is cancelled |
||||
if: github.repository == 'grafana/grafana' && (success() || failure()) |
||||
steps: |
||||
- name: Check out repository |
||||
uses: actions/checkout@v4.2.2 |
||||
- name: Setup Go environment |
||||
uses: actions/setup-go@v5.3.0 |
||||
with: |
||||
go-version-file: go.work |
||||
- name: Generate Go |
||||
run: make gen-go |
||||
- uses: actions/download-artifact@v4 |
||||
with: |
||||
pattern: '*-cov' |
||||
path: . |
||||
merge-multiple: true |
||||
- name: Join coverage outputs |
||||
run: | |
||||
cp unit.cov backend.cov |
||||
tail -n+2 integration.cov >> backend.cov |
||||
- name: Convert coverage info to per-func stats |
||||
run: go tool cover -func backend.cov > backend-funcs.log |
||||
# The HTML can be useful in some UI to browse the artifacts easily. |
||||
- name: Convert coverage info to HTML |
||||
run: go tool cover -html backend.cov -o backend.html |
||||
- name: Upload coverage file |
||||
uses: actions/upload-artifact@v4 |
||||
with: |
||||
name: backend-cov |
||||
path: | |
||||
backend.cov |
||||
backend-funcs.log |
||||
backend.html |
||||
retention-days: 30 |
||||
compression-level: 9 # this is raw text, and includes a _lot_ of repetition. compressing it should yield pretty good results. |
||||
- name: Delete old coverage files |
||||
# This is a community tool, not one provided by GitHub. Hence it shall be pinned to a hash. |
||||
# https://github.com/GeekyEggo/delete-artifact/tree/v5 |
||||
uses: GeekyEggo/delete-artifact@f275313e70c08f6120db482d7a6b98377786765b |
||||
with: |
||||
name: | |
||||
unit-cov |
||||
integration-cov |
||||
failOnError: false # oh well, we'll just have the extra artifacts... |
||||
- name: Set summary to total coverage |
||||
# We use single quotes here to disable the bash backtick behaviour of executing commands. |
||||
run: | |
||||
echo '# Coverage' >> $GITHUB_STEP_SUMMARY |
||||
echo '```' >> $GITHUB_STEP_SUMMARY |
||||
grep 'total:' backend-funcs.log | tr '\t' ' ' >> $GITHUB_STEP_SUMMARY |
||||
echo '```' >> $GITHUB_STEP_SUMMARY |
||||
@ -0,0 +1,25 @@ |
||||
name: Feature toggles CI |
||||
|
||||
on: |
||||
pull_request: |
||||
paths: |
||||
- 'pkg/services/featuremgmt/toggles_gen_test.go' |
||||
- 'pkg/services/featuremgmt/registry.go' |
||||
- 'docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md' |
||||
|
||||
jobs: |
||||
test: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
with: |
||||
persist-credentials: false |
||||
|
||||
- name: Set up Go |
||||
uses: actions/setup-go@v5 |
||||
with: |
||||
go-version-file: 'go.mod' |
||||
cache: true |
||||
|
||||
- name: Run feature toggle tests |
||||
run: go test -v -run TestFeatureToggleFiles ./pkg/services/featuremgmt/ |
||||
@ -0,0 +1,55 @@ |
||||
name: Lint Frontend |
||||
on: |
||||
pull_request: |
||||
push: |
||||
branches: |
||||
- main |
||||
- release-*.*.* |
||||
|
||||
jobs: |
||||
verify-i18n: |
||||
name: Verify i18n |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
- uses: actions/setup-node@v4 |
||||
with: |
||||
node-version-file: '.nvmrc' |
||||
cache: 'yarn' |
||||
cache-dependency-path: 'yarn.lock' |
||||
- run: yarn install --immutable --check-cache |
||||
- run: | |
||||
extract_error_message='::error::Extraction failed. Make sure that you have no dynamic translation phrases, such as "t(`preferences.theme.{themeID}`, themeName)" and that no translation key is used twice. Search the output for '[warning]' to find the offending file.' |
||||
make i18n-extract || (echo "${extract_error_message}" && false) |
||||
- run: | |
||||
uncommited_error_message="::error::Translation extraction has not been committed. Please run 'make i18n-extract', commit the changes and push again." |
||||
file_diff=$(git diff --dirstat public/locales) |
||||
if [ -n "$file_diff" ]; then |
||||
echo $file_diff |
||||
echo "${uncommited_error_message}" |
||||
exit 1 |
||||
fi |
||||
prettier: |
||||
name: Prettier |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
- uses: actions/setup-node@v4 |
||||
with: |
||||
node-version-file: '.nvmrc' |
||||
cache: 'yarn' |
||||
cache-dependency-path: 'yarn.lock' |
||||
- run: yarn install --immutable --check-cache |
||||
- run: yarn run prettier:check |
||||
typecheck: |
||||
name: Typecheck |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
- uses: actions/setup-node@v4 |
||||
with: |
||||
node-version-file: '.nvmrc' |
||||
cache: 'yarn' |
||||
cache-dependency-path: 'yarn.lock' |
||||
- run: yarn install --immutable --check-cache |
||||
- run: yarn run typecheck |
||||
@ -0,0 +1,29 @@ |
||||
name: Frontend tests |
||||
on: |
||||
pull_request: |
||||
push: |
||||
branches: |
||||
- main |
||||
- release-*.*.* |
||||
|
||||
jobs: |
||||
test-frontend: |
||||
runs-on: ubuntu-latest-8-cores |
||||
name: "Unit tests (${{ matrix.chunk }} / 8)" |
||||
strategy: |
||||
fail-fast: true |
||||
matrix: |
||||
chunk: [1, 2, 3, 4, 5, 6, 7, 8] |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
- uses: actions/setup-node@v4 |
||||
with: |
||||
node-version-file: '.nvmrc' |
||||
cache: 'yarn' |
||||
cache-dependency-path: 'yarn.lock' |
||||
- run: yarn install --immutable --check-cache |
||||
- run: yarn run test:ci |
||||
env: |
||||
TEST_MAX_WORKERS: 2 |
||||
TEST_SHARD: ${{ matrix.chunk }} |
||||
TEST_SHARD_TOTAL: 8 |
||||
@ -0,0 +1,37 @@ |
||||
name: Backend Code Checks |
||||
description: Validate go.mod and OpenAPI specifications |
||||
|
||||
on: |
||||
pull_request: |
||||
paths-ignore: |
||||
- '*.md' |
||||
- 'docs/**' |
||||
- 'latest.json' |
||||
|
||||
permissions: |
||||
contents: read |
||||
|
||||
jobs: |
||||
validate-configs: |
||||
name: Validate Backend Configs |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- uses: actions/checkout@v4 |
||||
|
||||
- name: Setup Go |
||||
uses: actions/setup-go@v5 |
||||
with: |
||||
go-version-file: go.mod |
||||
cache: true |
||||
|
||||
- name: Verify code generation |
||||
run: | |
||||
CODEGEN_VERIFY=1 make gen-cue |
||||
CODEGEN_VERIFY=1 make gen-jsonnet |
||||
|
||||
- name: Validate go.mod |
||||
run: go run scripts/modowners/modowners.go check go.mod |
||||
|
||||
- name: Generate and Validate OpenAPI Specs |
||||
run: | |
||||
make swagger-gen |
||||
@ -0,0 +1,78 @@ |
||||
name: Backend Unit Tests |
||||
|
||||
on: |
||||
workflow_dispatch: |
||||
push: |
||||
branches: |
||||
- main |
||||
paths-ignore: |
||||
- 'docs/**' |
||||
- '**/*.md' |
||||
pull_request: |
||||
paths-ignore: |
||||
- 'docs/**' |
||||
- '**/*.md' |
||||
|
||||
permissions: |
||||
contents: read |
||||
id-token: write |
||||
|
||||
env: |
||||
EDITION: 'oss' |
||||
WIRE_TAGS: 'oss' |
||||
|
||||
jobs: |
||||
backend-testing-coverage: |
||||
name: Backend Testing & Coverage |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: Checkout code |
||||
uses: actions/checkout@v4 |
||||
|
||||
- name: Setup Go |
||||
uses: actions/setup-go@v5 |
||||
with: |
||||
go-version-file: go.mod |
||||
cache: true |
||||
|
||||
- name: Install dependencies |
||||
run: | |
||||
sudo apt-get update |
||||
sudo apt-get install -y build-essential shared-mime-info |
||||
go install github.com/mfridman/tparse@c1754a1f484ac5cd422697b0fec635177ddc8507 # v0.17.0 |
||||
|
||||
- name: Generate Go code |
||||
run: make gen-go |
||||
|
||||
- name: Run unit tests |
||||
run: COVER_OPTS="-coverprofile=be-unit.cov -coverpkg=github.com/grafana/grafana/..." GO_TEST_OUTPUT="/tmp/unit.log" make test-go-unit |
||||
|
||||
- name: Process and upload coverage |
||||
uses: ./.github/actions/test-coverage-processor |
||||
with: |
||||
test-type: 'be-unit' |
||||
# Needs to be named 'unit.cov' based on the Makefile command `make test-go-unit` |
||||
coverage-file: 'unit.cov' |
||||
codecov-token: ${{ secrets.CODECOV_TOKEN }} |
||||
codecov-flag: 'be-unit' |
||||
codecov-name: 'be-unit' |
||||
|
||||
- name: Install Grafana Bench |
||||
# We can't allow forks here, as we need secret access. |
||||
if: ${{ github.event_name != 'pull_request' }} |
||||
uses: ./.github/actions/setup-grafana-bench |
||||
|
||||
- name: Process output for Bench |
||||
if: ${{ github.event_name != 'pull_request' }} |
||||
run: | |
||||
grafana-bench report \ |
||||
--trigger pr-backend-unit-tests-oss \ |
||||
--report-input go \ |
||||
--report-output log \ |
||||
--grafana-version "$(git rev-parse HEAD)" \ |
||||
--suite-name grafana-oss-unit-tests \ |
||||
/tmp/unit.log |
||||
|
||||
concurrency: |
||||
group: ${{ github.workflow }}-${{ github.ref }} |
||||
cancel-in-progress: true |
||||
@ -1,5 +1,5 @@ |
||||
MinAlertLevel = warning |
||||
|
||||
[*] |
||||
[*.md] |
||||
BasedOnStyles = Grafana |
||||
TokenIgnores = (<http[^\n]+>+?), \*\*[^\n]+\*\* |
||||
|
||||
@ -0,0 +1,18 @@ |
||||
.PHONY: generate |
||||
generate: |
||||
@grafana-app-sdk generate \
|
||||
--source=./kinds/ \
|
||||
--gogenpath=../../pkg/apis \
|
||||
--tsgenpath=../../packages/grafana-schema/src/schema \
|
||||
--grouping=group \
|
||||
--defencoding=none \
|
||||
--genoperatorstate=false \
|
||||
--noschemasinmanifest
|
||||
|
||||
# This is a workaround for SDK codegen not producing correct output for v0alpha1
|
||||
@rm ../../packages/grafana-schema/src/schema/dashboard/v0alpha1/types.spec.gen.ts
|
||||
@cp ./tshack/v0alpha1_spec_gen.ts ../../packages/grafana-schema/src/schema/dashboard/v0alpha1/types.spec.gen.ts
|
||||
|
||||
# Same for v1alpha1
|
||||
@rm ../../packages/grafana-schema/src/schema/dashboard/v1alpha1/types.spec.gen.ts
|
||||
@cp ./tshack/v1alpha1_spec_gen.ts ../../packages/grafana-schema/src/schema/dashboard/v1alpha1/types.spec.gen.ts
|
||||
@ -0,0 +1,4 @@ |
||||
module: "github.com/grafana/grafana/sdkkinds/dashboard" |
||||
language: { |
||||
version: "v0.9.0" |
||||
} |
||||
@ -0,0 +1,68 @@ |
||||
package kinds |
||||
|
||||
import ( |
||||
"github.com/grafana/grafana/sdkkinds/dashboard/v0alpha1" |
||||
"github.com/grafana/grafana/sdkkinds/dashboard/v1alpha1" |
||||
"github.com/grafana/grafana/sdkkinds/dashboard/v2alpha1" |
||||
) |
||||
|
||||
// Status is the shared status of all dashboard versions. |
||||
DashboardStatus: { |
||||
// Optional conversion status. |
||||
conversion?: ConversionStatus |
||||
} |
||||
|
||||
// ConversionStatus is the status of the conversion of the dashboard. |
||||
ConversionStatus: { |
||||
// Whether from another version has failed. |
||||
// If true, means that the dashboard is not valid, |
||||
// and the caller should instead fetch the stored version. |
||||
failed: bool |
||||
|
||||
// The version which was stored when the dashboard was created / updated. |
||||
// Fetching this version should always succeed. |
||||
storedVersion: string |
||||
|
||||
// The error message from the conversion. |
||||
// Empty if the conversion has not failed. |
||||
error: string |
||||
} |
||||
|
||||
dashboard: { |
||||
kind: "Dashboard" |
||||
pluralName: "Dashboards" |
||||
current: "v0alpha1" |
||||
|
||||
codegen: { |
||||
ts: { |
||||
enabled: true |
||||
config: { |
||||
enumsAsUnionTypes: true |
||||
} |
||||
} |
||||
go: { |
||||
enabled: true |
||||
} |
||||
} |
||||
|
||||
versions: { |
||||
"v0alpha1": { |
||||
schema: { |
||||
spec: v0alpha1.DashboardSpec |
||||
status: DashboardStatus |
||||
} |
||||
} |
||||
"v1alpha1": { |
||||
schema: { |
||||
spec: v1alpha1.DashboardSpec |
||||
status: DashboardStatus |
||||
} |
||||
} |
||||
"v2alpha1": { |
||||
schema: { |
||||
spec: v2alpha1.DashboardSpec |
||||
status: DashboardStatus |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,9 @@ |
||||
package kinds |
||||
|
||||
manifest: { |
||||
appName: "dashboard" |
||||
groupOverride: "dashboard.grafana.app" |
||||
kinds: [ |
||||
dashboard, |
||||
] |
||||
} |
||||
@ -0,0 +1,6 @@ |
||||
package v0alpha1 |
||||
|
||||
// TODO: this outputs nothing. |
||||
// For now, we use unstructured for the spec, |
||||
// but it cannot be produced by the SDK codegen. |
||||
DashboardSpec: [string]: _ |
||||
@ -0,0 +1,6 @@ |
||||
package v1alpha1 |
||||
|
||||
// TODO: this outputs nothing. |
||||
// For now, we use unstructured for the spec, |
||||
// but it cannot be produced by the SDK codegen. |
||||
DashboardSpec: [string]: _ |
||||
@ -0,0 +1,923 @@ |
||||
package v2alpha1 |
||||
|
||||
DashboardSpec: { |
||||
// Title of dashboard. |
||||
annotations: [...AnnotationQueryKind] |
||||
|
||||
// Configuration of dashboard cursor sync behavior. |
||||
// "Off" for no shared crosshair or tooltip (default). |
||||
// "Crosshair" for shared crosshair. |
||||
// "Tooltip" for shared crosshair AND shared tooltip. |
||||
cursorSync: DashboardCursorSync |
||||
|
||||
// Description of dashboard. |
||||
description?: string |
||||
|
||||
// Whether a dashboard is editable or not. |
||||
editable?: bool | *true |
||||
|
||||
elements: [ElementReference.name]: Element |
||||
|
||||
layout: GridLayoutKind | RowsLayoutKind | ResponsiveGridLayoutKind | TabsLayoutKind |
||||
|
||||
// Links with references to other dashboards or external websites. |
||||
links: [...DashboardLink] |
||||
|
||||
// When set to true, the dashboard will redraw panels at an interval matching the pixel width. |
||||
// This will keep data "moving left" regardless of the query refresh rate. This setting helps |
||||
// avoid dashboards presenting stale live data. |
||||
liveNow?: bool |
||||
|
||||
// When set to true, the dashboard will load all panels in the dashboard when it's loaded. |
||||
preload: bool |
||||
|
||||
// Plugins only. The version of the dashboard installed together with the plugin. |
||||
// This is used to determine if the dashboard should be updated when the plugin is updated. |
||||
revision?: uint16 |
||||
|
||||
// Tags associated with dashboard. |
||||
tags: [...string] |
||||
|
||||
timeSettings: TimeSettingsSpec |
||||
|
||||
// Title of dashboard. |
||||
title: string |
||||
|
||||
// Configured template variables. |
||||
variables: [...VariableKind] |
||||
} |
||||
|
||||
// Supported dashboard elements |
||||
Element: PanelKind | LibraryPanelKind // |* more element types in the future |
||||
|
||||
LibraryPanelKind: { |
||||
kind: "LibraryPanel" |
||||
spec: LibraryPanelKindSpec |
||||
} |
||||
|
||||
LibraryPanelKindSpec: { |
||||
// Panel ID for the library panel in the dashboard |
||||
id: number |
||||
// Title for the library panel in the dashboard |
||||
title: string |
||||
|
||||
libraryPanel: LibraryPanelRef |
||||
} |
||||
|
||||
// A library panel is a reusable panel that you can use in any dashboard. |
||||
// When you make a change to a library panel, that change propagates to all instances of where the panel is used. |
||||
// Library panels streamline reuse of panels across multiple dashboards. |
||||
LibraryPanelRef: { |
||||
// Library panel name |
||||
name: string |
||||
// Library panel uid |
||||
uid: string |
||||
} |
||||
|
||||
AnnotationPanelFilter: { |
||||
// Should the specified panels be included or excluded |
||||
exclude?: bool | *false |
||||
|
||||
// Panel IDs that should be included or excluded |
||||
ids: [...uint8] |
||||
} |
||||
|
||||
// "Off" for no shared crosshair or tooltip (default). |
||||
// "Crosshair" for shared crosshair. |
||||
// "Tooltip" for shared crosshair AND shared tooltip. |
||||
DashboardCursorSync: "Off" | "Crosshair" | "Tooltip" |
||||
|
||||
// Links with references to other dashboards or external resources |
||||
DashboardLink: { |
||||
// Title to display with the link |
||||
title: string |
||||
// Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) |
||||
// FIXME: The type is generated as `type: DashboardLinkType | dashboardLinkType.Link;` but it should be `type: DashboardLinkType` |
||||
type: DashboardLinkType |
||||
// Icon name to be displayed with the link |
||||
icon: string |
||||
// Tooltip to display when the user hovers their mouse over it |
||||
tooltip: string |
||||
// Link URL. Only required/valid if the type is link |
||||
url?: string |
||||
// List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards |
||||
tags: [...string] |
||||
// If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards |
||||
asDropdown: bool | *false |
||||
// If true, the link will be opened in a new tab |
||||
targetBlank: bool | *false |
||||
// If true, includes current template variables values in the link as query params |
||||
includeVars: bool | *false |
||||
// If true, includes current time range in the link as query params |
||||
keepTime: bool | *false |
||||
} |
||||
|
||||
DataSourceRef: { |
||||
// The plugin type-id |
||||
type?: string |
||||
|
||||
// Specific datasource instance |
||||
uid?: string |
||||
} |
||||
|
||||
// A topic is attached to DataFrame metadata in query results. |
||||
// This specifies where the data should be used. |
||||
DataTopic: "series" | "annotations" | "alertStates" @cog(kind="enum",memberNames="Series|Annotations|AlertStates") |
||||
|
||||
// Transformations allow to manipulate data returned by a query before the system applies a visualization. |
||||
// Using transformations you can: rename fields, join time series data, perform mathematical operations across queries, |
||||
// use the output of one transformation as the input to another transformation, etc. |
||||
DataTransformerConfig: { |
||||
// Unique identifier of transformer |
||||
id: string |
||||
// Disabled transformations are skipped |
||||
disabled?: bool |
||||
// Optional frame matcher. When missing it will be applied to all results |
||||
filter?: MatcherConfig |
||||
// Where to pull DataFrames from as input to transformation |
||||
topic?: DataTopic |
||||
// Options to be passed to the transformer |
||||
// Valid options depend on the transformer id |
||||
options: _ |
||||
} |
||||
|
||||
DataLink: { |
||||
title: string |
||||
url: string |
||||
targetBlank?: bool |
||||
} |
||||
|
||||
// The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. |
||||
// Each column within this structure is called a field. A field can represent a single time series or table column. |
||||
// Field options allow you to change how the data is displayed in your visualizations. |
||||
FieldConfigSource: { |
||||
// Defaults are the options applied to all fields. |
||||
defaults: FieldConfig |
||||
// Overrides are the options applied to specific fields overriding the defaults. |
||||
overrides: [...{ |
||||
matcher: MatcherConfig |
||||
properties: [...DynamicConfigValue] |
||||
}] |
||||
} |
||||
|
||||
// The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. |
||||
// Each column within this structure is called a field. A field can represent a single time series or table column. |
||||
// Field options allow you to change how the data is displayed in your visualizations. |
||||
FieldConfig: { |
||||
// The display value for this field. This supports template variables blank is auto |
||||
displayName?: string |
||||
|
||||
// This can be used by data sources that return and explicit naming structure for values and labels |
||||
// When this property is configured, this value is used rather than the default naming strategy. |
||||
displayNameFromDS?: string |
||||
|
||||
// Human readable field metadata |
||||
description?: string |
||||
|
||||
// An explicit path to the field in the datasource. When the frame meta includes a path, |
||||
// This will default to `${frame.meta.path}/${field.name} |
||||
// |
||||
// When defined, this value can be used as an identifier within the datasource scope, and |
||||
// may be used to update the results |
||||
path?: string |
||||
|
||||
// True if data source can write a value to the path. Auth/authz are supported separately |
||||
writeable?: bool |
||||
|
||||
// True if data source field supports ad-hoc filters |
||||
filterable?: bool |
||||
|
||||
// Unit a field should use. The unit you select is applied to all fields except time. |
||||
// You can use the units ID availables in Grafana or a custom unit. |
||||
// Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts |
||||
// As custom unit, you can use the following formats: |
||||
// `suffix:<suffix>` for custom unit that should go after value. |
||||
// `prefix:<prefix>` for custom unit that should go before value. |
||||
// `time:<format>` For custom date time formats type for example `time:YYYY-MM-DD`. |
||||
// `si:<base scale><unit characters>` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. |
||||
// `count:<unit>` for a custom count unit. |
||||
// `currency:<unit>` for custom a currency unit. |
||||
unit?: string |
||||
|
||||
// Specify the number of decimals Grafana includes in the rendered value. |
||||
// If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. |
||||
// For example 1.1234 will display as 1.12 and 100.456 will display as 100. |
||||
// To display all decimals, set the unit to `String`. |
||||
decimals?: number |
||||
|
||||
// The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
||||
min?: number |
||||
// The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
||||
max?: number |
||||
|
||||
// Convert input values into a display string |
||||
mappings?: [...ValueMapping] |
||||
|
||||
// Map numeric values to states |
||||
thresholds?: ThresholdsConfig |
||||
|
||||
// Panel color configuration |
||||
color?: FieldColor |
||||
|
||||
// The behavior when clicking on a result |
||||
links?: [...] |
||||
|
||||
// Alternative to empty string |
||||
noValue?: string |
||||
|
||||
// custom is specified by the FieldConfig field |
||||
// in panel plugin schemas. |
||||
custom?: {...} |
||||
} |
||||
|
||||
DynamicConfigValue: { |
||||
id: string | *"" |
||||
value?: _ |
||||
} |
||||
|
||||
// Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. |
||||
// It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. |
||||
MatcherConfig: { |
||||
// The matcher id. This is used to find the matcher implementation from registry. |
||||
id: string | *"" |
||||
// The matcher options. This is specific to the matcher implementation. |
||||
options?: _ |
||||
} |
||||
|
||||
Threshold: { |
||||
value: number |
||||
color: string |
||||
} |
||||
|
||||
ThresholdsMode: "absolute" | "percentage" |
||||
|
||||
ThresholdsConfig: { |
||||
mode: ThresholdsMode |
||||
steps: [...Threshold] |
||||
} |
||||
|
||||
ValueMapping: ValueMap | RangeMap | RegexMap | SpecialValueMap |
||||
|
||||
// Supported value mapping types |
||||
// `value`: Maps text values to a color or different display text and color. For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number. |
||||
// `range`: Maps numerical ranges to a display text and color. For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number. |
||||
// `regex`: Maps regular expressions to replacement text and a color. For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain. |
||||
// `special`: Maps special values like Null, NaN (not a number), and boolean values like true and false to a display text and color. See SpecialValueMatch to see the list of special values. For example, you can configure a special value mapping so that null values appear as N/A. |
||||
MappingType: "value" | "range" | "regex" | "special" @cog(kind="enum",memberNames="ValueToText|RangeToText|RegexToText|SpecialValue") |
||||
|
||||
// Maps text values to a color or different display text and color. |
||||
// For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number. |
||||
ValueMap: { |
||||
// TODO (@radiohead): Something broke in cog / app SDK codegen |
||||
// And this is no longer producing valid TS / Go output |
||||
// type: MappingType & "value" |
||||
type: "value" |
||||
// Map with <value_to_match>: ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } |
||||
options: [string]: ValueMappingResult |
||||
} |
||||
|
||||
// Maps numerical ranges to a display text and color. |
||||
// For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number. |
||||
RangeMap: { |
||||
// TODO (@radiohead): Something broke in cog / app SDK codegen |
||||
// And this is no longer producing valid TS / Go output |
||||
// type: MappingType & "range" |
||||
type: "range" |
||||
// Range to match against and the result to apply when the value is within the range |
||||
options: { |
||||
// Min value of the range. It can be null which means -Infinity |
||||
from: float64 | null |
||||
// Max value of the range. It can be null which means +Infinity |
||||
to: float64 | null |
||||
// Config to apply when the value is within the range |
||||
result: ValueMappingResult |
||||
} |
||||
} |
||||
|
||||
// Maps regular expressions to replacement text and a color. |
||||
// For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain. |
||||
RegexMap: { |
||||
// TODO (@radiohead): Something broke in cog / app SDK codegen |
||||
// And this is no longer producing valid TS / Go output |
||||
// type: MappingType & "regex" |
||||
type: "regex" |
||||
// Regular expression to match against and the result to apply when the value matches the regex |
||||
options: { |
||||
// Regular expression to match against |
||||
pattern: string |
||||
// Config to apply when the value matches the regex |
||||
result: ValueMappingResult |
||||
} |
||||
} |
||||
|
||||
// Maps special values like Null, NaN (not a number), and boolean values like true and false to a display text and color. |
||||
// See SpecialValueMatch to see the list of special values. |
||||
// For example, you can configure a special value mapping so that null values appear as N/A. |
||||
SpecialValueMap: { |
||||
// TODO (@radiohead): Something broke in cog / app SDK codegen |
||||
// And this is no longer producing valid TS / Go output |
||||
// type: MappingType & "special" |
||||
type: "special" |
||||
options: { |
||||
// Special value to match against |
||||
match: SpecialValueMatch |
||||
// Config to apply when the value matches the special value |
||||
result: ValueMappingResult |
||||
} |
||||
} |
||||
|
||||
// Special value types supported by the `SpecialValueMap` |
||||
SpecialValueMatch: "true" | "false" | "null" | "nan" | "null+nan" | "empty" @cog(kind="enum",memberNames="True|False|Null|NaN|NullAndNaN|Empty") |
||||
|
||||
// Result used as replacement with text and color when the value matches |
||||
ValueMappingResult: { |
||||
// Text to display when the value matches |
||||
text?: string |
||||
// Text to use when the value matches |
||||
color?: string |
||||
// Icon to display when the value matches. Only specific visualizations. |
||||
icon?: string |
||||
// Position in the mapping array. Only used internally. |
||||
index?: int32 |
||||
} |
||||
|
||||
// Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. |
||||
// Continuous color interpolates a color using the percentage of a value relative to min and max. |
||||
// Accepted values are: |
||||
// `thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold |
||||
// `palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations |
||||
// `palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations |
||||
// `continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode |
||||
// `continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode |
||||
// `continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode |
||||
// `continuous-YlRd`: Continuous Yellow-Red palette mode |
||||
// `continuous-BlPu`: Continuous Blue-Purple palette mode |
||||
// `continuous-YlBl`: Continuous Yellow-Blue palette mode |
||||
// `continuous-blues`: Continuous Blue palette mode |
||||
// `continuous-reds`: Continuous Red palette mode |
||||
// `continuous-greens`: Continuous Green palette mode |
||||
// `continuous-purples`: Continuous Purple palette mode |
||||
// `shades`: Shades of a single color. Specify a single color, useful in an override rule. |
||||
// `fixed`: Fixed color mode. Specify a single color, useful in an override rule. |
||||
FieldColorModeId: "thresholds" | "palette-classic" | "palette-classic-by-name" | "continuous-GrYlRd" | "continuous-RdYlGr" | "continuous-BlYlRd" | "continuous-YlRd" | "continuous-BlPu" | "continuous-YlBl" | "continuous-blues" | "continuous-reds" | "continuous-greens" | "continuous-purples" | "fixed" | "shades" |
||||
|
||||
// Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. |
||||
FieldColorSeriesByMode: "min" | "max" | "last" |
||||
|
||||
// Map a field to a color. |
||||
FieldColor: { |
||||
// The main color scheme mode. |
||||
mode: FieldColorModeId |
||||
// The fixed color value for fixed or shades color modes. |
||||
fixedColor?: string |
||||
// Some visualizations need to know how to assign a series color from by value color schemes. |
||||
seriesBy?: FieldColorSeriesByMode |
||||
} |
||||
|
||||
// Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) |
||||
DashboardLinkType: "link" | "dashboards" |
||||
|
||||
// --- Common types --- |
||||
Kind: { |
||||
kind: string |
||||
spec: _ |
||||
metadata?: _ |
||||
} |
||||
|
||||
// --- Kinds --- |
||||
VizConfigSpec: { |
||||
pluginVersion: string |
||||
options: [string]: _ |
||||
fieldConfig: FieldConfigSource |
||||
} |
||||
|
||||
VizConfigKind: { |
||||
// The kind of a VizConfigKind is the plugin ID |
||||
kind: string |
||||
spec: VizConfigSpec |
||||
} |
||||
|
||||
AnnotationQuerySpec: { |
||||
datasource?: DataSourceRef |
||||
query?: DataQueryKind |
||||
enable: bool |
||||
hide: bool |
||||
iconColor: string |
||||
name: string |
||||
builtIn?: bool | *false |
||||
filter?: AnnotationPanelFilter |
||||
} |
||||
|
||||
AnnotationQueryKind: { |
||||
kind: "AnnotationQuery" |
||||
spec: AnnotationQuerySpec |
||||
} |
||||
|
||||
QueryOptionsSpec: { |
||||
timeFrom?: string |
||||
maxDataPoints?: int |
||||
timeShift?: string |
||||
queryCachingTTL?: int |
||||
interval?: string |
||||
cacheTimeout?: string |
||||
hideTimeOverride?: bool |
||||
} |
||||
|
||||
DataQueryKind: { |
||||
// The kind of a DataQueryKind is the datasource type |
||||
kind: string |
||||
spec: [string]: _ |
||||
} |
||||
|
||||
PanelQuerySpec: { |
||||
query: DataQueryKind |
||||
datasource?: DataSourceRef |
||||
|
||||
refId: string |
||||
hidden: bool |
||||
} |
||||
|
||||
PanelQueryKind: { |
||||
kind: "PanelQuery" |
||||
spec: PanelQuerySpec |
||||
} |
||||
|
||||
TransformationKind: { |
||||
// The kind of a TransformationKind is the transformation ID |
||||
kind: string |
||||
spec: DataTransformerConfig |
||||
} |
||||
|
||||
QueryGroupSpec: { |
||||
queries: [...PanelQueryKind] |
||||
transformations: [...TransformationKind] |
||||
queryOptions: QueryOptionsSpec |
||||
} |
||||
|
||||
QueryGroupKind: { |
||||
kind: "QueryGroup" |
||||
spec: QueryGroupSpec |
||||
} |
||||
|
||||
TimeRangeOption: { |
||||
display: string | *"Last 6 hours" |
||||
from: string | *"now-6h" |
||||
to: string | *"now" |
||||
} |
||||
|
||||
// Time configuration |
||||
// It defines the default time config for the time picker, the refresh picker for the specific dashboard. |
||||
TimeSettingsSpec: { |
||||
// Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc". |
||||
timezone?: string | *"browser" |
||||
// Start time range for dashboard. |
||||
// Accepted values are relative time strings like "now-6h" or absolute time strings like "2020-07-10T08:00:00.000Z". |
||||
from: string | *"now-6h" |
||||
// End time range for dashboard. |
||||
// Accepted values are relative time strings like "now-6h" or absolute time strings like "2020-07-10T08:00:00.000Z". |
||||
to: string | *"now" |
||||
// Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". |
||||
autoRefresh: string // v1: refresh |
||||
// Interval options available in the refresh picker dropdown. |
||||
autoRefreshIntervals: [...string] | *["5s", "10s", "30s", "1m", "5m", "15m", "30m", "1h", "2h", "1d"] // v1: timepicker.refresh_intervals |
||||
// Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. |
||||
quickRanges?: [...TimeRangeOption] // v1: timepicker.quick_ranges , not exposed in the UI |
||||
// Whether timepicker is visible or not. |
||||
hideTimepicker: bool // v1: timepicker.hidden |
||||
// Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday". |
||||
weekStart?: "saturday" | "monday" | "sunday" |
||||
// The month that the fiscal year starts on. 0 = January, 11 = December |
||||
fiscalYearStartMonth: int |
||||
// Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values. |
||||
nowDelay?: string // v1: timepicker.nowDelay |
||||
} |
||||
|
||||
RepeatMode: "variable" // other repeat modes will be added in the future: label, frame |
||||
|
||||
RepeatOptions: { |
||||
mode: RepeatMode |
||||
value: string |
||||
direction?: "h" | "v" |
||||
maxPerRow?: int |
||||
} |
||||
|
||||
RowRepeatOptions: { |
||||
mode: RepeatMode |
||||
value: string |
||||
} |
||||
|
||||
ResponsiveGridRepeatOptions: { |
||||
mode: RepeatMode |
||||
value: string |
||||
} |
||||
|
||||
GridLayoutItemSpec: { |
||||
x: int |
||||
y: int |
||||
width: int |
||||
height: int |
||||
element: ElementReference // reference to a PanelKind from dashboard.spec.elements Expressed as JSON Schema reference |
||||
repeat?: RepeatOptions |
||||
} |
||||
|
||||
GridLayoutItemKind: { |
||||
kind: "GridLayoutItem" |
||||
spec: GridLayoutItemSpec |
||||
} |
||||
|
||||
GridLayoutRowKind: { |
||||
kind: "GridLayoutRow" |
||||
spec: GridLayoutRowSpec |
||||
} |
||||
|
||||
GridLayoutRowSpec: { |
||||
y: int |
||||
collapsed: bool |
||||
title: string |
||||
elements: [...GridLayoutItemKind] // Grid items in the row will have their Y value be relative to the rows Y value. This means a panel positioned at Y: 0 in a row with Y: 10 will be positioned at Y: 11 (row header has a heigh of 1) in the dashboard. |
||||
repeat?: RowRepeatOptions |
||||
} |
||||
|
||||
GridLayoutSpec: { |
||||
items: [...GridLayoutItemKind | GridLayoutRowKind] |
||||
} |
||||
|
||||
GridLayoutKind: { |
||||
kind: "GridLayout" |
||||
spec: GridLayoutSpec |
||||
} |
||||
|
||||
RowsLayoutKind: { |
||||
kind: "RowsLayout" |
||||
spec: RowsLayoutSpec |
||||
} |
||||
|
||||
RowsLayoutSpec: { |
||||
rows: [...RowsLayoutRowKind] |
||||
} |
||||
|
||||
RowsLayoutRowKind: { |
||||
kind: "RowsLayoutRow" |
||||
spec: RowsLayoutRowSpec |
||||
} |
||||
|
||||
RowsLayoutRowSpec: { |
||||
title?: string |
||||
collapsed: bool |
||||
repeat?: RowRepeatOptions |
||||
layout: GridLayoutKind | ResponsiveGridLayoutKind | TabsLayoutKind |
||||
} |
||||
|
||||
ResponsiveGridLayoutKind: { |
||||
kind: "ResponsiveGridLayout" |
||||
spec: ResponsiveGridLayoutSpec |
||||
} |
||||
|
||||
ResponsiveGridLayoutSpec: { |
||||
row: string |
||||
col: string |
||||
items: [...ResponsiveGridLayoutItemKind] |
||||
} |
||||
|
||||
ResponsiveGridLayoutItemKind: { |
||||
kind: "ResponsiveGridLayoutItem" |
||||
spec: ResponsiveGridLayoutItemSpec |
||||
} |
||||
|
||||
ResponsiveGridLayoutItemSpec: { |
||||
element: ElementReference |
||||
repeat?: ResponsiveGridRepeatOptions |
||||
} |
||||
|
||||
TabsLayoutKind: { |
||||
kind: "TabsLayout" |
||||
spec: TabsLayoutSpec |
||||
} |
||||
|
||||
TabsLayoutSpec: { |
||||
tabs: [...TabsLayoutTabKind] |
||||
} |
||||
|
||||
TabsLayoutTabKind: { |
||||
kind: "TabsLayoutTab" |
||||
spec: TabsLayoutTabSpec |
||||
} |
||||
|
||||
TabsLayoutTabSpec: { |
||||
title?: string |
||||
layout: GridLayoutKind | RowsLayoutKind | ResponsiveGridLayoutKind |
||||
} |
||||
|
||||
PanelSpec: { |
||||
id: number |
||||
title: string |
||||
description: string |
||||
links: [...DataLink] |
||||
data: QueryGroupKind |
||||
vizConfig: VizConfigKind |
||||
transparent?: bool |
||||
} |
||||
|
||||
PanelKind: { |
||||
kind: "Panel" |
||||
spec: PanelSpec |
||||
} |
||||
|
||||
ElementReference: { |
||||
kind: "ElementReference" |
||||
name: string |
||||
} |
||||
|
||||
// Start FIXME: variables - in CUE PR - this are things that should be added into the cue schema |
||||
// TODO: properties such as `hide`, `skipUrlSync`, `multi` are type boolean, and in the old schema they are conditional, |
||||
// should we make them conditional in the new schema as well? or should we make them required but default to false? |
||||
|
||||
// Variable types |
||||
VariableValue: VariableValueSingle | [...VariableValueSingle] |
||||
|
||||
VariableValueSingle: string | bool | number | CustomVariableValue |
||||
|
||||
// Custom formatter variable |
||||
CustomFormatterVariable: { |
||||
name: string |
||||
type: VariableType |
||||
multi: bool |
||||
includeAll: bool |
||||
} |
||||
|
||||
// Custom variable value |
||||
CustomVariableValue: { |
||||
// The format name or function used in the expression |
||||
formatter: *null | string | VariableCustomFormatterFn |
||||
} |
||||
|
||||
// Custom formatter function |
||||
VariableCustomFormatterFn: { |
||||
value: _ |
||||
legacyVariableModel: { |
||||
name: string |
||||
type: VariableType |
||||
multi: bool |
||||
includeAll: bool |
||||
} |
||||
legacyDefaultFormatter?: VariableCustomFormatterFn |
||||
} |
||||
|
||||
// Dashboard variable type |
||||
// `query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on. |
||||
// `adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only). |
||||
// `constant`: Define a hidden constant. |
||||
// `datasource`: Quickly change the data source for an entire dashboard. |
||||
// `interval`: Interval variables represent time spans. |
||||
// `textbox`: Display a free text input field with an optional default value. |
||||
// `custom`: Define the variable options manually using a comma-separated list. |
||||
// `system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables |
||||
VariableType: "query" | "adhoc" | "groupby" | "constant" | "datasource" | "interval" | "textbox" | "custom" | |
||||
"system" | "snapshot" |
||||
|
||||
VariableKind: QueryVariableKind | TextVariableKind | ConstantVariableKind | DatasourceVariableKind | IntervalVariableKind | CustomVariableKind | GroupByVariableKind | AdhocVariableKind |
||||
|
||||
// Sort variable options |
||||
// Accepted values are: |
||||
// `disabled`: No sorting |
||||
// `alphabeticalAsc`: Alphabetical ASC |
||||
// `alphabeticalDesc`: Alphabetical DESC |
||||
// `numericalAsc`: Numerical ASC |
||||
// `numericalDesc`: Numerical DESC |
||||
// `alphabeticalCaseInsensitiveAsc`: Alphabetical Case Insensitive ASC |
||||
// `alphabeticalCaseInsensitiveDesc`: Alphabetical Case Insensitive DESC |
||||
// `naturalAsc`: Natural ASC |
||||
// `naturalDesc`: Natural DESC |
||||
// VariableSort enum with default value |
||||
VariableSort: "disabled" | "alphabeticalAsc" | "alphabeticalDesc" | "numericalAsc" | "numericalDesc" | "alphabeticalCaseInsensitiveAsc" | "alphabeticalCaseInsensitiveDesc" | "naturalAsc" | "naturalDesc" |
||||
|
||||
// Options to config when to refresh a variable |
||||
// `never`: Never refresh the variable |
||||
// `onDashboardLoad`: Queries the data source every time the dashboard loads. |
||||
// `onTimeRangeChanged`: Queries the data source when the dashboard time range changes. |
||||
VariableRefresh: *"never" | "onDashboardLoad" | "onTimeRangeChanged" |
||||
|
||||
// Determine if the variable shows on dashboard |
||||
// Accepted values are `dontHide` (show label and value), `hideLabel` (show value only), `hideVariable` (show nothing). |
||||
VariableHide: *"dontHide" | "hideLabel" | "hideVariable" |
||||
|
||||
// FIXME: should we introduce this? --- Variable value option |
||||
VariableValueOption: { |
||||
label: string |
||||
value: VariableValueSingle |
||||
group?: string |
||||
} |
||||
|
||||
// Variable option specification |
||||
VariableOption: { |
||||
// Whether the option is selected or not |
||||
selected?: bool |
||||
// Text to be displayed for the option |
||||
text: string | [...string] |
||||
// Value of the option |
||||
value: string | [...string] |
||||
} |
||||
|
||||
// Query variable specification |
||||
QueryVariableSpec: { |
||||
name: string | *"" |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
label?: string |
||||
hide: VariableHide |
||||
refresh: VariableRefresh |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
datasource?: DataSourceRef |
||||
query: DataQueryKind |
||||
regex: string | *"" |
||||
sort: VariableSort |
||||
definition?: string |
||||
options: [...VariableOption] | *[] |
||||
multi: bool | *false |
||||
includeAll: bool | *false |
||||
allValue?: string |
||||
placeholder?: string |
||||
} |
||||
|
||||
// Query variable kind |
||||
QueryVariableKind: { |
||||
kind: "QueryVariable" |
||||
spec: QueryVariableSpec |
||||
} |
||||
|
||||
// Text variable specification |
||||
TextVariableSpec: { |
||||
name: string | *"" |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
query: string | *"" |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Text variable kind |
||||
TextVariableKind: { |
||||
kind: "TextVariable" |
||||
spec: TextVariableSpec |
||||
} |
||||
|
||||
// Constant variable specification |
||||
ConstantVariableSpec: { |
||||
name: string | *"" |
||||
query: string | *"" |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Constant variable kind |
||||
ConstantVariableKind: { |
||||
kind: "ConstantVariable" |
||||
spec: ConstantVariableSpec |
||||
} |
||||
|
||||
// Datasource variable specification |
||||
DatasourceVariableSpec: { |
||||
name: string | *"" |
||||
pluginId: string | *"" |
||||
refresh: VariableRefresh |
||||
regex: string | *"" |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
options: [...VariableOption] | *[] |
||||
multi: bool | *false |
||||
includeAll: bool | *false |
||||
allValue?: string |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Datasource variable kind |
||||
DatasourceVariableKind: { |
||||
kind: "DatasourceVariable" |
||||
spec: DatasourceVariableSpec |
||||
} |
||||
|
||||
// Interval variable specification |
||||
IntervalVariableSpec: { |
||||
name: string | *"" |
||||
query: string | *"" |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
options: [...VariableOption] | *[] |
||||
auto: bool | *false |
||||
auto_min: string | *"" |
||||
auto_count: int | *0 |
||||
refresh: VariableRefresh |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Interval variable kind |
||||
IntervalVariableKind: { |
||||
kind: "IntervalVariable" |
||||
spec: IntervalVariableSpec |
||||
} |
||||
|
||||
// Custom variable specification |
||||
CustomVariableSpec: { |
||||
name: string | *"" |
||||
query: string | *"" |
||||
current: VariableOption |
||||
options: [...VariableOption] | *[] |
||||
multi: bool | *false |
||||
includeAll: bool | *false |
||||
allValue?: string |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Custom variable kind |
||||
CustomVariableKind: { |
||||
kind: "CustomVariable" |
||||
spec: CustomVariableSpec |
||||
} |
||||
|
||||
// GroupBy variable specification |
||||
GroupByVariableSpec: { |
||||
name: string | *"" |
||||
datasource?: DataSourceRef |
||||
current: VariableOption | *{ |
||||
text: "" |
||||
value: "" |
||||
} |
||||
options: [...VariableOption] | *[] |
||||
multi: bool | *false |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Group variable kind |
||||
GroupByVariableKind: { |
||||
kind: "GroupByVariable" |
||||
spec: GroupByVariableSpec |
||||
} |
||||
|
||||
// Adhoc variable specification |
||||
AdhocVariableSpec: { |
||||
name: string | *"" |
||||
datasource?: DataSourceRef |
||||
baseFilters: [...AdHocFilterWithLabels] | *[] |
||||
filters: [...AdHocFilterWithLabels] | *[] |
||||
defaultKeys: [...MetricFindValue] | *[] |
||||
label?: string |
||||
hide: VariableHide |
||||
skipUrlSync: bool | *false |
||||
description?: string |
||||
} |
||||
|
||||
// Define the MetricFindValue type |
||||
MetricFindValue: { |
||||
text: string |
||||
value?: string | number |
||||
group?: string |
||||
expandable?: bool |
||||
} |
||||
|
||||
// Define the AdHocFilterWithLabels type |
||||
AdHocFilterWithLabels: { |
||||
key: string |
||||
operator: string |
||||
value: string |
||||
values?: [...string] |
||||
keyLabel?: string |
||||
valueLabels?: [...string] |
||||
forceEdit?: bool |
||||
// @deprecated |
||||
condition?: string |
||||
} |
||||
|
||||
// Adhoc variable kind |
||||
AdhocVariableKind: { |
||||
kind: "AdhocVariable" |
||||
spec: AdhocVariableSpec |
||||
} |
||||
@ -0,0 +1,7 @@ |
||||
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
|
||||
|
||||
export interface Spec { |
||||
[key: string]: any; |
||||
} |
||||
|
||||
export const defaultSpec = (): Spec => ({}); |
||||
@ -0,0 +1,7 @@ |
||||
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
|
||||
|
||||
export interface Spec { |
||||
[key: string]: any; |
||||
} |
||||
|
||||
export const defaultSpec = (): Spec => ({}); |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue