metrics

metrics 指令允许 NGINX Proxy-Wasm 模块在运行期间定义并记录指标。

语法metrics;
默认值none
上下文
参数none

说明

metrics 指令是 NGINX Proxy-Wasm 模块功能的重要组成部分,使其能够定义和处理用于监控嵌入在 NGINX 中的 WebAssembly 模块性能和行为的指标。它旨在帮助开发人员跟踪各种性能指标,例如与 WASM 模块执行相关的请求计数、延迟和错误率。通过记录指标,开发人员可以了解其应用的性能特征,并可能识别需要关注的瓶颈或问题。

该指令的功能是允许配置各种类型的指标,包括计数器和直方图。每个指标都可以定义为跟踪与 WebAssembly 模块执行相关的特定数据点。例如,计数器可以在 WASM 模块处理的每个传入请求时递增,而直方图可用于捕获这些请求的延迟分布。然后可以将这些信息导出到监控工具以进行分析和报告。

重要的是,指标可以通过 Proxy-Wasm 接口记录,使 NGINX 实例能够与外部监控系统通信。这种灵活性对于在使用微服务和无服务器函数的复杂架构中保持可观测性至关重要。该指令不带参数,这反映了其作为一种启动指标跟踪的直接目的,无需额外配置开销。

配置示例

wasm {
    module my_filter /path/to/filter.wasm;
    metrics;
}

确保metrics指令在配置中正确放置,以避免上下文错误。

如果 WASM 模块执行出现问题,或 metrics 子系统未正确初始化,指标可能无法被记录。

← 返回所有指令