summaryrefslogtreecommitdiff
path: root/internal/controlplane/usage.go
blob: 05bc155da5494ae750d8f12682b3d4959b4c1e0d (plain)
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
package controlplane

import (
	"context"
	"encoding/base64"
	"encoding/json"
	"errors"
	"fmt"
	"strings"
	"time"

	"aigw/internal/domain"

	"github.com/jackc/pgx/v5"
)

type UsageQuery struct {
	TenantID  string
	ProjectID string
	KeyID     string
	Model     string
	Provider  string
	Protocol  string
	ErrorType string
	Stream    *bool
	RequestID string
	Status    string
	From      time.Time
	To        time.Time
	Limit     int
	Cursor    string
}

var ErrInvalidUsageCursor = errors.New("invalid usage cursor")

type usageCursor struct {
	StartedAt time.Time `json:"started_at"`
	RequestID string    `json:"request_id"`
}

func (s *Store) RecordUsage(ctx context.Context, event domain.UsageEvent) error {
	tx, err := s.db.Begin(ctx)
	if err != nil {
		return fmt.Errorf("begin usage record: %w", err)
	}
	defer tx.Rollback(ctx)
	command, err := tx.Exec(ctx, `
		INSERT INTO usage_events (
			request_id, tenant_id, project_id, key_id, public_model, provider_id, upstream_model,
			protocol, stream, status_code, success, error_type, attempts, started_at, duration_ms,
			ttft_ms, input_tokens, output_tokens, total_tokens, cache_creation_input_tokens, cache_read_input_tokens,
			cost_micros, charged_micros, uncollected_micros, usage_reported, metering_status)
		VALUES ($1,$2,$3,$4,$5,NULLIF($6,''),NULLIF($7,''),$8,$9,$10,$11,$12,$13,$14,$15,$16,$17,$18,$19,$20,$21,0,0,0,$22,$23)
		ON CONFLICT (request_id) DO NOTHING`, event.RequestID, event.TenantID, event.ProjectID, event.KeyID,
		event.PublicModel, event.ProviderID, event.UpstreamModel, string(event.Protocol), event.Stream,
		event.StatusCode, event.Success, event.ErrorType, event.Attempts, event.StartedAt, event.DurationMS,
		event.TTFTMS, event.Usage.InputTokens, event.Usage.OutputTokens, event.Usage.TotalTokens,
		event.Usage.CacheCreationInputTokens, event.Usage.CacheReadInputTokens, event.UsageReported, usageMeteringStatus(event))
	if err != nil {
		return fmt.Errorf("persist usage event: %w", err)
	}
	if _, err := tx.Exec(ctx, `UPDATE api_keys
		SET last_used_at = GREATEST(COALESCE(last_used_at, $2), $2)
		WHERE id = $1`, event.KeyID, event.StartedAt); err != nil {
		return fmt.Errorf("update API key last used time: %w", err)
	}
	if command.RowsAffected() == 0 {
		return tx.Commit(ctx)
	}
	if err := upsertUsageRollup(ctx, tx, event, 0, 0, 0); err != nil {
		return err
	}
	if err := tx.Commit(ctx); err != nil {
		return fmt.Errorf("commit usage record: %w", err)
	}
	return nil
}

func usageMeteringStatus(event domain.UsageEvent) string {
	if event.StatusCode < 200 || event.StatusCode >= 300 || !event.Success {
		return "upstream_failed"
	}
	if event.UsageReported {
		return "reported"
	}
	return "missing"
}

