prometheus-api-metrics/src/index.d.ts

API and process monitoring with Prometheus for Node.js micro-service

import { Request, RequestHandler, Response } from 'express';
import { Context, Middleware } from 'koa';

export default function middleware(options?: ApiMetricsOpts) : RequestHandler;
export function koaMiddleware(options?: ApiMetricsOpts) : Middleware;
export function expressMiddleware(options?: ApiMetricsOpts) : RequestHandler;
export class HttpMetricsCollector {
  constructor(options?: CollectorOpts)
  static init(options?: CollectorOpts): void
  static collect(res: Response | any): void
}

export interface ApiMetricsOpts {
  metricsPath?: string;
  defaultMetricsInterval?: number;
  durationBuckets?: number[];
  requestSizeBuckets?: number[];
  responseSizeBuckets?: number[];
  useUniqueHistogramName?: boolean;
  metricsPrefix?: string;
  excludeRoutes?:string[];
  includeQueryParams?: boolean;
  additionalLabels?: string[];
  extractAdditionalLabelValuesFn?: ((req: Request, res: Response) => Record<string, unknown>) | ((ctx: Context) => Record<string, unknown>)
}

export interface CollectorOpts {
  durationBuckets?: number[];
  countClientErrors?: boolean;
  useUniqueHistogramName?: boolean
  prefix?: string;
}