metric

Documentation

Index

• Variables
• type MetricConfig
• type MetricTimestamper
  • func NewMetricTimestamper(params MetricTimestamperParams) *MetricTimestamper
  • func (m *MetricTimestamper) Process(batch *livekit.MetricsBatch)
• type MetricTimestamperConfig
• type MetricTimestamperParams
• type MetricsCollector
  • func NewMetricsCollector(params MetricsCollectorParams) *MetricsCollector
  • func (mc *MetricsCollector) AddPublisherRTT(participantIdentity livekit.ParticipantIdentity, rtt float32)
  • func (mc *MetricsCollector) AddRelayRTT(participantIdentity livekit.ParticipantIdentity, rtt float32)
  • func (mc *MetricsCollector) AddSubscriberRTT(rtt float32)
  • func (mc *MetricsCollector) Stop()
• type MetricsCollectorConfig
• type MetricsCollectorParams
• type MetricsCollectorProvider
• type MetricsReporter
  • func NewMetricsReporter(params MetricsReporterParams) *MetricsReporter
  • func (mr *MetricsReporter) Merge(other *livekit.MetricsBatch)
  • func (mr *MetricsReporter) Stop()
• type MetricsReporterConfig
• type MetricsReporterConsumer
• type MetricsReporterParams

Variables

var (
	DefaultMetricConfig = MetricConfig{
		Timestamper: DefaultMetricTimestamperConfig,
		Collector:   DefaultMetricsCollectorConfig,
		Reporter:    DefaultMetricsReporterConfig,
	}
)

var (
	DefaultMetricTimestamperConfig = MetricTimestamperConfig{
		OneWayDelayEstimatorMinInterval: 5 * time.Second,
		OneWayDelayEstimatorMaxBatch:    100,
	}
)

var (
	DefaultMetricsCollectorConfig = MetricsCollectorConfig{
		SamplingIntervalMs: 3 * 1000,
		BatchIntervalMs:    10 * 1000,
	}
)

var (
	DefaultMetricsReporterConfig = MetricsReporterConfig{
		ReportingIntervalMs: 10 * 1000,
	}
)

Types

type MetricConfig

type MetricConfig struct {
	Timestamper MetricTimestamperConfig `yaml:"timestamper_config,omitempty"`
	Collector   MetricsCollectorConfig  `yaml:"collector,omitempty"`
	Reporter    MetricsReporterConfig   `yaml:"reporter,omitempty"`
}

type MetricTimestamper

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

func NewMetricTimestamper

func NewMetricTimestamper(params MetricTimestamperParams) *MetricTimestamper

func (*MetricTimestamper) Process

func (m *MetricTimestamper) Process(batch *livekit.MetricsBatch)

type MetricTimestamperConfig

type MetricTimestamperConfig struct {
	OneWayDelayEstimatorMinInterval time.Duration `yaml:"one_way_delay_estimator_min_interval,omitempty"`
	OneWayDelayEstimatorMaxBatch    int           `yaml:"one_way_delay_estimator_max_batch,omitempty"`
}

type MetricTimestamperParams

type MetricTimestamperParams struct {
	Config MetricTimestamperConfig
	Logger logger.Logger
}

type MetricsCollector

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

func NewMetricsCollector

func NewMetricsCollector(params MetricsCollectorParams) *MetricsCollector

func (*MetricsCollector) AddPublisherRTT

func (mc *MetricsCollector) AddPublisherRTT(participantIdentity livekit.ParticipantIdentity, rtt float32)

func (*MetricsCollector) AddRelayRTT

func (mc *MetricsCollector) AddRelayRTT(participantIdentity livekit.ParticipantIdentity, rtt float32)

func (*MetricsCollector) AddSubscriberRTT

func (mc *MetricsCollector) AddSubscriberRTT(rtt float32)

func (*MetricsCollector) Stop

func (mc *MetricsCollector) Stop()

type MetricsCollectorConfig

type MetricsCollectorConfig struct {
	SamplingIntervalMs uint32 `yaml:"sampling_interval_ms,omitempty" json:"sampling_interval_ms,omitempty"`
	BatchIntervalMs    uint32 `yaml:"batch_interval_ms,omitempty" json:"batch_interval_ms,omitempty"`
}

type MetricsCollectorParams

type MetricsCollectorParams struct {
	ParticipantIdentity livekit.ParticipantIdentity
	Config              MetricsCollectorConfig
	Provider            MetricsCollectorProvider
	Logger              logger.Logger
}

type MetricsCollectorProvider

type MetricsCollectorProvider interface {
	MetricsCollectorTimeToCollectMetrics()
	MetricsCollectorBatchReady(mb *livekit.MetricsBatch)
}

type MetricsReporter

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

func NewMetricsReporter

func NewMetricsReporter(params MetricsReporterParams) *MetricsReporter

func (*MetricsReporter) Merge

func (mr *MetricsReporter) Merge(other *livekit.MetricsBatch)

func (*MetricsReporter) Stop

func (mr *MetricsReporter) Stop()

type MetricsReporterConfig

type MetricsReporterConfig struct {
	ReportingIntervalMs uint32 `yaml:"reporting_interval_ms,omitempty" json:"reporting_interval_ms,omitempty"`
}

type MetricsReporterConsumer

type MetricsReporterConsumer interface {
	MetricsReporterBatchReady(mb *livekit.MetricsBatch)
}

type MetricsReporterParams

type MetricsReporterParams struct {
	ParticipantIdentity livekit.ParticipantIdentity
	Config              MetricsReporterConfig
	Consumer            MetricsReporterConsumer
	Logger              logger.Logger
}