func upsertUsageRollup(ctx context.Context, tx pgx.Tx, event domain.UsageEvent, cost, charged, uncollected int64) error {
	period := time.Date(event.StartedAt.UTC().Year(), event.StartedAt.UTC().Month(), 1, 0, 0, 0, 0, time.UTC)
	_, err := tx.Exec(ctx, `
		INSERT INTO usage_monthly_rollups
		(period_start, tenant_id, project_id, request_count, successful_requests, input_tokens, output_tokens, total_tokens, cost_micros, charged_micros, uncollected_micros)
		VALUES ($1,$2,$3,1,$4,$5,$6,$7,$8,$9,$10)
		ON CONFLICT (project_id, period_start) DO UPDATE SET request_count=usage_monthly_rollups.request_count+1,
			successful_requests=usage_monthly_rollups.successful_requests+EXCLUDED.successful_requests,
			input_tokens=usage_monthly_rollups.input_tokens+EXCLUDED.input_tokens,
			output_tokens=usage_monthly_rollups.output_tokens+EXCLUDED.output_tokens,
			total_tokens=usage_monthly_rollups.total_tokens+EXCLUDED.total_tokens,
			cost_micros=usage_monthly_rollups.cost_micros+EXCLUDED.cost_micros,
			charged_micros=usage_monthly_rollups.charged_micros+EXCLUDED.charged_micros,
			uncollected_micros=usage_monthly_rollups.uncollected_micros+EXCLUDED.uncollected_micros,
			updated_at=now()`, period, event.TenantID, event.ProjectID, boolInt(event.Success),
		event.Usage.InputTokens, event.Usage.OutputTokens, event.Usage.TotalTokens, cost, charged, uncollected)
	if err != nil {
		return fmt.Errorf("update usage monthly rollup: %w", err)
	}
	return nil
}

func boolInt(value bool) int {
	if value {
		return 1
	}
	return 0
}

func (s *Store) ListUsage(ctx context.Context, query UsageQuery) (UsagePage, error) {
	limit := query.Limit
	if limit < 1 || limit > 1000 {
		limit = 200
	}
	where := []string{"1=1"}
	args := make([]any, 0, 16)
	index := 1
	for _, item := range []struct{ value, clause string }{{query.TenantID, "tenant_id=$"}, {query.ProjectID, "project_id=$"}, {query.KeyID, "key_id=$"}, {query.Model, "public_model=$"}, {query.RequestID, "request_id=$"}} {
		if strings.TrimSpace(item.value) != "" {
			where = append(where, item.clause+fmt.Sprint(index))
			args = append(args, item.value)
			index++
		}
	}
	for _, item := range []struct{ value, clause string }{{query.Protocol, "protocol=$"}, {query.ErrorType, "error_type=$"}} {
		if strings.TrimSpace(item.value) != "" {
			where = append(where, item.clause+fmt.Sprint(index))
			args = append(args, item.value)
			index++
		}
	}
	if strings.TrimSpace(query.Provider) != "" {
		where = append(where, "EXISTS (SELECT 1 FROM providers filter_provider WHERE filter_provider.id::text=usage_events.provider_id AND filter_provider.slug=$"+fmt.Sprint(index)+")")
		args = append(args, query.Provider)
		index++
	}
	if query.Stream != nil {
		where = append(where, "stream=$"+fmt.Sprint(index))
		args = append(args, *query.Stream)
		index++
	}
	if query.Status == "success" {
		where = append(where, "success=TRUE")
	} else if query.Status == "error" {
		where = append(where, "success=FALSE")
	}
	if !query.From.IsZero() {
		where = append(where, "started_at >= $"+fmt.Sprint(index))
		args = append(args, query.From)
		index++
	}
	if !query.To.IsZero() {
		where = append(where, "started_at < $"+fmt.Sprint(index))
		args = append(args, query.To)
		index++
	}
	if strings.TrimSpace(query.Cursor) != "" {
		cursor, err := decodeUsageCursor(query.Cursor)
		if err != nil {
			return UsagePage{}, err
		}
		where = append(where, "(started_at, request_id) < ($"+fmt.Sprint(index)+",$"+fmt.Sprint(index+1)+")")
		args = append(args, cursor.StartedAt, cursor.RequestID)
		index += 2
	}
	args = append(args, limit+1)
	rows, err := s.db.Query(ctx, `SELECT request_id, tenant_id::text, project_id::text,
		COALESCE((SELECT name FROM projects p WHERE p.id=usage_events.project_id),''), key_id::text,
		COALESCE((SELECT name FROM api_keys k WHERE k.id=usage_events.key_id),''), public_model,
		COALESCE(provider_id,''), COALESCE((SELECT name FROM providers p WHERE p.id::text=usage_events.provider_id),''),
		COALESCE(upstream_model,''), protocol, stream, status_code, success, error_type,
		attempts, started_at, duration_ms, ttft_ms, input_tokens, output_tokens, total_tokens, cache_creation_input_tokens,
		cache_read_input_tokens, cost_micros, charged_micros, uncollected_micros, usage_reported, metering_status FROM usage_events WHERE `+
		strings.Join(where, " AND ")+` ORDER BY started_at DESC, request_id DESC LIMIT $`+fmt.Sprint(index), args...)
	if err != nil {
		return UsagePage{}, fmt.Errorf("query usage events: %w", err)
	}
	defer rows.Close()
	result := make([]UsageRecord, 0, limit+1)
	for rows.Next() {
		var item UsageRecord
		if err := rows.Scan(&item.RequestID, &item.TenantID, &item.ProjectID, &item.ProjectName, &item.KeyID, &item.KeyName, &item.PublicModel, &item.ProviderID, &item.ProviderName, &item.UpstreamModel,
			&item.Protocol, &item.Stream, &item.StatusCode, &item.Success, &item.ErrorType, &item.Attempts, &item.StartedAt, &item.DurationMS,
			&item.TTFTMS, &item.InputTokens, &item.OutputTokens, &item.TotalTokens, &item.CacheCreationInputTokens, &item.CacheReadInputTokens,
			&item.CostMicros, &item.ChargedMicros, &item.UncollectedMicros, &item.UsageReported, &item.MeteringStatus); err != nil {
			return UsagePage{}, fmt.Errorf("scan usage event: %w", err)
		}
		result = append(result, item)
	}
	if err := rows.Err(); err != nil {
		return UsagePage{}, err
	}
	page := UsagePage{Data: result}
	if len(result) > limit {
		page.Data = result[:limit]
		page.NextCursor = encodeUsageCursor(page.Data[len(page.Data)-1])
	}
	return page, nil
}

