apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59059 Commits
1680 Branches
645 Tags
2.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 09153c25be
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '09153c25be'
${ noResults }
grafana/docs/sources/observability-as-code/schema-v2/annotations-schema.md

2.5 KiB
Raw Blame History

description keywords labels menuTitle title weight
A reference for the JSON annotations schema used with Observability as Code. [configuration as code as-code dashboards git integration git sync github annotations] [{products [cloud enterprise oss]}] annotations schema annotations 100

annotations

The configuration for the list of annotations that are associated with the dashboard.

  "annotations": [
    {
      "kind": "AnnotationQuery",
      "spec": {
        "builtIn": false,
        "datasource": {
          "type": "",
          "uid": ""
        },
        "enable": false,
        "hide": false,
        "iconColor": "",
        "name": ""
      }
    }
  ],

AnnotationsQueryKind consists of:

AnnotationQuerySpec

Name Type/Definition
datasource DataSourceRef
query DataQueryKind
enable bool
hide bool
iconColor string
name string
builtIn bool. Default is false.
filter AnnotationPanelFilter
options [string]: A catch-all field for datasource-specific properties.

DataSourceRef

Name Usage
type? string. The plugin type-id.
uid? The specific data source instance.

DataQueryKind

Name Type
kind string
spec string

AnnotationPanelFilter

Name Type/Definition
exclude? bool. Should the specified panels be included or excluded. Default is false.
ids [...uint8]. Panel IDs that should be included or excluded.