Class FlatCountMetrics

Hierarchy

FlatCountMetrics

Index

Constructors

Properties

Methods

flush getMetric putMetric

Constructors

constructor

new FlatCountMetrics(): FlatCountMetrics
Accumulate (add together) values for putMetric calls for Units that can be added (e.g. everything except the PerSecond Units).

Emit the accumulated metrics to a MetricsLogger class when flush is called. Note that the MetricsLogger must then be flushed or used with metricsScope to ensure it is flushed.

Returns FlatCountMetrics
- Defined in flat-count-metrics.ts:16

Properties

`Private` metrics

metrics: Map<string, {
unit: Unit;
value: number;
}> = ...

Type declaration

unit: Unit
value: number

Methods

flush

flush(logger): void
Write the accumulated counts through to an object implementing the MetricsLogger interface and releases the accumulated map of metric names and counts. Subsequent calls to putMetric will need another call to flush.
Parameters
- logger: MetricsLogger
  
  MetricsLogger or MetricsLoggerDummy
Returns void
- Defined in flat-count-metrics.ts:77

getMetric

getMetric(key): {
unit: Unit;
value: number;
}
Get the value for a specified metric key, if desired
Parameters
- key: string
Returns {
unit: Unit;
value: number;
}
- unit: Unit
- value: number
- Defined in flat-count-metrics.ts:23

putMetric

putMetric(key, value, unit): FlatCountMetrics
Put a metric value. These values will only be emitted to CloudWatch when flush() is called, which will put the current count into a metric.
Parameters
- key: string
- value: number
- unit: Unit
  
  Any Unit that can be aggregated (e.g. Count, Bytes, Milliseconds but not BytesPerSecond)
Returns FlatCountMetrics
- Defined in flat-count-metrics.ts:39

Generated using TypeDoc