Skip to main content

@nest-boot/metrics

Classes​

MetricsModule​

Defined in: packages/metrics/src/metrics.module.ts:23

Extends​

  • ConfigurableModuleClass

Indexable​

[key: string]: any

Constructors​

Constructor​
new MetricsModule(): MetricsModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns​

MetricsModule

Inherited from​
ConfigurableModuleClass.constructor

Properties​

register()​
static register: (options) => DynamicModule;
Parameters​
ParameterType
optionsMetricsModuleOptions<RegistryContentType> & Partial<{ isGlobal: boolean; }>
Returns​

DynamicModule

Inherited from​
ConfigurableModuleClass.register
registerAsync()​
static registerAsync: (options) => DynamicModule;
Parameters​
ParameterType
optionsConfigurableModuleAsyncOptions<MetricsModuleOptions<RegistryContentType>, "create"> & Partial<{ isGlobal: boolean; }>
Returns​

DynamicModule

Inherited from​
ConfigurableModuleClass.registerAsync

Registry​

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:24

Container for all registered metrics

Type Parameters​

Type Parameter
BoundRegistryContentType extends RegistryContentType

Constructors​

Constructor​
new Registry<BoundRegistryContentType>(): Registry<BoundRegistryContentType>;
Returns​

Registry<BoundRegistryContentType>

Properties​

contentType​
readonly contentType: BoundRegistryContentType;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:86

Gets the Content-Type of the metrics for use in the response headers.

OPENMETRICS_CONTENT_TYPE​
static OPENMETRICS_CONTENT_TYPE: "application/openmetrics-text; version=1.0.0; charset=utf-8";

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:109

HTTP OpenMetrics Content-Type for metrics response headers.

PROMETHEUS_CONTENT_TYPE​
static PROMETHEUS_CONTENT_TYPE: "text/plain; version=0.0.4; charset=utf-8";

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:104

HTTP Prometheus Content-Type for metrics response headers.

Methods​

clear()​
clear(): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:35

Remove all metrics from the registry

Returns​

void

getMetricsAsArray()​
getMetricsAsArray(): MetricObject[];

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:56

Get all metrics as objects

Returns​

MetricObject[]

getMetricsAsJSON()​
getMetricsAsJSON(): Promise<MetricObjectWithValues<MetricValue<string>>[]>;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:51

Get all metrics as objects

Returns​

Promise<MetricObjectWithValues<MetricValue<string>>[]>

getSingleMetric()​
getSingleMetric<T>(name): Metric<T> | undefined;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:68

Get a single metric

Type Parameters​
Type Parameter
T extends string
Parameters​
ParameterTypeDescription
namestringThe name of the metric
Returns​

Metric<T> | undefined

getSingleMetricAsString()​
getSingleMetricAsString(name): Promise<string>;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:81

Get a string representation of a single metric by name

Parameters​
ParameterTypeDescription
namestringThe name of the metric
Returns​

Promise<string>

metrics()​
metrics(): Promise<string>;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:30

Get string representation for all metrics

Returns​

Promise<string>

registerMetric()​
registerMetric<T>(metric): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:46

Register metric to register

Type Parameters​
Type Parameter
T extends string
Parameters​
ParameterTypeDescription
metricMetric<T>Metric to add to register
Returns​

void

removeSingleMetric()​
removeSingleMetric(name): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:62

Remove a single metric

Parameters​
ParameterTypeDescription
namestringThe name of the metric to remove
Returns​

void

resetMetrics()​
resetMetrics(): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:40

Reset all metrics in the registry

Returns​

void

setContentType()​
setContentType(contentType): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:93

Set the content type of a registry. Used to change between Prometheus and OpenMetrics versions.

Parameters​
ParameterTypeDescription
contentTypeBoundRegistryContentTypeThe type of the registry
Returns​

void

setDefaultLabels()​
setDefaultLabels(labels): void;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:75

Set static labels to every metric emitted by this registry

Parameters​
ParameterTypeDescription
labelsobjectof name/value pairs: { defaultLabel: "value", anotherLabel: "value 2" }
Returns​

void

merge()​
static merge(registers): Registry;

Defined in: node_modules/.pnpm/prom-client@15.1.3/node_modules/prom-client/index.d.ts:99

Merge registers

Parameters​
ParameterTypeDescription
registersRegistry<"text/plain; version=0.0.4; charset=utf-8">[]The registers you want to merge together
Returns​

Registry

Type Aliases​

MetricsModuleOptions​

type MetricsModuleOptions<T> = Omit<DefaultMetricsCollectorConfiguration<T>, "register">;

Defined in: packages/metrics/src/metrics-module-options.interface.ts:6

Type Parameters​

Type Parameter
T extends RegistryContentType