Grafana的ClickHouse数据源

ClickHouse数据源插件允许您在Grafana中查询和可视化ClickHouse数据。

从2.0开始，这个插件只支持使用ClickHouse 22.7+时的特殊过滤器

安装

有关如何在Grafana Cloud或本地安装插件的详细说明，请查看插件安装文档．

配置

数据源的ClickHouse用户

建立一个ClickHouse用户帐户只读的对要查询的数据库和表的权限和访问。请注意，Grafana并不验证查询是否安全。查询可以包含任何SQL语句。例如，像这样的语句修改表系统。删除'sadUser'而且删除悲伤表会被处决。

ClickHouse协议支持

插件同时支持HTTP而且本地的(默认)传输协议。可以在配置中通过协议配置参数。这两个协议都使用优化的本机格式与ClickHouse交换数据。

注意，默认端口为HTTP /秒而且本地的不同:

• HTTP - 8123
• HTTPS - 8443
• 本机- 9000
• 本地TLS - 9440

手动配置

一旦插件安装到您的Grafana实例上，就可以执行下面的操作了这些指令来添加一个新的ClickHouse数据源，并输入配置选项。

使用配置文件

可以使用配置文件和Grafana的供应系统来配置数据源。要了解它的工作方式，包括可以为此数据源设置的所有设置，请参阅提供Grafana数据源．

下面是一些使用基本身份验证的数据源配置示例:

apiVersion: 1 datasources:—name: ClickHouse type: grafana-clickhouse-datasource jsonData: defaultDatabase:数据库端口:9000 server: localhost username:用户名tlsSkipVerify: false secureJsonData: password:密码

构建查询

查询编辑器允许您查询ClickHouse以返回时间序列或表格数据。查询可以包含简化语法并允许动态部分的宏。

时间序列

控件后，可以选择时间序列可视化选项datetime字段类型。这个字段将被用作时间戳。您可以使用可视化选项选择时间序列可视化。Grafana将没有显式时区的时间戳行解释为UTC。任何列除了时间作为值列处理。

多行时间序列

要创建多行时间序列，查询必须返回至少3个字段，顺序如下:

• 字段1:datetime字段的别名为时间
• 字段2:group by的值
• 字段3+:度量值

例如:

SELECT log_time AS time, machine_group, avg(disk_free) AS avg_disk_free FROM mgbench。logs1 GROUP BY machine_group, log_time ORDER BY log_time

表

对于任何有效的ClickHouse查询，表可视化总是可用的。

使用日志面板可视化日志

要使用Logs面板，查询必须返回时间戳和字符串值。若要默认使用Explore模式中的日志可视化，请将时间戳别名设置为log_time．

例如:

SELECT log_time AS log_time, machine_group, toString(avg(disk_free)) AS avg_disk_free FROM logs1 GROUP BY machine_group, log_time ORDER BY log_time

宏

为了简化语法并允许动态部分(如日期范围过滤器)，查询可以包含宏。

下面是一个宏查询的例子，它将使用Grafana的时间过滤器:

SELECT date_time FROM test_data WHERE $__timeFilter(date_time)

该插件还支持使用大括号{}来表示符号。当需要在参数中进行查询时，使用此符号。

模板和变量

若要添加新的ClickHouse查询变量，请参见添加查询变量．

创建变量后，可以在ClickHouse查询中使用它变量的语法．有关变量的更多信息，请参见模板和变量．

为ClickHouse导入仪表板

遵循这些指令导入仪表板。

您还可以通过导航到数据源配置页面，选择ClickHouse数据源并单击dashboards选项卡来找到可用的预先制作的仪表板。

我们在插件中发布了以下仪表板。这些旨在帮助ClickHouse集群的支持分析，不依赖于外部数据集。查询用户需要访问系统数据库。

1. 集群分析-配置集群、合并、突变和数据复制的概述。
2. 数据分析——当前数据库和表的概述，包括它们各自的大小、分区和部分。
3. 查询分析——按类型、性能和资源消耗对查询进行分析。

Ad Hoc过滤器

Ad hoc过滤器只支持版本22.7+的ClickHouse。

特设过滤器允许您添加键/值过滤器，这些过滤器将自动添加到使用指定数据源的所有指标查询中，而无需显式地在查询中使用。

默认情况下，Ad Hoc过滤器将填充所有表和列。如果在Datasource设置中定义了默认数据库，则该数据库中的所有table将用于填充过滤器。由于这可能很慢/很昂贵，您可以引入第二个变量来限制Ad Hoc过滤器。它应该是常数类型命名clickhouse_adhoc_query并且可以包含:以逗号分隔的数据库列表、仅一个数据库或一个数据库。表组合，仅显示单个表的列。

有关Ad Hoc过滤器的详细信息，请查看Grafana文档

使用Ad Hoc过滤器的查询

第二个clickhouse_adhoc_query还允许任何有效的Clickhouse查询。查询结果将用于填充临时过滤器的可选过滤器。您可以选择从视图中隐藏此变量，因为它没有进一步的用途。

例如，如果clickhouse_adhoc_query设置为SELECT DISTINCT machine_name FROM mgbench.logs1您可以在仪表板中选择要过滤的机器名称。

了解更多

• 添加注释．
• 配置和使用模板和变量．
• 添加转换．
• 设置报警;指警报概述．