Node.js: 有没有办法模拟 prometheus pushgateway 服务器？

Question

我正在使用 node.js 包 prom-client 尝试将不同的自定义指标推送到 Prometheus Pushgateway 服务器。

代码正在运行，现在我正在编写该功能的测试代码。我想知道是否有办法模拟 Prometheus Pushgateway 服务器？

我曾尝试使用普通的 express API 服务器（如下所示）

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

let data = null;

// ROUTES FOR OUR API
// =============================================================================
const router = express.Router();

app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());

router.get('/', (req, res) => {
  console.log("pushgateway server: get to '/' received");
  res.json(data);
});

router.post('/', (req, res) => {
  console.log("pushgateway server: post to '/' received");
  console.log(req.body);
  data = req.body;
  res.send('POST request to the homepage');
})

app.use(router);

// API JSON BASED ERRORS
// =============================================================================
app.use((err, req, res, next) => {
  if (req.xhr) {
    console.error(err);
    res.status(500).send({ err: 'Something failed!' });
  } else {
    next(err);
  }
});
app.use((err, req, res, next) => { // eslint-disable-line
  console.error(err);
  res.status(500).send({ err: err.message });
});

// START THE SERVER
// =============================================================================
const port = 9876;
const server = app.listen(port, '0.0.0.0');
console.log(`Prometheus Pushgateway Mock Server is listening on port ${port}`);

// SHUTDOWN HANDLING
// =============================================================================

// Nodemon Signal Handling
process.once('SIGUSR2', () => {
  console.log('Received kill signal, attempting gracefully close');
  server.close(() => {
    console.log('Closed out remaining connections');
    process.kill(process.pid, 'SIGUSR2');
  });
  setTimeout(() => {
    console.error('Timeout, forcefully shutting down');
    process.kill(process.pid, 'SIGUSR2');
  }, 3000);
});

module.exports = server;

但它不起作用——当我在我的测试代码上调用 gateway.pushAdd() 时，服务器没有收到任何 post 消息。

任何人都可以给我一些关于如何执行此操作的提示（模拟 prometheus pushgateway 服务器）吗？

Answer 1

所以我通过创建一个简单的 http 服务器解决了这个问题。

服务器代码如下：

const http = require('http');

const body = [];
let text = null;
let path = null;

function createServer(port) {
  return http.createServer()
    .on('request', (req, res) => {
      if (req.method === 'POST' || req.method === 'PUT') {
        path = req.url;
        req.on('data', (chunk) => {
          body.push(chunk);
        }).on('end', () => {
          text = Buffer.concat(body).toString();
          res.end(`${req.method} success`);
        }).on('error', (err) => {
          console.error(err);
        });
      } else if (req.method === 'GET') {
        res.end(JSON.stringify({ path, text }));
      } else if (req.method === 'DELETE') {
        path = null;
        text = null;
        res.end('DELETE success');
      }
    }).on('error', (err) => {
      console.log(`Server error: ${err}`);
    })
    .listen(port, '0.0.0.0');
}

module.exports = (createServer);

服务器接受POST/PUT/DELETE/GET个请求，处理网关的pushAdd()/push()/delete()函数来处理metric数据，以及检查mocked pushgateway上的推送数据.

同时将request.url和推送到服务器的文本数据保存起来，传递给测试程序进行校验。

以下是其中一个测试用例（使用Mocha+Chai）：

describe('Check adding custom push count metric', () => {
  it('Check connection: should return - network status: 200, result contains custom count metric string', async () => {
    metricInstance = promMetric.createCustomPushMetric({
      name: 'test_counter',
      help: 'Used to test the pushgateway for custom counter metrics',
      type: 'counter',
      jobName: 'custom-metric-pushgateway-counter',
      groupings: { key: 'test', type: 'customMetric' },
    });
    await promMetric.addPushMetric(metricInstance, 0.879);
    await sleep(500);
    const result = await chai.request(mockPgwServer).get('/');
    expect(result).to.have.status(200);
    const json = JSON.parse(result.text);
    expect(json.path).to.equal('/metrics/job/custom-metric-pushgateway-counter/key/test/type/customMetric');
    expect(json.text).to.match(/# HELP Push_gateway_test_test_counter Used to test the pushgateway for custom counter metrics/);
    expect(json.text).to.match(/# TYPE Push_gateway_test_test_counter counter/);
    expect(json.text).to.match(/Push_gateway_test_test_counter 0.879/);
  });
});

从客户端发布指标时存储在服务器中的“路径”和“文本”在查询和验证时发送回客户端。

Answer 2

有不同的选项可以模拟第三方 HTTP 服务器。这里有 3 个：

免责声明：我是固执背后的维护者

诺克和戴森是最受欢迎的，它们各有利弊。 Stubborn 较新，试图涵盖 Nock 和 Dyson 的一些局限性。

您可以查看我写的这篇 reddit post first comment 比较 3 种解决方案的文章。

Node.js: 有没有办法模拟 prometheus pushgateway 服务器？

Node.js: Is there a way to mock the prometheus pushgateway server?

node.js

prometheus

prometheus-pushgateway

prom-client