Class Writer

Class that writes metrics into an S3 bucket of your choice.

Hierarchy

Writer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Writer(s3Bucket: string, mergeMode: MergeMode, s3Client: S3): Writer

- Defined in writer.ts:13
Parameters
- s3Bucket: string
- mergeMode: MergeMode
- s3Client: S3
Returns Writer

Properties

mergeMode

mergeMode: MergeMode

s3Bucket

s3Bucket: string

s3Client

s3Client: S3

Methods

writeMetrics

writeMetrics(metricKey: MetricKey, metrics: Metric[]): Promise<any>

- Defined in writer.ts:30
Writes the metric into the S3 bucket. Metrics are located in the bucket in a path based on their resolution, then group and finally key. Depending on resolution there might then be sub folders created to save the values.

Parameters
- metricKey: MetricKey
- metrics: Metric[]
Returns Promise<any>

Static builder

builder(): IBuilder<Writer>

- Defined in writer.ts:21
Returns IBuilder<Writer>

Generated using TypeDoc