telemetry_services > MetricsCollector

Class: MetricsCollector

The MetricsCollector provides a background service for collecting Prometheseus metrics for consumption by external clients and compatible servers using the built-in MetricsRoute route handler.

author: Jean-Philippe Steinmetz info@acceleratxr.com

Hierarchy

BackgroundService

↳ MetricsCollector

Index

Constructors

Properties

Methods


Constructors

constructor

new MetricsCollector(config: any, logger: any): MetricsCollector

Overrides BackgroundService.__constructor

Defined in jobs/MetricsCollector.ts:14

Parameters:

Name Type
config any
logger any

Returns: MetricsCollector


Properties

<Protected> config

● config: any

Inherited from BackgroundService.config

Defined in C:/Users/jpsaxr/gitlab/telemetry_services/node_modules/@acceleratxr/utilities/dist/types/BackgroundService.d.ts:9

The global application configuration that the service can reference.


<Protected> logger

● logger: any

Inherited from BackgroundService.logger

Defined in C:/Users/jpsaxr/gitlab/telemetry_services/node_modules/@acceleratxr/utilities/dist/types/BackgroundService.d.ts:11

The logging utility to use.


<Private> registry

● registry: Registry

Defined in jobs/MetricsCollector.ts:14


Methods

run

run(): void

Overrides BackgroundService.run

Defined in jobs/MetricsCollector.ts:21

Returns: void


start

start(): Promise<void>

Overrides BackgroundService.start

Defined in jobs/MetricsCollector.ts:25

Returns: Promise<void>


stop

stop(): Promise<void>

Overrides BackgroundService.stop

Defined in jobs/MetricsCollector.ts:27

Returns: Promise<void>