对接Grafana
表格存储对接Grafana后,您可以通过Grafana可视化展示表格存储中的数据。
前提条件
- 首次使用表格存储时,请开通表格存储服务以及创建实例和数据表等。具体操作,请参见通过控制台使用或者通过命令行工具使用宽表模型。
已为表格存储的数据表或者时序表创建映射关系。具体操作,请分别参见创建表的映射关系和创建多值模型映射关系。
首次使用时,请自行安装开源Grafana,且Grafana版本必须大于8.0.0。关于安装Grafana的具体操作,请参见Grafana官方文档。
- 已获取AccessKey(包括AccessKey ID和AccessKey Secret)。具体操作,请参见获取AccessKey。
背景信息
Grafana是一款开源的可视化和分析平台,支持Prometheus、Graphite、OpenTSDB、InfluxDB、Elasticsearch、MySQL、PostgreSQL等多种数据源的数据查询、可视化等。更多信息,请参见Grafana官方文档。
表格存储的表数据接入Grafana后,Grafana可以根据表数据生成大盘面板,将数据实时展示给需要的用户。
注意事项
目前表格存储支持使用Grafana实现数据可视化功能的地域有华东1(杭州)、华东2(上海)、华北2(北京)、华北3(张家口)、华南1(深圳)和新加坡。
步骤一:安装表格存储插件
如果使用阿里云可观测可视化 Grafana 版,请跳过此步骤。关于使用阿里云可观测可视化 Grafana 版的具体操作,请参见添加并使用Tablestore数据源。
在Windows平台操作
下载表格存储Grafana插件包。具体下载路径为表格存储Grafana插件包。
解压表格存储Grafana插件包,并将表格存储Grafana插件包放到Grafana插件的plugins-bundled目录中。
修改Grafana配置文件。
使用文本编辑器工具打开Grafana插件conf目录中的配置文件defaults.ini。
在配置文件的[plugins]节点中,设置allow_loading_unsigned_plugins参数。
allow_loading_unsigned_plugins = aliyun-tablestore-grafana-datasource
在任务管理器中重启grafana-server.exe进程。
在Linux或者Mac平台操作
执行以下命令下载表格存储Grafana插件包。
wget https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20220527/ygdf/tablestore-grafana-plugin-1.0.0.zip
将表格存储Grafana插件包解压到Grafana插件目录。
根据Grafana的安装方式执行对应命令。
使用YUM或RPM安装的Grafana(只适用于Linux平台):unzip tablestore-grafana-plugin-1.0.0.zip -d /var/lib/grafana/plugins
使用.tar.gz文件安装的Grafana:unzip tablestore-grafana-plugin-1.0.0.zip -d {PATH_TO}/grafana-{VERSION}/data/plugins
修改Grafana配置文件。
进入文件目录打开配置文件。
使用YUM或RPM安装的Grafana(只适用于Linux平台):/etc/grafana/grafana.ini
使用.tar.gz文件安装的Grafana:{PATH_TO}/grafana-{VERSION}/conf/defaults.ini
其中
{PATH_TO}/grafana-{VERSION}
为Grafana的安装路径,VERSION为Grafana的版本号。
在配置文件的[plugins]节点中,设置allow_loading_unsigned_plugins参数。
allow_loading_unsigned_plugins = aliyun-tablestore-grafana-datasource
重启Grafana。
使用kill命令终止Grafana进程。
执行以下命令启动Grafana。
使用YUM或RPM安装的Grafana(只适用于Linux平台):systemctl restart grafana-server
使用.tar.gz文件安装的Grafana:./bin/grafana-server web
步骤二:配置数据源
登录Grafana。
在浏览器中输入
http://localhost:3000/
,进入Grafana登录界面。输入Email or username和Password,单击Log in。
Grafana默认初始登录用户名和密码均为admin。首次登录时,请根据系统提示修改初始密码。
将鼠标移动到左侧导航栏的
图标上,单击Data sources。
在Data sources页签,单击Add data source。
在Add data source页面的Others区域,单击aliyun-tablestore-grafana-datasource。
在Settings页面,根据下表说明配置相关参数。
参数
示例值
说明
Name
aliyun-tablestore-grafana-datasource
数据源名称,可自定义。默认为aliyun-tablestore-grafana-datasource。
Endpoint
https://myinstance.cn-hangzhou.ots.aliyuncs.com
表格存储实例的服务地址,请根据访问的表格存储实例填写。更多信息,请参见服务地址。
Instance
myinstance
Tablestore实例名称。
AccessId
************************
拥有表格存储访问权限的阿里云账号或者RAM用户的AccessKey ID。
AccessKey
********************************
拥有表格存储访问权限的阿里云账号或者RAM用户的AccessKey Secret。
单击Save & test。
连接成功后,界面会显示Data source is working信息。
步骤三:创建大盘面板
在Grafana控制台界面,将鼠标移动到左侧导航栏的
图标上,单击Dashboard。
在New dashboard页面单击
图标。
在Add panel区域,单击Add a new panel。
在Edit Panel页面Query区域配置数据源查询条件。
在Data source下拉列表中选择tablestore数据源。
配置数据源参数。
参数
示例
说明
Query
SELECT * FROM your_table WHERE $__unixMicroTimeRangeFilter(_time)AND _m_name = "your_measurement" AND tag_value_at(_tags, "your_tag")="your_tag_value"LIMIT 1000
SQL查询语句。更多信息,请参见查询数据。
重要在WHERE子句中要通过预定义宏过滤时间范围,即示例中的
$__unixMicroTimeRangeFilter
。更多的时间宏函数请单击配置页面中的“Show Help”查看。如果以时序图形式展示,则需要返回以数字时间戳形式表示的时间列,并配置时间列的列名。
Format As
Timeseries
结果处理形式。取值范围如下:
Timeseries(默认):普通时序图。
FlowGraph:多维图表展示。
Table:普通表格形式。
Time Column
_time
返回数据中时间列的列名,时间列会作为时序图的横坐标。当选择Format As为Timeseries或者FlowGraph时可配置。
Aggregation Column
_field_name#:#_double_value
将同一时间点的多行单列数据转换为同一时间点的单行多列数据,适用于将Tablestore时序SQL产生的单值模型数据转换为多值模型数据。当选择Format As为FlowGraph时可配置。格式为
<数据点名称列>#:#<数值列>
。
单击Run SQL,执行SQL语句查看数据和调试。
设置并保存大盘面板。
在右侧设置监控图表的名称、类型、展示样式等。
单击右上角的Apply。
单击右上角的
图标,在Save dashboard as...对话框,设置Dashboard name和大盘归属的Folder后,单击Save。
步骤四:查看监控数据
在Grafana控制台界面,将鼠标移动到左侧导航栏的
图标上,单击Browse。
在Browse页签,单击目标目录下的监控大盘,即可查看目标大盘上的所有监控图表。