Documentation

NodeStats extends Message
in package

Generated from protobuf message <code>livekit.NodeStats</code>

Table of Contents

Properties

$bytes_in  : mixed
packet
$bytes_in_per_sec  : mixed
Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>
$bytes_out  : mixed
Generated from protobuf field <code>uint64 bytes_out = 8;</code>
$bytes_out_per_sec  : mixed
Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>
$cpu_load  : mixed
Generated from protobuf field <code>float cpu_load = 21;</code>
$forward_jitter  : mixed
Generated from protobuf field <code>uint32 forward_jitter = 49;</code>
$forward_latency  : mixed
forward metrics
$load_avg_last15min  : mixed
Generated from protobuf field <code>float load_avg_last15min = 20;</code>
$load_avg_last1min  : mixed
Generated from protobuf field <code>float load_avg_last1min = 18;</code>
$load_avg_last5min  : mixed
Generated from protobuf field <code>float load_avg_last5min = 19;</code>
$memory_load  : mixed
Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>
$memory_total  : mixed
Generated from protobuf field <code>uint64 memory_total = 34;</code>
$memory_used  : mixed
Generated from protobuf field <code>uint64 memory_used = 35;</code>
$nack_per_sec  : mixed
Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>
$nack_total  : mixed
Generated from protobuf field <code>uint64 nack_total = 11;</code>
$num_clients  : mixed
Generated from protobuf field <code>int32 num_clients = 4;</code>
$num_cpus  : mixed
system
$num_rooms  : mixed
room
$num_track_publish_attempts  : mixed
Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>
$num_track_publish_cancels  : mixed
Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>
$num_track_publish_success  : mixed
Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>
$num_track_subscribe_attempts  : mixed
Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>
$num_track_subscribe_cancels  : mixed
Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>
$num_track_subscribe_success  : mixed
Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>
$num_tracks_in  : mixed
Generated from protobuf field <code>int32 num_tracks_in = 5;</code>
$num_tracks_out  : mixed
Generated from protobuf field <code>int32 num_tracks_out = 6;</code>
$packets_in  : mixed
Generated from protobuf field <code>uint64 packets_in = 9;</code>
$packets_in_per_sec  : mixed
Generated from protobuf field <code>float packets_in_per_sec = 14;</code>
$packets_out  : mixed
Generated from protobuf field <code>uint64 packets_out = 10;</code>
$packets_out_per_sec  : mixed
Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>
$participant_rtc_canceled  : mixed
Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>
$participant_rtc_connected  : mixed
Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>
$participant_rtc_connected_per_sec  : mixed
Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>
$participant_rtc_init  : mixed
Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>
$participant_rtc_init_per_sec  : mixed
Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>
$participant_signal_connected  : mixed
participant joins
$participant_signal_connected_per_sec  : mixed
Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>
$retransmit_bytes_out  : mixed
retransmissions
$retransmit_bytes_out_per_sec  : mixed
Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>
$retransmit_packets_out  : mixed
Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>
$retransmit_packets_out_per_sec  : mixed
Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>
$started_at  : mixed
when server was started
$sys_packets_dropped  : mixed
Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>
$sys_packets_dropped_pct_per_sec  : mixed
Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>
$sys_packets_dropped_per_sec  : mixed
Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>
$sys_packets_out  : mixed
Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>
$sys_packets_out_per_sec  : mixed
Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>
$track_publish_attempts_per_sec  : mixed
Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>
$track_publish_success_per_sec  : mixed
Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>
$track_subscribe_attempts_per_sec  : mixed
Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>
$track_subscribe_success_per_sec  : mixed
Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>
$updated_at  : mixed
when server last reported its status
$rates  : mixed
Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>

Methods