func encodeUsageCursor(record UsageRecord) string {
	payload, _ := json.Marshal(usageCursor{StartedAt: record.StartedAt.UTC(), RequestID: record.RequestID})
	return base64.RawURLEncoding.EncodeToString(payload)
}

func decodeUsageCursor(raw string) (usageCursor, error) {
	if len(raw) > 2048 {
		return usageCursor{}, ErrInvalidUsageCursor
	}
	payload, err := base64.RawURLEncoding.DecodeString(raw)
	if err != nil {
		return usageCursor{}, ErrInvalidUsageCursor
	}
	var cursor usageCursor
	if json.Unmarshal(payload, &cursor) != nil || cursor.StartedAt.IsZero() || strings.TrimSpace(cursor.RequestID) == "" {
		return usageCursor{}, ErrInvalidUsageCursor
	}
	return cursor, nil
}

func (s *Store) UsageDaily(ctx context.Context, query UsageQuery) ([]UsageDailyPoint, error) {
	where := []string{"1=1"}
	args := make([]any, 0, 12)
	index := 1
	for _, item := range []struct{ value, clause string }{{query.TenantID, "tenant_id=$"}, {query.ProjectID, "project_id=$"}, {query.KeyID, "key_id=$"}, {query.Model, "public_model=$"}, {query.RequestID, "request_id=$"}} {
		if strings.TrimSpace(item.value) != "" {
			where = append(where, item.clause+fmt.Sprint(index))
			args = append(args, item.value)
			index++
		}
	}
	for _, item := range []struct{ value, clause string }{{query.Protocol, "protocol=$"}, {query.ErrorType, "error_type=$"}} {
		if strings.TrimSpace(item.value) != "" {
			where = append(where, item.clause+fmt.Sprint(index))
			args = append(args, item.value)
			index++
		}
	}
	if strings.TrimSpace(query.Provider) != "" {
		where = append(where, "EXISTS (SELECT 1 FROM providers filter_provider WHERE filter_provider.id::text=usage_events.provider_id AND filter_provider.slug=$"+fmt.Sprint(index)+")")
		args = append(args, query.Provider)
		index++
	}
	if query.Stream != nil {
		where = append(where, "stream=$"+fmt.Sprint(index))
		args = append(args, *query.Stream)
		index++
	}
	if query.Status == "success" {
		where = append(where, "success=TRUE")
	} else if query.Status == "error" {
		where = append(where, "success=FALSE")
	}
	if !query.From.IsZero() {
		where = append(where, "started_at >= $"+fmt.Sprint(index))
		args = append(args, query.From)
		index++
	}
	if !query.To.IsZero() {
		where = append(where, "started_at < $"+fmt.Sprint(index))
		args = append(args, query.To)
		index++
	}
	rows, err := s.db.Query(ctx, `SELECT date_trunc('day', started_at AT TIME ZONE 'UTC'), count(*),
		count(*) FILTER (WHERE success), COALESCE(sum(input_tokens),0), COALESCE(sum(output_tokens),0),
		COALESCE(sum(total_tokens),0), COALESCE(sum(charged_micros),0), COALESCE(sum(uncollected_micros),0),
		COALESCE(round(avg(duration_ms)),0)::bigint,
		COALESCE(round(percentile_cont(0.50) WITHIN GROUP (ORDER BY duration_ms)),0)::bigint,
		COALESCE(round(percentile_cont(0.95) WITHIN GROUP (ORDER BY duration_ms)),0)::bigint,
		COALESCE(round(percentile_cont(0.50) WITHIN GROUP (ORDER BY ttft_ms) FILTER (WHERE ttft_ms > 0)),0)::bigint,
		COALESCE(round(percentile_cont(0.95) WITHIN GROUP (ORDER BY ttft_ms) FILTER (WHERE ttft_ms > 0)),0)::bigint
		FROM usage_events WHERE `+strings.Join(where, " AND ")+` GROUP BY 1 ORDER BY 1`, args...)
	if err != nil {
		return nil, fmt.Errorf("query daily usage: %w", err)
	}
	defer rows.Close()
	result := make([]UsageDailyPoint, 0)
	for rows.Next() {
		var item UsageDailyPoint
		if err := rows.Scan(&item.Day, &item.RequestCount, &item.SuccessfulRequests, &item.InputTokens, &item.OutputTokens,
			&item.TotalTokens, &item.ChargedMicros, &item.UncollectedMicros, &item.AverageDurationMS, &item.P50DurationMS,
			&item.P95DurationMS, &item.P50TTFTMS, &item.P95TTFTMS); err != nil {
			return nil, fmt.Errorf("scan daily usage: %w", err)
		}
		result = append(result, item)
	}
	return result, rows.Err()
}

