# rtcstats-server

**Repository Path**: mirrors_jitsi/rtcstats-server

## Basic Information

- **Project Name**: rtcstats-server
- **Description**: Server for https://github.com/fippo/rtcstats
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rtcstats-server

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.

## Requirements

- node v12 or above
- npm v6 or above

## Architecture

Comming soon...

## Security

The certificates in the `certs/` folder are examples intended for **local testing only**, using a HTTPS server.

## How to use
### Run
```
$ npm install
$ npm run start
```
### Configure
The server is configured using the node [config](https://github.com/jitsi/rtcstats-server/blob/master/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 seen here [default](https://github.com/jitsi/rtcstats-server/blob/master/config/default.yaml).

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](https://github.com/jitsi/rtcstats-server/blob/master/config/custom-environment-variables.yaml)

### Prometheus stats

- 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


## Authors and acknowledgment
The project is a fork of https://github.com/fippo/rtcstats-server thus proper thanks are in order for the original
contributors.