__construct()  : mixed
Constructor.
getBytesIn()  : int|string
packet
getBytesInPerSec()  : float
Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>
getBytesOut()  : int|string
Generated from protobuf field <code>uint64 bytes_out = 8;</code>
getBytesOutPerSec()  : float
Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>
getCpuLoad()  : float
Generated from protobuf field <code>float cpu_load = 21;</code>
getForwardJitter()  : int
Generated from protobuf field <code>uint32 forward_jitter = 49;</code>
getForwardLatency()  : int
forward metrics
getLoadAvgLast15Min()  : float
Generated from protobuf field <code>float load_avg_last15min = 20;</code>
getLoadAvgLast1Min()  : float
Generated from protobuf field <code>float load_avg_last1min = 18;</code>
getLoadAvgLast5Min()  : float
Generated from protobuf field <code>float load_avg_last5min = 19;</code>
getMemoryLoad()  : float
Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>
getMemoryTotal()  : int|string
Generated from protobuf field <code>uint64 memory_total = 34;</code>
getMemoryUsed()  : int|string
Generated from protobuf field <code>uint64 memory_used = 35;</code>
getNackPerSec()  : float
Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>
getNackTotal()  : int|string
Generated from protobuf field <code>uint64 nack_total = 11;</code>
getNumClients()  : int
Generated from protobuf field <code>int32 num_clients = 4;</code>
getNumCpus()  : int
system
getNumRooms()  : int
room
getNumTrackPublishAttempts()  : int
Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>
getNumTrackPublishCancels()  : int
Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>
getNumTrackPublishSuccess()  : int
Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>
getNumTracksIn()  : int
Generated from protobuf field <code>int32 num_tracks_in = 5;</code>
getNumTracksOut()  : int
Generated from protobuf field <code>int32 num_tracks_out = 6;</code>
getNumTrackSubscribeAttempts()  : int
Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>
getNumTrackSubscribeCancels()  : int
Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>
getNumTrackSubscribeSuccess()  : int
Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>
getPacketsIn()  : int|string
Generated from protobuf field <code>uint64 packets_in = 9;</code>
getPacketsInPerSec()  : float
Generated from protobuf field <code>float packets_in_per_sec = 14;</code>
getPacketsOut()  : int|string
Generated from protobuf field <code>uint64 packets_out = 10;</code>
getPacketsOutPerSec()  : float
Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>
getParticipantRtcCanceled()  : int|string
Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>
getParticipantRtcConnected()  : int|string
Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>
getParticipantRtcConnectedPerSec()  : float
Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>
getParticipantRtcInit()  : int|string
Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>
getParticipantRtcInitPerSec()  : float
Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>
getParticipantSignalConnected()  : int|string
participant joins
getParticipantSignalConnectedPerSec()  : float
Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>
getRates()  : RepeatedField<string|int, NodeStatsRate>
Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>
getRetransmitBytesOut()  : int|string
retransmissions
getRetransmitBytesOutPerSec()  : float
Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>
getRetransmitPacketsOut()  : int|string
Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>
getRetransmitPacketsOutPerSec()  : float
Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>
getStartedAt()  : int|string
when server was started
getSysPacketsDropped()  : int
Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>
getSysPacketsDroppedPctPerSec()  : float
Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>
getSysPacketsDroppedPerSec()  : float
Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>
getSysPacketsOut()  : int
Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>
getSysPacketsOutPerSec()  : float
Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>
getTrackPublishAttemptsPerSec()  : float
Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>
getTrackPublishSuccessPerSec()  : float
Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>
getTrackSubscribeAttemptsPerSec()  : float
Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>
getTrackSubscribeSuccessPerSec()  : float
Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>
getUpdatedAt()  : int|string
when server last reported its status
setBytesIn()  : $this
packet
setBytesInPerSec()  : $this
Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>
setBytesOut()  : $this
Generated from protobuf field <code>uint64 bytes_out = 8;</code>
setBytesOutPerSec()  : $this
Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>
setCpuLoad()  : $this
Generated from protobuf field <code>float cpu_load = 21;</code>
setForwardJitter()  : $this
Generated from protobuf field <code>uint32 forward_jitter = 49;</code>
setForwardLatency()  : $this
forward metrics
setLoadAvgLast15Min()  : $this
Generated from protobuf field <code>float load_avg_last15min = 20;</code>
setLoadAvgLast1Min()  : $this
Generated from protobuf field <code>float load_avg_last1min = 18;</code>
setLoadAvgLast5Min()  : $this
Generated from protobuf field <code>float load_avg_last5min = 19;</code>
setMemoryLoad()  : $this
Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>
setMemoryTotal()  : $this
Generated from protobuf field <code>uint64 memory_total = 34;</code>
setMemoryUsed()  : $this
Generated from protobuf field <code>uint64 memory_used = 35;</code>
setNackPerSec()  : $this
Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>
setNackTotal()  : $this
Generated from protobuf field <code>uint64 nack_total = 11;</code>
setNumClients()  : $this
Generated from protobuf field <code>int32 num_clients = 4;</code>
setNumCpus()  : $this
system
setNumRooms()  : $this
room
setNumTrackPublishAttempts()  : $this
Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>
setNumTrackPublishCancels()  : $this
Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>
setNumTrackPublishSuccess()  : $this
Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>
setNumTracksIn()  : $this
Generated from protobuf field <code>int32 num_tracks_in = 5;</code>
setNumTracksOut()  : $this
Generated from protobuf field <code>int32 num_tracks_out = 6;</code>
setNumTrackSubscribeAttempts()  : $this
Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>
setNumTrackSubscribeCancels()  : $this
Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>
setNumTrackSubscribeSuccess()  : $this
Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>
setPacketsIn()  : $this
Generated from protobuf field <code>uint64 packets_in = 9;</code>
setPacketsInPerSec()  : $this
Generated from protobuf field <code>float packets_in_per_sec = 14;</code>
setPacketsOut()  : $this
Generated from protobuf field <code>uint64 packets_out = 10;</code>
setPacketsOutPerSec()  : $this
Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>
setParticipantRtcCanceled()  : $this
Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>
setParticipantRtcConnected()  : $this
Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>
setParticipantRtcConnectedPerSec()  : $this
Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>
setParticipantRtcInit()  : $this
Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>
setParticipantRtcInitPerSec()  : $this
Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>
setParticipantSignalConnected()  : $this
participant joins
setParticipantSignalConnectedPerSec()  : $this
Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>
setRates()  : $this
Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>
setRetransmitBytesOut()  : $this
retransmissions
setRetransmitBytesOutPerSec()  : $this
Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>
setRetransmitPacketsOut()  : $this
Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>
setRetransmitPacketsOutPerSec()  : $this
Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>
setStartedAt()  : $this
when server was started
setSysPacketsDropped()  : $this
Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>
setSysPacketsDroppedPctPerSec()  : $this
Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>
setSysPacketsDroppedPerSec()  : $this
Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>
setSysPacketsOut()  : $this
Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>
setSysPacketsOutPerSec()  : $this
Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>
setTrackPublishAttemptsPerSec()  : $this
Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>
setTrackPublishSuccessPerSec()  : $this
Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>
setTrackSubscribeAttemptsPerSec()  : $this
Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>
setTrackSubscribeSuccessPerSec()  : $this
Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>
setUpdatedAt()  : $this
when server last reported its status

