telemetry

Documentation

Index

• Constants
• func GetRttMs(packet *rtcp.ReceiverReport) int64
• func NtpToTimeMicros(val NtpTime) int64
• func SaturatedUsToCompactNtp(us int64) uint32
• type AnalyticsService
  • func NewAnalyticsService(_ *config.Config, currentNode routing.LocalNode) AnalyticsService
• type NtpTime
  • func NtpCompactToTime(val uint32) NtpTime
  • func TimeMicrosToNtp(time_us int64) *NtpTime
  • func (n *NtpTime) Compact() uint32
  • func (n *NtpTime) FromCompact(val uint32)
  • func (n *NtpTime) Ntp() uint64
  • func (n *NtpTime) Set(val uint64)
• type Stats
• type StatsWorker
  • func (s *StatsWorker) AddBuffer(trackID livekit.TrackID, buffer *buffer.Buffer)
  • func (s *StatsWorker) Close()
  • func (s *StatsWorker) OnDownstreamPacket(trackID livekit.TrackID, bytes int)
  • func (s *StatsWorker) OnRTCP(trackID livekit.TrackID, direction livekit.StreamType, ...)
  • func (s *StatsWorker) RemoveBuffer(trackID livekit.TrackID)
  • func (s *StatsWorker) Update()
• type TelemetryReporter
• type TelemetryService
  • func NewTelemetryService(notifier webhook.Notifier, analytics AnalyticsService) TelemetryService
• type TelemetryServiceInternal
  • func NewTelemetryServiceInternal(notifier webhook.Notifier, analytics AnalyticsService) TelemetryServiceInternal

Constants

const (
	NanoSecondsInMicroSecond        = 1000
	MicroSecondsInSecond     int64  = 1000000
	NtpJan1970Sec            int64  = 2208988800
	MaxCompactNtp            uint32 = 0xFFFFFFFF
	CompactNtpInSecond       int64  = 0x10000
	NtpInSecond              int64  = 1 << 32
)

Functions

func GetRttMs

func GetRttMs(packet *rtcp.ReceiverReport) int64

func NtpToTimeMicros

func NtpToTimeMicros(val NtpTime) int64

func SaturatedUsToCompactNtp

func SaturatedUsToCompactNtp(us int64) uint32

SaturatedUsToCompactNtp convert us to rtp compact ntptime field (from webrtc)

Types

type AnalyticsService

type AnalyticsService interface {
	SendStats(ctx context.Context, stats []*livekit.AnalyticsStat)
	SendEvent(ctx context.Context, events *livekit.AnalyticsEvent)
}

func NewAnalyticsService

func NewAnalyticsService(_ *config.Config, currentNode routing.LocalNode) AnalyticsService

type NtpTime

type NtpTime struct {
	// contains filtered or unexported fields
}

NtpTime represents ntp time in rtp

func NtpCompactToTime

func NtpCompactToTime(val uint32) NtpTime

func TimeMicrosToNtp

func TimeMicrosToNtp(time_us int64) *NtpTime

TimeMicrosToNtp convert us to NtpTime (from webrtc)

func (*NtpTime) Compact

func (n *NtpTime) Compact() uint32

Compact convert ntptime to rtp compact ntptime field (middle 32 bit, uint32)

func (*NtpTime) FromCompact

func (n *NtpTime) FromCompact(val uint32)

FromCompact set ntp fields from compact ntp filed(32bit)

func (*NtpTime) Ntp

func (n *NtpTime) Ntp() uint64

Ntp return rtp ntptime field

func (*NtpTime) Set

func (n *NtpTime) Set(val uint64)

Set set ntptime from rtp's ntptime field (uint64)

type Stats

type Stats struct {
	// contains filtered or unexported fields
}

type StatsWorker

type StatsWorker struct {
	// contains filtered or unexported fields
}

StatsWorker handles participant stats

func (*StatsWorker) AddBuffer

func (s *StatsWorker) AddBuffer(trackID livekit.TrackID, buffer *buffer.Buffer)

func (*StatsWorker) Close

func (s *StatsWorker) Close()

func (*StatsWorker) OnDownstreamPacket

func (s *StatsWorker) OnDownstreamPacket(trackID livekit.TrackID, bytes int)

func (*StatsWorker) OnRTCP

func (s *StatsWorker) OnRTCP(trackID livekit.TrackID, direction livekit.StreamType, stats *livekit.AnalyticsStat)

func (*StatsWorker) RemoveBuffer

func (s *StatsWorker) RemoveBuffer(trackID livekit.TrackID)

func (*StatsWorker) Update

func (s *StatsWorker) Update()

type TelemetryReporter

type TelemetryReporter interface {
	Report(ctx context.Context, stats []*livekit.AnalyticsStat)
}

type TelemetryService

type TelemetryService interface {
	// stats
	AddUpTrack(participantID livekit.ParticipantID, trackID livekit.TrackID, buff *buffer.Buffer)
	OnDownstreamPacket(participantID livekit.ParticipantID, trackID livekit.TrackID, bytes int)
	HandleRTCP(streamType livekit.StreamType, participantID livekit.ParticipantID, trackID livekit.TrackID, pkts []rtcp.Packet)

	// events
	RoomStarted(ctx context.Context, room *livekit.Room)
	RoomEnded(ctx context.Context, room *livekit.Room)
	ParticipantJoined(ctx context.Context, room *livekit.Room, participant *livekit.ParticipantInfo, clientInfo *livekit.ClientInfo)
	ParticipantLeft(ctx context.Context, room *livekit.Room, participant *livekit.ParticipantInfo)
	TrackPublished(ctx context.Context, participantID livekit.ParticipantID, track *livekit.TrackInfo)
	TrackUnpublished(ctx context.Context, participantID livekit.ParticipantID, track *livekit.TrackInfo, ssrc uint32)
	TrackSubscribed(ctx context.Context, participantID livekit.ParticipantID, track *livekit.TrackInfo)
	TrackUnsubscribed(ctx context.Context, participantID livekit.ParticipantID, track *livekit.TrackInfo)
	RecordingStarted(ctx context.Context, ri *livekit.RecordingInfo)
	RecordingEnded(ctx context.Context, ri *livekit.RecordingInfo)
}

func NewTelemetryService

func NewTelemetryService(notifier webhook.Notifier, analytics AnalyticsService) TelemetryService

type TelemetryServiceInternal

type TelemetryServiceInternal interface {
	TelemetryService
	SendAnalytics()
}

func NewTelemetryServiceInternal

func NewTelemetryServiceInternal(notifier webhook.Notifier, analytics AnalyticsService) TelemetryServiceInternal