WARN: This custom plugin has been only tested with an unique video player. It is not tested with multiple video players and it may not work properly.
WARN: This custom plugin only works with Time Series Panel
This project is a sample of how to integrate OpenVidu with Grafana.
It has the following components inside of a Docker container:
All the configuration is in the docker-compose.yml file
- openvidu-server: OpenVidu server which will be used to publish the RTSP Camera.
- MySQL: Database used to store the data of the video panel and datasource for data panels.
- Grafana: Grafana dashboard connected to a MySQL database and with the openvidu-video-panel plugin installed.
It also has the app component outside of the Docker container:
- RTSP Application: NodeJS application which automatically publish the RTSP Camera into a session and record it to a .mp4 file. It also generates random data for the data panels.
The following technologies must be installed in your computer
- Docker Compose
- NodeJS and npm
- yarn:
npm install --global yarn
For running the openvidu-server, MySQL and Grafana, you can follow the next steps:
Under the root path:
docker compose -f docker/docker-compose.yml upOnce every service is ready, you can access to the grafana dashboad on localhost:3000
For running the RTSP Application, you can check the README.md file.
-
Video panel: allows to play and pause a video.
-
Video connected to the TimeSeries panel: When hovering over the time series panel, the video will be updated to the time of the hovered point.
-
Rewind button: allows to rewind the video to 10 seconds ago.
-
Forward button: allows to forward the video to 10 seconds later.
-
Video panel with annotations: allows to add a marker to the time series panel in the current time of the video.
-
Skip to next annotation: allows to skip to the next annotation in the time series panel.
-
Skip to previous annotation: allows to skip to the previous annotation in the time series panel.
-
Annotation progress: when video is playing the annotation progress will be updated and it is represented by a red line in the time series panel.
For integrating the openvidu video panel to your own grafana dashboard, you can follow the next steps:
As we are using Docker, we have add a volume to the docker-compose file
If you don't use docker, you can follow the next steps:
Copy the openvidu-video-panel folder to your grafana plugins folder. By default, it is located in /var/lib/grafana/plugins in Linux and C:\Program Files\GrafanaLabs\grafana\data\plugins in Windows.