UNPKG

1.77 kBTypeScriptView Raw
1import * as express from 'express';
2import * as prometheus from 'prom-client';
3import { TypedError } from 'typed-error';
4import { AuthTestFunc, CustomParams, LabelSet, MetricsMetaMap } from './types';
5export declare class MetricsGathererError extends TypedError {
6}
7interface Describer {
8 [kind: string]: (name: string, help: string, customParams?: CustomParams) => void;
9}
10export declare class MetricsGatherer {
11 internalErrorCount: number;
12 meta: MetricsMetaMap;
13 private metrics;
14 describe: Describer;
15 client: any;
16 constructor();
17 private initState;
18 private setupDescribe;
19 gauge(name: string, val: number, labels?: LabelSet): void;
20 inc(name: string, val?: number, labels?: LabelSet): void;
21 dec(name: string, val?: number, labels?: LabelSet): void;
22 counter(name: string, val?: number, labels?: LabelSet): void;
23 summary(name: string, val: number, labels?: LabelSet, customParams?: CustomParams): void;
24 histogram(name: string, val: number, labels?: LabelSet, customParams?: CustomParams): void;
25 histogramSummary(name: string, val: number, labels?: LabelSet): void;
26 checkMetricType(name: string, kinds: string[]): boolean | undefined;
27 getMetric<T extends string = string>(name: string): prometheus.Metric<T> | undefined;
28 exists(name: string): boolean;
29 private ensureExists;
30 reset(name?: string): void;
31 exportOn(port: number, path?: string, requestHandler?: express.Handler): void;
32 requestHandler(authTest?: AuthTestFunc): express.Handler;
33 aggregateRequestHandler(authTest?: AuthTestFunc): express.Handler;
34 collectDefaultMetrics(): void;
35 collectAPIMetrics(app: express.Application): express.Application;
36 output(): string;
37 clear(): void;
38 private err;
39}
40export {};