Spaces:
Running
Running
File size: 19,307 Bytes
98c9143 | 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 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 | import consola from "consola"
import path from "node:path"
import { PATHS } from "~/lib/paths"
import { registerProcessCleanup } from "~/lib/process-cleanup"
import {
isSqliteRuntimeSupported,
SqliteDbStore,
type SqliteDatabase,
} from "~/lib/sqlite"
export type TokenUsageSource = "copilot" | "provider"
export type TokenUsageEndpoint =
| "chat_completions"
| "embeddings"
| "messages"
| "provider_messages"
| "responses"
export type TokenUsagePeriod = "day" | "week" | "month"
export interface UsageTokens {
cache_creation_input_tokens?: number | null
cache_read_input_tokens?: number | null
input_tokens?: number | null
output_tokens?: number | null
total_tokens?: number | null
}
export interface PersistedTokenUsageEvent {
cache_creation_input_tokens: number
cache_read_input_tokens: number
created_at_ms: number
created_at_utc: string
endpoint: TokenUsageEndpoint
input_tokens: number
model: string
output_tokens: number
provider_name: string | null
session_id: string
source: TokenUsageSource
total_tokens: number
trace_id: string
user_id: string
}
export interface TokenUsageTotals {
cache_creation_input_tokens: number
cache_read_input_tokens: number
input_tokens: number
output_tokens: number
request_count: number
total_tokens: number
}
export interface TokenUsageModelSummary extends TokenUsageTotals {
model: string
}
export interface TokenUsageEventRecord {
cache_creation_input_tokens: number
cache_read_input_tokens: number
created_at_ms: number
created_at_utc: string
endpoint: TokenUsageEndpoint
id: number
input_tokens: number
model: string
output_tokens: number
provider_name: string | null
session_id: string
source: TokenUsageSource
total_tokens: number
trace_id: string
user_id: string
}
export interface TokenUsageSummary {
byModel: Array<TokenUsageModelSummary>
period: TokenUsagePeriod
range: {
end_ms: number
end_utc: string
start_ms: number
start_utc: string
}
totals: TokenUsageTotals
}
export interface TokenUsageDailyBucket {
byModel: Array<TokenUsageModelSummary>
date: string
end_ms: number
start_ms: number
totals: TokenUsageTotals
}
export interface TokenUsageDailySummary {
byModel: Array<TokenUsageModelSummary>
days: Array<TokenUsageDailyBucket>
period: TokenUsagePeriod
range: {
end_ms: number
end_utc: string
start_ms: number
start_utc: string
}
totals: TokenUsageTotals
}
export interface TokenUsageEventsPage {
items: Array<TokenUsageEventRecord>
page: number
page_size: number
period: TokenUsagePeriod
range: {
end_ms: number
end_utc: string
start_ms: number
start_utc: string
}
total: number
total_pages: number
}
const DB_PATH_ENV = "COPILOT_API_SQLITE_DB_PATH"
const DEFAULT_DB_FILENAME = "copilot-api.sqlite"
let writeQueue: Promise<void> = Promise.resolve()
function getDbPath(): string {
return (
process.env[DB_PATH_ENV] ?? path.join(PATHS.APP_DIR, DEFAULT_DB_FILENAME)
)
}
const tokenUsageDbStore = new SqliteDbStore({
getPath: getDbPath,
initialize: initializeTokenUsageDb,
})
function getDb(): Promise<SqliteDatabase> {
return tokenUsageDbStore.getDb()
}
export function isTokenUsageStorageEnabled(): boolean {
return isSqliteRuntimeSupported()
}
function initializeTokenUsageDb(db: SqliteDatabase): void {
db.exec("PRAGMA journal_mode = WAL")
db.exec("PRAGMA busy_timeout = 5000")
db.exec(`
CREATE TABLE IF NOT EXISTS token_usage_events (
id INTEGER PRIMARY KEY AUTOINCREMENT,
created_at_ms INTEGER NOT NULL,
created_at_utc TEXT NOT NULL,
trace_id TEXT NOT NULL,
session_id TEXT NOT NULL DEFAULT '',
user_id TEXT NOT NULL DEFAULT '',
source TEXT NOT NULL,
endpoint TEXT NOT NULL,
provider_name TEXT,
model TEXT NOT NULL,
input_tokens INTEGER NOT NULL DEFAULT 0,
output_tokens INTEGER NOT NULL DEFAULT 0,
cache_read_input_tokens INTEGER NOT NULL DEFAULT 0,
cache_creation_input_tokens INTEGER NOT NULL DEFAULT 0,
total_tokens INTEGER NOT NULL DEFAULT 0
)
`)
ensureColumn(db, "user_id", "TEXT NOT NULL DEFAULT ''")
ensureColumn(db, "total_tokens", "INTEGER NOT NULL DEFAULT 0")
db.exec(`
CREATE INDEX IF NOT EXISTS idx_token_usage_events_created_at_ms
ON token_usage_events(created_at_ms)
`)
db.exec(`
CREATE INDEX IF NOT EXISTS idx_token_usage_events_model
ON token_usage_events(model)
`)
db.exec(`
CREATE INDEX IF NOT EXISTS idx_token_usage_events_trace_id
ON token_usage_events(trace_id)
`)
db.exec(`
CREATE INDEX IF NOT EXISTS idx_token_usage_events_session_id
ON token_usage_events(session_id)
`)
db.exec(`
CREATE INDEX IF NOT EXISTS idx_token_usage_events_user_id
ON token_usage_events(user_id)
`)
}
function ensureColumn(
db: SqliteDatabase,
name: string,
definition: string,
): void {
const rows = db
.prepare("PRAGMA table_info(token_usage_events)")
.all() as Array<Record<string, unknown>>
const hasColumn = rows.some((row) => row.name === name)
if (!hasColumn) {
db.exec(`ALTER TABLE token_usage_events ADD COLUMN ${name} ${definition}`)
}
}
export function normalizeToken(value: number | null | undefined): number {
if (typeof value !== "number" || !Number.isFinite(value)) {
return 0
}
return Math.max(0, Math.floor(value))
}
export function normalizeOptionalToken(
value: number | null | undefined,
): number | undefined {
return value === null || value === undefined ?
undefined
: normalizeToken(value)
}
export function hasAnyToken(tokens: UsageTokens): boolean {
return (
normalizeToken(tokens.input_tokens) > 0
|| normalizeToken(tokens.output_tokens) > 0
|| normalizeToken(tokens.cache_read_input_tokens) > 0
|| normalizeToken(tokens.cache_creation_input_tokens) > 0
|| normalizeToken(tokens.total_tokens) > 0
)
}
export function resolveTotalTokens(input: UsageTokens): number {
const explicitTotal = normalizeOptionalToken(input.total_tokens)
if (explicitTotal !== undefined) {
return explicitTotal
}
return (
normalizeToken(input.input_tokens)
+ normalizeToken(input.output_tokens)
+ normalizeToken(input.cache_read_input_tokens)
+ normalizeToken(input.cache_creation_input_tokens)
)
}
async function writeTokenUsageEvent(
event: PersistedTokenUsageEvent,
): Promise<void> {
const db = await getDb()
db.prepare(
`
INSERT INTO token_usage_events (
created_at_ms,
created_at_utc,
trace_id,
session_id,
user_id,
source,
endpoint,
provider_name,
model,
input_tokens,
output_tokens,
cache_read_input_tokens,
cache_creation_input_tokens,
total_tokens
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
`,
).run(
event.created_at_ms,
event.created_at_utc,
event.trace_id,
event.session_id,
event.user_id,
event.source,
event.endpoint,
event.provider_name,
event.model,
event.input_tokens,
event.output_tokens,
event.cache_read_input_tokens,
event.cache_creation_input_tokens,
event.total_tokens,
)
}
export function enqueueTokenUsageWrite(event: PersistedTokenUsageEvent): void {
if (!isTokenUsageStorageEnabled()) {
return
}
writeQueue = writeQueue
.then(() => writeTokenUsageEvent(event))
.catch((error: unknown) => {
consola.warn("Failed to record token usage", error)
})
}
async function flushTokenUsageEvents(): Promise<void> {
let currentQueue = writeQueue
while (true) {
await currentQueue
if (currentQueue === writeQueue) {
return
}
currentQueue = writeQueue
}
}
function getPeriodRange(period: TokenUsagePeriod, now = new Date()) {
const start = new Date(now)
start.setHours(0, 0, 0, 0)
switch (period) {
case "day": {
break
}
case "week": {
start.setDate(start.getDate() - 6)
break
}
case "month": {
start.setDate(start.getDate() - 29)
break
}
default: {
break
}
}
const end = new Date(start)
switch (period) {
case "day": {
end.setDate(end.getDate() + 1)
break
}
case "week": {
end.setDate(end.getDate() + 7)
break
}
case "month": {
end.setDate(end.getDate() + 30)
break
}
default: {
break
}
}
return {
endMs: end.getTime(),
startMs: start.getTime(),
}
}
function formatLocalDate(date: Date): string {
const year = date.getFullYear()
const month = String(date.getMonth() + 1).padStart(2, "0")
const day = String(date.getDate()).padStart(2, "0")
return `${year}-${month}-${day}`
}
function createDailyIntervals(range: { endMs: number; startMs: number }) {
const intervals: Array<{
date: string
endMs: number
startMs: number
}> = []
const cursor = new Date(range.startMs)
while (cursor.getTime() < range.endMs) {
const startMs = cursor.getTime()
const next = new Date(cursor)
next.setDate(next.getDate() + 1)
const endMs = Math.min(next.getTime(), range.endMs)
intervals.push({
date: formatLocalDate(cursor),
endMs,
startMs,
})
cursor.setTime(endMs)
}
return intervals
}
function createEmptyTotals(): TokenUsageTotals {
return {
cache_creation_input_tokens: 0,
cache_read_input_tokens: 0,
input_tokens: 0,
output_tokens: 0,
request_count: 0,
total_tokens: 0,
}
}
function addTotals(target: TokenUsageTotals, next: TokenUsageTotals): void {
target.cache_creation_input_tokens += next.cache_creation_input_tokens
target.cache_read_input_tokens += next.cache_read_input_tokens
target.input_tokens += next.input_tokens
target.output_tokens += next.output_tokens
target.request_count += next.request_count
target.total_tokens += next.total_tokens
}
function createEmptySummary(period: TokenUsagePeriod): TokenUsageSummary {
const range = getPeriodRange(period)
return {
byModel: [],
period,
range: {
end_ms: range.endMs,
end_utc: new Date(range.endMs).toISOString(),
start_ms: range.startMs,
start_utc: new Date(range.startMs).toISOString(),
},
totals: createEmptyTotals(),
}
}
function createEmptyDailySummary(
period: TokenUsagePeriod,
): TokenUsageDailySummary {
const range = getPeriodRange(period)
return {
byModel: [],
days: createDailyIntervals(range).map((interval) => ({
byModel: [],
date: interval.date,
end_ms: interval.endMs,
start_ms: interval.startMs,
totals: createEmptyTotals(),
})),
period,
range: {
end_ms: range.endMs,
end_utc: new Date(range.endMs).toISOString(),
start_ms: range.startMs,
start_utc: new Date(range.startMs).toISOString(),
},
totals: createEmptyTotals(),
}
}
function createEmptyEventsPage(input: {
page: number
pageSize: number
period: TokenUsagePeriod
}): TokenUsageEventsPage {
const range = getPeriodRange(input.period)
const page = Math.max(1, Math.floor(input.page))
const pageSize = Math.min(100, Math.max(1, Math.floor(input.pageSize)))
return {
items: [],
page,
page_size: pageSize,
period: input.period,
range: {
end_ms: range.endMs,
end_utc: new Date(range.endMs).toISOString(),
start_ms: range.startMs,
start_utc: new Date(range.startMs).toISOString(),
},
total: 0,
total_pages: 1,
}
}
function rangePayload(range: { endMs: number; startMs: number }) {
return {
end_ms: range.endMs,
end_utc: new Date(range.endMs).toISOString(),
start_ms: range.startMs,
start_utc: new Date(range.startMs).toISOString(),
}
}
function numberFromRow(
row: Record<string, unknown> | undefined,
key: string,
): number {
const value = row?.[key]
return typeof value === "number" && Number.isFinite(value) ? value : 0
}
function totalsFromRow(
row: Record<string, unknown> | undefined,
): TokenUsageTotals {
return {
cache_creation_input_tokens: numberFromRow(
row,
"cache_creation_input_tokens",
),
cache_read_input_tokens: numberFromRow(row, "cache_read_input_tokens"),
input_tokens: numberFromRow(row, "input_tokens"),
output_tokens: numberFromRow(row, "output_tokens"),
request_count: numberFromRow(row, "request_count"),
total_tokens: numberFromRow(row, "total_tokens"),
}
}
function modelSummaryFromRow(
row: Record<string, unknown>,
): TokenUsageModelSummary {
return {
...totalsFromRow(row),
model: typeof row.model === "string" ? row.model : "unknown",
}
}
function stringFromRow(row: Record<string, unknown>, key: string): string {
const value = row[key]
return typeof value === "string" ? value : ""
}
function nullableStringFromRow(
row: Record<string, unknown>,
key: string,
): string | null {
const value = row[key]
return typeof value === "string" ? value : null
}
function usageEventFromRow(
row: Record<string, unknown>,
): TokenUsageEventRecord {
return {
cache_creation_input_tokens: numberFromRow(
row,
"cache_creation_input_tokens",
),
cache_read_input_tokens: numberFromRow(row, "cache_read_input_tokens"),
created_at_ms: numberFromRow(row, "created_at_ms"),
created_at_utc: stringFromRow(row, "created_at_utc"),
endpoint: stringFromRow(row, "endpoint") as TokenUsageEndpoint,
id: numberFromRow(row, "id"),
input_tokens: numberFromRow(row, "input_tokens"),
model: stringFromRow(row, "model") || "unknown",
output_tokens: numberFromRow(row, "output_tokens"),
provider_name: nullableStringFromRow(row, "provider_name"),
session_id: stringFromRow(row, "session_id"),
source: stringFromRow(row, "source") as TokenUsageSource,
total_tokens: numberFromRow(row, "total_tokens"),
trace_id: stringFromRow(row, "trace_id"),
user_id: stringFromRow(row, "user_id"),
}
}
function getTotalsRow(
db: SqliteDatabase,
range: { endMs: number; startMs: number },
): Record<string, unknown> | undefined {
return db
.prepare(
`
SELECT
COUNT(*) AS request_count,
COALESCE(SUM(input_tokens), 0) AS input_tokens,
COALESCE(SUM(output_tokens), 0) AS output_tokens,
COALESCE(SUM(cache_read_input_tokens), 0) AS cache_read_input_tokens,
COALESCE(SUM(cache_creation_input_tokens), 0) AS cache_creation_input_tokens,
COALESCE(SUM(total_tokens), 0) AS total_tokens
FROM token_usage_events
WHERE created_at_ms >= ? AND created_at_ms < ?
`,
)
.get(range.startMs, range.endMs) as Record<string, unknown> | undefined
}
function getModelRows(
db: SqliteDatabase,
range: { endMs: number; startMs: number },
): Array<Record<string, unknown>> {
return db
.prepare(
`
SELECT
model,
COUNT(*) AS request_count,
COALESCE(SUM(input_tokens), 0) AS input_tokens,
COALESCE(SUM(output_tokens), 0) AS output_tokens,
COALESCE(SUM(cache_read_input_tokens), 0) AS cache_read_input_tokens,
COALESCE(SUM(cache_creation_input_tokens), 0) AS cache_creation_input_tokens,
COALESCE(SUM(total_tokens), 0) AS total_tokens
FROM token_usage_events
WHERE created_at_ms >= ? AND created_at_ms < ?
GROUP BY model
ORDER BY
total_tokens DESC,
model ASC
`,
)
.all(range.startMs, range.endMs) as Array<Record<string, unknown>>
}
function createDailyBucket(
interval: { date: string; endMs: number; startMs: number },
rows: Array<Record<string, unknown>>,
): TokenUsageDailyBucket {
const byModel = rows.map((row) => modelSummaryFromRow(row))
const totals = createEmptyTotals()
for (const model of byModel) {
addTotals(totals, model)
}
return {
byModel,
date: interval.date,
end_ms: interval.endMs,
start_ms: interval.startMs,
totals,
}
}
export async function getTokenUsageSummary(
period: TokenUsagePeriod,
): Promise<TokenUsageSummary> {
if (!isTokenUsageStorageEnabled()) {
return createEmptySummary(period)
}
await flushTokenUsageEvents()
const range = getPeriodRange(period)
const db = await getDb()
const totalsRow = getTotalsRow(db, range)
const byModelRows = getModelRows(db, range)
return {
byModel: byModelRows.map((row) => modelSummaryFromRow(row)),
period,
range: rangePayload(range),
totals: totalsFromRow(totalsRow),
}
}
export async function getTokenUsageDailySummary(
period: TokenUsagePeriod,
): Promise<TokenUsageDailySummary> {
if (!isTokenUsageStorageEnabled()) {
return createEmptyDailySummary(period)
}
await flushTokenUsageEvents()
const range = getPeriodRange(period)
const db = await getDb()
const intervals = createDailyIntervals(range)
return {
byModel: getModelRows(db, range).map((row) => modelSummaryFromRow(row)),
days: intervals.map((interval) =>
createDailyBucket(interval, getModelRows(db, interval)),
),
period,
range: rangePayload(range),
totals: totalsFromRow(getTotalsRow(db, range)),
}
}
export async function getTokenUsageEventsPage(input: {
page: number
pageSize: number
period: TokenUsagePeriod
}): Promise<TokenUsageEventsPage> {
if (!isTokenUsageStorageEnabled()) {
return createEmptyEventsPage(input)
}
await flushTokenUsageEvents()
const range = getPeriodRange(input.period)
const page = Math.max(1, Math.floor(input.page))
const pageSize = Math.min(100, Math.max(1, Math.floor(input.pageSize)))
const offset = (page - 1) * pageSize
const db = await getDb()
const totalRow = db
.prepare(
`
SELECT COUNT(*) AS total
FROM token_usage_events
WHERE created_at_ms >= ? AND created_at_ms < ?
`,
)
.get(range.startMs, range.endMs) as Record<string, unknown> | undefined
const rows = db
.prepare(
`
SELECT
id,
created_at_ms,
created_at_utc,
trace_id,
session_id,
user_id,
source,
endpoint,
provider_name,
model,
input_tokens,
output_tokens,
cache_read_input_tokens,
cache_creation_input_tokens,
total_tokens
FROM token_usage_events
WHERE created_at_ms >= ? AND created_at_ms < ?
ORDER BY created_at_ms DESC, id DESC
LIMIT ? OFFSET ?
`,
)
.all(range.startMs, range.endMs, pageSize, offset) as Array<
Record<string, unknown>
>
const total = numberFromRow(totalRow, "total")
return {
items: rows.map((row) => usageEventFromRow(row)),
page,
page_size: pageSize,
period: input.period,
range: {
end_ms: range.endMs,
end_utc: new Date(range.endMs).toISOString(),
start_ms: range.startMs,
start_utc: new Date(range.startMs).toISOString(),
},
total,
total_pages: Math.max(1, Math.ceil(total / pageSize)),
}
}
export async function closeUsageStore(): Promise<void> {
await flushTokenUsageEvents()
await tokenUsageDbStore.close({
beforeClose: (db) => {
try {
db.exec("PRAGMA wal_checkpoint(TRUNCATE)")
} catch {
// Ignore cleanup errors in tests.
}
},
})
writeQueue = Promise.resolve()
}
registerProcessCleanup(closeUsageStore)
|