livekit-protocol 0.8.2

Livekit protocol and utilities for the Rust SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

package logger

import (
	"io"
	"testing"

	"go.uber.org/zap/zapcore"

	"github.com/livekit/protocol/logger/testutil"
	"github.com/livekit/protocol/logger/zaputil"
	"github.com/livekit/protocol/utils/must"
)

var benchSink Logger

type loggerBenchCase struct {
	label string
	conf  *Config
	opts  []ZapLoggerOption
}

func (c loggerBenchCase) logger(b *testing.B) ZapLogger {
	b.Helper()
	return must.Get(NewZapLogger(c.conf, c.opts...))
}

func derivationBenchCases() []loggerBenchCase {
	return []loggerBenchCase{
		{label: "console", conf: &Config{}},
		{label: "json", conf: &Config{JSON: true}},
		{label: "console tee", conf: &Config{}, opts: withDiscardTee()},
		{label: "json tee", conf: &Config{JSON: true}, opts: withDiscardTee()},
	}
}

func withDiscardTee() []ZapLoggerOption {
	return []ZapLoggerOption{WithTee(zaputil.NewTee(testutil.NewJSONCoreFactory(zapcore.AddSync(io.Discard))))}
}

func BenchmarkLoggerWithComponent(b *testing.B) {
	for _, c := range derivationBenchCases() {
		b.Run(c.label, func(b *testing.B) {
			root := c.logger(b)
			branch := root.WithComponentLeveler(zaputil.NewComponentLeveler(root.Leveler(), FixedComponentLevel(zapcore.DebugLevel)))

			// One repeated component, so this measures the cache rather than resolution.
			b.Run("root", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					benchSink = root.WithComponent("rtc")
				}
			})

			b.Run("branch leveler", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					benchSink = branch.WithComponent("rtc")
				}
			})
		})
	}
}

func BenchmarkLoggerWithComponentLeveler(b *testing.B) {
	for _, c := range derivationBenchCases() {
		b.Run(c.label, func(b *testing.B) {
			root := c.logger(b)
			lv := zaputil.NewComponentLeveler(root.Leveler(), FixedComponentLevel(zapcore.DebugLevel))

			b.ReportAllocs()
			for range b.N {
				benchSink = root.WithComponentLeveler(lv)
			}
		})
	}
}

func BenchmarkLoggerWithValues(b *testing.B) {
	for _, c := range derivationBenchCases() {
		b.Run(c.label, func(b *testing.B) {
			root := c.logger(b)

			b.Run("root", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					benchSink = root.WithValues("participant", "PA_1234")
				}
			})

			b.Run("derived", func(b *testing.B) {
				derived := root.WithValues("room", "RM_1234")
				b.ReportAllocs()
				for range b.N {
					benchSink = derived.WithValues("participant", "PA_1234")
				}
			})
		})
	}
}

func BenchmarkLoggerWithDeferredValues(b *testing.B) {
	for _, c := range derivationBenchCases() {
		b.Run(c.label, func(b *testing.B) {
			root := c.logger(b)

			b.Run("derive", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					benchSink, _ = root.WithDeferredValues()
				}
			})

			b.Run("derive and resolve", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					l, resolver := root.WithDeferredValues()
					resolver.Resolve("participant", "PA_1234")
					benchSink = l
				}
			})
		})
	}
}

func BenchmarkLoggerWrite(b *testing.B) {
	silenceStderr(b)

	cases := []loggerBenchCase{
		{label: "console", conf: &Config{Level: "debug"}},
		{label: "json", conf: &Config{JSON: true, Level: "debug"}},
		{label: "level disabled", conf: &Config{Level: "info"}},
		{label: "console tee", conf: &Config{Level: "debug"}, opts: withDiscardTee()},
		{label: "json tee", conf: &Config{JSON: true, Level: "debug"}, opts: withDiscardTee()},
	}

	for _, c := range cases {
		b.Run(c.label, func(b *testing.B) {
			root := c.logger(b)

			b.Run("plain", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					root.Debugw("bench", "participant", "PA_1234")
				}
			})

			b.Run("deferred", func(b *testing.B) {
				l, resolver := root.WithDeferredValues()
				resolver.Resolve("room", "RM_1234")
				b.ReportAllocs()
				for range b.N {
					l.Debugw("bench", "participant", "PA_1234")
				}
			})

			b.Run("deferred flush", func(b *testing.B) {
				b.ReportAllocs()
				for range b.N {
					l, resolver := root.WithDeferredValues()
					l.Debugw("bench", "participant", "PA_1234")
					resolver.Resolve("room", "RM_1234")
				}
			})
		})
	}
}