func (s *Store) UsageSummary(ctx context.Context, tenantID, projectID string) ([]UsageSummary, error) {
	where := []string{"1=1"}
	args := make([]any, 0, 2)
	index := 1
	for _, item := range []struct{ value, clause string }{{tenantID, "r.tenant_id=$"}, {projectID, "r.project_id=$"}} {
		if strings.TrimSpace(item.value) != "" {
			where = append(where, item.clause+fmt.Sprint(index))
			args = append(args, item.value)
			index++
		}
	}
	rows, err := s.db.Query(ctx, `SELECT r.period_start, r.tenant_id::text, r.project_id::text, p.name,
		r.request_count, r.successful_requests, r.input_tokens, r.output_tokens, r.total_tokens,
		r.cost_micros, r.charged_micros, r.uncollected_micros FROM usage_monthly_rollups r JOIN projects p ON p.id=r.project_id WHERE `+
		strings.Join(where, " AND ")+` ORDER BY r.period_start DESC, p.name`, args...)
	if err != nil {
		return nil, fmt.Errorf("query usage summary: %w", err)
	}
	defer rows.Close()
	result := make([]UsageSummary, 0)
	for rows.Next() {
		var item UsageSummary
		if err := rows.Scan(&item.PeriodStart, &item.TenantID, &item.ProjectID, &item.ProjectName, &item.RequestCount, &item.SuccessfulRequests,
			&item.InputTokens, &item.OutputTokens, &item.TotalTokens, &item.CostMicros, &item.ChargedMicros, &item.UncollectedMicros); err != nil {
			return nil, fmt.Errorf("scan usage summary: %w", err)
		}
		result = append(result, item)
	}
	return result, rows.Err()
}