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/links-schema.md

2.2 KiB
Raw Blame History

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

links

The links schema is the configuration for links with references to other dashboards or external websites. Following are the default JSON fields:

  "links": [
    {
      "asDropdown": false,
      "icon": "",
      "includeVars": false,
      "keepTime": false,
      "tags": [],
      "targetBlank": false,
      "title": "",
      "tooltip": "",
      "type": "link",
    },
  ],

DashboardLink

The following table explains the usage of the dashboard link JSON fields. The table includes default and other fields:

Name Usage
title string. Title to display with the link.
type DashboardLinkType. Link type. Accepted values are:
  • dashboards - To refer to another dashboard
  • link - To refer to an external resource
icon string. Icon name to be displayed with the link.
tooltip string. Tooltip to display when the user hovers their mouse over it.
url? string. Link URL. Only required/valid if the type is link.
tags string. List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards.
asDropdown bool. 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. Default is false.
targetBlank bool. If true, the link will be opened in a new tab. Default is false.
includeVars bool. If true, includes current template variables values in the link as query params. Default is false.
keepTime bool. If true, includes current time range in the link as query params. Default is false.