prom-push v1.0.4

prom-push

A package for pushing metrics to Prometheus.

Installation

yarn add prom-push

Usage

To use prom-push in your project, import the pushMetrics function and call it with the appropriate arguments:

import pushMetrics from 'prom-push'

const serviceName = 'my-service'
const metrics = {
  requests: 100,
  errors: 2,
}
const metricType = 'Counter'
const pushMethod = 'pushAdd'

pushMetrics(serviceName, metrics, metricType, pushMethod)

The pushMetrics function takes four arguments:

• serviceName: A string representing the name of the service.
• metrics: An object containing the metric names and values. The keys of the object should be the metric names, and the values should be the corresponding metric values.
• metricType: A string representing the type of metric, such as 'Counter' or 'Gauge'.
• pushMethod: A string specifying the method to use for pushing the metrics, either 'push' or 'pushAdd'.

The function pushes the metrics to the Prometheus Pushgateway and logs any errors that occur during the push operation.

Example

Here's an example of how to use prom-push to pushmetrics for a web server:

import http from 'http'
import pushMetrics from 'prom-push'

const server = http.createServer((req, res) => {
  // handle HTTP requests
  const serviceName = 'web-server'
  const metrics = {
    requests: 1,
    duration: 100,
  }
  const metricType = 'Counter'
  const pushMethod = 'pushAdd'

  pushMetrics(serviceName, metrics, metricType, pushMethod)

  res.end('Hello, world!')
})

server.listen(3000, () => {
  console.log('Server listening on port 3000')
})

In this example, the pushMetrics function is called with the appropriate arguments inside the request handler of an HTTP server. The metrics being pushed are a Counter for the number of requests and a Counter for the request duration. The metrics are pushed using the pushAdd method, which adds the metrics to the existing metrics for the specified job and labels.