Skip to content

@ralphschuler.prom metrics decorator

github-actions edited this page Nov 26, 2023 · 14 revisions

Module: @ralphschuler/prom-metrics-decorator

Table of contents

Modules

Enumerations

Interfaces

Type Aliases

Functions

Type Aliases

MetricConfigurations

Ƭ MetricConfigurations: CounterConfiguration<any> | GaugeConfiguration<any> | HistogramConfiguration<any> | SummaryConfiguration<any>

Defined in

packages/prom-metrics-decorator/src/index.ts:21


MetricTypes

Ƭ MetricTypes: Counter | Gauge | Histogram | Summary<any>

Defined in

packages/prom-metrics-decorator/src/index.ts:20

Functions

PromCounter

PromCounter(config): (target: Object | Function, propertyKey?: string | symbol, descriptor?: PropertyDescriptor) => void

Parameters

Name Type
config IMetricConfig<CounterConfiguration<any>>

Returns

fn

▸ (target, propertyKey?, descriptor?): void

Parameters
Name Type
target Object | Function
propertyKey? string | symbol
descriptor? PropertyDescriptor
Returns

void

Defined in

packages/prom-metrics-decorator/src/index.ts:61


PromGauge

PromGauge(config): (target: Object | Function, propertyKey?: string | symbol, descriptor?: PropertyDescriptor) => void

Parameters

Name Type
config IMetricConfig<GaugeConfiguration<any>>

Returns

fn

▸ (target, propertyKey?, descriptor?): void

Parameters
Name Type
target Object | Function
propertyKey? string | symbol
descriptor? PropertyDescriptor
Returns

void

Defined in

packages/prom-metrics-decorator/src/index.ts:61


PromHistogram

PromHistogram(config): (target: Object | Function, propertyKey?: string | symbol, descriptor?: PropertyDescriptor) => void

Parameters

Name Type
config IMetricConfig<HistogramConfiguration<any>>

Returns

fn

▸ (target, propertyKey?, descriptor?): void

Parameters
Name Type
target Object | Function
propertyKey? string | symbol
descriptor? PropertyDescriptor
Returns

void

Defined in

packages/prom-metrics-decorator/src/index.ts:61


PromSummary

PromSummary(config): (target: Object | Function, propertyKey?: string | symbol, descriptor?: PropertyDescriptor) => void

Parameters

Name Type
config IMetricConfig<SummaryConfiguration<any>>

Returns

fn

▸ (target, propertyKey?, descriptor?): void

Parameters
Name Type
target Object | Function
propertyKey? string | symbol
descriptor? PropertyDescriptor
Returns

void

Defined in

packages/prom-metrics-decorator/src/index.ts:61

Typescript Libraries

Modules

Namespaces

Clone this wiki locally