prometheus-remote-write/types.d.ts

Send samples to prometheus via remote_write from NodeJS

/// <reference types="node" />

interface Sample {
  value: number;
  timestamp?: number;
}

interface Timeseries {
  // Labels for every sample
  labels: {
    // Key for sample, should end with _totals, etc, see https://prometheus.io/docs/practices/naming/
    __name__: string;
    // Optional properties, i.e. instance, job, service
    [key: string]: string;
  };
  // List of samples, timestamp is optional, will be set by pushTimeseries
  samples: Sample[];
}

type MinimalFetch = (
  url: string,
  init?: {
    method: string;
    headers: { [key: string]: string };
    timeout?: number;
    body: ArrayBufferLike;
  }
) => Promise<{ status: number; statusText: string; text: () => Promise<string> }>;

interface Options {
  url?: string;
  auth?: {
    username?: string;
    password?: string;
  };
  verbose?: boolean;
  timing?: boolean;
  proto?: string;
  labels?: { [key: string]: string };
  timeout?: number;
  console?: Console;
  fetch?: MinimalFetch;
  headers?: { [key: string]: string };
}

interface Result {
  // Status 200 OK
  status: number;
  statusText: string;
  errorMessage?: string;
}

/** Push timeseries entries to Prometheus */
export function pushTimeseries(timeseries: Timeseries | Timeseries[], options?: Options): Promise<Result>;

/** Push simpler key:value metrics to Prometheus, additional labels can be provided via options */
export function pushMetrics(metrics: Record<string, number>, options?: Options): Promise<Result>;

/** Deserialize a protobuf buffer to a timeseries object */
export function deserialize(buffer: ArrayBufferLike, options?: Options): Promise<Timeseries>;

/** Serialize a timeseries object to a protobuf buffer */
export function serialize(timeseries: Timeseries, options?: Options): Promise<ArrayBufferLike>;