-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathrecording.go
More file actions
397 lines (340 loc) · 8.93 KB
/
recording.go
File metadata and controls
397 lines (340 loc) · 8.93 KB
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
package opik
import (
"context"
"sync"
"time"
"github.com/google/uuid"
)
// RecordedTrace represents a trace captured during local recording.
type RecordedTrace struct {
ID string
Name string
StartTime time.Time
EndTime time.Time
Input any
Output any
Metadata map[string]any
Tags []string
Spans []*RecordedSpan
Feedback []*RecordedFeedback
}
// RecordedSpan represents a span captured during local recording.
type RecordedSpan struct {
ID string
TraceID string
ParentSpanID string
Name string
Type string
StartTime time.Time
EndTime time.Time
Input any
Output any
Metadata map[string]any
Tags []string
Model string
Provider string
Children []*RecordedSpan
Feedback []*RecordedFeedback
}
// RecordedFeedback represents a feedback score captured during local recording.
type RecordedFeedback struct {
Name string
Value float64
Reason string
}
// LocalRecording captures traces and spans locally without sending to the server.
type LocalRecording struct {
mu sync.RWMutex
traces map[string]*RecordedTrace
spans map[string]*RecordedSpan
feedback []RecordedFeedback
}
// NewLocalRecording creates a new local recording storage.
func NewLocalRecording() *LocalRecording {
return &LocalRecording{
traces: make(map[string]*RecordedTrace),
spans: make(map[string]*RecordedSpan),
}
}
// AddTrace adds a trace to the recording.
func (r *LocalRecording) AddTrace(trace *RecordedTrace) {
r.mu.Lock()
defer r.mu.Unlock()
r.traces[trace.ID] = trace
}
// AddSpan adds a span to the recording.
func (r *LocalRecording) AddSpan(span *RecordedSpan) {
r.mu.Lock()
defer r.mu.Unlock()
r.spans[span.ID] = span
// Also add to parent trace
if trace, ok := r.traces[span.TraceID]; ok {
if span.ParentSpanID == "" {
trace.Spans = append(trace.Spans, span)
}
}
// Add to parent span if exists
if span.ParentSpanID != "" {
if parent, ok := r.spans[span.ParentSpanID]; ok {
parent.Children = append(parent.Children, span)
}
}
}
// AddFeedback adds feedback to the recording.
func (r *LocalRecording) AddFeedback(entityID string, feedback RecordedFeedback) {
r.mu.Lock()
defer r.mu.Unlock()
// Try trace first
if trace, ok := r.traces[entityID]; ok {
trace.Feedback = append(trace.Feedback, &feedback)
return
}
// Try span
if span, ok := r.spans[entityID]; ok {
span.Feedback = append(span.Feedback, &feedback)
return
}
// Store as orphan
r.feedback = append(r.feedback, feedback)
}
// Traces returns all recorded traces.
func (r *LocalRecording) Traces() []*RecordedTrace {
r.mu.RLock()
defer r.mu.RUnlock()
traces := make([]*RecordedTrace, 0, len(r.traces))
for _, t := range r.traces {
traces = append(traces, t)
}
return traces
}
// Spans returns all recorded spans.
func (r *LocalRecording) Spans() []*RecordedSpan {
r.mu.RLock()
defer r.mu.RUnlock()
spans := make([]*RecordedSpan, 0, len(r.spans))
for _, s := range r.spans {
spans = append(spans, s)
}
return spans
}
// GetTrace returns a specific trace by ID.
func (r *LocalRecording) GetTrace(id string) *RecordedTrace {
r.mu.RLock()
defer r.mu.RUnlock()
return r.traces[id]
}
// GetSpan returns a specific span by ID.
func (r *LocalRecording) GetSpan(id string) *RecordedSpan {
r.mu.RLock()
defer r.mu.RUnlock()
return r.spans[id]
}
// Clear clears all recorded data.
func (r *LocalRecording) Clear() {
r.mu.Lock()
defer r.mu.Unlock()
r.traces = make(map[string]*RecordedTrace)
r.spans = make(map[string]*RecordedSpan)
r.feedback = nil
}
// TraceCount returns the number of recorded traces.
func (r *LocalRecording) TraceCount() int {
r.mu.RLock()
defer r.mu.RUnlock()
return len(r.traces)
}
// SpanCount returns the number of recorded spans.
func (r *LocalRecording) SpanCount() int {
r.mu.RLock()
defer r.mu.RUnlock()
return len(r.spans)
}
// RecordingClient is a client that records traces locally instead of sending to server.
type RecordingClient struct {
recording *LocalRecording
project string
}
// NewRecordingClient creates a new recording client for local testing.
func NewRecordingClient(projectName string) *RecordingClient {
return &RecordingClient{
recording: NewLocalRecording(),
project: projectName,
}
}
// Recording returns the local recording storage.
func (c *RecordingClient) Recording() *LocalRecording {
return c.recording
}
// Trace creates a new trace and records it locally.
func (c *RecordingClient) Trace(ctx context.Context, name string, opts ...TraceOption) (*RecordingTrace, error) {
options := &traceOptions{
metadata: make(map[string]any),
}
for _, opt := range opts {
opt(options)
}
trace := &RecordedTrace{
ID: generateID(),
Name: name,
StartTime: time.Now(),
Input: options.input,
Metadata: options.metadata,
Tags: options.tags,
Spans: make([]*RecordedSpan, 0),
Feedback: make([]*RecordedFeedback, 0),
}
c.recording.AddTrace(trace)
return &RecordingTrace{
client: c,
trace: trace,
}, nil
}
// RecordingTrace is a trace that records locally.
type RecordingTrace struct {
client *RecordingClient
trace *RecordedTrace
}
// ID returns the trace ID.
func (t *RecordingTrace) ID() string {
return t.trace.ID
}
// Name returns the trace name.
func (t *RecordingTrace) Name() string {
return t.trace.Name
}
// End ends the trace.
func (t *RecordingTrace) End(ctx context.Context, opts ...TraceOption) error {
options := &traceOptions{}
for _, opt := range opts {
opt(options)
}
t.trace.EndTime = time.Now()
if options.output != nil {
t.trace.Output = options.output
}
return nil
}
// Span creates a new span under this trace.
func (t *RecordingTrace) Span(ctx context.Context, name string, opts ...SpanOption) (*RecordingSpan, error) {
options := &spanOptions{
spanType: SpanTypeGeneral,
metadata: make(map[string]any),
}
for _, opt := range opts {
opt(options)
}
span := &RecordedSpan{
ID: generateID(),
TraceID: t.trace.ID,
Name: name,
Type: options.spanType,
StartTime: time.Now(),
Input: options.input,
Metadata: options.metadata,
Tags: options.tags,
Model: options.model,
Provider: options.provider,
Children: make([]*RecordedSpan, 0),
Feedback: make([]*RecordedFeedback, 0),
}
t.client.recording.AddSpan(span)
return &RecordingSpan{
client: t.client,
span: span,
}, nil
}
// AddFeedbackScore adds a feedback score to this trace.
func (t *RecordingTrace) AddFeedbackScore(ctx context.Context, name string, value float64, reason string) error {
t.client.recording.AddFeedback(t.trace.ID, RecordedFeedback{
Name: name,
Value: value,
Reason: reason,
})
return nil
}
// RecordingSpan is a span that records locally.
type RecordingSpan struct {
client *RecordingClient
span *RecordedSpan
}
// ID returns the span ID.
func (s *RecordingSpan) ID() string {
return s.span.ID
}
// TraceID returns the trace ID.
func (s *RecordingSpan) TraceID() string {
return s.span.TraceID
}
// Name returns the span name.
func (s *RecordingSpan) Name() string {
return s.span.Name
}
// End ends the span.
func (s *RecordingSpan) End(ctx context.Context, opts ...SpanOption) error {
options := &spanOptions{}
for _, opt := range opts {
opt(options)
}
s.span.EndTime = time.Now()
if options.output != nil {
s.span.Output = options.output
}
return nil
}
// Span creates a child span.
func (s *RecordingSpan) Span(ctx context.Context, name string, opts ...SpanOption) (*RecordingSpan, error) {
options := &spanOptions{
spanType: SpanTypeGeneral,
metadata: make(map[string]any),
}
for _, opt := range opts {
opt(options)
}
span := &RecordedSpan{
ID: generateID(),
TraceID: s.span.TraceID,
ParentSpanID: s.span.ID,
Name: name,
Type: options.spanType,
StartTime: time.Now(),
Input: options.input,
Metadata: options.metadata,
Tags: options.tags,
Model: options.model,
Provider: options.provider,
Children: make([]*RecordedSpan, 0),
Feedback: make([]*RecordedFeedback, 0),
}
s.client.recording.AddSpan(span)
return &RecordingSpan{
client: s.client,
span: span,
}, nil
}
// AddFeedbackScore adds a feedback score to this span.
func (s *RecordingSpan) AddFeedbackScore(ctx context.Context, name string, value float64, reason string) error {
s.client.recording.AddFeedback(s.span.ID, RecordedFeedback{
Name: name,
Value: value,
Reason: reason,
})
return nil
}
// Helper function to generate IDs
func generateID() string {
return generateUUID()
}
func generateUUID() string {
return uuid.New().String()
}
// RecordTracesLocally returns a recording client for local testing.
// Usage:
//
// client := opik.RecordTracesLocally("my-project")
// trace, _ := client.Trace(ctx, "test-trace")
// // ... do work ...
// trace.End(ctx)
// traces := client.Recording().Traces()
func RecordTracesLocally(projectName string) *RecordingClient {
return NewRecordingClient(projectName)
}