jitsi/jitsi-videobridge

Update Statistics.md Documentation

dketterer opened this issue · 8 comments

Description

The documentation on Statistics is outdated. If I run http://localhost:8080/colibri/stats I get a different JSON then what is described in the docs.

The current result of the endpoint looks like this:

{
    "inactive_endpoints": 0,
    "inactive_conferences": 0,
    "total_ice_succeeded_relayed": 0,
    "total_loss_degraded_participant_seconds": 51,
    "bit_rate_download": 0.5,
    "muc_clients_connected": 1,
    "total_participants": 30,
    "total_packets_received": 12907003,
    "rtt_aggregate": 0.0,
    "packet_rate_upload": 0,
    "p2p_conferences": 0,
    "total_loss_limited_participant_seconds": 193,
    "octo_send_bitrate": 0,
    "total_dominant_speaker_changes": 2529,
    "receive_only_endpoints": 0,
    "total_colibri_web_socket_messages_received": 0,
    "octo_receive_bitrate": 0,
    "version": "2.1.416-g2f43d1b4",
    "total_ice_succeeded": 27,
    "total_colibri_web_socket_messages_sent": 0,
    "total_bytes_sent_octo": 0,
    "total_data_channel_messages_received": 82839,
    "total_conference_seconds": 21574,
    "num_eps_oversending": 0,
    "bit_rate_upload": 0.5,
    "total_conferences_completed": 5,
    "octo_conferences": 0,
    "num_eps_no_msg_transport_after_delay": 1,
    "endpoints_sending_video": 0,
    "packet_rate_download": 0,
    "muc_clients_configured": 1,
    "outgoing_loss": 0.0,
    "overall_loss": 0.0,
    "conference_sizes": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
    "total_packets_sent_octo": 0,
    "conferences_by_video_senders": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
    "stress_level": 0.0,
    "jitter_aggregate": 0.0,
    "total_ice_succeeded_tcp": 0,
    "octo_endpoints": 0,
    "current_timestamp": "2021-01-21 20:46:05.479",
    "total_packets_dropped_octo": 0,
    "conferences": 0,
    "participants": 0,
    "largest_conference": 0,
    "total_packets_sent": 24424516,
    "total_data_channel_messages_sent": 106168,
    "incoming_loss": 0.0,
    "total_bytes_received_octo": 0,
    "octo_send_packet_rate": 0,
    "conferences_by_audio_senders": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
    "total_conferences_created": 5,
    "total_ice_failed": 2,
    "threads": 32,
    "videochannels": 0,
    "total_packets_received_octo": 0,
    "graceful_shutdown": false,
    "octo_receive_packet_rate": 0,
    "total_bytes_received": 7599692481,
    "total_loss_controlled_participant_seconds": 63831,
    "total_partially_failed_conferences": 1,
    "endpoints_sending_audio": 0,
    "dtls_failed_endpoints": 2,
    "total_bytes_sent": 8409274671,
    "mucs_configured": 1,
    "total_failed_conferences": 0,
    "mucs_joined": 1
}

Current behavior


Expected Behavior


Possible Solution


Steps to reproduce

  • Install with the Quick Install Guide
  • Enable org.jitsi.videobridge.ENABLE_STATISTICS and the private REST API

Environment details

Debian 10

dpkg -l | grep jitsi

ii  jitsi-meet                      2.0.5390-2                   all          WebRTC JavaScript video conferences
ii  jitsi-meet-prosody              1.0.4628-1                   all          Prosody configuration for Jitsi Meet
ii  jitsi-meet-web                  1.0.4628-1                   all          WebRTC JavaScript video conferences
ii  jitsi-meet-web-config           1.0.4628-1                   all          Configuration for web serving of Jitsi Meet
rc  jitsi-videobridge               1126-1                       amd64        WebRTC compatible Selective Forwarding Unit (SFU)
ii  jitsi-videobridge2              2.1-416-g2f43d1b4-1          all          WebRTC compatible Selective Forwarding Unit (SFU)

This means Videobridge 2.0.5390.

Hey @bgrozev,
you did a lot of work in VideobridgeStatistics.java recently. Maybe you can help here?

RafPe commented

Hi team! Also working on stats exporter and would be great to have some document more less explaining new stats and as well giving some more insights into the existing ones

Also interested in an update for this

Hi same here, i can see there is a total_participants also

@bgrozev can you please at least mark the docs as outdated? This situation is very misleading

See #1741, please let us know if you find anything inaccurate or missing

hex-m commented

Thanks for the update!

  • I would assume to find such information in the Handbook but that is already requested in jitsi/handbook#22.
  • rest-colibri.md links to a nonexistant section in statistics.md that should explain how to enable the statistics.

Thanks, I fixed (well, removed) the link in #1744. The move to the handbook would be a separate effort.