Properties

$bytes_in

packet

protected mixed $bytes_in = 0

Generated from protobuf field uint64 bytes_in = 7;

$bytes_in_per_sec

Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>

protected mixed $bytes_in_per_sec = 0.0

$bytes_out

Generated from protobuf field <code>uint64 bytes_out = 8;</code>

protected mixed $bytes_out = 0

$bytes_out_per_sec

Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>

protected mixed $bytes_out_per_sec = 0.0

$cpu_load

Generated from protobuf field <code>float cpu_load = 21;</code>

protected mixed $cpu_load = 0.0

$forward_jitter

Generated from protobuf field <code>uint32 forward_jitter = 49;</code>

protected mixed $forward_jitter = 0

$forward_latency

forward metrics

protected mixed $forward_latency = 0

Generated from protobuf field uint32 forward_latency = 48;

$load_avg_last15min

Generated from protobuf field <code>float load_avg_last15min = 20;</code>

protected mixed $load_avg_last15min = 0.0

$load_avg_last1min

Generated from protobuf field <code>float load_avg_last1min = 18;</code>

protected mixed $load_avg_last1min = 0.0

$load_avg_last5min

Generated from protobuf field <code>float load_avg_last5min = 19;</code>

protected mixed $load_avg_last5min = 0.0

$memory_load

Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>

protected mixed $memory_load = 0.0

$memory_total

Generated from protobuf field <code>uint64 memory_total = 34;</code>

protected mixed $memory_total = 0

$memory_used

Generated from protobuf field <code>uint64 memory_used = 35;</code>

protected mixed $memory_used = 0

$nack_per_sec

Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>

protected mixed $nack_per_sec = 0.0

$nack_total

Generated from protobuf field <code>uint64 nack_total = 11;</code>

protected mixed $nack_total = 0

$num_clients

Generated from protobuf field <code>int32 num_clients = 4;</code>

protected mixed $num_clients = 0

$num_cpus

system

protected mixed $num_cpus = 0

Generated from protobuf field uint32 num_cpus = 17;

$num_rooms

room

protected mixed $num_rooms = 0

