Membrane RTC Engine v0.11.0

View Source Membrane.RTC.Engine.Metrics (Membrane RTC Engine v0.11.0)

Defines list of metrics, that Reporter instance can aggregate by listening on events emitted in RTC Engine. Suggested Reporter implementation is Membrane.TelemetryMetrics.Reporter from membrane_telemetry_metrics. Membrane.TelemetryMetrics.Reporter started with metrics returned by metrics/1 function will be able to generate reports, that matches type Membrane.RTC.Engine.Metrics.rtc_engine_report() You can see usage example in (membrane_videoroom)[github.com/membraneframework/membrane_videoroom].

Link to this section Summary

Types

rtc_engine_report()

Functions

metrics()

Link to this section Types

Link to this type

rtc_engine_report()

View Source 
@type rtc_engine_report() :: %{
  optional({:room_id, binary()}) => %{
    optional({:peer_id, binary()}) => %{
      optional({:track_id, binary()}) => %{
        "inbound-rtp.encoding": :OPUS | :VP8 | :H264,
        "inbound-rtp.ssrc": integer(),
        "inbound-rtp.bytes_received": integer(),
        "inbound-rtp.keyframe_request_sent": integer(),
        "inbound-rtp.packets": integer(),
        "inbound-rtp.frames": integer(),
        "inbound-rtp.keyframes": integer(),
        "track.metadata": any()
      },
      optional({:track_id, binary()}) => %{
        "outbound-rtp.variant": Membrane.RTC.Engine.Track.variant(),
        "outbound-rtp.variant-reason":
          Membrane.RTC.Engine.Endpoint.WebRTC.TrackReceiver.variant_switch_reason()
      },
      "ice.binding_requests_received": integer(),
      "ice.binding_responses_sent": integer(),
      "ice.bytes_received": integer(),
      "ice.bytes_sent": integer(),
      "ice.packets_received": integer(),
      "ice.packets_sent": integer(),
      "peer.metadata": any()
    }
  }
}

Link to this section Functions

Link to this function

metrics()

View Source 
@spec metrics() :: [Telemetry.Metrics.t()]