@intentius/chant-lexicon-grafana 0.96.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/dist/build.d.ts +116 -0
- package/dist/build.d.ts.map +1 -0
- package/dist/catalog.d.ts +26 -0
- package/dist/catalog.d.ts.map +1 -0
- package/dist/codegen/docs-cli.d.ts +3 -0
- package/dist/codegen/docs-cli.d.ts.map +1 -0
- package/dist/codegen/docs.d.ts +8 -0
- package/dist/codegen/docs.d.ts.map +1 -0
- package/dist/codegen/generate-cli.d.ts +3 -0
- package/dist/codegen/generate-cli.d.ts.map +1 -0
- package/dist/codegen/generate.d.ts +21 -0
- package/dist/codegen/generate.d.ts.map +1 -0
- package/dist/codegen/package.d.ts +7 -0
- package/dist/codegen/package.d.ts.map +1 -0
- package/dist/codegen/schema-types.d.ts +41 -0
- package/dist/codegen/schema-types.d.ts.map +1 -0
- package/dist/composites/agent-dashboard.d.ts +70 -0
- package/dist/composites/agent-dashboard.d.ts.map +1 -0
- package/dist/composites/catalog.d.ts +3 -0
- package/dist/composites/catalog.d.ts.map +1 -0
- package/dist/composites/index.d.ts +12 -0
- package/dist/composites/index.d.ts.map +1 -0
- package/dist/composites/red-dashboard.d.ts +58 -0
- package/dist/composites/red-dashboard.d.ts.map +1 -0
- package/dist/composites/shared.d.ts +68 -0
- package/dist/composites/shared.d.ts.map +1 -0
- package/dist/composites/slo-dashboard.d.ts +62 -0
- package/dist/composites/slo-dashboard.d.ts.map +1 -0
- package/dist/dashboard.d.ts +84 -0
- package/dist/dashboard.d.ts.map +1 -0
- package/dist/datasource.d.ts +67 -0
- package/dist/datasource.d.ts.map +1 -0
- package/dist/detect.d.ts +20 -0
- package/dist/detect.d.ts.map +1 -0
- package/dist/index.d.ts +17 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/integrity.json +22 -0
- package/dist/lint/audit-catalog.d.ts +13 -0
- package/dist/lint/audit-catalog.d.ts.map +1 -0
- package/dist/lint/post-synth/graf101.d.ts +8 -0
- package/dist/lint/post-synth/graf101.d.ts.map +1 -0
- package/dist/lint/post-synth/graf102.d.ts +8 -0
- package/dist/lint/post-synth/graf102.d.ts.map +1 -0
- package/dist/lint/post-synth/graf103.d.ts +8 -0
- package/dist/lint/post-synth/graf103.d.ts.map +1 -0
- package/dist/lint/post-synth/graf104.d.ts +8 -0
- package/dist/lint/post-synth/graf104.d.ts.map +1 -0
- package/dist/lint/post-synth/graf105.d.ts +8 -0
- package/dist/lint/post-synth/graf105.d.ts.map +1 -0
- package/dist/lint/post-synth/graf106.d.ts +8 -0
- package/dist/lint/post-synth/graf106.d.ts.map +1 -0
- package/dist/lint/post-synth/graf107.d.ts +8 -0
- package/dist/lint/post-synth/graf107.d.ts.map +1 -0
- package/dist/lint/post-synth/grafana-helpers.d.ts +16 -0
- package/dist/lint/post-synth/grafana-helpers.d.ts.map +1 -0
- package/dist/lint/post-synth/index.d.ts +3 -0
- package/dist/lint/post-synth/index.d.ts.map +1 -0
- package/dist/lint/rules/grafana-ast.d.ts +21 -0
- package/dist/lint/rules/grafana-ast.d.ts.map +1 -0
- package/dist/lint/rules/index.d.ts +6 -0
- package/dist/lint/rules/index.d.ts.map +1 -0
- package/dist/lint/rules/literal-secret.d.ts +12 -0
- package/dist/lint/rules/literal-secret.d.ts.map +1 -0
- package/dist/lint/rules/uid-syntax.d.ts +12 -0
- package/dist/lint/rules/uid-syntax.d.ts.map +1 -0
- package/dist/lsp/completions.d.ts +4 -0
- package/dist/lsp/completions.d.ts.map +1 -0
- package/dist/lsp/hover.d.ts +4 -0
- package/dist/lsp/hover.d.ts.map +1 -0
- package/dist/manifest.json +8 -0
- package/dist/meta.json +107 -0
- package/dist/okf/index.md +39 -0
- package/dist/okf/rules/GRAF001.md +16 -0
- package/dist/okf/rules/GRAF002.md +15 -0
- package/dist/okf/rules/GRAF101.md +15 -0
- package/dist/okf/rules/GRAF102.md +15 -0
- package/dist/okf/rules/GRAF103.md +11 -0
- package/dist/okf/rules/GRAF104.md +15 -0
- package/dist/okf/rules/GRAF105.md +11 -0
- package/dist/okf/rules/GRAF106.md +11 -0
- package/dist/okf/rules/GRAF107.md +11 -0
- package/dist/okf/types/ConstantVariable.md +9 -0
- package/dist/okf/types/CustomVariable.md +9 -0
- package/dist/okf/types/Dashboard.md +14 -0
- package/dist/okf/types/DashboardProvider.md +9 -0
- package/dist/okf/types/Datasource.md +16 -0
- package/dist/okf/types/DatasourceVariable.md +9 -0
- package/dist/okf/types/GaugePanel.md +9 -0
- package/dist/okf/types/HeatmapPanel.md +9 -0
- package/dist/okf/types/IntervalVariable.md +9 -0
- package/dist/okf/types/LogsPanel.md +9 -0
- package/dist/okf/types/LokiQuery.md +9 -0
- package/dist/okf/types/PromQuery.md +9 -0
- package/dist/okf/types/QueryVariable.md +9 -0
- package/dist/okf/types/Row.md +9 -0
- package/dist/okf/types/StatPanel.md +9 -0
- package/dist/okf/types/TablePanel.md +9 -0
- package/dist/okf/types/TempoQuery.md +9 -0
- package/dist/okf/types/TextPanel.md +9 -0
- package/dist/okf/types/TextboxVariable.md +9 -0
- package/dist/okf/types/TimeSeriesPanel.md +9 -0
- package/dist/okf/types/TracesPanel.md +9 -0
- package/dist/package-cli.d.ts +3 -0
- package/dist/package-cli.d.ts.map +1 -0
- package/dist/panels.d.ts +138 -0
- package/dist/panels.d.ts.map +1 -0
- package/dist/pin.d.ts +32 -0
- package/dist/pin.d.ts.map +1 -0
- package/dist/plugin.d.ts +12 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/query.d.ts +81 -0
- package/dist/query.d.ts.map +1 -0
- package/dist/rules/graf101.ts +17 -0
- package/dist/rules/graf102.ts +17 -0
- package/dist/rules/graf103.ts +17 -0
- package/dist/rules/graf104.ts +17 -0
- package/dist/rules/graf105.ts +17 -0
- package/dist/rules/graf106.ts +17 -0
- package/dist/rules/graf107.ts +17 -0
- package/dist/rules/grafana-ast.ts +70 -0
- package/dist/rules/grafana-helpers.ts +68 -0
- package/dist/rules/literal-secret.ts +48 -0
- package/dist/rules/uid-syntax.ts +56 -0
- package/dist/schema/dashboard.gen.d.ts +1231 -0
- package/dist/schema/dashboard.gen.d.ts.map +1 -0
- package/dist/schema/gauge.gen.d.ts +57 -0
- package/dist/schema/gauge.gen.d.ts.map +1 -0
- package/dist/schema/heatmap.gen.d.ts +295 -0
- package/dist/schema/heatmap.gen.d.ts.map +1 -0
- package/dist/schema/index.d.ts +18 -0
- package/dist/schema/index.d.ts.map +1 -0
- package/dist/schema/logs.gen.d.ts +29 -0
- package/dist/schema/logs.gen.d.ts.map +1 -0
- package/dist/schema/loki.gen.d.ts +69 -0
- package/dist/schema/loki.gen.d.ts.map +1 -0
- package/dist/schema/prometheus.gen.d.ts +169 -0
- package/dist/schema/prometheus.gen.d.ts.map +1 -0
- package/dist/schema/stat.gen.d.ts +75 -0
- package/dist/schema/stat.gen.d.ts.map +1 -0
- package/dist/schema/table.gen.d.ts +295 -0
- package/dist/schema/table.gen.d.ts.map +1 -0
- package/dist/schema/tempo.gen.d.ts +136 -0
- package/dist/schema/tempo.gen.d.ts.map +1 -0
- package/dist/schema/text.gen.d.ts +16 -0
- package/dist/schema/text.gen.d.ts.map +1 -0
- package/dist/schema/timeseries.gen.d.ts +179 -0
- package/dist/schema/timeseries.gen.d.ts.map +1 -0
- package/dist/schema-validate.d.ts +20 -0
- package/dist/schema-validate.d.ts.map +1 -0
- package/dist/serializer.d.ts +22 -0
- package/dist/serializer.d.ts.map +1 -0
- package/dist/skill-defs.d.ts +3 -0
- package/dist/skill-defs.d.ts.map +1 -0
- package/dist/skills/chant-grafana-provisioning.md +42 -0
- package/dist/skills/chant-grafana.md +93 -0
- package/dist/spec/fetch-cli.d.ts +3 -0
- package/dist/spec/fetch-cli.d.ts.map +1 -0
- package/dist/spec/schemas.d.ts +25 -0
- package/dist/spec/schemas.d.ts.map +1 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/util.d.ts +17 -0
- package/dist/util.d.ts.map +1 -0
- package/dist/validate-cli.d.ts +3 -0
- package/dist/validate-cli.d.ts.map +1 -0
- package/dist/validate-output.d.ts +42 -0
- package/dist/validate-output.d.ts.map +1 -0
- package/dist/validate.d.ts +12 -0
- package/dist/validate.d.ts.map +1 -0
- package/dist/variables.d.ts +100 -0
- package/dist/variables.d.ts.map +1 -0
- package/package.json +79 -0
- package/src/build.test.ts +210 -0
- package/src/build.ts +573 -0
- package/src/catalog.ts +116 -0
- package/src/codegen/docs-cli.ts +4 -0
- package/src/codegen/docs.ts +97 -0
- package/src/codegen/generate-cli.ts +8 -0
- package/src/codegen/generate.ts +83 -0
- package/src/codegen/package.ts +41 -0
- package/src/codegen/schema-types.ts +173 -0
- package/src/composites/agent-dashboard.ts +235 -0
- package/src/composites/catalog.test.ts +37 -0
- package/src/composites/catalog.ts +223 -0
- package/src/composites/composites.test.ts +314 -0
- package/src/composites/index.ts +12 -0
- package/src/composites/red-dashboard.ts +159 -0
- package/src/composites/shared.ts +94 -0
- package/src/composites/slo-dashboard.ts +177 -0
- package/src/dashboard.ts +123 -0
- package/src/datasource.ts +93 -0
- package/src/detect.ts +30 -0
- package/src/generated/lexicon-grafana.json +107 -0
- package/src/import.e2e.test.ts +147 -0
- package/src/import.test.ts +45 -0
- package/src/index.ts +178 -0
- package/src/lint/audit-catalog.ts +87 -0
- package/src/lint/post-synth/graf101.ts +17 -0
- package/src/lint/post-synth/graf102.ts +17 -0
- package/src/lint/post-synth/graf103.ts +17 -0
- package/src/lint/post-synth/graf104.ts +17 -0
- package/src/lint/post-synth/graf105.ts +17 -0
- package/src/lint/post-synth/graf106.ts +17 -0
- package/src/lint/post-synth/graf107.ts +17 -0
- package/src/lint/post-synth/grafana-helpers.ts +68 -0
- package/src/lint/post-synth/index.ts +19 -0
- package/src/lint/post-synth/post-synth.test.ts +231 -0
- package/src/lint/rules/grafana-ast.ts +70 -0
- package/src/lint/rules/index.ts +9 -0
- package/src/lint/rules/literal-secret.ts +48 -0
- package/src/lint/rules/rules.test.ts +70 -0
- package/src/lint/rules/uid-syntax.ts +56 -0
- package/src/lsp/completions.test.ts +31 -0
- package/src/lsp/completions.ts +15 -0
- package/src/lsp/hover.test.ts +25 -0
- package/src/lsp/hover.ts +28 -0
- package/src/package-cli.ts +17 -0
- package/src/panels.ts +275 -0
- package/src/pin.ts +68 -0
- package/src/plugin.test.ts +50 -0
- package/src/plugin.ts +116 -0
- package/src/query.ts +160 -0
- package/src/schema/dashboard.gen.ts +1289 -0
- package/src/schema/gauge.gen.ts +64 -0
- package/src/schema/heatmap.gen.ts +321 -0
- package/src/schema/index.ts +17 -0
- package/src/schema/logs.gen.ts +34 -0
- package/src/schema/loki.gen.ts +77 -0
- package/src/schema/prometheus.gen.ts +181 -0
- package/src/schema/stat.gen.ts +86 -0
- package/src/schema/table.gen.ts +334 -0
- package/src/schema/tempo.gen.ts +146 -0
- package/src/schema/text.gen.ts +22 -0
- package/src/schema/timeseries.gen.ts +208 -0
- package/src/schema-validate.ts +143 -0
- package/src/schema.test.ts +76 -0
- package/src/serializer.test.ts +170 -0
- package/src/serializer.ts +37 -0
- package/src/skill-defs.ts +31 -0
- package/src/skills/chant-grafana-provisioning.md +42 -0
- package/src/skills/chant-grafana.md +93 -0
- package/src/spec/fetch-cli.ts +27 -0
- package/src/spec/schemas/dashboard.jsonschema.json +1901 -0
- package/src/spec/schemas/gauge.jsonschema.json +114 -0
- package/src/spec/schemas/heatmap.jsonschema.json +480 -0
- package/src/spec/schemas/logs.jsonschema.json +94 -0
- package/src/spec/schemas/loki.jsonschema.json +118 -0
- package/src/spec/schemas/prometheus.jsonschema.json +276 -0
- package/src/spec/schemas/stat.jsonschema.json +163 -0
- package/src/spec/schemas/table.jsonschema.json +751 -0
- package/src/spec/schemas/tempo.jsonschema.json +225 -0
- package/src/spec/schemas/text.jsonschema.json +72 -0
- package/src/spec/schemas/timeseries.jsonschema.json +471 -0
- package/src/spec/schemas.ts +56 -0
- package/src/util.ts +43 -0
- package/src/validate-cli.ts +7 -0
- package/src/validate-output.ts +380 -0
- package/src/validate.ts +108 -0
- package/src/variables.ts +161 -0
|
@@ -0,0 +1,1901 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$ref": "#/definitions/Dashboard",
|
|
4
|
+
"definitions": {
|
|
5
|
+
"AnnotationActions": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"additionalProperties": false,
|
|
8
|
+
"properties": {
|
|
9
|
+
"canAdd": {
|
|
10
|
+
"type": "boolean"
|
|
11
|
+
},
|
|
12
|
+
"canDelete": {
|
|
13
|
+
"type": "boolean"
|
|
14
|
+
},
|
|
15
|
+
"canEdit": {
|
|
16
|
+
"type": "boolean"
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"AnnotationPermission": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"additionalProperties": false,
|
|
23
|
+
"properties": {
|
|
24
|
+
"dashboard": {
|
|
25
|
+
"$ref": "#/definitions/AnnotationActions"
|
|
26
|
+
},
|
|
27
|
+
"organization": {
|
|
28
|
+
"$ref": "#/definitions/AnnotationActions"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"DashboardMeta": {
|
|
33
|
+
"type": "object",
|
|
34
|
+
"additionalProperties": false,
|
|
35
|
+
"properties": {
|
|
36
|
+
"annotationsPermissions": {
|
|
37
|
+
"$ref": "#/definitions/AnnotationPermission"
|
|
38
|
+
},
|
|
39
|
+
"apiVersion": {
|
|
40
|
+
"type": "string"
|
|
41
|
+
},
|
|
42
|
+
"canAdmin": {
|
|
43
|
+
"type": "boolean"
|
|
44
|
+
},
|
|
45
|
+
"canDelete": {
|
|
46
|
+
"type": "boolean"
|
|
47
|
+
},
|
|
48
|
+
"canEdit": {
|
|
49
|
+
"type": "boolean"
|
|
50
|
+
},
|
|
51
|
+
"canSave": {
|
|
52
|
+
"type": "boolean"
|
|
53
|
+
},
|
|
54
|
+
"canStar": {
|
|
55
|
+
"type": "boolean"
|
|
56
|
+
},
|
|
57
|
+
"created": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"format": "date-time"
|
|
60
|
+
},
|
|
61
|
+
"createdBy": {
|
|
62
|
+
"type": "string"
|
|
63
|
+
},
|
|
64
|
+
"expires": {
|
|
65
|
+
"type": "string",
|
|
66
|
+
"format": "date-time"
|
|
67
|
+
},
|
|
68
|
+
"folderId": {
|
|
69
|
+
"type": "integer",
|
|
70
|
+
"description": "Deprecated: use FolderUID instead"
|
|
71
|
+
},
|
|
72
|
+
"folderTitle": {
|
|
73
|
+
"type": "string"
|
|
74
|
+
},
|
|
75
|
+
"folderUid": {
|
|
76
|
+
"type": "string"
|
|
77
|
+
},
|
|
78
|
+
"folderUrl": {
|
|
79
|
+
"type": "string"
|
|
80
|
+
},
|
|
81
|
+
"hasAcl": {
|
|
82
|
+
"type": "boolean"
|
|
83
|
+
},
|
|
84
|
+
"isFolder": {
|
|
85
|
+
"type": "boolean"
|
|
86
|
+
},
|
|
87
|
+
"isSnapshot": {
|
|
88
|
+
"type": "boolean"
|
|
89
|
+
},
|
|
90
|
+
"isStarred": {
|
|
91
|
+
"type": "boolean"
|
|
92
|
+
},
|
|
93
|
+
"provisioned": {
|
|
94
|
+
"type": "boolean"
|
|
95
|
+
},
|
|
96
|
+
"provisionedExternalId": {
|
|
97
|
+
"type": "string"
|
|
98
|
+
},
|
|
99
|
+
"publicDashboardEnabled": {
|
|
100
|
+
"type": "boolean"
|
|
101
|
+
},
|
|
102
|
+
"slug": {
|
|
103
|
+
"type": "string"
|
|
104
|
+
},
|
|
105
|
+
"type": {
|
|
106
|
+
"type": "string"
|
|
107
|
+
},
|
|
108
|
+
"updated": {
|
|
109
|
+
"type": "string",
|
|
110
|
+
"format": "date-time"
|
|
111
|
+
},
|
|
112
|
+
"updatedBy": {
|
|
113
|
+
"type": "string"
|
|
114
|
+
},
|
|
115
|
+
"url": {
|
|
116
|
+
"type": "string"
|
|
117
|
+
},
|
|
118
|
+
"version": {
|
|
119
|
+
"type": "integer"
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"Dashboard": {
|
|
124
|
+
"type": "object",
|
|
125
|
+
"additionalProperties": false,
|
|
126
|
+
"required": [
|
|
127
|
+
"schemaVersion",
|
|
128
|
+
"templating",
|
|
129
|
+
"annotations"
|
|
130
|
+
],
|
|
131
|
+
"properties": {
|
|
132
|
+
"id": {
|
|
133
|
+
"anyOf": [
|
|
134
|
+
{
|
|
135
|
+
"type": "integer"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"type": "null"
|
|
139
|
+
}
|
|
140
|
+
],
|
|
141
|
+
"description": "Unique numeric identifier for the dashboard.\n`id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances.\nTODO eliminate this null option"
|
|
142
|
+
},
|
|
143
|
+
"uid": {
|
|
144
|
+
"type": "string",
|
|
145
|
+
"description": "Unique dashboard identifier that can be generated by anyone. string (8-40)"
|
|
146
|
+
},
|
|
147
|
+
"title": {
|
|
148
|
+
"type": "string",
|
|
149
|
+
"description": "Title of dashboard."
|
|
150
|
+
},
|
|
151
|
+
"description": {
|
|
152
|
+
"type": "string",
|
|
153
|
+
"description": "Description of dashboard."
|
|
154
|
+
},
|
|
155
|
+
"revision": {
|
|
156
|
+
"type": "integer",
|
|
157
|
+
"description": "This property should only be used in dashboards defined by plugins. It is a quick check\nto see if the version has changed since the last time."
|
|
158
|
+
},
|
|
159
|
+
"gnetId": {
|
|
160
|
+
"type": "string",
|
|
161
|
+
"description": "ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal"
|
|
162
|
+
},
|
|
163
|
+
"tags": {
|
|
164
|
+
"type": "array",
|
|
165
|
+
"items": {
|
|
166
|
+
"type": "string"
|
|
167
|
+
},
|
|
168
|
+
"description": "Tags associated with dashboard."
|
|
169
|
+
},
|
|
170
|
+
"timezone": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"description": "Timezone of dashboard. Accepted values are IANA TZDB zone ID or \"browser\" or \"utc\".",
|
|
173
|
+
"default": "browser"
|
|
174
|
+
},
|
|
175
|
+
"editable": {
|
|
176
|
+
"type": "boolean",
|
|
177
|
+
"description": "Whether a dashboard is editable or not.",
|
|
178
|
+
"default": true
|
|
179
|
+
},
|
|
180
|
+
"graphTooltip": {
|
|
181
|
+
"$ref": "#/definitions/DashboardCursorSync",
|
|
182
|
+
"description": "Configuration of dashboard cursor sync behavior.\nAccepted values are 0 (sync turned off), 1 (shared crosshair), 2 (shared crosshair and tooltip).",
|
|
183
|
+
"default": 0
|
|
184
|
+
},
|
|
185
|
+
"time": {
|
|
186
|
+
"type": "object",
|
|
187
|
+
"additionalProperties": false,
|
|
188
|
+
"required": [
|
|
189
|
+
"from",
|
|
190
|
+
"to"
|
|
191
|
+
],
|
|
192
|
+
"properties": {
|
|
193
|
+
"from": {
|
|
194
|
+
"type": "string",
|
|
195
|
+
"default": "now-6h"
|
|
196
|
+
},
|
|
197
|
+
"to": {
|
|
198
|
+
"type": "string",
|
|
199
|
+
"default": "now"
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"description": "Time range for dashboard.\nAccepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}."
|
|
203
|
+
},
|
|
204
|
+
"timepicker": {
|
|
205
|
+
"$ref": "#/definitions/TimePickerConfig",
|
|
206
|
+
"description": "Configuration of the time picker shown at the top of a dashboard."
|
|
207
|
+
},
|
|
208
|
+
"fiscalYearStartMonth": {
|
|
209
|
+
"type": "integer",
|
|
210
|
+
"exclusiveMaximum": 12,
|
|
211
|
+
"description": "The month that the fiscal year starts on. 0 = January, 11 = December",
|
|
212
|
+
"default": 0
|
|
213
|
+
},
|
|
214
|
+
"liveNow": {
|
|
215
|
+
"type": "boolean",
|
|
216
|
+
"description": "When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data \"moving left\" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data"
|
|
217
|
+
},
|
|
218
|
+
"weekStart": {
|
|
219
|
+
"type": "string",
|
|
220
|
+
"description": "Day when the week starts. Expressed by the name of the day in lowercase, e.g. \"monday\"."
|
|
221
|
+
},
|
|
222
|
+
"refresh": {
|
|
223
|
+
"type": "string",
|
|
224
|
+
"description": "Refresh rate of dashboard. Represented via interval string, e.g. \"5s\", \"1m\", \"1h\", \"1d\"."
|
|
225
|
+
},
|
|
226
|
+
"schemaVersion": {
|
|
227
|
+
"type": "integer",
|
|
228
|
+
"description": "Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.",
|
|
229
|
+
"default": 42
|
|
230
|
+
},
|
|
231
|
+
"version": {
|
|
232
|
+
"type": "integer",
|
|
233
|
+
"description": "Version of the dashboard, incremented each time the dashboard is updated."
|
|
234
|
+
},
|
|
235
|
+
"panels": {
|
|
236
|
+
"type": "array",
|
|
237
|
+
"items": {
|
|
238
|
+
"oneOf": [
|
|
239
|
+
{
|
|
240
|
+
"$ref": "#/definitions/Panel"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"$ref": "#/definitions/RowPanel"
|
|
244
|
+
}
|
|
245
|
+
]
|
|
246
|
+
},
|
|
247
|
+
"description": "List of dashboard panels"
|
|
248
|
+
},
|
|
249
|
+
"templating": {
|
|
250
|
+
"type": "object",
|
|
251
|
+
"additionalProperties": false,
|
|
252
|
+
"properties": {
|
|
253
|
+
"list": {
|
|
254
|
+
"type": "array",
|
|
255
|
+
"items": {
|
|
256
|
+
"$ref": "#/definitions/VariableModel"
|
|
257
|
+
},
|
|
258
|
+
"description": "List of configured template variables with their saved values along with some other metadata"
|
|
259
|
+
}
|
|
260
|
+
},
|
|
261
|
+
"description": "Configured template variables"
|
|
262
|
+
},
|
|
263
|
+
"annotations": {
|
|
264
|
+
"$ref": "#/definitions/AnnotationContainer",
|
|
265
|
+
"description": "Contains the list of annotations that are associated with the dashboard.\nAnnotations are used to overlay event markers and overlay event tags on graphs.\nGrafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.\nSee https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/"
|
|
266
|
+
},
|
|
267
|
+
"links": {
|
|
268
|
+
"type": "array",
|
|
269
|
+
"items": {
|
|
270
|
+
"$ref": "#/definitions/DashboardLink"
|
|
271
|
+
},
|
|
272
|
+
"description": "Links with references to other dashboards or external websites."
|
|
273
|
+
},
|
|
274
|
+
"snapshot": {
|
|
275
|
+
"$ref": "#/definitions/Snapshot",
|
|
276
|
+
"description": "Snapshot options. They are present only if the dashboard is a snapshot."
|
|
277
|
+
},
|
|
278
|
+
"preload": {
|
|
279
|
+
"type": "boolean",
|
|
280
|
+
"description": "When set to true, the dashboard will load all panels in the dashboard when it's loaded."
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"deprecated": true,
|
|
284
|
+
"x-deprecation-message": "Prefer using dashboardv2.Dashboard instead."
|
|
285
|
+
},
|
|
286
|
+
"DashboardCursorSync": {
|
|
287
|
+
"enum": [
|
|
288
|
+
0,
|
|
289
|
+
1,
|
|
290
|
+
2
|
|
291
|
+
],
|
|
292
|
+
"type": "integer",
|
|
293
|
+
"description": "0 for no shared crosshair or tooltip (default).\n1 for shared crosshair.\n2 for shared crosshair AND shared tooltip."
|
|
294
|
+
},
|
|
295
|
+
"TimePickerConfig": {
|
|
296
|
+
"type": "object",
|
|
297
|
+
"additionalProperties": false,
|
|
298
|
+
"properties": {
|
|
299
|
+
"hidden": {
|
|
300
|
+
"type": "boolean",
|
|
301
|
+
"description": "Whether timepicker is visible or not.",
|
|
302
|
+
"default": false
|
|
303
|
+
},
|
|
304
|
+
"refresh_intervals": {
|
|
305
|
+
"type": "array",
|
|
306
|
+
"items": {
|
|
307
|
+
"type": "string"
|
|
308
|
+
},
|
|
309
|
+
"description": "Interval options available in the refresh picker dropdown.",
|
|
310
|
+
"default": [
|
|
311
|
+
"5s",
|
|
312
|
+
"10s",
|
|
313
|
+
"30s",
|
|
314
|
+
"1m",
|
|
315
|
+
"5m",
|
|
316
|
+
"15m",
|
|
317
|
+
"30m",
|
|
318
|
+
"1h",
|
|
319
|
+
"2h",
|
|
320
|
+
"1d"
|
|
321
|
+
]
|
|
322
|
+
},
|
|
323
|
+
"quick_ranges": {
|
|
324
|
+
"type": "array",
|
|
325
|
+
"items": {
|
|
326
|
+
"$ref": "#/definitions/TimeOption"
|
|
327
|
+
},
|
|
328
|
+
"description": "Quick ranges for time picker."
|
|
329
|
+
},
|
|
330
|
+
"nowDelay": {
|
|
331
|
+
"type": "string",
|
|
332
|
+
"description": "Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values."
|
|
333
|
+
}
|
|
334
|
+
},
|
|
335
|
+
"description": "Time picker configuration\nIt defines the default config for the time picker and the refresh picker for the specific dashboard."
|
|
336
|
+
},
|
|
337
|
+
"TimeOption": {
|
|
338
|
+
"type": "object",
|
|
339
|
+
"additionalProperties": false,
|
|
340
|
+
"required": [
|
|
341
|
+
"display",
|
|
342
|
+
"from",
|
|
343
|
+
"to"
|
|
344
|
+
],
|
|
345
|
+
"properties": {
|
|
346
|
+
"display": {
|
|
347
|
+
"type": "string"
|
|
348
|
+
},
|
|
349
|
+
"from": {
|
|
350
|
+
"type": "string"
|
|
351
|
+
},
|
|
352
|
+
"to": {
|
|
353
|
+
"type": "string"
|
|
354
|
+
}
|
|
355
|
+
},
|
|
356
|
+
"description": "Counterpart for TypeScript's TimeOption type."
|
|
357
|
+
},
|
|
358
|
+
"Panel": {
|
|
359
|
+
"type": "object",
|
|
360
|
+
"additionalProperties": false,
|
|
361
|
+
"required": [
|
|
362
|
+
"type"
|
|
363
|
+
],
|
|
364
|
+
"properties": {
|
|
365
|
+
"type": {
|
|
366
|
+
"type": "string",
|
|
367
|
+
"minLength": 1,
|
|
368
|
+
"description": "The panel plugin type id. This is used to find the plugin to display the panel."
|
|
369
|
+
},
|
|
370
|
+
"id": {
|
|
371
|
+
"type": "integer",
|
|
372
|
+
"description": "Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally."
|
|
373
|
+
},
|
|
374
|
+
"pluginVersion": {
|
|
375
|
+
"type": "string",
|
|
376
|
+
"description": "The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs."
|
|
377
|
+
},
|
|
378
|
+
"targets": {
|
|
379
|
+
"type": "array",
|
|
380
|
+
"items": {
|
|
381
|
+
"type": "object",
|
|
382
|
+
"additionalProperties": {}
|
|
383
|
+
},
|
|
384
|
+
"description": "Depends on the panel plugin. See the plugin documentation for details."
|
|
385
|
+
},
|
|
386
|
+
"title": {
|
|
387
|
+
"type": "string",
|
|
388
|
+
"description": "Panel title."
|
|
389
|
+
},
|
|
390
|
+
"description": {
|
|
391
|
+
"type": "string",
|
|
392
|
+
"description": "Panel description."
|
|
393
|
+
},
|
|
394
|
+
"transparent": {
|
|
395
|
+
"type": "boolean",
|
|
396
|
+
"description": "Whether to display the panel without a background.",
|
|
397
|
+
"default": false
|
|
398
|
+
},
|
|
399
|
+
"datasource": {
|
|
400
|
+
"$ref": "#/definitions/DataSourceRef",
|
|
401
|
+
"description": "The datasource used in all targets."
|
|
402
|
+
},
|
|
403
|
+
"gridPos": {
|
|
404
|
+
"$ref": "#/definitions/GridPos",
|
|
405
|
+
"description": "Grid position."
|
|
406
|
+
},
|
|
407
|
+
"links": {
|
|
408
|
+
"type": "array",
|
|
409
|
+
"items": {
|
|
410
|
+
"$ref": "#/definitions/DashboardLink"
|
|
411
|
+
},
|
|
412
|
+
"description": "Panel links."
|
|
413
|
+
},
|
|
414
|
+
"repeat": {
|
|
415
|
+
"type": "string",
|
|
416
|
+
"description": "Name of template variable to repeat for."
|
|
417
|
+
},
|
|
418
|
+
"repeatDirection": {
|
|
419
|
+
"enum": [
|
|
420
|
+
"h",
|
|
421
|
+
"v"
|
|
422
|
+
],
|
|
423
|
+
"type": "string",
|
|
424
|
+
"description": "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical.",
|
|
425
|
+
"default": "h"
|
|
426
|
+
},
|
|
427
|
+
"maxPerRow": {
|
|
428
|
+
"type": "number",
|
|
429
|
+
"description": "Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels"
|
|
430
|
+
},
|
|
431
|
+
"maxDataPoints": {
|
|
432
|
+
"type": "number",
|
|
433
|
+
"description": "The maximum number of data points that the panel queries are retrieving."
|
|
434
|
+
},
|
|
435
|
+
"transformations": {
|
|
436
|
+
"type": "array",
|
|
437
|
+
"items": {
|
|
438
|
+
"$ref": "#/definitions/DataTransformerConfig"
|
|
439
|
+
},
|
|
440
|
+
"description": "List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline."
|
|
441
|
+
},
|
|
442
|
+
"interval": {
|
|
443
|
+
"type": "string",
|
|
444
|
+
"description": "The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: \"40s\", \"3d\", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options"
|
|
445
|
+
},
|
|
446
|
+
"timeFrom": {
|
|
447
|
+
"type": "string",
|
|
448
|
+
"description": "Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options"
|
|
449
|
+
},
|
|
450
|
+
"timeShift": {
|
|
451
|
+
"type": "string",
|
|
452
|
+
"description": "Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options"
|
|
453
|
+
},
|
|
454
|
+
"hideTimeOverride": {
|
|
455
|
+
"type": "boolean",
|
|
456
|
+
"description": "Controls if the timeFrom or timeShift overrides are shown in the panel header"
|
|
457
|
+
},
|
|
458
|
+
"timeCompare": {
|
|
459
|
+
"type": "string",
|
|
460
|
+
"description": "Compare the current time range with a previous period\nFor example \"1d\" to compare current period but shifted back 1 day"
|
|
461
|
+
},
|
|
462
|
+
"libraryPanel": {
|
|
463
|
+
"$ref": "#/definitions/LibraryPanelRef",
|
|
464
|
+
"description": "Dynamically load the panel"
|
|
465
|
+
},
|
|
466
|
+
"cacheTimeout": {
|
|
467
|
+
"type": "string",
|
|
468
|
+
"description": "Sets panel queries cache timeout."
|
|
469
|
+
},
|
|
470
|
+
"queryCachingTTL": {
|
|
471
|
+
"type": "number",
|
|
472
|
+
"description": "Overrides the data source configured time-to-live for a query cache item in milliseconds"
|
|
473
|
+
},
|
|
474
|
+
"options": {
|
|
475
|
+
"type": "object",
|
|
476
|
+
"additionalProperties": {},
|
|
477
|
+
"description": "It depends on the panel plugin. They are specified by the Options field in panel plugin schemas."
|
|
478
|
+
},
|
|
479
|
+
"fieldConfig": {
|
|
480
|
+
"$ref": "#/definitions/FieldConfigSource",
|
|
481
|
+
"description": "Field options allow you to change how the data is displayed in your visualizations."
|
|
482
|
+
}
|
|
483
|
+
},
|
|
484
|
+
"description": "Dashboard panels are the basic visualization building blocks."
|
|
485
|
+
},
|
|
486
|
+
"DataSourceRef": {
|
|
487
|
+
"type": "object",
|
|
488
|
+
"additionalProperties": false,
|
|
489
|
+
"properties": {
|
|
490
|
+
"type": {
|
|
491
|
+
"type": "string",
|
|
492
|
+
"description": "The plugin type-id"
|
|
493
|
+
},
|
|
494
|
+
"uid": {
|
|
495
|
+
"type": "string",
|
|
496
|
+
"description": "Specific datasource instance"
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
},
|
|
500
|
+
"GridPos": {
|
|
501
|
+
"type": "object",
|
|
502
|
+
"additionalProperties": false,
|
|
503
|
+
"required": [
|
|
504
|
+
"h",
|
|
505
|
+
"w",
|
|
506
|
+
"x",
|
|
507
|
+
"y"
|
|
508
|
+
],
|
|
509
|
+
"properties": {
|
|
510
|
+
"h": {
|
|
511
|
+
"type": "integer",
|
|
512
|
+
"exclusiveMinimum": 0,
|
|
513
|
+
"description": "Panel height. The height is the number of rows from the top edge of the panel.",
|
|
514
|
+
"default": 9
|
|
515
|
+
},
|
|
516
|
+
"w": {
|
|
517
|
+
"type": "integer",
|
|
518
|
+
"exclusiveMinimum": 0,
|
|
519
|
+
"maximum": 24,
|
|
520
|
+
"description": "Panel width. The width is the number of columns from the left edge of the panel.",
|
|
521
|
+
"default": 12
|
|
522
|
+
},
|
|
523
|
+
"x": {
|
|
524
|
+
"type": "integer",
|
|
525
|
+
"minimum": 0,
|
|
526
|
+
"exclusiveMaximum": 24,
|
|
527
|
+
"description": "Panel x. The x coordinate is the number of columns from the left edge of the grid",
|
|
528
|
+
"default": 0
|
|
529
|
+
},
|
|
530
|
+
"y": {
|
|
531
|
+
"type": "integer",
|
|
532
|
+
"minimum": 0,
|
|
533
|
+
"description": "Panel y. The y coordinate is the number of rows from the top edge of the grid",
|
|
534
|
+
"default": 0
|
|
535
|
+
},
|
|
536
|
+
"static": {
|
|
537
|
+
"type": "boolean",
|
|
538
|
+
"description": "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions"
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
"description": "Position and dimensions of a panel in the grid"
|
|
542
|
+
},
|
|
543
|
+
"DashboardLink": {
|
|
544
|
+
"type": "object",
|
|
545
|
+
"additionalProperties": false,
|
|
546
|
+
"required": [
|
|
547
|
+
"title",
|
|
548
|
+
"type",
|
|
549
|
+
"icon",
|
|
550
|
+
"tooltip",
|
|
551
|
+
"tags",
|
|
552
|
+
"asDropdown",
|
|
553
|
+
"targetBlank",
|
|
554
|
+
"includeVars",
|
|
555
|
+
"keepTime"
|
|
556
|
+
],
|
|
557
|
+
"properties": {
|
|
558
|
+
"title": {
|
|
559
|
+
"type": "string",
|
|
560
|
+
"description": "Title to display with the link"
|
|
561
|
+
},
|
|
562
|
+
"type": {
|
|
563
|
+
"$ref": "#/definitions/DashboardLinkType",
|
|
564
|
+
"description": "Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)"
|
|
565
|
+
},
|
|
566
|
+
"icon": {
|
|
567
|
+
"type": "string",
|
|
568
|
+
"description": "Icon name to be displayed with the link"
|
|
569
|
+
},
|
|
570
|
+
"tooltip": {
|
|
571
|
+
"type": "string",
|
|
572
|
+
"description": "Tooltip to display when the user hovers their mouse over it"
|
|
573
|
+
},
|
|
574
|
+
"url": {
|
|
575
|
+
"type": "string",
|
|
576
|
+
"description": "Link URL. Only required/valid if the type is link"
|
|
577
|
+
},
|
|
578
|
+
"tags": {
|
|
579
|
+
"type": "array",
|
|
580
|
+
"items": {
|
|
581
|
+
"type": "string"
|
|
582
|
+
},
|
|
583
|
+
"description": "List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards"
|
|
584
|
+
},
|
|
585
|
+
"asDropdown": {
|
|
586
|
+
"type": "boolean",
|
|
587
|
+
"description": "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",
|
|
588
|
+
"default": false
|
|
589
|
+
},
|
|
590
|
+
"placement": {
|
|
591
|
+
"allOf": [
|
|
592
|
+
{
|
|
593
|
+
"$ref": "#/definitions/DashboardLinkPlacement"
|
|
594
|
+
}
|
|
595
|
+
],
|
|
596
|
+
"default": "inControlsMenu",
|
|
597
|
+
"description": "Placement can be used to display the link somewhere else on the dashboard other than above the visualisations."
|
|
598
|
+
},
|
|
599
|
+
"targetBlank": {
|
|
600
|
+
"type": "boolean",
|
|
601
|
+
"description": "If true, the link will be opened in a new tab",
|
|
602
|
+
"default": false
|
|
603
|
+
},
|
|
604
|
+
"includeVars": {
|
|
605
|
+
"type": "boolean",
|
|
606
|
+
"description": "If true, includes current template variables values in the link as query params",
|
|
607
|
+
"default": false
|
|
608
|
+
},
|
|
609
|
+
"keepTime": {
|
|
610
|
+
"type": "boolean",
|
|
611
|
+
"description": "If true, includes current time range in the link as query params",
|
|
612
|
+
"default": false
|
|
613
|
+
}
|
|
614
|
+
},
|
|
615
|
+
"description": "Links with references to other dashboards or external resources"
|
|
616
|
+
},
|
|
617
|
+
"DashboardLinkType": {
|
|
618
|
+
"enum": [
|
|
619
|
+
"link",
|
|
620
|
+
"dashboards"
|
|
621
|
+
],
|
|
622
|
+
"type": "string",
|
|
623
|
+
"description": "Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)"
|
|
624
|
+
},
|
|
625
|
+
"DashboardLinkPlacement": {
|
|
626
|
+
"enum": [
|
|
627
|
+
"inControlsMenu"
|
|
628
|
+
],
|
|
629
|
+
"type": "string",
|
|
630
|
+
"description": "Dashboard Link placement. Defines where the link should be displayed.\n- \"inControlsMenu\" renders the link in bottom part of the dashboard controls dropdown menu"
|
|
631
|
+
},
|
|
632
|
+
"DataTransformerConfig": {
|
|
633
|
+
"type": "object",
|
|
634
|
+
"additionalProperties": false,
|
|
635
|
+
"required": [
|
|
636
|
+
"id",
|
|
637
|
+
"options"
|
|
638
|
+
],
|
|
639
|
+
"properties": {
|
|
640
|
+
"id": {
|
|
641
|
+
"type": "string",
|
|
642
|
+
"description": "Unique identifier of transformer"
|
|
643
|
+
},
|
|
644
|
+
"disabled": {
|
|
645
|
+
"type": "boolean",
|
|
646
|
+
"description": "Disabled transformations are skipped"
|
|
647
|
+
},
|
|
648
|
+
"filter": {
|
|
649
|
+
"$ref": "#/definitions/MatcherConfig",
|
|
650
|
+
"description": "Optional frame matcher. When missing it will be applied to all results"
|
|
651
|
+
},
|
|
652
|
+
"topic": {
|
|
653
|
+
"enum": [
|
|
654
|
+
"series",
|
|
655
|
+
"annotations",
|
|
656
|
+
"alertStates"
|
|
657
|
+
],
|
|
658
|
+
"type": "string",
|
|
659
|
+
"description": "Where to pull DataFrames from as input to transformation\nreplaced with common.DataTopic"
|
|
660
|
+
},
|
|
661
|
+
"options": {
|
|
662
|
+
"type": "object",
|
|
663
|
+
"additionalProperties": {},
|
|
664
|
+
"description": "Options to be passed to the transformer\nValid options depend on the transformer id"
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"description": "Transformations allow to manipulate data returned by a query before the system applies a visualization.\nUsing transformations you can: rename fields, join time series data, perform mathematical operations across queries,\nuse the output of one transformation as the input to another transformation, etc."
|
|
668
|
+
},
|
|
669
|
+
"MatcherConfig": {
|
|
670
|
+
"type": "object",
|
|
671
|
+
"additionalProperties": false,
|
|
672
|
+
"required": [
|
|
673
|
+
"id"
|
|
674
|
+
],
|
|
675
|
+
"properties": {
|
|
676
|
+
"id": {
|
|
677
|
+
"type": "string",
|
|
678
|
+
"description": "The matcher id. This is used to find the matcher implementation from registry.",
|
|
679
|
+
"default": ""
|
|
680
|
+
},
|
|
681
|
+
"options": {
|
|
682
|
+
"type": "object",
|
|
683
|
+
"additionalProperties": {},
|
|
684
|
+
"description": "The matcher options. This is specific to the matcher implementation."
|
|
685
|
+
}
|
|
686
|
+
},
|
|
687
|
+
"description": "Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type."
|
|
688
|
+
},
|
|
689
|
+
"LibraryPanelRef": {
|
|
690
|
+
"type": "object",
|
|
691
|
+
"additionalProperties": false,
|
|
692
|
+
"required": [
|
|
693
|
+
"name",
|
|
694
|
+
"uid"
|
|
695
|
+
],
|
|
696
|
+
"properties": {
|
|
697
|
+
"name": {
|
|
698
|
+
"type": "string",
|
|
699
|
+
"description": "Library panel name"
|
|
700
|
+
},
|
|
701
|
+
"uid": {
|
|
702
|
+
"type": "string",
|
|
703
|
+
"description": "Library panel uid"
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"description": "A library panel is a reusable panel that you can use in any dashboard.\nWhen you make a change to a library panel, that change propagates to all instances of where the panel is used.\nLibrary panels streamline reuse of panels across multiple dashboards."
|
|
707
|
+
},
|
|
708
|
+
"FieldConfigSource": {
|
|
709
|
+
"type": "object",
|
|
710
|
+
"additionalProperties": false,
|
|
711
|
+
"required": [
|
|
712
|
+
"defaults",
|
|
713
|
+
"overrides"
|
|
714
|
+
],
|
|
715
|
+
"properties": {
|
|
716
|
+
"defaults": {
|
|
717
|
+
"$ref": "#/definitions/FieldConfig",
|
|
718
|
+
"description": "Defaults are the options applied to all fields."
|
|
719
|
+
},
|
|
720
|
+
"overrides": {
|
|
721
|
+
"type": "array",
|
|
722
|
+
"items": {
|
|
723
|
+
"type": "object",
|
|
724
|
+
"additionalProperties": false,
|
|
725
|
+
"required": [
|
|
726
|
+
"matcher",
|
|
727
|
+
"properties"
|
|
728
|
+
],
|
|
729
|
+
"properties": {
|
|
730
|
+
"__systemRef": {
|
|
731
|
+
"type": "string"
|
|
732
|
+
},
|
|
733
|
+
"matcher": {
|
|
734
|
+
"$ref": "#/definitions/MatcherConfig"
|
|
735
|
+
},
|
|
736
|
+
"properties": {
|
|
737
|
+
"type": "array",
|
|
738
|
+
"items": {
|
|
739
|
+
"$ref": "#/definitions/DynamicConfigValue"
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
"description": "Overrides are the options applied to specific fields overriding the defaults."
|
|
745
|
+
}
|
|
746
|
+
},
|
|
747
|
+
"description": "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.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations."
|
|
748
|
+
},
|
|
749
|
+
"FieldConfig": {
|
|
750
|
+
"type": "object",
|
|
751
|
+
"additionalProperties": false,
|
|
752
|
+
"properties": {
|
|
753
|
+
"displayName": {
|
|
754
|
+
"type": "string",
|
|
755
|
+
"description": "The display value for this field. This supports template variables blank is auto"
|
|
756
|
+
},
|
|
757
|
+
"displayNameFromDS": {
|
|
758
|
+
"type": "string",
|
|
759
|
+
"description": "This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy."
|
|
760
|
+
},
|
|
761
|
+
"description": {
|
|
762
|
+
"type": "string",
|
|
763
|
+
"description": "Human readable field metadata"
|
|
764
|
+
},
|
|
765
|
+
"path": {
|
|
766
|
+
"type": "string",
|
|
767
|
+
"description": "An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results"
|
|
768
|
+
},
|
|
769
|
+
"writeable": {
|
|
770
|
+
"type": "boolean",
|
|
771
|
+
"description": "True if data source can write a value to the path. Auth/authz are supported separately"
|
|
772
|
+
},
|
|
773
|
+
"filterable": {
|
|
774
|
+
"type": "boolean",
|
|
775
|
+
"description": "True if data source field supports ad-hoc filters"
|
|
776
|
+
},
|
|
777
|
+
"unit": {
|
|
778
|
+
"type": "string",
|
|
779
|
+
"description": "Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:\u003csuffix\u003e` for custom unit that should go after value.\n`prefix:\u003cprefix\u003e` for custom unit that should go before value.\n`time:\u003cformat\u003e` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:\u003cbase scale\u003e\u003cunit characters\u003e` 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.\n`count:\u003cunit\u003e` for a custom count unit.\n`currency:\u003cunit\u003e` for custom a currency unit."
|
|
780
|
+
},
|
|
781
|
+
"decimals": {
|
|
782
|
+
"type": "number",
|
|
783
|
+
"description": "Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`."
|
|
784
|
+
},
|
|
785
|
+
"min": {
|
|
786
|
+
"type": "number",
|
|
787
|
+
"description": "The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields."
|
|
788
|
+
},
|
|
789
|
+
"max": {
|
|
790
|
+
"type": "number",
|
|
791
|
+
"description": "The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields."
|
|
792
|
+
},
|
|
793
|
+
"mappings": {
|
|
794
|
+
"type": "array",
|
|
795
|
+
"items": {
|
|
796
|
+
"$ref": "#/definitions/ValueMapping"
|
|
797
|
+
},
|
|
798
|
+
"description": "Convert input values into a display string"
|
|
799
|
+
},
|
|
800
|
+
"thresholds": {
|
|
801
|
+
"$ref": "#/definitions/ThresholdsConfig",
|
|
802
|
+
"description": "Map numeric values to states"
|
|
803
|
+
},
|
|
804
|
+
"color": {
|
|
805
|
+
"$ref": "#/definitions/FieldColor",
|
|
806
|
+
"description": "Panel color configuration"
|
|
807
|
+
},
|
|
808
|
+
"links": {
|
|
809
|
+
"type": "array",
|
|
810
|
+
"items": {
|
|
811
|
+
"$ref": "#/definitions/DashboardLink"
|
|
812
|
+
},
|
|
813
|
+
"description": "The behavior when clicking on a result"
|
|
814
|
+
},
|
|
815
|
+
"actions": {
|
|
816
|
+
"type": "array",
|
|
817
|
+
"items": {
|
|
818
|
+
"$ref": "#/definitions/Action"
|
|
819
|
+
},
|
|
820
|
+
"description": "Define interactive HTTP requests that can be triggered from data visualizations."
|
|
821
|
+
},
|
|
822
|
+
"noValue": {
|
|
823
|
+
"type": "string",
|
|
824
|
+
"description": "Alternative to empty string"
|
|
825
|
+
},
|
|
826
|
+
"custom": {
|
|
827
|
+
"type": "object",
|
|
828
|
+
"additionalProperties": {},
|
|
829
|
+
"description": "custom is specified by the FieldConfig field\nin panel plugin schemas."
|
|
830
|
+
},
|
|
831
|
+
"fieldMinMax": {
|
|
832
|
+
"type": "boolean"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"description": "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.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations."
|
|
836
|
+
},
|
|
837
|
+
"ValueMapping": {
|
|
838
|
+
"oneOf": [
|
|
839
|
+
{
|
|
840
|
+
"$ref": "#/definitions/ValueMap"
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"$ref": "#/definitions/RangeMap"
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"$ref": "#/definitions/RegexMap"
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"$ref": "#/definitions/SpecialValueMap"
|
|
850
|
+
}
|
|
851
|
+
],
|
|
852
|
+
"description": "Allow to transform the visual representation of specific data values in a visualization, irrespective of their original units"
|
|
853
|
+
},
|
|
854
|
+
"ValueMap": {
|
|
855
|
+
"type": "object",
|
|
856
|
+
"additionalProperties": false,
|
|
857
|
+
"required": [
|
|
858
|
+
"type",
|
|
859
|
+
"options"
|
|
860
|
+
],
|
|
861
|
+
"properties": {
|
|
862
|
+
"type": {
|
|
863
|
+
"allOf": [
|
|
864
|
+
{
|
|
865
|
+
"$ref": "#/definitions/MappingType"
|
|
866
|
+
}
|
|
867
|
+
],
|
|
868
|
+
"default": "value"
|
|
869
|
+
},
|
|
870
|
+
"options": {
|
|
871
|
+
"type": "object",
|
|
872
|
+
"additionalProperties": {
|
|
873
|
+
"$ref": "#/definitions/ValueMappingResult"
|
|
874
|
+
},
|
|
875
|
+
"description": "Map with \u003cvalue_to_match\u003e: ValueMappingResult. For example: { \"10\": { text: \"Perfection!\", color: \"green\" } }"
|
|
876
|
+
}
|
|
877
|
+
},
|
|
878
|
+
"description": "Maps text values to a color or different display text and color.\nFor example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number."
|
|
879
|
+
},
|
|
880
|
+
"MappingType": {
|
|
881
|
+
"enum": [
|
|
882
|
+
"value",
|
|
883
|
+
"range",
|
|
884
|
+
"regex",
|
|
885
|
+
"special"
|
|
886
|
+
],
|
|
887
|
+
"type": "string",
|
|
888
|
+
"description": "Supported value mapping types\n`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.\n`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.\n`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.\n`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."
|
|
889
|
+
},
|
|
890
|
+
"ValueMappingResult": {
|
|
891
|
+
"type": "object",
|
|
892
|
+
"additionalProperties": false,
|
|
893
|
+
"properties": {
|
|
894
|
+
"text": {
|
|
895
|
+
"type": "string",
|
|
896
|
+
"description": "Text to display when the value matches"
|
|
897
|
+
},
|
|
898
|
+
"color": {
|
|
899
|
+
"type": "string",
|
|
900
|
+
"description": "Text to use when the value matches"
|
|
901
|
+
},
|
|
902
|
+
"icon": {
|
|
903
|
+
"type": "string",
|
|
904
|
+
"description": "Icon to display when the value matches. Only specific visualizations."
|
|
905
|
+
},
|
|
906
|
+
"index": {
|
|
907
|
+
"type": "integer",
|
|
908
|
+
"description": "Position in the mapping array. Only used internally."
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
"description": "Result used as replacement with text and color when the value matches"
|
|
912
|
+
},
|
|
913
|
+
"RangeMap": {
|
|
914
|
+
"type": "object",
|
|
915
|
+
"additionalProperties": false,
|
|
916
|
+
"required": [
|
|
917
|
+
"type",
|
|
918
|
+
"options"
|
|
919
|
+
],
|
|
920
|
+
"properties": {
|
|
921
|
+
"type": {
|
|
922
|
+
"allOf": [
|
|
923
|
+
{
|
|
924
|
+
"$ref": "#/definitions/MappingType"
|
|
925
|
+
}
|
|
926
|
+
],
|
|
927
|
+
"default": "range"
|
|
928
|
+
},
|
|
929
|
+
"options": {
|
|
930
|
+
"type": "object",
|
|
931
|
+
"additionalProperties": false,
|
|
932
|
+
"required": [
|
|
933
|
+
"from",
|
|
934
|
+
"to",
|
|
935
|
+
"result"
|
|
936
|
+
],
|
|
937
|
+
"properties": {
|
|
938
|
+
"from": {
|
|
939
|
+
"anyOf": [
|
|
940
|
+
{
|
|
941
|
+
"type": "number"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"type": "null"
|
|
945
|
+
}
|
|
946
|
+
],
|
|
947
|
+
"description": "Min value of the range. It can be null which means -Infinity"
|
|
948
|
+
},
|
|
949
|
+
"to": {
|
|
950
|
+
"anyOf": [
|
|
951
|
+
{
|
|
952
|
+
"type": "number"
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
"type": "null"
|
|
956
|
+
}
|
|
957
|
+
],
|
|
958
|
+
"description": "Max value of the range. It can be null which means +Infinity"
|
|
959
|
+
},
|
|
960
|
+
"result": {
|
|
961
|
+
"$ref": "#/definitions/ValueMappingResult",
|
|
962
|
+
"description": "Config to apply when the value is within the range"
|
|
963
|
+
}
|
|
964
|
+
},
|
|
965
|
+
"description": "Range to match against and the result to apply when the value is within the range"
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
"description": "Maps numerical ranges to a display text and color.\nFor 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."
|
|
969
|
+
},
|
|
970
|
+
"RegexMap": {
|
|
971
|
+
"type": "object",
|
|
972
|
+
"additionalProperties": false,
|
|
973
|
+
"required": [
|
|
974
|
+
"type",
|
|
975
|
+
"options"
|
|
976
|
+
],
|
|
977
|
+
"properties": {
|
|
978
|
+
"type": {
|
|
979
|
+
"allOf": [
|
|
980
|
+
{
|
|
981
|
+
"$ref": "#/definitions/MappingType"
|
|
982
|
+
}
|
|
983
|
+
],
|
|
984
|
+
"default": "regex"
|
|
985
|
+
},
|
|
986
|
+
"options": {
|
|
987
|
+
"type": "object",
|
|
988
|
+
"additionalProperties": false,
|
|
989
|
+
"required": [
|
|
990
|
+
"pattern",
|
|
991
|
+
"result"
|
|
992
|
+
],
|
|
993
|
+
"properties": {
|
|
994
|
+
"pattern": {
|
|
995
|
+
"type": "string",
|
|
996
|
+
"description": "Regular expression to match against"
|
|
997
|
+
},
|
|
998
|
+
"result": {
|
|
999
|
+
"$ref": "#/definitions/ValueMappingResult",
|
|
1000
|
+
"description": "Config to apply when the value matches the regex"
|
|
1001
|
+
}
|
|
1002
|
+
},
|
|
1003
|
+
"description": "Regular expression to match against and the result to apply when the value matches the regex"
|
|
1004
|
+
}
|
|
1005
|
+
},
|
|
1006
|
+
"description": "Maps regular expressions to replacement text and a color.\nFor example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain."
|
|
1007
|
+
},
|
|
1008
|
+
"SpecialValueMap": {
|
|
1009
|
+
"type": "object",
|
|
1010
|
+
"additionalProperties": false,
|
|
1011
|
+
"required": [
|
|
1012
|
+
"type",
|
|
1013
|
+
"options"
|
|
1014
|
+
],
|
|
1015
|
+
"properties": {
|
|
1016
|
+
"type": {
|
|
1017
|
+
"allOf": [
|
|
1018
|
+
{
|
|
1019
|
+
"$ref": "#/definitions/MappingType"
|
|
1020
|
+
}
|
|
1021
|
+
],
|
|
1022
|
+
"default": "special"
|
|
1023
|
+
},
|
|
1024
|
+
"options": {
|
|
1025
|
+
"type": "object",
|
|
1026
|
+
"additionalProperties": false,
|
|
1027
|
+
"required": [
|
|
1028
|
+
"match",
|
|
1029
|
+
"result"
|
|
1030
|
+
],
|
|
1031
|
+
"properties": {
|
|
1032
|
+
"match": {
|
|
1033
|
+
"$ref": "#/definitions/SpecialValueMatch",
|
|
1034
|
+
"description": "Special value to match against"
|
|
1035
|
+
},
|
|
1036
|
+
"result": {
|
|
1037
|
+
"$ref": "#/definitions/ValueMappingResult",
|
|
1038
|
+
"description": "Config to apply when the value matches the special value"
|
|
1039
|
+
}
|
|
1040
|
+
}
|
|
1041
|
+
}
|
|
1042
|
+
},
|
|
1043
|
+
"description": "Maps special values like Null, NaN (not a number), and boolean values like true and false to a display text and color.\nSee SpecialValueMatch to see the list of special values.\nFor example, you can configure a special value mapping so that null values appear as N/A."
|
|
1044
|
+
},
|
|
1045
|
+
"SpecialValueMatch": {
|
|
1046
|
+
"enum": [
|
|
1047
|
+
"true",
|
|
1048
|
+
"false",
|
|
1049
|
+
"null",
|
|
1050
|
+
"nan",
|
|
1051
|
+
"null+nan",
|
|
1052
|
+
"empty"
|
|
1053
|
+
],
|
|
1054
|
+
"type": "string",
|
|
1055
|
+
"description": "Special value types supported by the `SpecialValueMap`"
|
|
1056
|
+
},
|
|
1057
|
+
"ThresholdsConfig": {
|
|
1058
|
+
"type": "object",
|
|
1059
|
+
"additionalProperties": false,
|
|
1060
|
+
"required": [
|
|
1061
|
+
"mode",
|
|
1062
|
+
"steps"
|
|
1063
|
+
],
|
|
1064
|
+
"properties": {
|
|
1065
|
+
"mode": {
|
|
1066
|
+
"$ref": "#/definitions/ThresholdsMode",
|
|
1067
|
+
"description": "Thresholds mode."
|
|
1068
|
+
},
|
|
1069
|
+
"steps": {
|
|
1070
|
+
"type": "array",
|
|
1071
|
+
"items": {
|
|
1072
|
+
"$ref": "#/definitions/Threshold"
|
|
1073
|
+
},
|
|
1074
|
+
"description": "Must be sorted by 'value', first value is always -Infinity"
|
|
1075
|
+
}
|
|
1076
|
+
},
|
|
1077
|
+
"description": "Thresholds configuration for the panel"
|
|
1078
|
+
},
|
|
1079
|
+
"ThresholdsMode": {
|
|
1080
|
+
"enum": [
|
|
1081
|
+
"absolute",
|
|
1082
|
+
"percentage"
|
|
1083
|
+
],
|
|
1084
|
+
"type": "string",
|
|
1085
|
+
"description": "Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1)."
|
|
1086
|
+
},
|
|
1087
|
+
"Threshold": {
|
|
1088
|
+
"type": "object",
|
|
1089
|
+
"additionalProperties": false,
|
|
1090
|
+
"required": [
|
|
1091
|
+
"value",
|
|
1092
|
+
"color"
|
|
1093
|
+
],
|
|
1094
|
+
"properties": {
|
|
1095
|
+
"value": {
|
|
1096
|
+
"anyOf": [
|
|
1097
|
+
{
|
|
1098
|
+
"type": "number"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"type": "null"
|
|
1102
|
+
}
|
|
1103
|
+
],
|
|
1104
|
+
"description": "Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON."
|
|
1105
|
+
},
|
|
1106
|
+
"color": {
|
|
1107
|
+
"type": "string",
|
|
1108
|
+
"description": "Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded."
|
|
1109
|
+
}
|
|
1110
|
+
},
|
|
1111
|
+
"description": "User-defined value for a metric that triggers visual changes in a panel when this value is met or exceeded\nThey are used to conditionally style and color visualizations based on query results , and can be applied to most visualizations."
|
|
1112
|
+
},
|
|
1113
|
+
"FieldColor": {
|
|
1114
|
+
"type": "object",
|
|
1115
|
+
"additionalProperties": false,
|
|
1116
|
+
"required": [
|
|
1117
|
+
"mode"
|
|
1118
|
+
],
|
|
1119
|
+
"properties": {
|
|
1120
|
+
"mode": {
|
|
1121
|
+
"$ref": "#/definitions/FieldColorModeId",
|
|
1122
|
+
"description": "The main color scheme mode."
|
|
1123
|
+
},
|
|
1124
|
+
"fixedColor": {
|
|
1125
|
+
"type": "string",
|
|
1126
|
+
"description": "The fixed color value for fixed or shades color modes."
|
|
1127
|
+
},
|
|
1128
|
+
"seriesBy": {
|
|
1129
|
+
"$ref": "#/definitions/FieldColorSeriesByMode",
|
|
1130
|
+
"description": "Some visualizations need to know how to assign a series color from by value color schemes."
|
|
1131
|
+
}
|
|
1132
|
+
},
|
|
1133
|
+
"description": "Map a field to a color."
|
|
1134
|
+
},
|
|
1135
|
+
"FieldColorModeId": {
|
|
1136
|
+
"enum": [
|
|
1137
|
+
"thresholds",
|
|
1138
|
+
"palette-classic",
|
|
1139
|
+
"palette-classic-by-name",
|
|
1140
|
+
"continuous-GrYlRd",
|
|
1141
|
+
"continuous-RdYlGr",
|
|
1142
|
+
"continuous-BlYlRd",
|
|
1143
|
+
"continuous-YlRd",
|
|
1144
|
+
"continuous-BlPu",
|
|
1145
|
+
"continuous-YlBl",
|
|
1146
|
+
"continuous-blues",
|
|
1147
|
+
"continuous-reds",
|
|
1148
|
+
"continuous-greens",
|
|
1149
|
+
"continuous-purples",
|
|
1150
|
+
"fixed",
|
|
1151
|
+
"shades"
|
|
1152
|
+
],
|
|
1153
|
+
"type": "string",
|
|
1154
|
+
"description": "Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`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\n`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\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule."
|
|
1155
|
+
},
|
|
1156
|
+
"FieldColorSeriesByMode": {
|
|
1157
|
+
"enum": [
|
|
1158
|
+
"min",
|
|
1159
|
+
"max",
|
|
1160
|
+
"last"
|
|
1161
|
+
],
|
|
1162
|
+
"type": "string",
|
|
1163
|
+
"description": "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."
|
|
1164
|
+
},
|
|
1165
|
+
"Action": {
|
|
1166
|
+
"type": "object",
|
|
1167
|
+
"additionalProperties": false,
|
|
1168
|
+
"required": [
|
|
1169
|
+
"type",
|
|
1170
|
+
"title"
|
|
1171
|
+
],
|
|
1172
|
+
"properties": {
|
|
1173
|
+
"type": {
|
|
1174
|
+
"$ref": "#/definitions/ActionType"
|
|
1175
|
+
},
|
|
1176
|
+
"title": {
|
|
1177
|
+
"type": "string"
|
|
1178
|
+
},
|
|
1179
|
+
"fetch": {
|
|
1180
|
+
"$ref": "#/definitions/FetchOptions"
|
|
1181
|
+
},
|
|
1182
|
+
"infinity": {
|
|
1183
|
+
"$ref": "#/definitions/InfinityOptions"
|
|
1184
|
+
},
|
|
1185
|
+
"confirmation": {
|
|
1186
|
+
"type": "string"
|
|
1187
|
+
},
|
|
1188
|
+
"oneClick": {
|
|
1189
|
+
"type": "boolean"
|
|
1190
|
+
},
|
|
1191
|
+
"variables": {
|
|
1192
|
+
"type": "array",
|
|
1193
|
+
"items": {
|
|
1194
|
+
"$ref": "#/definitions/ActionVariable"
|
|
1195
|
+
}
|
|
1196
|
+
},
|
|
1197
|
+
"style": {
|
|
1198
|
+
"type": "object",
|
|
1199
|
+
"additionalProperties": false,
|
|
1200
|
+
"properties": {
|
|
1201
|
+
"backgroundColor": {
|
|
1202
|
+
"type": "string"
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
}
|
|
1206
|
+
},
|
|
1207
|
+
"description": "Dashboard action"
|
|
1208
|
+
},
|
|
1209
|
+
"ActionType": {
|
|
1210
|
+
"enum": [
|
|
1211
|
+
"fetch",
|
|
1212
|
+
"infinity"
|
|
1213
|
+
],
|
|
1214
|
+
"type": "string",
|
|
1215
|
+
"description": "Dashboard action type"
|
|
1216
|
+
},
|
|
1217
|
+
"FetchOptions": {
|
|
1218
|
+
"type": "object",
|
|
1219
|
+
"additionalProperties": false,
|
|
1220
|
+
"required": [
|
|
1221
|
+
"method",
|
|
1222
|
+
"url"
|
|
1223
|
+
],
|
|
1224
|
+
"properties": {
|
|
1225
|
+
"method": {
|
|
1226
|
+
"$ref": "#/definitions/HttpRequestMethod"
|
|
1227
|
+
},
|
|
1228
|
+
"url": {
|
|
1229
|
+
"type": "string"
|
|
1230
|
+
},
|
|
1231
|
+
"body": {
|
|
1232
|
+
"type": "string"
|
|
1233
|
+
},
|
|
1234
|
+
"queryParams": {
|
|
1235
|
+
"type": "array",
|
|
1236
|
+
"items": {
|
|
1237
|
+
"type": "array",
|
|
1238
|
+
"items": {
|
|
1239
|
+
"type": "string"
|
|
1240
|
+
}
|
|
1241
|
+
},
|
|
1242
|
+
"description": "These are 2D arrays of strings, each representing a key-value pair\nWe are defining this way because we can't generate a go struct that\nthat would have exactly two strings in each sub-array"
|
|
1243
|
+
},
|
|
1244
|
+
"headers": {
|
|
1245
|
+
"type": "array",
|
|
1246
|
+
"items": {
|
|
1247
|
+
"type": "array",
|
|
1248
|
+
"items": {
|
|
1249
|
+
"type": "string"
|
|
1250
|
+
}
|
|
1251
|
+
}
|
|
1252
|
+
}
|
|
1253
|
+
},
|
|
1254
|
+
"description": "Fetch options"
|
|
1255
|
+
},
|
|
1256
|
+
"HttpRequestMethod": {
|
|
1257
|
+
"enum": [
|
|
1258
|
+
"GET",
|
|
1259
|
+
"PUT",
|
|
1260
|
+
"POST",
|
|
1261
|
+
"DELETE",
|
|
1262
|
+
"PATCH"
|
|
1263
|
+
],
|
|
1264
|
+
"type": "string"
|
|
1265
|
+
},
|
|
1266
|
+
"InfinityOptions": {
|
|
1267
|
+
"type": "object",
|
|
1268
|
+
"additionalProperties": false,
|
|
1269
|
+
"required": [
|
|
1270
|
+
"method",
|
|
1271
|
+
"url",
|
|
1272
|
+
"datasourceUid"
|
|
1273
|
+
],
|
|
1274
|
+
"properties": {
|
|
1275
|
+
"method": {
|
|
1276
|
+
"$ref": "#/definitions/HttpRequestMethod"
|
|
1277
|
+
},
|
|
1278
|
+
"url": {
|
|
1279
|
+
"type": "string"
|
|
1280
|
+
},
|
|
1281
|
+
"body": {
|
|
1282
|
+
"type": "string"
|
|
1283
|
+
},
|
|
1284
|
+
"queryParams": {
|
|
1285
|
+
"type": "array",
|
|
1286
|
+
"items": {
|
|
1287
|
+
"type": "array",
|
|
1288
|
+
"items": {
|
|
1289
|
+
"type": "string"
|
|
1290
|
+
}
|
|
1291
|
+
},
|
|
1292
|
+
"description": "These are 2D arrays of strings, each representing a key-value pair\nWe are defining them this way because we can't generate a go struct that\nthat would have exactly two strings in each sub-array"
|
|
1293
|
+
},
|
|
1294
|
+
"headers": {
|
|
1295
|
+
"type": "array",
|
|
1296
|
+
"items": {
|
|
1297
|
+
"type": "array",
|
|
1298
|
+
"items": {
|
|
1299
|
+
"type": "string"
|
|
1300
|
+
}
|
|
1301
|
+
}
|
|
1302
|
+
},
|
|
1303
|
+
"datasourceUid": {
|
|
1304
|
+
"type": "string"
|
|
1305
|
+
}
|
|
1306
|
+
},
|
|
1307
|
+
"description": "Infinity options"
|
|
1308
|
+
},
|
|
1309
|
+
"ActionVariable": {
|
|
1310
|
+
"type": "object",
|
|
1311
|
+
"additionalProperties": false,
|
|
1312
|
+
"required": [
|
|
1313
|
+
"key",
|
|
1314
|
+
"name",
|
|
1315
|
+
"type"
|
|
1316
|
+
],
|
|
1317
|
+
"properties": {
|
|
1318
|
+
"key": {
|
|
1319
|
+
"type": "string"
|
|
1320
|
+
},
|
|
1321
|
+
"name": {
|
|
1322
|
+
"type": "string"
|
|
1323
|
+
},
|
|
1324
|
+
"type": {
|
|
1325
|
+
"allOf": [
|
|
1326
|
+
{
|
|
1327
|
+
"$ref": "#/definitions/ActionVariableType"
|
|
1328
|
+
}
|
|
1329
|
+
],
|
|
1330
|
+
"default": "string"
|
|
1331
|
+
}
|
|
1332
|
+
}
|
|
1333
|
+
},
|
|
1334
|
+
"ActionVariableType": {
|
|
1335
|
+
"enum": [
|
|
1336
|
+
"string"
|
|
1337
|
+
],
|
|
1338
|
+
"type": "string",
|
|
1339
|
+
"description": "Action variable type"
|
|
1340
|
+
},
|
|
1341
|
+
"DynamicConfigValue": {
|
|
1342
|
+
"type": "object",
|
|
1343
|
+
"additionalProperties": false,
|
|
1344
|
+
"required": [
|
|
1345
|
+
"id"
|
|
1346
|
+
],
|
|
1347
|
+
"properties": {
|
|
1348
|
+
"id": {
|
|
1349
|
+
"type": "string",
|
|
1350
|
+
"default": ""
|
|
1351
|
+
},
|
|
1352
|
+
"value": {
|
|
1353
|
+
"type": "object",
|
|
1354
|
+
"additionalProperties": {}
|
|
1355
|
+
}
|
|
1356
|
+
}
|
|
1357
|
+
},
|
|
1358
|
+
"RowPanel": {
|
|
1359
|
+
"type": "object",
|
|
1360
|
+
"additionalProperties": false,
|
|
1361
|
+
"required": [
|
|
1362
|
+
"type",
|
|
1363
|
+
"collapsed",
|
|
1364
|
+
"id",
|
|
1365
|
+
"panels"
|
|
1366
|
+
],
|
|
1367
|
+
"properties": {
|
|
1368
|
+
"type": {
|
|
1369
|
+
"type": "string",
|
|
1370
|
+
"const": "row",
|
|
1371
|
+
"description": "The panel type"
|
|
1372
|
+
},
|
|
1373
|
+
"collapsed": {
|
|
1374
|
+
"type": "boolean",
|
|
1375
|
+
"description": "Whether this row should be collapsed or not.",
|
|
1376
|
+
"default": false
|
|
1377
|
+
},
|
|
1378
|
+
"title": {
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"description": "Row title"
|
|
1381
|
+
},
|
|
1382
|
+
"datasource": {
|
|
1383
|
+
"$ref": "#/definitions/DataSourceRef",
|
|
1384
|
+
"description": "Name of default datasource for the row"
|
|
1385
|
+
},
|
|
1386
|
+
"gridPos": {
|
|
1387
|
+
"$ref": "#/definitions/GridPos",
|
|
1388
|
+
"description": "Row grid position"
|
|
1389
|
+
},
|
|
1390
|
+
"id": {
|
|
1391
|
+
"type": "integer",
|
|
1392
|
+
"description": "Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally."
|
|
1393
|
+
},
|
|
1394
|
+
"panels": {
|
|
1395
|
+
"type": "array",
|
|
1396
|
+
"items": {
|
|
1397
|
+
"$ref": "#/definitions/Panel"
|
|
1398
|
+
},
|
|
1399
|
+
"description": "List of panels in the row"
|
|
1400
|
+
},
|
|
1401
|
+
"repeat": {
|
|
1402
|
+
"type": "string",
|
|
1403
|
+
"description": "Name of template variable to repeat for."
|
|
1404
|
+
}
|
|
1405
|
+
},
|
|
1406
|
+
"description": "Row panel"
|
|
1407
|
+
},
|
|
1408
|
+
"VariableModel": {
|
|
1409
|
+
"type": "object",
|
|
1410
|
+
"additionalProperties": false,
|
|
1411
|
+
"required": [
|
|
1412
|
+
"type",
|
|
1413
|
+
"name"
|
|
1414
|
+
],
|
|
1415
|
+
"properties": {
|
|
1416
|
+
"type": {
|
|
1417
|
+
"$ref": "#/definitions/VariableType",
|
|
1418
|
+
"description": "Type of variable"
|
|
1419
|
+
},
|
|
1420
|
+
"name": {
|
|
1421
|
+
"type": "string",
|
|
1422
|
+
"description": "Name of variable"
|
|
1423
|
+
},
|
|
1424
|
+
"label": {
|
|
1425
|
+
"type": "string",
|
|
1426
|
+
"description": "Optional display name"
|
|
1427
|
+
},
|
|
1428
|
+
"hide": {
|
|
1429
|
+
"$ref": "#/definitions/VariableHide",
|
|
1430
|
+
"description": "Visibility configuration for the variable"
|
|
1431
|
+
},
|
|
1432
|
+
"skipUrlSync": {
|
|
1433
|
+
"type": "boolean",
|
|
1434
|
+
"description": "Whether the variable value should be managed by URL query params or not",
|
|
1435
|
+
"default": false
|
|
1436
|
+
},
|
|
1437
|
+
"description": {
|
|
1438
|
+
"type": "string",
|
|
1439
|
+
"description": "Description of variable. It can be defined but `null`."
|
|
1440
|
+
},
|
|
1441
|
+
"query": {
|
|
1442
|
+
"oneOf": [
|
|
1443
|
+
{
|
|
1444
|
+
"type": "string"
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"type": "object",
|
|
1448
|
+
"additionalProperties": {
|
|
1449
|
+
"type": "object",
|
|
1450
|
+
"additionalProperties": {}
|
|
1451
|
+
}
|
|
1452
|
+
}
|
|
1453
|
+
],
|
|
1454
|
+
"description": "Query used to fetch values for a variable"
|
|
1455
|
+
},
|
|
1456
|
+
"datasource": {
|
|
1457
|
+
"$ref": "#/definitions/DataSourceRef",
|
|
1458
|
+
"description": "Data source used to fetch values for a variable. It can be defined but `null`."
|
|
1459
|
+
},
|
|
1460
|
+
"current": {
|
|
1461
|
+
"$ref": "#/definitions/VariableOption",
|
|
1462
|
+
"description": "Shows current selected variable text/value on the dashboard"
|
|
1463
|
+
},
|
|
1464
|
+
"multi": {
|
|
1465
|
+
"type": "boolean",
|
|
1466
|
+
"description": "Whether multiple values can be selected or not from variable value list",
|
|
1467
|
+
"default": false
|
|
1468
|
+
},
|
|
1469
|
+
"allowCustomValue": {
|
|
1470
|
+
"type": "boolean",
|
|
1471
|
+
"description": "Allow custom values to be entered in the variable",
|
|
1472
|
+
"default": true
|
|
1473
|
+
},
|
|
1474
|
+
"options": {
|
|
1475
|
+
"type": "array",
|
|
1476
|
+
"items": {
|
|
1477
|
+
"$ref": "#/definitions/VariableOption"
|
|
1478
|
+
},
|
|
1479
|
+
"description": "Options that can be selected for a variable."
|
|
1480
|
+
},
|
|
1481
|
+
"refresh": {
|
|
1482
|
+
"$ref": "#/definitions/VariableRefresh",
|
|
1483
|
+
"description": "Options to config when to refresh a variable"
|
|
1484
|
+
},
|
|
1485
|
+
"sort": {
|
|
1486
|
+
"$ref": "#/definitions/VariableSort",
|
|
1487
|
+
"description": "Options sort order"
|
|
1488
|
+
},
|
|
1489
|
+
"includeAll": {
|
|
1490
|
+
"type": "boolean",
|
|
1491
|
+
"description": "Whether all value option is available or not",
|
|
1492
|
+
"default": false
|
|
1493
|
+
},
|
|
1494
|
+
"allValue": {
|
|
1495
|
+
"type": "string",
|
|
1496
|
+
"description": "Custom all value"
|
|
1497
|
+
},
|
|
1498
|
+
"regex": {
|
|
1499
|
+
"type": "string",
|
|
1500
|
+
"description": "Optional field, if you want to extract part of a series name or metric node segment.\nNamed capture groups can be used to separate the display text and value."
|
|
1501
|
+
},
|
|
1502
|
+
"staticOptions": {
|
|
1503
|
+
"type": "array",
|
|
1504
|
+
"items": {
|
|
1505
|
+
"$ref": "#/definitions/VariableOption"
|
|
1506
|
+
},
|
|
1507
|
+
"description": "Additional static options for query variable"
|
|
1508
|
+
},
|
|
1509
|
+
"staticOptionsOrder": {
|
|
1510
|
+
"enum": [
|
|
1511
|
+
"before",
|
|
1512
|
+
"after",
|
|
1513
|
+
"sorted"
|
|
1514
|
+
],
|
|
1515
|
+
"type": "string",
|
|
1516
|
+
"description": "Ordering of static options in relation to options returned from data source for query variable"
|
|
1517
|
+
},
|
|
1518
|
+
"auto": {
|
|
1519
|
+
"type": "boolean",
|
|
1520
|
+
"description": "Dynamically calculates interval by dividing time range by the count specified.",
|
|
1521
|
+
"default": false
|
|
1522
|
+
},
|
|
1523
|
+
"auto_min": {
|
|
1524
|
+
"type": "string",
|
|
1525
|
+
"description": "The minimum threshold below which the step count intervals will not divide the time.",
|
|
1526
|
+
"default": "10s"
|
|
1527
|
+
},
|
|
1528
|
+
"auto_count": {
|
|
1529
|
+
"type": "integer",
|
|
1530
|
+
"exclusiveMinimum": 0,
|
|
1531
|
+
"description": "How many times the current time range should be divided to calculate the value, similar to the Max data points query option.\nFor example, if the current visible time range is 30 minutes, then the auto interval groups the data into 30 one-minute increments.",
|
|
1532
|
+
"default": 30
|
|
1533
|
+
},
|
|
1534
|
+
"definition": {
|
|
1535
|
+
"type": "string"
|
|
1536
|
+
}
|
|
1537
|
+
},
|
|
1538
|
+
"description": "A variable is a placeholder for a value. You can use variables in metric queries and in panel titles."
|
|
1539
|
+
},
|
|
1540
|
+
"VariableType": {
|
|
1541
|
+
"enum": [
|
|
1542
|
+
"query",
|
|
1543
|
+
"adhoc",
|
|
1544
|
+
"groupby",
|
|
1545
|
+
"constant",
|
|
1546
|
+
"datasource",
|
|
1547
|
+
"interval",
|
|
1548
|
+
"textbox",
|
|
1549
|
+
"custom",
|
|
1550
|
+
"system",
|
|
1551
|
+
"snapshot",
|
|
1552
|
+
"switch"
|
|
1553
|
+
],
|
|
1554
|
+
"type": "string",
|
|
1555
|
+
"description": "Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables\n`switch`: Boolean variables rendered as a switch"
|
|
1556
|
+
},
|
|
1557
|
+
"VariableHide": {
|
|
1558
|
+
"enum": [
|
|
1559
|
+
0,
|
|
1560
|
+
1,
|
|
1561
|
+
2,
|
|
1562
|
+
3
|
|
1563
|
+
],
|
|
1564
|
+
"type": "integer",
|
|
1565
|
+
"description": "Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing), 3 (show under the controls dropdown menu)."
|
|
1566
|
+
},
|
|
1567
|
+
"VariableOption": {
|
|
1568
|
+
"type": "object",
|
|
1569
|
+
"additionalProperties": false,
|
|
1570
|
+
"required": [
|
|
1571
|
+
"text",
|
|
1572
|
+
"value"
|
|
1573
|
+
],
|
|
1574
|
+
"properties": {
|
|
1575
|
+
"selected": {
|
|
1576
|
+
"type": "boolean",
|
|
1577
|
+
"description": "Whether the option is selected or not"
|
|
1578
|
+
},
|
|
1579
|
+
"text": {
|
|
1580
|
+
"oneOf": [
|
|
1581
|
+
{
|
|
1582
|
+
"type": "string"
|
|
1583
|
+
},
|
|
1584
|
+
{
|
|
1585
|
+
"type": "array",
|
|
1586
|
+
"items": {
|
|
1587
|
+
"type": "string"
|
|
1588
|
+
}
|
|
1589
|
+
}
|
|
1590
|
+
],
|
|
1591
|
+
"description": "Text to be displayed for the option"
|
|
1592
|
+
},
|
|
1593
|
+
"value": {
|
|
1594
|
+
"oneOf": [
|
|
1595
|
+
{
|
|
1596
|
+
"type": "string"
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"type": "array",
|
|
1600
|
+
"items": {
|
|
1601
|
+
"type": "string"
|
|
1602
|
+
}
|
|
1603
|
+
}
|
|
1604
|
+
],
|
|
1605
|
+
"description": "Value of the option"
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
"description": "Option to be selected in a variable."
|
|
1609
|
+
},
|
|
1610
|
+
"VariableRefresh": {
|
|
1611
|
+
"enum": [
|
|
1612
|
+
0,
|
|
1613
|
+
1,
|
|
1614
|
+
2
|
|
1615
|
+
],
|
|
1616
|
+
"type": "integer",
|
|
1617
|
+
"description": "Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes."
|
|
1618
|
+
},
|
|
1619
|
+
"VariableSort": {
|
|
1620
|
+
"enum": [
|
|
1621
|
+
0,
|
|
1622
|
+
1,
|
|
1623
|
+
2,
|
|
1624
|
+
3,
|
|
1625
|
+
4,
|
|
1626
|
+
5,
|
|
1627
|
+
6,
|
|
1628
|
+
7,
|
|
1629
|
+
8
|
|
1630
|
+
],
|
|
1631
|
+
"type": "integer",
|
|
1632
|
+
"description": "Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC\n`7`: Natural ASC\n`8`: Natural DESC"
|
|
1633
|
+
},
|
|
1634
|
+
"AnnotationContainer": {
|
|
1635
|
+
"type": "object",
|
|
1636
|
+
"additionalProperties": false,
|
|
1637
|
+
"properties": {
|
|
1638
|
+
"list": {
|
|
1639
|
+
"type": "array",
|
|
1640
|
+
"items": {
|
|
1641
|
+
"$ref": "#/definitions/AnnotationQuery"
|
|
1642
|
+
},
|
|
1643
|
+
"description": "List of annotations"
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"description": "Contains the list of annotations that are associated with the dashboard.\nAnnotations are used to overlay event markers and overlay event tags on graphs.\nGrafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.\nSee https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/"
|
|
1647
|
+
},
|
|
1648
|
+
"AnnotationQuery": {
|
|
1649
|
+
"type": "object",
|
|
1650
|
+
"additionalProperties": false,
|
|
1651
|
+
"required": [
|
|
1652
|
+
"name",
|
|
1653
|
+
"enable",
|
|
1654
|
+
"iconColor"
|
|
1655
|
+
],
|
|
1656
|
+
"properties": {
|
|
1657
|
+
"name": {
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"description": "Name of annotation."
|
|
1660
|
+
},
|
|
1661
|
+
"datasource": {
|
|
1662
|
+
"$ref": "#/definitions/DataSourceRef",
|
|
1663
|
+
"description": "Datasource where the annotations data is"
|
|
1664
|
+
},
|
|
1665
|
+
"enable": {
|
|
1666
|
+
"type": "boolean",
|
|
1667
|
+
"description": "When enabled the annotation query is issued with every dashboard refresh",
|
|
1668
|
+
"default": true
|
|
1669
|
+
},
|
|
1670
|
+
"hide": {
|
|
1671
|
+
"type": "boolean",
|
|
1672
|
+
"description": "Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.",
|
|
1673
|
+
"default": false
|
|
1674
|
+
},
|
|
1675
|
+
"iconColor": {
|
|
1676
|
+
"type": "string",
|
|
1677
|
+
"description": "Color to use for the annotation event markers"
|
|
1678
|
+
},
|
|
1679
|
+
"filter": {
|
|
1680
|
+
"$ref": "#/definitions/AnnotationPanelFilter",
|
|
1681
|
+
"description": "Filters to apply when fetching annotations"
|
|
1682
|
+
},
|
|
1683
|
+
"target": {
|
|
1684
|
+
"type": "object",
|
|
1685
|
+
"additionalProperties": {},
|
|
1686
|
+
"description": "TODO.. this should just be a normal query target"
|
|
1687
|
+
},
|
|
1688
|
+
"type": {
|
|
1689
|
+
"type": "string",
|
|
1690
|
+
"description": "TODO -- this should not exist here, it is based on the --grafana-- datasource"
|
|
1691
|
+
},
|
|
1692
|
+
"builtIn": {
|
|
1693
|
+
"type": "number",
|
|
1694
|
+
"description": "Set to 1 for the standard annotation query all dashboards have by default.",
|
|
1695
|
+
"default": 0
|
|
1696
|
+
},
|
|
1697
|
+
"placement": {
|
|
1698
|
+
"allOf": [
|
|
1699
|
+
{
|
|
1700
|
+
"$ref": "#/definitions/AnnotationQueryPlacement"
|
|
1701
|
+
}
|
|
1702
|
+
],
|
|
1703
|
+
"default": "inControlsMenu",
|
|
1704
|
+
"description": "Placement can be used to display the annotation query somewhere else on the dashboard other than the default location."
|
|
1705
|
+
},
|
|
1706
|
+
"expr": {
|
|
1707
|
+
"type": "string"
|
|
1708
|
+
},
|
|
1709
|
+
"textFormat": {
|
|
1710
|
+
"type": "string",
|
|
1711
|
+
"description": "Format for Prometheus annotation text. Label values can be interpolated with templates like {{instance}}."
|
|
1712
|
+
},
|
|
1713
|
+
"titleFormat": {
|
|
1714
|
+
"type": "string",
|
|
1715
|
+
"description": "Format for Prometheus and Loki annotation titles. Label values can be interpolated with templates like {{instance}}."
|
|
1716
|
+
},
|
|
1717
|
+
"tagKeys": {
|
|
1718
|
+
"type": "string",
|
|
1719
|
+
"description": "Comma-separated label keys used as annotation tags."
|
|
1720
|
+
},
|
|
1721
|
+
"step": {
|
|
1722
|
+
"type": "string",
|
|
1723
|
+
"description": "Legacy Prometheus annotation query step interval."
|
|
1724
|
+
},
|
|
1725
|
+
"useValueForTime": {
|
|
1726
|
+
"type": "boolean",
|
|
1727
|
+
"description": "Use the Prometheus series value as the annotation timestamp."
|
|
1728
|
+
},
|
|
1729
|
+
"mappings": {
|
|
1730
|
+
"type": "object",
|
|
1731
|
+
"additionalProperties": {
|
|
1732
|
+
"$ref": "#/definitions/AnnotationEventFieldMapping"
|
|
1733
|
+
},
|
|
1734
|
+
"description": "Mappings define how to convert data frame fields to annotation event fields."
|
|
1735
|
+
}
|
|
1736
|
+
},
|
|
1737
|
+
"description": "TODO docs\nFROM: AnnotationQuery in grafana-data/src/types/annotations.ts"
|
|
1738
|
+
},
|
|
1739
|
+
"AnnotationPanelFilter": {
|
|
1740
|
+
"type": "object",
|
|
1741
|
+
"additionalProperties": false,
|
|
1742
|
+
"required": [
|
|
1743
|
+
"ids"
|
|
1744
|
+
],
|
|
1745
|
+
"properties": {
|
|
1746
|
+
"exclude": {
|
|
1747
|
+
"type": "boolean",
|
|
1748
|
+
"description": "Should the specified panels be included or excluded",
|
|
1749
|
+
"default": false
|
|
1750
|
+
},
|
|
1751
|
+
"ids": {
|
|
1752
|
+
"type": "array",
|
|
1753
|
+
"items": {
|
|
1754
|
+
"type": "integer"
|
|
1755
|
+
},
|
|
1756
|
+
"description": "Panel IDs that should be included or excluded"
|
|
1757
|
+
}
|
|
1758
|
+
}
|
|
1759
|
+
},
|
|
1760
|
+
"AnnotationTarget": {
|
|
1761
|
+
"type": "object",
|
|
1762
|
+
"additionalProperties": false,
|
|
1763
|
+
"required": [
|
|
1764
|
+
"limit",
|
|
1765
|
+
"matchAny",
|
|
1766
|
+
"tags",
|
|
1767
|
+
"type"
|
|
1768
|
+
],
|
|
1769
|
+
"properties": {
|
|
1770
|
+
"limit": {
|
|
1771
|
+
"type": "integer",
|
|
1772
|
+
"description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change"
|
|
1773
|
+
},
|
|
1774
|
+
"matchAny": {
|
|
1775
|
+
"type": "boolean",
|
|
1776
|
+
"description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change"
|
|
1777
|
+
},
|
|
1778
|
+
"tags": {
|
|
1779
|
+
"type": "array",
|
|
1780
|
+
"items": {
|
|
1781
|
+
"type": "string"
|
|
1782
|
+
},
|
|
1783
|
+
"description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change"
|
|
1784
|
+
},
|
|
1785
|
+
"type": {
|
|
1786
|
+
"type": "string",
|
|
1787
|
+
"description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change"
|
|
1788
|
+
}
|
|
1789
|
+
},
|
|
1790
|
+
"description": "TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the \"grafana\" datasouce that is default in most dashboards"
|
|
1791
|
+
},
|
|
1792
|
+
"AnnotationQueryPlacement": {
|
|
1793
|
+
"enum": [
|
|
1794
|
+
"inControlsMenu"
|
|
1795
|
+
],
|
|
1796
|
+
"type": "string",
|
|
1797
|
+
"description": "Annotation Query placement. Defines where the annotation query should be displayed.\n- \"inControlsMenu\" renders the annotation query in the dashboard controls dropdown menu"
|
|
1798
|
+
},
|
|
1799
|
+
"Snapshot": {
|
|
1800
|
+
"type": "object",
|
|
1801
|
+
"additionalProperties": false,
|
|
1802
|
+
"required": [
|
|
1803
|
+
"created",
|
|
1804
|
+
"expires",
|
|
1805
|
+
"external",
|
|
1806
|
+
"externalUrl",
|
|
1807
|
+
"originalUrl",
|
|
1808
|
+
"id",
|
|
1809
|
+
"key",
|
|
1810
|
+
"name",
|
|
1811
|
+
"orgId",
|
|
1812
|
+
"updated",
|
|
1813
|
+
"userId"
|
|
1814
|
+
],
|
|
1815
|
+
"properties": {
|
|
1816
|
+
"created": {
|
|
1817
|
+
"type": "string",
|
|
1818
|
+
"format": "date-time",
|
|
1819
|
+
"description": "Time when the snapshot was created"
|
|
1820
|
+
},
|
|
1821
|
+
"expires": {
|
|
1822
|
+
"type": "string",
|
|
1823
|
+
"description": "Time when the snapshot expires, default is never to expire"
|
|
1824
|
+
},
|
|
1825
|
+
"external": {
|
|
1826
|
+
"type": "boolean",
|
|
1827
|
+
"description": "Is the snapshot saved in an external grafana instance"
|
|
1828
|
+
},
|
|
1829
|
+
"externalUrl": {
|
|
1830
|
+
"type": "string",
|
|
1831
|
+
"description": "external url, if snapshot was shared in external grafana instance"
|
|
1832
|
+
},
|
|
1833
|
+
"originalUrl": {
|
|
1834
|
+
"type": "string",
|
|
1835
|
+
"description": "original url, url of the dashboard that was snapshotted"
|
|
1836
|
+
},
|
|
1837
|
+
"id": {
|
|
1838
|
+
"type": "integer",
|
|
1839
|
+
"description": "Unique identifier of the snapshot"
|
|
1840
|
+
},
|
|
1841
|
+
"key": {
|
|
1842
|
+
"type": "string",
|
|
1843
|
+
"description": "Optional, defined the unique key of the snapshot, required if external is true"
|
|
1844
|
+
},
|
|
1845
|
+
"name": {
|
|
1846
|
+
"type": "string",
|
|
1847
|
+
"description": "Optional, name of the snapshot"
|
|
1848
|
+
},
|
|
1849
|
+
"orgId": {
|
|
1850
|
+
"type": "integer",
|
|
1851
|
+
"description": "org id of the snapshot"
|
|
1852
|
+
},
|
|
1853
|
+
"updated": {
|
|
1854
|
+
"type": "string",
|
|
1855
|
+
"format": "date-time",
|
|
1856
|
+
"description": "last time when the snapshot was updated"
|
|
1857
|
+
},
|
|
1858
|
+
"url": {
|
|
1859
|
+
"type": "string",
|
|
1860
|
+
"description": "url of the snapshot, if snapshot was shared internally"
|
|
1861
|
+
},
|
|
1862
|
+
"userId": {
|
|
1863
|
+
"type": "integer",
|
|
1864
|
+
"description": "user id of the snapshot creator"
|
|
1865
|
+
},
|
|
1866
|
+
"dashboard": {
|
|
1867
|
+
"$ref": "#/definitions/Dashboard"
|
|
1868
|
+
}
|
|
1869
|
+
},
|
|
1870
|
+
"description": "A dashboard snapshot shares an interactive dashboard publicly.\nIt is a read-only version of a dashboard, and is not editable.\nIt is possible to create a snapshot of a snapshot.\nGrafana strips away all sensitive information from the dashboard.\nSensitive information stripped: queries (metric, template,annotation) and panel links."
|
|
1871
|
+
},
|
|
1872
|
+
"AnnotationEventFieldSource": {
|
|
1873
|
+
"enum": [
|
|
1874
|
+
"field",
|
|
1875
|
+
"text",
|
|
1876
|
+
"skip"
|
|
1877
|
+
],
|
|
1878
|
+
"type": "string",
|
|
1879
|
+
"description": "Annotation event field source. Defines how to obtain the value for an annotation event field.\n- \"field\": Find the value with a matching key (default)\n- \"text\": Write a constant string into the value\n- \"skip\": Do not include the field"
|
|
1880
|
+
},
|
|
1881
|
+
"AnnotationEventFieldMapping": {
|
|
1882
|
+
"type": "object",
|
|
1883
|
+
"additionalProperties": false,
|
|
1884
|
+
"properties": {
|
|
1885
|
+
"source": {
|
|
1886
|
+
"$ref": "#/definitions/AnnotationEventFieldSource",
|
|
1887
|
+
"description": "Source type for the field value."
|
|
1888
|
+
},
|
|
1889
|
+
"value": {
|
|
1890
|
+
"type": "string",
|
|
1891
|
+
"description": "Constant value to use when source is \"text\"."
|
|
1892
|
+
},
|
|
1893
|
+
"regex": {
|
|
1894
|
+
"type": "string",
|
|
1895
|
+
"description": "Regular expression to apply to the field value."
|
|
1896
|
+
}
|
|
1897
|
+
},
|
|
1898
|
+
"description": "Annotation event field mapping. Defines how to map a data frame field to an annotation event field."
|
|
1899
|
+
}
|
|
1900
|
+
}
|
|
1901
|
+
}
|