Link Search Menu Expand Document Documentation Menu

查询指标

2.16 版本引入

关键查询指标,例如聚合类型、查询类型、延迟和每种查询类型的资源使用情况,均通过 OpenTelemetry (OTel) 检测框架在搜索路径中捕获。遥测数据可以使用 OTel 指标导出器进行消费。

配置查询指标生成

要配置查询指标生成,请按照以下步骤操作。

步骤 1:安装查询洞察插件

有关安装查询洞察插件的信息,请参阅安装查询洞察插件

步骤 2:安装 OpenTelemetry 插件

有关安装 OpenTelemetry 插件的信息,请参阅分布式跟踪

步骤 3:启用查询指标

通过配置以下 opensearch.yml 设置启用查询指标

telemetry.feature.metrics.enabled: true
search.query.metrics.enabled: true

以下是包含遥测配置的完整示例配置

# Enable query metrics feature
search.query.metrics.enabled: true
telemetry.feature.metrics.enabled: true

# OTel-related configuration
opensearch.experimental.feature.telemetry.enabled: true
telemetry.tracer.sampler.probability: 1.0
telemetry.feature.tracer.enabled: true

或者,您可以使用 API 配置查询指标生成

PUT _cluster/settings
{
  "persistent" : {
    "search.query.metrics.enabled" : true
  }
}

使用 gRPC 导出器配置指标和跟踪的导出。有关更多信息,请参阅导出器。如果您使用默认日志导出器,则可以跳过此步骤。

telemetry.otel.tracer.span.exporter.class: io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter
telemetry.otel.metrics.exporter.class: io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter

指标

查询指标提供以下度量:

  • 每种查询类型的查询数量(例如,matchregex 查询的数量)
  • 每种聚合类型的查询数量(例如,terms 聚合查询的数量)
  • 每种排序顺序的查询数量(例如,升序和降序 sort 查询的数量)
  • 每种查询类型、聚合类型和排序顺序的 latency 直方图
  • 每种查询类型、聚合类型和排序顺序的 cpu 直方图
  • 每种查询类型、聚合类型和排序顺序的 memory 直方图

默认日志导出器

默认情况下,如果未配置 gRPC 导出器,则指标和跟踪将导出到日志文件。数据保存在 opensearch/logs 目录中的以下文件中

  • opensearch_otel_metrics.log
  • opensearch_otel_traces.log
剩余 350 字符

有问题?

想要贡献?