Class Aggregator

MetricsAggregator class manages all the metrics for this artifact, integrating with Prometheus for metrics collection and aggregation.

Index

Constructors

Accessors

Methods

clear getMetric getMetricAsJSON getMetricAsString metricsJSON metricsText register

Constructors

constructor

new Aggregator(
logger: LoggerInstance,
port?: AggregatorRegistry<"text/plain; version=0.0.4; charset=utf-8">,
): Aggregator
Create a new instance of MetricsAggregator
Parameters
- logger: LoggerInstance
  Instance for logging
- Optionalport: AggregatorRegistry<"text/plain; version=0.0.4; charset=utf-8">
  Optional AggregatorRegistry for cluster metrics
Returns Aggregator

Accessors

registry

get registry(): Registry<"text/plain; version=0.0.4; charset=utf-8">
Return the registry used by the aggregator

Returns Registry<"text/plain; version=0.0.4; charset=utf-8">

Methods

clear

clear(): void
Clear the registry

Returns void

getMetric

getMetric(name: string): undefined | Metric
Retrieves a single metric by name from the registry.
Parameters
- name: string
  The name of the metric to retrieve
Returns undefined | Metric

getMetricAsJSON

getMetricAsJSON(
name: string,
): Promise<undefined | MetricObjectWithValues<MetricValue<string>>>
Retrieves a single metric value in JSON format by name.
Parameters
- name: string
  The name of the metric to retrieve
Returns Promise<undefined | MetricObjectWithValues<MetricValue<string>>>

getMetricAsString

getMetricAsString(name: string): Promise<string>
Retrieves a single metric value in Prometheus format by name.
Parameters
- name: string
  The name of the metric to retrieve
Returns Promise<string>

metricsJSON

metricsJSON(): Promise<Response>
Return the actual metrics in JSON format

Returns Promise<Response>

metricsText

metricsText(): Promise<Response>
Return the metrics in text/plain format

Returns Promise<Response>

register

register(service: Layer.App.Service | Layer.App.Service[]): void
Register a service or a list of services in the aggregator
Parameters
- service: Layer.App.Service | Layer.App.Service[]
  Service to register in the aggregator
Returns void