QuestDB

概述
安装
更新日志
相关内容

Grafana 的 QuestDB 数据源

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

安装

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

阅读 QuestDB 网站上的指南：第三方工具 - Grafana。

配置

用于数据源的 QuestDB 用户

设置一个具有只读权限的 QuestDB 用户账号，并授予对您要查询的数据库和表的访问权限。请注意，Grafana 不会验证查询是否安全。查询可以包含任何 SQL 语句。例如，诸如 UPDATE users SET name='blahblah' 和 DROP TABLE importantTable; 之类的语句都将被执行。

配置只读用户，请按照以下步骤操作：

开源版本
1. 在 server.conf 文件中设置以下属性：
  - pg.readonly.user.enabled=true
  - pg.readonly.user=myuser
  - pg.readonly.password=secret
2. 重启 QuestDB 实例。
企业版
1. 创建用户
  - CREATE USER grafana_readonly;
2. 授予对选定表/表列的读取权限；
  - GRANT SELECT ON table1, ... TO grafana_readonly;

手动配置

在您的 Grafana 实例上安装插件后，按照这些说明添加新的 QuestDB 数据源，并输入配置选项。

通过配置文件

可以使用 Grafana 的 Provisioning 系统通过配置文件配置数据源。要了解其工作原理，包括可以为此数据源设置的所有设置，请参阅Provisioning Grafana 数据源。

请注意，插件必须事先安装。如果您使用 Docker 并希望自动化安装，可以设置GF_INSTALL_PLUGINS 环境变量

docker run -p 3000:3000 -e GF_INSTALL_PLUGINS=questdb-questdb-datasource grafana/grafana-oss

这是使用 QuestDB 开源版默认配置的此数据源的示例 Provisioning 文件。

apiVersion: 1
datasources:
  - name: QuestDB
    type: questdb-questdb-datasource
    jsonData:
      server: localhost
      port: 8812
      username: admin
      tlsMode: disable
      # timeout: <seconds>
      # queryTimeout: <seconds>
      maxOpenConnections: 100
      maxIdleConnections: 100
      maxConnectionLifetime: 14400
    secureJsonData:
      password: quest
      # tlsCACert: <string>

如果您使用的是 QuestDB 企业版并已启用 TLS，则需要将上面示例中的 tlsMode: require 修改为其他值。

构建查询

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

时间序列

将 timestamp 字段类型添加到查询后，可以选择时间序列可视化选项。此字段将用作时间戳。您可以使用可视化选项选择时间序列可视化。Grafana 将没有明确时区的时间戳行解释为 UTC。除了 time 以外的任何列都被视为值列。

多线时间序列

要创建多线时间序列，查询必须按照以下顺序返回至少 3 个字段：

字段 1：别名为 time 的 timestamp 字段
字段 2：用于分组的值
字段 3+：指标值

例如：

SELECT pickup_datetime AS time, cab_type, avg(fare_amount) AS avg_fare_amount
FROM trips
GROUP BY cab_type, pickup_datetime
ORDER BY pickup_datetime

表格

对于任何有效的 QuestDB 查询，表格可视化始终可用。

宏

为了简化语法和支持动态部分（如日期范围过滤器），查询可以包含宏。

这是一个包含宏的查询示例，该宏将使用 Grafana 的时间过滤器：

SELECT desginated_timestamp, data_stuff
FROM test_data
WHERE $__timeFilter(desginated_timestamp)

宏	描述	输出示例
$__timeFilter(columnName)	根据面板的时间范围（以秒为单位），使用提供的列进行数据过滤的条件表达式替代	`timestamp >= cast(1706263425598000 as timestamp) AND timestamp <= cast(1706285057560000 as timestamp)`
$__fromTime	用转换成时间戳的面板时间范围的起始时间替代	`cast(1706263425598000 as timestamp)`
$__toTime	用转换成时间戳的面板时间范围的结束时间替代	`cast(1706285057560000 as timestamp)`
$__sampleByInterval	用间隔值后跟单位（d, h, s 或 T（毫秒））替代。示例：1d, 5h, 20s, 1T。	`20s` (20 秒) , `1T` (1 毫秒)
$__conditionalAll(condition, $templateVar)	当第二个参数中的模板变量未选择所有值时，用第一个参数替代。当模板变量选择所有值时，用 1=1 替代。	`condition` 或 `1=1`

插件还支持使用大括号 {} 的记法。当参数内部需要查询时，使用此记法。

此外，Grafana 具有内置的 $__interval 宏，用于计算以秒或毫秒为单位的间隔。由于时间单位不兼容（1ms 与 QuestDB 期望的 1T），不应将其与 SAMPLE BY 一起使用。请改用 $__sampleByInterval。

模板和变量

要添加新的 QuestDB 查询变量，请参阅添加查询变量。

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

即席过滤器

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

默认情况下，即席过滤器将填充所有表和列。如果您在数据源设置中定义了默认数据库，则将使用该数据库中的所有表来填充过滤器。由于这可能会很慢/昂贵，您可以引入第二个变量来限制即席过滤器。它应该是一个名为 questdb_adhoc_query 的 constant 类型变量，可以包含：一个逗号分隔的表列表，仅显示一个或多个表的列。

有关即席过滤器的更多信息，请查看Grafana 文档