Class PrometheusComposedMetricsCollectorManager

Creates ComposedMetricCollectors for Prometheus and exposes the metrics on a Prometheus scrapable endpoint.

Hierarchy

PrometheusComposedMetricsCollectorManager

Implements

ComposedMetricCollectorFactory

Index

Constructors

Accessors

Methods

createCollector start stop

Constructors

constructor

new PrometheusComposedMetricsCollectorManager(): PrometheusComposedMetricsCollectorManager
Returns PrometheusComposedMetricsCollectorManager

Accessors

isActive

get isActive(): boolean
Returns boolean
- Defined in libs/prometheus/src/lib/composed-metrics/public/prometheus-composed-metrics-collector-manager.ts:130

Methods

createCollector

createCollector<M, V>(metricType, params): ComposedMetricCollector<V>
Creates a ComposedMetricCollector for the specified ComposedMetricType and target params combination.
Type Parameters
- M extends ComposedMetricType<V, ComposedMetricParams>
- V
Parameters
- metricType: M
  
  The ComposedMetricType that should be collected.
- params: ComposedMetricParams
  
  The ComposedMetricParams that specify for which SloTarget the metric should be collected.
Returns ComposedMetricCollector<V>
A new ComposedMetricCollector instance.
Implementation of ComposedMetricCollectorFactory.createCollector
- Defined in libs/prometheus/src/lib/composed-metrics/public/prometheus-composed-metrics-collector-manager.ts:170

start

start(config): void
Starts the manager and the scrape endpoint.
Parameters
- config: PrometheusCollectorManagerConfig
Returns void
- Defined in libs/prometheus/src/lib/composed-metrics/public/prometheus-composed-metrics-collector-manager.ts:137

stop

stop(): void
Stops the manager and the scrape endpoint.

Returns void
- Defined in libs/prometheus/src/lib/composed-metrics/public/prometheus-composed-metrics-collector-manager.ts:161

Generated using TypeDoc