metrics

Documentation

Index

• func GetPlaybackMetricsRepresentation() int
• func GetStreamHealthOverview() *models.StreamHealthOverview
• func RegisterPlaybackErrorCount(clientID string, count float64)
• func RegisterPlayerBandwidth(clientID string, kbps float64)
• func RegisterPlayerLatency(clientID string, seconds float64)
• func RegisterPlayerSegmentDownloadDuration(clientID string, seconds float64)
• func RegisterQualityVariantChangesCount(clientID string, count float64)
• func Start(getStatus func() models.Status)
• type CollectedMetrics
  • func GetMetrics() *CollectedMetrics
• type TimestampedValue
  • func GetChatClientCountOverTime(start, end time.Time) []TimestampedValue
  • func GetMaxDownloadRateOverTime() []TimestampedValue
  • func GetMaximumDownloadDurationsOverTime() []TimestampedValue
  • func GetMaximumDownloadRateOverTime() []TimestampedValue
  • func GetMaximumLatencyOverTime() []TimestampedValue
  • func GetMedianDownloadDurationsOverTime() []TimestampedValue
  • func GetMedianDownloadRateOverTime() []TimestampedValue
  • func GetMedianLatencyOverTime() []TimestampedValue
  • func GetMinimumDownloadDurationsOverTime() []TimestampedValue
  • func GetMinimumDownloadRateOverTime() []TimestampedValue
  • func GetMinimumLatencyOverTime() []TimestampedValue
  • func GetPlaybackErrorCountOverTime() []TimestampedValue
  • func GetQualityVariantChangesOverTime() []TimestampedValue
  • func GetSlowestDownloadRateOverTime() []TimestampedValue
  • func GetViewersOverTime(start, end time.Time) []TimestampedValue

Functions

func GetPlaybackMetricsRepresentation

func GetPlaybackMetricsRepresentation() int

GetPlaybackMetricsRepresentation returns what percentage of all known players the metrics represent.

func GetStreamHealthOverview

func GetStreamHealthOverview() *models.StreamHealthOverview

GetStreamHealthOverview will return the stream health overview.

func RegisterPlaybackErrorCount

func RegisterPlaybackErrorCount(clientID string, count float64)

RegisterPlaybackErrorCount will add to the windowed playback error count.

func RegisterPlayerBandwidth

func RegisterPlayerBandwidth(clientID string, kbps float64)

RegisterPlayerBandwidth will add to the windowed playback bandwidth.

func RegisterPlayerLatency

func RegisterPlayerLatency(clientID string, seconds float64)

RegisterPlayerLatency will add to the windowed player latency values.

func RegisterPlayerSegmentDownloadDuration

func RegisterPlayerSegmentDownloadDuration(clientID string, seconds float64)

RegisterPlayerSegmentDownloadDuration will add to the windowed player segment download duration values.

func RegisterQualityVariantChangesCount

func RegisterQualityVariantChangesCount(clientID string, count float64)

RegisterQualityVariantChangesCount will add to the windowed quality variant change count.

func Start

func Start(getStatus func() models.Status)

Start will begin the metrics collection and alerting.

Types

type CollectedMetrics

type CollectedMetrics struct {
	DiskUtilizations []TimestampedValue `json:"disk"`

	RAMUtilizations []TimestampedValue `json:"memory"`

	CPUUtilizations []TimestampedValue `json:"cpu"`
	// contains filtered or unexported fields
}

CollectedMetrics stores different collected + timestamped values.

func GetMetrics

func GetMetrics() *CollectedMetrics

GetMetrics will return the collected metrics.

type TimestampedValue

type TimestampedValue struct {
	Time  time.Time `json:"time"`
	Value float64   `json:"value"`
}

TimestampedValue is a value with a timestamp.

func GetChatClientCountOverTime

func GetChatClientCountOverTime(start, end time.Time) []TimestampedValue

GetChatClientCountOverTime will return a window of connected chat clients over time.

func GetMaxDownloadRateOverTime

func GetMaxDownloadRateOverTime() []TimestampedValue

GetMaxDownloadRateOverTime will return the collected highest bandwidth values.

func GetMaximumDownloadDurationsOverTime

func GetMaximumDownloadDurationsOverTime() []TimestampedValue

GetMaximumDownloadDurationsOverTime will return a maximum durations errors over time.

func GetMaximumDownloadRateOverTime

func GetMaximumDownloadRateOverTime() []TimestampedValue

GetMaximumDownloadRateOverTime will return the collected maximum bandwidth values.

func GetMaximumLatencyOverTime

func GetMaximumLatencyOverTime() []TimestampedValue

GetMaximumLatencyOverTime will return the max latency values over time.

func GetMedianDownloadDurationsOverTime

func GetMedianDownloadDurationsOverTime() []TimestampedValue

GetMedianDownloadDurationsOverTime will return a window of durations errors over time.

func GetMedianDownloadRateOverTime

func GetMedianDownloadRateOverTime() []TimestampedValue

GetMedianDownloadRateOverTime will return the collected median bandwidth values.

func GetMedianLatencyOverTime

func GetMedianLatencyOverTime() []TimestampedValue

GetMedianLatencyOverTime will return the median latency values over time.

func GetMinimumDownloadDurationsOverTime

func GetMinimumDownloadDurationsOverTime() []TimestampedValue

GetMinimumDownloadDurationsOverTime will return a maximum durations errors over time.

func GetMinimumDownloadRateOverTime

func GetMinimumDownloadRateOverTime() []TimestampedValue

GetMinimumDownloadRateOverTime will return the collected minimum bandwidth values.

func GetMinimumLatencyOverTime

func GetMinimumLatencyOverTime() []TimestampedValue

GetMinimumLatencyOverTime will return the min latency values over time.

func GetPlaybackErrorCountOverTime

func GetPlaybackErrorCountOverTime() []TimestampedValue

GetPlaybackErrorCountOverTime will return a window of playback errors over time.

func GetQualityVariantChangesOverTime

func GetQualityVariantChangesOverTime() []TimestampedValue

GetQualityVariantChangesOverTime will return the collected quality variant changes.

func GetSlowestDownloadRateOverTime

func GetSlowestDownloadRateOverTime() []TimestampedValue

GetSlowestDownloadRateOverTime will return the collected lowest bandwidth values over time.

func GetViewersOverTime

func GetViewersOverTime(start, end time.Time) []TimestampedValue

GetViewersOverTime will return a window of viewer counts over time.