Generated from protobuf field int32 num_rooms = 3;

$num_track_publish_attempts

Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>

protected mixed $num_track_publish_attempts = 0

$num_track_publish_cancels

Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>

protected mixed $num_track_publish_cancels = 0

$num_track_publish_success

Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>

protected mixed $num_track_publish_success = 0

$num_track_subscribe_attempts

Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>

protected mixed $num_track_subscribe_attempts = 0

$num_track_subscribe_cancels

Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>

protected mixed $num_track_subscribe_cancels = 0

$num_track_subscribe_success

Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>

protected mixed $num_track_subscribe_success = 0

$num_tracks_in

Generated from protobuf field <code>int32 num_tracks_in = 5;</code>

protected mixed $num_tracks_in = 0

$num_tracks_out

Generated from protobuf field <code>int32 num_tracks_out = 6;</code>

protected mixed $num_tracks_out = 0

$packets_in

Generated from protobuf field <code>uint64 packets_in = 9;</code>

protected mixed $packets_in = 0

$packets_in_per_sec

Generated from protobuf field <code>float packets_in_per_sec = 14;</code>

protected mixed $packets_in_per_sec = 0.0

$packets_out

Generated from protobuf field <code>uint64 packets_out = 10;</code>

protected mixed $packets_out = 0

$packets_out_per_sec

Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>

protected mixed $packets_out_per_sec = 0.0

$participant_rtc_canceled

Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>

protected mixed $participant_rtc_canceled = 0

$participant_rtc_connected

Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>

protected mixed $participant_rtc_connected = 0

$participant_rtc_connected_per_sec

Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>

protected mixed $participant_rtc_connected_per_sec = 0.0

$participant_rtc_init

Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>

protected mixed $participant_rtc_init = 0

$participant_rtc_init_per_sec

Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>

protected mixed $participant_rtc_init_per_sec = 0.0

$participant_signal_connected

participant joins

protected mixed $participant_signal_connected = 0

Generated from protobuf field uint64 participant_signal_connected = 26;

$participant_signal_connected_per_sec

Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>

protected mixed $participant_signal_connected_per_sec = 0.0

$retransmit_bytes_out

retransmissions

protected mixed $retransmit_bytes_out = 0

Generated from protobuf field uint64 retransmit_bytes_out = 22;

$retransmit_bytes_out_per_sec

Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>

protected mixed $retransmit_bytes_out_per_sec = 0.0

$retransmit_packets_out

Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>

protected mixed $retransmit_packets_out = 0

$retransmit_packets_out_per_sec

Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>

protected mixed $retransmit_packets_out_per_sec = 0.0

$started_at

when server was started

protected mixed $started_at = 0

Generated from protobuf field int64 started_at = 1;

$sys_packets_dropped

Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>

protected mixed $sys_packets_dropped = 0

$sys_packets_dropped_pct_per_sec

Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>

protected mixed $sys_packets_dropped_pct_per_sec = 0.0

$sys_packets_dropped_per_sec

Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>

protected mixed $sys_packets_dropped_per_sec = 0.0

$sys_packets_out

Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>

protected mixed $sys_packets_out = 0

$sys_packets_out_per_sec

Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>

protected mixed $sys_packets_out_per_sec = 0.0

$track_publish_attempts_per_sec

Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>

protected mixed $track_publish_attempts_per_sec = 0.0

$track_publish_success_per_sec

Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>

protected mixed $track_publish_success_per_sec = 0.0

$track_subscribe_attempts_per_sec

Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>

protected mixed $track_subscribe_attempts_per_sec = 0.0

$track_subscribe_success_per_sec

Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>

protected mixed $track_subscribe_success_per_sec = 0.0

$updated_at

when server last reported its status

protected mixed $updated_at = 0

Generated from protobuf field int64 updated_at = 2;

$rates

Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>

private mixed $rates

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type int|string $started_at
      when server was started
@type int|string $updated_at
      when server last reported its status
@type int $num_rooms
      room
@type int $num_clients
@type int $num_tracks_in
@type int $num_tracks_out
@type int $num_track_publish_attempts
@type float $track_publish_attempts_per_sec
@type int $num_track_publish_success
@type float $track_publish_success_per_sec
@type int $num_track_publish_cancels
@type int $num_track_subscribe_attempts
@type float $track_subscribe_attempts_per_sec
@type int $num_track_subscribe_success
@type float $track_subscribe_success_per_sec
@type int $num_track_subscribe_cancels
@type int|string $bytes_in
      packet
