Prometheus标签值允许字符疑问：Node.js Exporter用户输入处理

你的理解偏差 #

Prometheus文档提到“标签值可包含任意Unicode字符”是没错的，但这指的是逻辑层面允许的字符范围，而非输出到文本格式时可以直接原样输出。Exporter返回的是Prometheus文本格式，该格式有严格的语法规则，标签值中的特殊字符必须经过转义才能合法输出。

需要转义的字符 #

除了你遇到的双引号（"），还有两个必须处理的字符：

• 反斜杠（\）：需转义为\\
• 换行符（\n）：需转义为\n

不处理这些字符的话，Prometheus抓取器会因无法正确识别标签值边界而解析失败。

最优处理方案 #

方案1：手动实现转义函数 #

可以写一个简单的转义函数，处理特殊字符后再插入模板字符串：

function escapeLabelValue(value) {
  return String(value)
    .replace(/\\/g, '\\\\')
    .replace(/"/g, '\\"')
    .replace(/\n/g, '\\n');
}

const bar = `value"`; // 外部用户输入
const escapedBar = escapeLabelValue(bar);

let payload = "";
payload += "# HELP my_great_metric Awesome description\n";
payload += "# TYPE my_great_metric gauge\n";
payload += `my_great_metric{foo="${escapedBar}"} 0\n`;

方案2：使用成熟的Prometheus客户端库 #

不建议手动拼接Prometheus文本格式，容易遗漏转义规则或出现格式错误。推荐使用prom-client这类客户端库，它会自动处理标签值转义、指标类型管理等细节：

const promClient = require('prom-client');

// 初始化指标
const myGreatMetric = new promClient.Gauge({
  name: 'my_great_metric',
  help: 'Awesome description',
  labelNames: ['foo']
});

// 设置指标值（自动处理标签值转义）
const bar = `value"`; // 外部用户输入
myGreatMetric.set({ foo: bar }, 0);

// 导出指标（直接返回给Prometheus抓取）
async function getMetrics() {
  return await promClient.register.metrics();
}

这种方式既避免了手动处理转义的麻烦，也能保证输出格式完全符合Prometheus的要求。

内容的提问来源于stack exchange，提问作者dinamica