Class Reporter

Records telemetry events, ships the ones worth their bytes, and counts them all.

Index

Constructors

Accessors

dropped emitted threshold total

Methods

adaptTo count record snapshot

Constructors

constructor

new Reporter(threshold: Level): Reporter
Creates a reporter that ships events at or above threshold.
Parameters
- threshold: Level
Returns Reporter
- Defined in index.d.ts:1223

Accessors

dropped

get dropped(): number
How many events the threshold dropped.

Returns number
- Defined in index.d.ts:1244

emitted

get emitted(): number
How many events passed the threshold and were shipped.

Returns number
- Defined in index.d.ts:1242

threshold

get threshold(): Level
The level this reporter is currently shipping from.

Returns Level
- Defined in index.d.ts:1225
set threshold(threshold: Level): void
Moves the level this reporter ships from.
Parameters
- threshold: Level
Returns void
- Defined in index.d.ts:1227

total

get total(): number
How many events have been seen across every level.

Returns number
- Defined in index.d.ts:1240

Methods

adaptTo

adaptTo(cost: LinkCost): void
Moves the threshold to match what the link now costs.
Parameters
- cost: LinkCost
Returns void
- Defined in index.d.ts:1229

count

count(level: Level): number
Returns how many events have been seen at level, shipped or not.
Parameters
- level: Level
Returns number
- Defined in index.d.ts:1238

record

record(level: Level): boolean
Records an event at level and returns whether it should be shipped.

The event is counted either way, so the aggregate picture survives even when the link is too costly to carry the detail.
Parameters
- level: Level
Returns boolean
- Defined in index.d.ts:1236

snapshot

snapshot(): Snapshot
Takes a snapshot of the counters to ship in place of the event stream.

Returns Snapshot
- Defined in index.d.ts:1246