@type int|string $bytes_out
@type int|string $packets_in
@type int|string $packets_out
@type int|string $nack_total
@type float $bytes_in_per_sec
@type float $bytes_out_per_sec
@type float $packets_in_per_sec
@type float $packets_out_per_sec
@type float $nack_per_sec
@type int $num_cpus
      system
@type float $load_avg_last1min
@type float $load_avg_last5min
@type float $load_avg_last15min
@type float $cpu_load
@type float $memory_load
@type int|string $memory_total
@type int|string $memory_used
@type int $sys_packets_out
@type int $sys_packets_dropped
@type float $sys_packets_out_per_sec
@type float $sys_packets_dropped_per_sec
@type float $sys_packets_dropped_pct_per_sec
@type int|string $retransmit_bytes_out
      retransmissions
@type int|string $retransmit_packets_out
@type float $retransmit_bytes_out_per_sec
@type float $retransmit_packets_out_per_sec
@type int|string $participant_signal_connected
      participant joins
@type float $participant_signal_connected_per_sec
@type int|string $participant_rtc_connected
@type float $participant_rtc_connected_per_sec
@type int|string $participant_rtc_init
@type float $participant_rtc_init_per_sec
@type int|string $participant_rtc_canceled
@type int $forward_latency
      forward metrics
@type int $forward_jitter
@type \Livekit\NodeStatsRate[] $rates

}

getBytesIn()

packet

public getBytesIn() : int|string

Generated from protobuf field uint64 bytes_in = 7;

Return values
int|string

getBytesInPerSec()

Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>

public getBytesInPerSec() : float
Return values
float

getBytesOut()

Generated from protobuf field <code>uint64 bytes_out = 8;</code>

public getBytesOut() : int|string
Return values
int|string

getBytesOutPerSec()

Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>

public getBytesOutPerSec() : float
Return values
float

getCpuLoad()

Generated from protobuf field <code>float cpu_load = 21;</code>

public getCpuLoad() : float
Return values
float

getForwardJitter()

Generated from protobuf field <code>uint32 forward_jitter = 49;</code>

public getForwardJitter() : int
Return values
int

getForwardLatency()

forward metrics

public getForwardLatency() : int

Generated from protobuf field uint32 forward_latency = 48;

Return values
int

getLoadAvgLast15Min()

Generated from protobuf field <code>float load_avg_last15min = 20;</code>

public getLoadAvgLast15Min() : float
Return values
float

getLoadAvgLast1Min()

Generated from protobuf field <code>float load_avg_last1min = 18;</code>

public getLoadAvgLast1Min() : float
Return values
float

getLoadAvgLast5Min()

Generated from protobuf field <code>float load_avg_last5min = 19;</code>

public getLoadAvgLast5Min() : float
Return values
float

getMemoryLoad()

Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>

public getMemoryLoad() : float
Return values
float

getMemoryTotal()

Generated from protobuf field <code>uint64 memory_total = 34;</code>

public getMemoryTotal() : int|string
Return values
int|string

getMemoryUsed()

Generated from protobuf field <code>uint64 memory_used = 35;</code>

public getMemoryUsed() : int|string
Return values
int|string

getNackPerSec()

Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>

public getNackPerSec() : float
Return values
float

getNackTotal()

Generated from protobuf field <code>uint64 nack_total = 11;</code>

public getNackTotal() : int|string
Return values
int|string

getNumClients()

Generated from protobuf field <code>int32 num_clients = 4;</code>

public getNumClients() : int
Return values
int

getNumCpus()

system

public getNumCpus() : int

Generated from protobuf field uint32 num_cpus = 17;

Return values
int

getNumRooms()

room

public getNumRooms() : int

Generated from protobuf field int32 num_rooms = 3;

Return values
int

getNumTrackPublishAttempts()

Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>

public getNumTrackPublishAttempts() : int
Return values
int

getNumTrackPublishCancels()

Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>

public getNumTrackPublishCancels() : int
Return values
int

getNumTrackPublishSuccess()

Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>

public getNumTrackPublishSuccess() : int
Return values
int

getNumTracksIn()

Generated from protobuf field <code>int32 num_tracks_in = 5;</code>

public getNumTracksIn() : int
Return values
int

getNumTracksOut()

