max_metric_name_length

指令 `max_metric_name_length` 设置 NGINX WebAssembly 模块中指标名称的最大允许长度。

语法max_metric_name_length integer;
默认值none
上下文
参数1

说明

max_metric_name_length 指令在 NGINX WebAssembly 模块中定义指标时非常重要,因为它指定了指标名称的字符数上限。这个约束有助于确保指标格式良好,并符合与 WebAssembly 运行时交互的底层 APIs 所期望的规范。该指令的参数是一个整数值,表示指标名称的最大长度。如果正确定义,它可以防止过长的名称在指标注册或数据收集过程中导致错误。

在注册指标时,提供的名称会与此长度限制进行比较,以判断名称是否合法或是否应因长度超限而触发错误。此功能通过强制执行适合日志记录和监控用途的通用命名约定,从而符合性能和可维护性的最佳实践。此外,指标长度配置不当可能导致配置错误或运行时异常,因此在使用 Proxy-Wasm 模块的环境中正确使用该指令有助于维持顺畅运行。

配置示例

wasm {
    max_metric_name_length 256;
    module my_metrics /path/to/metrics_module.wasm;
}

使用超过定义长度的指标名称将导致注册错误。

确保所有指标名称都遵守指定长度,以避免在指标收集期间出现运行时错误。

← 返回所有指令