Nodejs 中的 Prometheus 客户端 - 设置标签值

Question

我正在 prom-client 中使用普罗米修斯。我像这样初始化直方图，现在一旦请求被处理，我想设置处理它所花费的时间（我从节点请求对象中获取它）并设置标签值。

const southboundMetricsHistogram = prometheusClient.register.getSingleMetric(consts.PROMETHEUS_SOUTHBOUND_METRICS_NAME) ||
    new prometheusClient.Histogram({
        name: consts.PROMETHEUS_SOUTHBOUND_METRICS_NAME,
        help: consts.PROMETHEUS_SOUTHBOUND_METRICS_DESC,
        labelNames: ['target', 'route', 'status_code', 'method'],
        buckets: consts.PROMETHEUS_SOUTHBOUND_DURATION_SIZES_BUCKETS
    });

我尝试使用 observe 或 labels，但出现错误。是否可以设置经过的时间和标签值？

谢谢。

Answer 1

看起来 node.js 客户端库中的直方图有一个内置的 startTimer() 函数就是为了这个目的。

在 Github 的示例部分下，给出了这个示例：

const end = histogram.startTimer();
xhrRequest(function(err, res) {
end(); // Observes the value to xhrRequests duration in seconds
});

所以你可以在发出请求时启动计时器，然后在发送响应时停止它。

Source

Answer 2

这样解决：

southboundMetricsHistogram.observe({target: request.target, method: request.method, route: response.req.path, status_code: response.statusCode}, response.elapsedTime);

Answer 3

这是一个完整的例子

    import express from 'express';
    import pino from 'pino';
    import expressPino from 'express-pino-logger';
    import promClient from 'prom-client';
    
    const PORT = process.env.PORT || 5555;
    
    const logger = pino({level:process.env.LOG_LEVEL || 'info'})
    const expressLogger = expressPino({logger});
    
    const app = express();
    app.use(express.json(), expressLogger);
    
    // Create a Registry which registers the metrics
    const register = new promClient.Registry()
    promClient.collectDefaultMetrics({ register });
    
    const Histogram = promClient.Histogram;
    const requestDuration = new Histogram({
        name: 'http_request_duration_seconds',
        help: 'request duration histogram',
        labelNames: ['handler' , 'method', 'statuscode'],
        //buckets: [0.5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000],
        buckets: [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10],
    });
    
    // Register the histogram
    register.registerMetric(requestDuration)
    
    const profilerMiddleware = (req, res, next) => {
        //const start = Date.now();
        const end = requestDuration.startTimer()
        res.once('finish', () => {
        //const duration = Date.now() - start;
        //requestDuration.labels(req.url, req.method, res.statusCode).observe(duration);
        //requestDuration.observe({ handler:req.url, method: req.method, statuscode: res.statusCode }, duration);
        const duration = end({ handler:req.url, method: req.method, statuscode: res.statusCode });
        logger.info('Duration  %d', duration);
        });
    
    next();
    };
    app.use(profilerMiddleware);
    
    
    app.get('/health', (req, res) => {
        logger.debug('Calling res.send');    
        return res.status(200).send({message: "Health is good"});
    });
    
    app.listen(PORT, () => {
        logger.info('App is listening for requests on port %d', PORT);
    });
    
    // Setup server to Prometheus scrapes:
    app.get('/metrics', async (req, res) => {
        try {
            res.set('Content-Type', register.contentType);
            res.end(await register.metrics());
        } catch (ex) {
            res.status(500).end(ex);
        }
    });

Nodejs 中的 Prometheus 客户端 - 设置标签值

Prometheus client in Nodejs - setting label values

node.js

prometheus