The rtcstats-server represents the server side component of the rtcstats ecosystem, the client side being https://github.com/jitsi/rtcstats which collects and sends WebRTC related statistics.
- node v12 or above
- npm v6 or above
Comming soon...
The certificates in the certs/ folder are examples intended for local testing only, using a HTTPS server.
$ npm install
$ npm run start
The server is configured using the node config module thus it will use one of the available config yaml files found under the ./config directory in accordance to the NODE_ENV (debug|production) environment variable.
Default values can be see 69A8 n here default.
There are also some additional env variables that can be set in order do overwrite config options from the command line, these can be found here custom-env-var
-
rtcstats_websocket_connections
- help: 'number of open websocket connections'
- type: Gauge
-
rtcstats_websocket_connection_error
- help: 'number of open websocket connections that failed with an error',
- type: Counter
-
rtcstats_queued_dumps
- help: 'Number of rtcstats dumps queued up for future processing'
- type: Counter
-
rtcstats_queue_size
- help: 'Number of dumps currently queued for processing'
- type: Gauge
-
rtcstats_disk_queue_size
- help: 'Size occupied on disk by queued dumps'
- type: Gauge
-
rtcstats_files_processed
- help: 'number of files processed',
- type: Counter
-
rtcstats_files_errored
- help: 'number of files with errors during processing'
- type: Counter
-
rtcstats_processing_time
- help: 'Processing time for a request',
- maxAgeSeconds: 600,
- ageBuckets: 5,
- percentiles: [ 0.1, 0.25, 0.5, 0.75, 0.9 ],
- type: Summary
-
rtcstats_dump_size
- help: 'Size of processed rtcstats dumps',
- maxAgeSeconds: 600,
- ageBuckets: 5,
- percentiles: [ 0.1, 0.25, 0.5, 0.75, 0.9 ],
- type: Summary
The project is a fork of https://github.com/fippo/rtcstats-server thus proper thanks are in order for the original contributors.