Class PollingMetricsHandler

Index

Constructors

Accessors

Methods

addTaskInProgress finalizeCycle initializeCycle removeTaskInProgress

Constructors

constructor

new PollingMetricsHandler(
    componentId: string,
    resource: string,
    pollingGroup: PollingGroup,
    cyclesOnStats?: number,
    metrics: MetricsDefinitions,
): PollingMetricsHandler
Create a polling stats manager
Parameters
- componentId: string
  Component identifier
- resource: string
  Resource identifier
- pollingGroup: PollingGroup
  Polling group assigned to this manager
- cyclesOnStats: number = DEFAULT_SCAN_CYCLES_ON_STATS
  Number of cycles on stats
- metrics: MetricsDefinitions
  Metrics instances
Returns PollingMetricsHandler

Accessors

check

get check(): Check<any>
Get health check of the component

Returns Check<any>

Methods

addTaskInProgress

addTaskInProgress(taskId: string): void
Add a task to the in progress stats
Parameters
- taskId: string
  Task identifier
Returns void

finalizeCycle

finalizeCycle(): void
Set the final point of a cycle

Returns void

initializeCycle

initializeCycle(): void
Set the initial point of a cycle

Returns void

removeTaskInProgress

removeTaskInProgress(
    taskId: string,
    duration?: number,
    error?: Crash | Multi,
): void
Remove a task from the in progress stats
Parameters
- taskId: string
  Task identifier
- duration: number = 0
  Task duration
- Optionalerror: Crash | Multi
  Task error
Returns void