mirror of
https://github.com/hanzoai/livekit.git
synced 2026-10-30 18:29:34 +00:00
zeekay
f143a420ac
This repo did not compile, and had not before any of the KV work: at the commit prior to it, `go build ./...` failed identically in pkg/telemetry/prometheus. That failure masked every package downstream of it, which is why the KV rename could only be type-checked in isolation. The telemetry code was written against an older luxfi/metric API: metric.CounterVec/HistogramVec/GaugeVec are INTERFACES, but 28 declarations said *metric.X — a pointer to an interface, which nothing satisfies. metric.MustRegister does not exist, and is not needed: NewHistogramVec and friends already register into DefaultRegistry at construction. 36 calls removed. metric.ExponentialBucketsRange does not exist; the bucket helper comes from prometheus/client_golang. rpc.InitPSRPCStats / webhook.InitWebhookStats come from livekit/protocol and take prometheus.Labels, not metric.Labels. Those two call sites now pass the type the upstream signature actually declares. metric.DefaultGatherer does not exist. Replaced with metric.DefaultRegistry, which satisfies Gatherer (Registry embeds it). NOT metric.Handler() — that wraps a FRESH NewRegistry(), so the endpoint would have served zero metrics while looking healthy. `go build ./...` and `go vet ./pkg/...` now pass.
262 lines
8.2 KiB
Go
262 lines
8.2 KiB
Go
// Copyright 2023 LiveKit, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package prometheus
|
|
|
|
import (
|
|
"strconv"
|
|
"time"
|
|
|
|
metric "github.com/luxfi/metric"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"go.uber.org/atomic"
|
|
|
|
"github.com/livekit/protocol/livekit"
|
|
)
|
|
|
|
var (
|
|
roomCurrent atomic.Int32
|
|
participantCurrent atomic.Int32
|
|
trackPublishedCurrent atomic.Int32
|
|
trackSubscribedCurrent atomic.Int32
|
|
trackPublishAttempts atomic.Int32
|
|
trackPublishSuccess atomic.Int32
|
|
trackPublishCancels atomic.Int32
|
|
trackSubscribeAttempts atomic.Int32
|
|
trackSubscribeSuccess atomic.Int32
|
|
trackSubscribeCancels atomic.Int32
|
|
// count the number of failures that are due to user error (permissions, track doesn't exist), so we could compute
|
|
// success rate by subtracting this from total attempts
|
|
trackSubscribeUserError atomic.Int32
|
|
|
|
promRoomCurrent metric.Gauge
|
|
promRoomDuration metric.Histogram
|
|
promParticipantCurrent metric.Gauge
|
|
promTrackPublishedCurrent metric.GaugeVec
|
|
promTrackSubscribedCurrent metric.GaugeVec
|
|
promTrackPublishCounter metric.CounterVec
|
|
promTrackSubscribeCounter metric.CounterVec
|
|
promSessionStartTime metric.HistogramVec
|
|
promSessionDuration metric.HistogramVec
|
|
promPubSubTime metric.HistogramVec
|
|
)
|
|
|
|
func initRoomStats(nodeID string, nodeType livekit.NodeType) {
|
|
promRoomCurrent = metric.NewGauge(metric.GaugeOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "room",
|
|
Name: "total",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
})
|
|
promRoomDuration = metric.NewHistogram(metric.HistogramOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "room",
|
|
Name: "duration_seconds",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
Buckets: []float64{
|
|
5, 10, 60, 5 * 60, 10 * 60, 30 * 60, 60 * 60, 2 * 60 * 60, 5 * 60 * 60, 10 * 60 * 60,
|
|
},
|
|
})
|
|
promParticipantCurrent = metric.NewGauge(metric.GaugeOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "participant",
|
|
Name: "total",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
})
|
|
promTrackPublishedCurrent = metric.NewGaugeVec(metric.GaugeOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "track",
|
|
Name: "published_total",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
}, []string{"kind"})
|
|
promTrackSubscribedCurrent = metric.NewGaugeVec(metric.GaugeOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "track",
|
|
Name: "subscribed_total",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
}, []string{"kind"})
|
|
promTrackPublishCounter = metric.NewCounterVec(metric.CounterOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "track",
|
|
Name: "publish_counter",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
}, []string{"kind", "state"})
|
|
promTrackSubscribeCounter = metric.NewCounterVec(metric.CounterOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "track",
|
|
Name: "subscribe_counter",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
}, []string{"state", "error"})
|
|
promSessionStartTime = metric.NewHistogramVec(metric.HistogramOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "session",
|
|
Name: "start_time_ms",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
Buckets: prometheus.ExponentialBucketsRange(100, 10000, 15),
|
|
}, []string{"protocol_version"})
|
|
promSessionDuration = metric.NewHistogramVec(metric.HistogramOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "session",
|
|
Name: "duration_ms",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
Buckets: prometheus.ExponentialBucketsRange(100, 4*60*60*1000, 15),
|
|
}, []string{"protocol_version"})
|
|
promPubSubTime = metric.NewHistogramVec(metric.HistogramOpts{
|
|
Namespace: livekitNamespace,
|
|
Subsystem: "pubsubtime",
|
|
Name: "ms",
|
|
ConstLabels: metric.Labels{"node_id": nodeID, "node_type": nodeType.String()},
|
|
Buckets: []float64{100, 200, 500, 700, 1000, 5000, 10000},
|
|
}, append(promStreamLabels, "sdk", "kind", "count"))
|
|
}
|
|
|
|
func RoomStarted() {
|
|
promRoomCurrent.Add(1)
|
|
roomCurrent.Inc()
|
|
}
|
|
|
|
func RoomEnded(startedAt time.Time) {
|
|
if !startedAt.IsZero() {
|
|
promRoomDuration.Observe(float64(time.Since(startedAt)) / float64(time.Second))
|
|
}
|
|
promRoomCurrent.Sub(1)
|
|
roomCurrent.Dec()
|
|
}
|
|
|
|
func AddParticipant() {
|
|
promParticipantCurrent.Add(1)
|
|
participantCurrent.Inc()
|
|
}
|
|
|
|
func SubParticipant() {
|
|
promParticipantCurrent.Sub(1)
|
|
participantCurrent.Dec()
|
|
}
|
|
|
|
func AddPublishedTrack(kind string) {
|
|
promTrackPublishedCurrent.WithLabelValues(kind).Add(1)
|
|
trackPublishedCurrent.Inc()
|
|
}
|
|
|
|
func SubPublishedTrack(kind string) {
|
|
promTrackPublishedCurrent.WithLabelValues(kind).Sub(1)
|
|
trackPublishedCurrent.Dec()
|
|
}
|
|
|
|
func RecordTrackPublishAttempt(kind string) {
|
|
trackPublishAttempts.Inc()
|
|
promTrackPublishCounter.WithLabelValues(kind, "attempt").Inc()
|
|
}
|
|
|
|
func RecordTrackPublishSuccess(kind string) {
|
|
trackPublishSuccess.Inc()
|
|
promTrackPublishCounter.WithLabelValues(kind, "success").Inc()
|
|
}
|
|
|
|
func RecordTrackPublishCancels(kind string, numCancels int32) {
|
|
trackPublishCancels.Add(numCancels)
|
|
promTrackPublishCounter.WithLabelValues(kind, "cancel").Add(float64(numCancels))
|
|
}
|
|
|
|
func RecordPublishTime(
|
|
country string,
|
|
source livekit.TrackSource,
|
|
trackType livekit.TrackType,
|
|
d time.Duration,
|
|
sdk livekit.ClientInfo_SDK,
|
|
kind livekit.ParticipantInfo_Kind,
|
|
) {
|
|
recordPubSubTime(true, country, source, trackType, d, sdk, kind, 1)
|
|
}
|
|
|
|
func RecordSubscribeTime(
|
|
country string,
|
|
source livekit.TrackSource,
|
|
trackType livekit.TrackType,
|
|
d time.Duration,
|
|
sdk livekit.ClientInfo_SDK,
|
|
kind livekit.ParticipantInfo_Kind,
|
|
count int,
|
|
) {
|
|
recordPubSubTime(false, country, source, trackType, d, sdk, kind, count)
|
|
}
|
|
|
|
func recordPubSubTime(
|
|
isPublish bool,
|
|
country string,
|
|
source livekit.TrackSource,
|
|
trackType livekit.TrackType,
|
|
d time.Duration,
|
|
sdk livekit.ClientInfo_SDK,
|
|
kind livekit.ParticipantInfo_Kind,
|
|
count int,
|
|
) {
|
|
direction := "subscribe"
|
|
if isPublish {
|
|
direction = "publish"
|
|
}
|
|
promPubSubTime.WithLabelValues(
|
|
direction,
|
|
source.String(),
|
|
trackType.String(),
|
|
country,
|
|
sdk.String(),
|
|
kind.String(),
|
|
strconv.Itoa(count),
|
|
).Observe(float64(d.Milliseconds()))
|
|
}
|
|
|
|
func RecordTrackSubscribeSuccess(kind string) {
|
|
// modify both current and total counters
|
|
promTrackSubscribedCurrent.WithLabelValues(kind).Add(1)
|
|
trackSubscribedCurrent.Inc()
|
|
|
|
promTrackSubscribeCounter.WithLabelValues("success", "").Inc()
|
|
trackSubscribeSuccess.Inc()
|
|
}
|
|
|
|
func RecordTrackUnsubscribed(kind string) {
|
|
// unsubscribed modifies current counter, but we leave the total values alone since they
|
|
// are used to compute rate
|
|
promTrackSubscribedCurrent.WithLabelValues(kind).Sub(1)
|
|
trackSubscribedCurrent.Dec()
|
|
}
|
|
|
|
func RecordTrackSubscribeAttempt() {
|
|
trackSubscribeAttempts.Inc()
|
|
promTrackSubscribeCounter.WithLabelValues("attempt", "").Inc()
|
|
}
|
|
|
|
func RecordTrackSubscribeFailure(err error, isUserError bool) {
|
|
promTrackSubscribeCounter.WithLabelValues("failure", err.Error()).Inc()
|
|
|
|
if isUserError {
|
|
trackSubscribeUserError.Inc()
|
|
trackSubscribeCancels.Inc()
|
|
}
|
|
}
|
|
|
|
func RecordTrackSubscribeCancels(numCancels int32) {
|
|
trackSubscribeCancels.Add(numCancels)
|
|
promTrackSubscribeCounter.WithLabelValues("cancel", "").Add(float64(numCancels))
|
|
}
|
|
|
|
func RecordSessionStartTime(protocolVersion int, d time.Duration) {
|
|
promSessionStartTime.WithLabelValues(strconv.Itoa(protocolVersion)).Observe(float64(d.Milliseconds()))
|
|
}
|
|
|
|
func RecordSessionDuration(protocolVersion int, d time.Duration) {
|
|
promSessionDuration.WithLabelValues(strconv.Itoa(protocolVersion)).Observe(float64(d.Milliseconds()))
|
|
}
|