prometheus-remote-write

Send samples to prometheus via remote_write from NodeJS

0.1.5
Source
npm

Version published: 3 years ago

Maintainers: 1

Created: 3 years ago

Source

Push timeseries to Prometheus via remote_write

Using remote_write facility (see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) to send metrics to remote Prometheus from NodeJS app.

Pretty much anything from https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage should be supported, but tested only with grafana.com:

(List copied from https://github.com/prometheus/docs/blob/main/content/docs/operating/integrations.md)

Usage:

import { pushTimeseries, pushMetrics } from "prometheus-remote-write";

// Just push some metrics metrics
await pushMetrics(
  {
    queue_depth_total: 100,
  },
  {
    url: process.env.GRAFANA_PUSH_URL || "http://localhost:9201",
    labels: { service: "queue-worker" },
  }
);

// Full config - only url is required
const config = {
  // Remote url
  url: "http://localhost:9201",
  // Auth settings
  auth: {
    username: "...",
    password: "...",
  },
  // Optional prometheus protocol descripton .proto/.json
  proto: undefined,
  // Logging & debugging, disabled by default
  console: undefined,
  verbose: false,
  timing: false,
  // Override used node-fetch
  fetch: undefined,
  // Additional labels to apply to each timeseries, i.e. [{ service: "SQS" }]
  labels: undefined
};

// Follows remote_write payload format (see https://github.com/prometheus/prometheus/blob/main/prompb/types.proto)
await pushTimeseries(
  {
    labels: {
      __name__: "queue_depth_total",
      instance: "dev.example.com",
      service: "SQS",
    },
    samples: [
      {
        value: 150,
        timestamp: Date.now(),
      },
    ],
  },
  config
);

Keywords

FAQs

What is prometheus-remote-write?

Is prometheus-remote-write well maintained?

Package last updated on 12 Aug 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install