Generated from protobuf field <code>int32 num_tracks_out = 6;</code>

public getNumTracksOut() : int
Return values
int

getNumTrackSubscribeAttempts()

Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>

public getNumTrackSubscribeAttempts() : int
Return values
int

getNumTrackSubscribeCancels()

Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>

public getNumTrackSubscribeCancels() : int
Return values
int

getNumTrackSubscribeSuccess()

Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>

public getNumTrackSubscribeSuccess() : int
Return values
int

getPacketsIn()

Generated from protobuf field <code>uint64 packets_in = 9;</code>

public getPacketsIn() : int|string
Return values
int|string

getPacketsInPerSec()

Generated from protobuf field <code>float packets_in_per_sec = 14;</code>

public getPacketsInPerSec() : float
Return values
float

getPacketsOut()

Generated from protobuf field <code>uint64 packets_out = 10;</code>

public getPacketsOut() : int|string
Return values
int|string

getPacketsOutPerSec()

Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>

public getPacketsOutPerSec() : float
Return values
float

getParticipantRtcCanceled()

Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>

public getParticipantRtcCanceled() : int|string
Return values
int|string

getParticipantRtcConnected()

Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>

public getParticipantRtcConnected() : int|string
Return values
int|string

getParticipantRtcConnectedPerSec()

Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>

public getParticipantRtcConnectedPerSec() : float
Return values
float

getParticipantRtcInit()

Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>

public getParticipantRtcInit() : int|string
Return values
int|string

getParticipantRtcInitPerSec()

Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>

public getParticipantRtcInitPerSec() : float
Return values
float

getParticipantSignalConnected()

participant joins

public getParticipantSignalConnected() : int|string

Generated from protobuf field uint64 participant_signal_connected = 26;

Return values
int|string

getParticipantSignalConnectedPerSec()

Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>

public getParticipantSignalConnectedPerSec() : float
Return values
float

getRates()

Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>

public getRates() : RepeatedField<string|int, NodeStatsRate>
Return values
RepeatedField<string|int, NodeStatsRate>

getRetransmitBytesOut()

retransmissions

public getRetransmitBytesOut() : int|string

Generated from protobuf field uint64 retransmit_bytes_out = 22;

Return values
int|string

getRetransmitBytesOutPerSec()

Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>

public getRetransmitBytesOutPerSec() : float
Return values
float

getRetransmitPacketsOut()

Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>

public getRetransmitPacketsOut() : int|string
Return values
int|string

getRetransmitPacketsOutPerSec()

Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>

public getRetransmitPacketsOutPerSec() : float
Return values
float

getStartedAt()

when server was started

public getStartedAt() : int|string

Generated from protobuf field int64 started_at = 1;

Return values
int|string

getSysPacketsDropped()

Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>

public getSysPacketsDropped() : int
Return values
int

getSysPacketsDroppedPctPerSec()

Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>

public getSysPacketsDroppedPctPerSec() : float
Return values
float

getSysPacketsDroppedPerSec()

Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>

public getSysPacketsDroppedPerSec() : float
Return values
float

getSysPacketsOut()

Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>

public getSysPacketsOut() : int
Return values
int

getSysPacketsOutPerSec()

Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>

public getSysPacketsOutPerSec() : float
Return values
float

getTrackPublishAttemptsPerSec()

Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>

public getTrackPublishAttemptsPerSec() : float
Return values
float

getTrackPublishSuccessPerSec()

Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>

public getTrackPublishSuccessPerSec() : float
Return values
float

getTrackSubscribeAttemptsPerSec()

Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>

public getTrackSubscribeAttemptsPerSec() : float
Return values
float

getTrackSubscribeSuccessPerSec()

Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>

public getTrackSubscribeSuccessPerSec() : float
Return values
float

getUpdatedAt()

when server last reported its status

public getUpdatedAt() : int|string

Generated from protobuf field int64 updated_at = 2;

Return values
int|string

setBytesIn()

packet

public setBytesIn(int|string $var) : $this

Generated from protobuf field uint64 bytes_in = 7;

Parameters
$var : int|string
Return values
$this

setBytesInPerSec()

Generated from protobuf field <code>float bytes_in_per_sec = 12 [deprecated = true];</code>

public setBytesInPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setBytesOut()

Generated from protobuf field <code>uint64 bytes_out = 8;</code>

