跳转至

关联视图配置说明

telemetry 用于配置实体详情页中的关联视图，例如日志、事件、链路和仪表板。每个配置项代表一个可展示的视图卡片。

基本结构

telemetry:
  - name: "错误日志"
    type: explorer
    viewName: logs
    query: "service='{{metadata.service}}'"

  - name: "指标"
    type: dashboard
    timerange: "30m"
    viewName: "服务概览"

说明：

  • name、viewName 如果需要国际化，可拆分为 zh-CN、en-US
  • 如果不需要国际化，直接写字符串即可

字段说明

name

详情页中展示的视图名称。

示例：

name: "错误日志"

type

关联视图类型，目前支持两类：

  • dashboard：仪表板
  • explorer：查看器

explorer 类型配置

explorer 用于关联日志、事件、链路、容器、Pod 等查看器。

viewName

查看器类型，当前支持：

  • logs：日志查看器
  • event：事件查看器
  • trace：链路查看器
  • container：容器查看器
  • pod：Pod 查看器

query

过滤条件，使用 DQL 查询语法。

支持通过变量引用当前实体属性：

{{metadata.field}}

例如：

query: "service='{{metadata.service}}'"

也可以写更复杂的条件：

query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

explorer 示例

- name: "错误日志"
  type: explorer
  viewName: logs
  query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

- name: "链路"
  type: explorer
  viewName: trace
  query: "service='{{metadata.service}}'"

- name: "事件"
  type: explorer
  viewName: event
  query: "service='{{metadata.service}}'"

dashboard 类型配置

dashboard 用于在详情页展示仪表板。

timerange

仪表板查询的时间范围，例如：

timerange: "30m"
timerange: "1h"
timerange: "24h"

keys

当满足某个实体条件时才显示该仪表板。

例如：

keys: { database_type: "MySQL" }

表示仅当当前实体的 database_type 为 MySQL 时显示该仪表板。

viewName

仪表板名称。

  • 必须填写内置视图中的 dashboard 名称
  • 名称需要与系统内置仪表板保持一致，否则无法正确打开

dashboard 示例

- name: "指标"
  type: dashboard
  timerange: "30m"
  viewName: "服务概览"

- name: "指标"
  type: dashboard
  keys: { database_type: "MySQL" }
  timerange: "1h"
  viewName: "基础设施 MySQL 监控视图"

- name: "指标"
  type: dashboard
  keys: { database_type: "Oracle" }
  timerange: "1h"
  viewName: "基础设施 Oracle 监控视图"

完整示例

telemetry:
  - name: "错误日志"
    type: explorer
    viewName: logs
    query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

  - name: "链路"
    type: explorer
    viewName: trace
    query: "service='{{metadata.service}}'"

  - name: "事件"
    type: explorer
    viewName: event
    query: "service='{{metadata.service}}'"

  - name: "指标"
    type: dashboard
    timerange: "30m"
    viewName: "服务概览"

  - name: "指标"
    type: dashboard
    keys: { database_type: "MySQL" }
    timerange: "1h"
    viewName: "基础设施 MySQL 监控视图"

  - name: "指标"
    type: dashboard
    keys: { database_type: "Oracle" }
    timerange: "1h"
    viewName: "基础设施 Oracle 监控视图"

配置建议

  • 需要国际化时，name 和 viewName 可使用 zh-CN、en-US
  • explorer.query 中引用的 {{metadata.field}} 必须是实体中真实存在的属性
  • dashboard.viewName 必须指向系统内置的 dashboard
  • keys 适合用于按实体属性值展示不同仪表板
  • 一个实体可配置多个关联视图，直接在 telemetry 下追加即可

文档评价

文档内容是否对您有帮助？ ×