opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 07:02:22 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/observability-as-code/schema-v2/links-schema.md
Irene Rodríguez 09153c25be Add schema v2 new files (#104858) 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2025-05-02 16:21:03 +00:00

2.2 KiB
Raw Permalink 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.