public setBytesOut(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setBytesOutPerSec()

Generated from protobuf field <code>float bytes_out_per_sec = 13 [deprecated = true];</code>

public setBytesOutPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setCpuLoad()

Generated from protobuf field <code>float cpu_load = 21;</code>

public setCpuLoad(float $var) : $this
Parameters
$var : float
Return values
$this

setForwardJitter()

Generated from protobuf field <code>uint32 forward_jitter = 49;</code>

public setForwardJitter(int $var) : $this
Parameters
$var : int
Return values
$this

setForwardLatency()

forward metrics

public setForwardLatency(int $var) : $this

Generated from protobuf field uint32 forward_latency = 48;

Parameters
$var : int
Return values
$this

setLoadAvgLast15Min()

Generated from protobuf field <code>float load_avg_last15min = 20;</code>

public setLoadAvgLast15Min(float $var) : $this
Parameters
$var : float
Return values
$this

setLoadAvgLast1Min()

Generated from protobuf field <code>float load_avg_last1min = 18;</code>

public setLoadAvgLast1Min(float $var) : $this
Parameters
$var : float
Return values
$this

setLoadAvgLast5Min()

Generated from protobuf field <code>float load_avg_last5min = 19;</code>

public setLoadAvgLast5Min(float $var) : $this
Parameters
$var : float
Return values
$this

setMemoryLoad()

Generated from protobuf field <code>float memory_load = 33 [deprecated = true];</code>

public setMemoryLoad(float $var) : $this
Parameters
$var : float
Return values
$this

setMemoryTotal()

Generated from protobuf field <code>uint64 memory_total = 34;</code>

public setMemoryTotal(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setMemoryUsed()

Generated from protobuf field <code>uint64 memory_used = 35;</code>

public setMemoryUsed(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setNackPerSec()

Generated from protobuf field <code>float nack_per_sec = 16 [deprecated = true];</code>

public setNackPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setNackTotal()

Generated from protobuf field <code>uint64 nack_total = 11;</code>

public setNackTotal(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setNumClients()

Generated from protobuf field <code>int32 num_clients = 4;</code>

public setNumClients(int $var) : $this
Parameters
$var : int
Return values
$this

setNumCpus()

system

public setNumCpus(int $var) : $this

Generated from protobuf field uint32 num_cpus = 17;

Parameters
$var : int
Return values
$this

setNumRooms()

room

public setNumRooms(int $var) : $this

Generated from protobuf field int32 num_rooms = 3;

Parameters
$var : int
Return values
$this

setNumTrackPublishAttempts()

Generated from protobuf field <code>int32 num_track_publish_attempts = 36;</code>

public setNumTrackPublishAttempts(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTrackPublishCancels()

Generated from protobuf field <code>int32 num_track_publish_cancels = 51;</code>

public setNumTrackPublishCancels(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTrackPublishSuccess()

Generated from protobuf field <code>int32 num_track_publish_success = 38;</code>

public setNumTrackPublishSuccess(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTracksIn()

Generated from protobuf field <code>int32 num_tracks_in = 5;</code>

public setNumTracksIn(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTracksOut()

Generated from protobuf field <code>int32 num_tracks_out = 6;</code>

public setNumTracksOut(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTrackSubscribeAttempts()

Generated from protobuf field <code>int32 num_track_subscribe_attempts = 40;</code>

public setNumTrackSubscribeAttempts(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTrackSubscribeCancels()

Generated from protobuf field <code>int32 num_track_subscribe_cancels = 52;</code>

public setNumTrackSubscribeCancels(int $var) : $this
Parameters
$var : int
Return values
$this

setNumTrackSubscribeSuccess()

Generated from protobuf field <code>int32 num_track_subscribe_success = 42;</code>

public setNumTrackSubscribeSuccess(int $var) : $this
Parameters
$var : int
Return values
$this

setPacketsIn()

Generated from protobuf field <code>uint64 packets_in = 9;</code>

public setPacketsIn(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setPacketsInPerSec()

Generated from protobuf field <code>float packets_in_per_sec = 14;</code>

public setPacketsInPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setPacketsOut()

Generated from protobuf field <code>uint64 packets_out = 10;</code>

public setPacketsOut(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setPacketsOutPerSec()

Generated from protobuf field <code>float packets_out_per_sec = 15 [deprecated = true];</code>

public setPacketsOutPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setParticipantRtcCanceled()

Generated from protobuf field <code>uint64 participant_rtc_canceled = 53;</code>

public setParticipantRtcCanceled(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setParticipantRtcConnected()

Generated from protobuf field <code>uint64 participant_rtc_connected = 44;</code>

public setParticipantRtcConnected(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setParticipantRtcConnectedPerSec()

Generated from protobuf field <code>float participant_rtc_connected_per_sec = 45 [deprecated = true];</code>

public setParticipantRtcConnectedPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setParticipantRtcInit()

Generated from protobuf field <code>uint64 participant_rtc_init = 46;</code>

public setParticipantRtcInit(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setParticipantRtcInitPerSec()

Generated from protobuf field <code>float participant_rtc_init_per_sec = 47 [deprecated = true];</code>

public setParticipantRtcInitPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setParticipantSignalConnected()

participant joins

public setParticipantSignalConnected(int|string $var) : $this

Generated from protobuf field uint64 participant_signal_connected = 26;

Parameters
$var : int|string
Return values
$this

setParticipantSignalConnectedPerSec()

Generated from protobuf field <code>float participant_signal_connected_per_sec = 27 [deprecated = true];</code>

public setParticipantSignalConnectedPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setRates()

Generated from protobuf field <code>repeated .livekit.NodeStatsRate rates = 50;</code>

public setRates(array<string|int, NodeStatsRate> $var) : $this
Parameters
$var : array<string|int, NodeStatsRate>
Return values
$this

setRetransmitBytesOut()

retransmissions

public setRetransmitBytesOut(int|string $var) : $this

Generated from protobuf field uint64 retransmit_bytes_out = 22;

Parameters
$var : int|string
Return values
$this

setRetransmitBytesOutPerSec()

Generated from protobuf field <code>float retransmit_bytes_out_per_sec = 24 [deprecated = true];</code>

public setRetransmitBytesOutPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setRetransmitPacketsOut()

Generated from protobuf field <code>uint64 retransmit_packets_out = 23;</code>

public setRetransmitPacketsOut(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setRetransmitPacketsOutPerSec()

Generated from protobuf field <code>float retransmit_packets_out_per_sec = 25 [deprecated = true];</code>

public setRetransmitPacketsOutPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setStartedAt()

when server was started

public setStartedAt(int|string $var) : $this

Generated from protobuf field int64 started_at = 1;

Parameters
$var : int|string
Return values
$this

setSysPacketsDropped()

Generated from protobuf field <code>uint32 sys_packets_dropped = 29;</code>

public setSysPacketsDropped(int $var) : $this
Parameters
$var : int
Return values
$this

setSysPacketsDroppedPctPerSec()

Generated from protobuf field <code>float sys_packets_dropped_pct_per_sec = 32 [deprecated = true];</code>

public setSysPacketsDroppedPctPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setSysPacketsDroppedPerSec()

Generated from protobuf field <code>float sys_packets_dropped_per_sec = 31 [deprecated = true];</code>

public setSysPacketsDroppedPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setSysPacketsOut()

Generated from protobuf field <code>uint32 sys_packets_out = 28;</code>

public setSysPacketsOut(int $var) : $this
Parameters
$var : int
Return values
$this

setSysPacketsOutPerSec()

Generated from protobuf field <code>float sys_packets_out_per_sec = 30 [deprecated = true];</code>

public setSysPacketsOutPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setTrackPublishAttemptsPerSec()

Generated from protobuf field <code>float track_publish_attempts_per_sec = 37 [deprecated = true];</code>

public setTrackPublishAttemptsPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setTrackPublishSuccessPerSec()

Generated from protobuf field <code>float track_publish_success_per_sec = 39 [deprecated = true];</code>

public setTrackPublishSuccessPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setTrackSubscribeAttemptsPerSec()

Generated from protobuf field <code>float track_subscribe_attempts_per_sec = 41 [deprecated = true];</code>

public setTrackSubscribeAttemptsPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setTrackSubscribeSuccessPerSec()

Generated from protobuf field <code>float track_subscribe_success_per_sec = 43 [deprecated = true];</code>

public setTrackSubscribeSuccessPerSec(float $var) : $this
Parameters
$var : float
Return values
$this

setUpdatedAt()

when server last reported its status

public setUpdatedAt(int|string $var) : $this

Generated from protobuf field int64 updated_at = 2;

Parameters
$var : int|string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results