Class Telemetry

Use Telemetry to report statistics from an IStats object at a regular interval to a WebSocket or HTTP server.

Example

// Streamer statistics reporting to a websocket SSL server with a frequency of 1 second
const telemetry = new Telemetry('wss://address/metrics');
telemetry.report(new StreamerStats(streamer), 1);

Hierarchy (View Summary)

Loggable
- Telemetry

Index

Constructors

constructor

new Telemetry(url: string | URL): Telemetry
Build a metrics reporter configured with a URL, which can be a websocket or http server. You must call report to start reporting metrics.
Parameters
- url: string | URL
  a Websocket or HTTP server URL.
Returns Telemetry
Overrides Loggable.constructor
- Defined in src/stats/Telemetry.ts:44

Properties

log

log: ILog

Start a log

Param: args

Returns

a Log object with the levels of log to call

Accessors

reporting

get reporting(): number
Number of current reports

Returns number
- Defined in src/stats/Telemetry.ts:29

url

get url(): string
URL of connection

Returns string
- Defined in src/stats/Telemetry.ts:22

Methods

report

report(stats: IStats, frequency: number): void
Starts reporting metrics from an IStats instance to the URL end-point
Parameters
- stats: IStats
  IStats implementation
- frequency: number
  report interval, if is equals to 0 it reports only one time the stats
Returns void
- Defined in src/stats/Telemetry.ts:61

Class Telemetry

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Telemetry

Properties

log

Param: args

Returns

Accessors

reporting

Returns number

url

Returns string

Methods

report

Parameters

Returns void

Settings

On This Page