// 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.
// 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.
// `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.
// 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
// 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.
// 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.
// 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
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
exportinterfaceSpec{
[key: string]:any;
}
exportconstdefaultSpec=():Spec=>({});
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Igor Suleymanov
Ryan McKinley