Jitsi Client Metrics Collector (JCMC)

Warning

Project is still under development

Description

This project is a Node.js application built using the Express.js framework. It provides a RESTful API for managing Jitsi clients metrics (browser). The application is designed to be scalable, maintainable, and easy to extend with additional features.

sequenceDiagram
    Client->>JCMC: Get client file/client-file 
    JCMC-->>Client: Send client file/client-file 
    loop On each "cq.local_stats_updated" event
        Client->>JCMC: Send metrics
        JCMC->>JCMC: Validate metrics
        JCMC->>Redis: Update metrics TTL 
        Redis-->>JCMC: Confirm TTL update 
        JCMC->>JCMC: Add received metrics to exposed metrics
        JCMC-->>Client: Confirm metrics reception
    end
    loop every X seconds
    Prometheus->>JCMC: Scrape metrics
    JCMC-->>Prometheus: Expose metrics in Prometheus format
    end

Loading

Features

• RESTful API endpoints
• Data validation
• Error handling
• Environment-based configuration
• Logging

Requirements

• Node.js (version v22.5.1 or higher). This project hasn't been tested with other versions of Node.js
• Redis

Installation

1. Clone the repository:

   git clone https://github.com/HamzaKhait/jitsi-client-metrics-collector.git
   cd jitsi-client-metrics-collector

2. Install dependencies:

   npm install

3. Adjust the variables in .env file according to your needs

4. Install redis server https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis

Environment Variables

The following environment variables are required:

NODE_ENV=development
REDIS_URL=redis://127.0.0.1:6379
METRICS_EXPIRATION_CHECK=5 # In seconds
METRICS_EXPIRATION=30 #In seconds
ALLOW_PRIVATE_SCRAPE_ONLY=true
PUSH_URL=http://127.0.0.1:3000/metrics/push # the push url that will be used by users

Running the Application

Development

To run the application in development mode:

npm start

Production

1. Download and uncompress the latest release
2. Install dependencies (don't forget Redis):

   npm install

To run the application in production mode:

npm start

Contribution

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

Author

Hamza KHAIT

For any queries or issues, please open an issue on GitHub.