监视

Voice Gateway 监视功能提供 REST API 来显示度量以供管理员访问。

• 格式
• REST 端点
• 连接到数据存储器和监视工具
• Prometheus 格式详细信息
• JSON 格式详细信息
• 度量
• 配置

格式

度量端点提供两种输出格式。用于每个响应的格式取决于对应请求的 HTTP accept 头。

• Prometheus 文本格式 - 与 Prometheus 监视工具兼容的度量的表示法。针对具有 text/plain accept 头的请求会返回此格式。
• JSON 格式 - 度量的 JSON 表示法。针对具有 application/json accept 头的请求会返回此格式。

REST 端点

下表说明可访问以提供度量的监视端点。

连接到数据存储器和监视工具

您可以将 Voice Gateway 度量连接到可分析和监视度量信息的工具和堆栈。 缺省情况下， /metrics/application 端点返回与 Prometheus 兼容的格式的数据。要将 Voice Gateway 服务器连接到 Prometheus，请将 Prometheus 配置为使用 http://host:http_port/metrics/application 或 https://host:https_port/metrics/application 端点。 JSON 格式可由其他理解 JSON 的度量收集工具使用。

Prometheus 格式详细信息

Prometheus 文本格式基于 Prometheus 文档中描述的 0.0.4 阐释格式。在可用的情况下，将为每个度量提供元数据。# Help 行包含度量的描述。元数据中存在的任何标记都以 Prometheus 标签的形式提供。对于标尺和直方图，会在度量名称的末尾附加度量单位。

标尺由单个值表示。以下示例显示将如何为 123456789 租户显示名为 vg_MaxConversationLatency 的以毫秒为单位的标尺：

# TYPE application:vg_max_conversation_latency{tenant_id="123456789"}_seconds gauge
# HELP application:vg_max_conversation_latency{tenant_id="123456789"}_seconds Maximum conversation latency per monitoring interval
application:vg_max_conversation_latency{tenant_id="123456789"}_seconds 7.049

以下示例说明 vg_MaxCalls 标尺的所生成文本格式。

# TYPE application:vg_max_calls_per_second gauge
# HELP application:vg_max_calls_per_second Maximum calls per second per monitoring interval
application:vg_max_calls_per_second 1

JSON 格式详细信息

JSON 格式返回以树形结构格式化的数据。每个度量通过名称和值进行引用。

{
  "vg_MaxTTSLatency{tenantID=\"123456789\"}": 528,
  "vg_MaxConversationLatency{tenantID=\"123456789\"}": 7049,
  "vg_MaxSTTLatency{tenantID=\"123456789\"}": 0,
  "vg_MaxCalls": 1,
  "vg_MaxConcurrentCalls{tenantID=\"123456789\"}": 1
}

度量

特定于租户的度量

配置

使用以下环境变量可配置监视功能。