这是存档的文档v9.0。去最新版本。
仪表板JSON模型
仪表板在Grafana是由一个JSON对象,存储元数据的仪表板。仪表板元数据包括仪表板属性、元数据面板模板变量,面板查询,等等。
查看仪表板的JSON:
- 导航到仪表板。
- 在顶部导航菜单,单击仪表板设置(齿轮)图标。
- 点击JSON模型。
JSON字段
当用户创建一个新的仪表板时,初始化一个新的仪表板JSON对象有以下字段:
注意:在接下来的JSON, id是显示为空默认值分配给保存到仪表板。一旦保存一个仪表板,被分配到一个整数价值
id
字段。
{" id ":空,“uid”:“cLV5GDCkz”,“标题”:“新的仪表板”,“标签”:[],“风格”:“黑暗”、“时区”:“浏览器”,“可编辑”:真的,“hideControls”:假的,“graphTooltip”: 1、“面板”:[],“时间”:{“从”:“now-6h”,“对”:“现在”},“timepicker”: {“time_options”: [],“refresh_intervals”:[]},“模板”:{“列表”:[]},“注释”:{“列表”:[]},“刷新”:“5 s”、“schemaVersion”: 17岁的“版本”:0,“链接”:[]}
仪表板中的每个字段JSON是下面解释的用法:
的名字 | 使用 |
---|---|
id | 独特的仪表板的数字标识符。(db)生成的 |
uid | 唯一的仪表板标识符,可以由任何人。字符串(8-40) |
标题 | 当前的仪表板 |
标签 | 标签与仪表板,字符串数组 |
风格 | 仪表板的主题,即。黑暗 或光 |
时区 | 时区的仪表板。utc 或浏览器 |
可编辑的 | 是否仪表板是可编辑的 |
graphTooltip | 0没有共享十字丝或工具提示(默认),1共享十字丝,2为共享十字丝和共享的工具提示 |
时间 | 时间范围为仪表板,即去年6小时,持续7天,等 |
timepicker | timepicker元数据,看到timepicker节有关详细信息, |
模板 | 模板的元数据,看到模板部分有关详细信息, |
注释 | 元数据注释,看注释部分有关详细信息, |
刷新 | 自动刷新时间间隔 |
schemaVersion | 版本的JSON模式(整数),增加每次Grafana更新带来的变化来表示模式 |
版本 | 版本的仪表板(整数),增加每次更新仪表板 |
面板 | 电池板阵列,对细节见下文。 |
面板
面板是一个仪表板的基石。它由数据源查询,图表类型,别名等。面板JSON由一个JSON对象数组,每个代表一个不同的面板。大多数字段是常见的所有板但某些领域取决于类型的面板。下面是一个例子的面板JSON文本面板。
“板”:[{“类型”:“文本”,“标题”:“面板标题”、“gridPos”: {“x”: 0,“y”: 0,“w”: 12,“h”: 9},“id”: 4,“模式”:“减价”、“内容”:“#标题”}
面板的大小和位置
gridPos属性描述了面板的大小和位置的坐标。
w
上皮(仪表板的宽度分为24列)h
在网格高度单位,每个代表30像素。x
x的位置,在同一单位w
。y
y的位置,在同一单位h
。
网格的负重力移动面板上面如果有空间一个面板。
timepicker
“timepicker”:{“崩溃”:假的,“使”:真的,“注意”:假的,“现在”:真的,“refresh_intervals”: [“5 s”,“10”,“30年代”,“1米”,“5米”,“15米”,“30米”,“1 h”,“2 h”,“一维”),“状态”:“稳定”,“类型”:“timepicker”}
使用的字段如下解释:
的名字 | 使用 |
---|---|
崩溃 | timepicker是否倒塌 |
启用 | 是否启用timepicker |
请注意 | 待办事项 |
现在 | 待办事项 |
refresh_intervals | 待办事项 |
状态 | 待办事项 |
类型 | 待办事项 |
模板
的模板
字段包含一个数组保存的模板变量值以及一些其他元数据,例如:
“模板”:{“启用”:真的,“名单”:[{“allFormat”:“通配符”,“当前”:{“标签”:[],“文本”:“刺激”,“价值”:“刺激”},“数据源”:空,“includeAll”:真的,“名字”:“env”、“选项”:[{“选择”:假的,“文本”:“所有”、“价值”:“*”},{“选择”:假的,“文本”:“阶段”,“价值”:“阶段”},{“选择”:假的,“文本”:“测试”,“价值”:“测试”}],“查询”:“tag_values (cpu.utilization.average env)”,“刷新”:假的,“类型”:“查询”},{“allFormat”:“通配符”,“当前”:{“文本”:“apache”、“价值”:“apache”},“数据源”:空,“includeAll”:假的,“多”:假的,“多格式”:“水珠”、“名称”:“应用程序”,“选项”:[{“选择”:真的,“文本”:“tomcat”、“价值”:“tomcat”},{“选择”:假的,“文本”:“卡桑德拉”,“价值”:“卡桑德拉”}],“查询”:“tag_values (cpu.utilization.average应用)”,“刷新”:假的,“正则表达式”:“”,“类型”:“查询”}]}
使用上述字段模板部分解释如下:
的名字 | 使用 |
---|---|
启用 | 是否启用模板 |
列表 | 一个对象数组每个代表一个模板变量 |
allFormat | 格式使用时从数据源获取所有的值,例如:通配符 ,一团 ,正则表达式 ,管 等。 |
当前的 | 显示当前选中变量文本/值在仪表板上 |
数据源 | 显示数据源变量 |
includeAll | 是否所有的价值选择是可用的 |
多 | 是否可以选择多个值的变量值列表 |
多规格 | 从数据源格式使用而抓取timeseries |
的名字 | 变量的名称 |
选项 | 数组变量文本/值对可供选择的仪表板 |
查询 | 数据源查询用于获取一个变量的值 |
刷新 | 待办事项 |
正则表达式 | 待办事项 |
类型 | 类型的变量,即。自定义 ,查询 或时间间隔 |
相关Grafana资源
开幕式主题:新Grafana 9吗?
Raj达特Myrle“将军”,Torkel突袭推出什么新Grafana 9。从2022年GrafanaCONline观看开幕式主题演讲。随需应变。