YDB

概览
安装
更改日志
相关内容

用于 Grafana 的 YDB 数据源

版本兼容性

插件需要 Grafana v9.2 及更高版本。

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

安装

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

配置

数据源的 YDB 用户

设置一个具有只读权限的 YDB 用户帐户 (更多关于权限的信息) 以及您要查询的数据库和表的访问权限。请注意，Grafana 不会验证查询是否安全。查询可以包含任何 SQL 语句，包括修改指令。

数据传输协议支持

该插件支持 GRPCS 和 GRPC 传输协议。请注意，使用 grpcs 时需要提供 TLS/SSL 证书。

手动配置

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

使用配置文件

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

插件支持不同的身份验证类型身份验证类型。

以下是用用户/密码配置此数据源的示例

apiVersion: 1
datasources:
  - name: YDB
    type: ydbtech-ydb-datasource
    jsonData:
      authKind: "UserPassword",
      endpoint: 'grpcs://endpoint',
      dbLocation: 'location',
      user: 'username',
    secureJsonData:
      password: 'userpassword',
      certificate: 'certificate',

以下是连接配置中支持的字段

    jsonData:
      authKind: "Anonymous" | "ServiceAccountKey" | "AccessToken" | "UserPassword" | "MetaData";
      endpoint: string;
      dbLocation: string;
      user?: string;
    secureJsonData:
      serviceAccAuthAccessKey?: string;
      accessToken?: string;
      password?: string;
      certificate?: string;

构建查询

YQL 方言用于查询 YDB。查询可以包含简化语法并允许动态部分的宏。查询编辑器允许您以不同的表示形式获取数据：时间序列、表格或日志。

时间序列

在向查询添加一个具有 Date、Datetime 或 Timestamp 类型的字段和至少一个具有 number 类型的字段后，可以选择时间序列可视化选项。Grafana 将没有显式时区的 timestamp 行解释为 UTC。任何其他列都被视为值列。

多行时间序列

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

字段 1：时间字段
字段 2：要分组的值
字段 3+：度量值

例如

SELECT `timestamp`, `requestTime`, AVG(`responseStatus`) AS `avgRespStatus`
FROM `/database/endpoint/my-logs`
GROUP BY `requestTime`, `timestamp`
ORDER BY `timestamp`

表格

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

使用日志面板可视化日志

要使用日志面板，您的查询必须返回时间和字符串值。您可以使用可视化选项选择日志可视化。

默认情况下，只有第一个文本字段将表示为日志行，但这可以通过查询构建器进行自定义。

宏

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

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

SELECT `timeCol`
FROM `/database/endpoint/my-logs`
WHERE $__timeFilter(`timeCol`)

宏	描述	输出示例
$__timeFilter(columnName)	替换为一个条件语句，根据面板的时间范围（以微秒为单位）使用提供的列过滤数据	`foo >= CAST(1636717526371000 AS TIMESTAMP) AND foo <= CAST(1668253526371000 AS TIMESTAMP)' )`
$__fromTimestamp	替换为面板时间范围的开始时间，并转换为 Timestamp 类型	`CAST(1636717526371000 AS TIMESTAMP)`
$__toTimestamp	替换为面板时间范围的结束时间，并转换为 Timestamp 类型	`CAST(1636717526371000 AS TIMESTAMP)`
$__varFallback(condition, $templateVar)	当第二个参数中的模板变量未提供时，替换为第一个参数。	`condition` 或 `templateVarValue`