Class: UsageTracker
Defined in: costs/tracker.ts:47
UsageTracker tracks token usage across LLM calls
Constructors
Constructor
new UsageTracker(options?): UsageTracker;
Defined in: costs/tracker.ts:59
Parameters
| Parameter | Type |
|---|---|
options | UsageTrackerOptions |
Returns
UsageTracker
Accessors
isEnabled
Get Signature
get isEnabled(): boolean;
Defined in: costs/tracker.ts:338
Check if tracking is enabled
Returns
boolean
size
Get Signature
get size(): number;
Defined in: costs/tracker.ts:345
Get the number of records
Returns
number
Methods
formatTokens()
formatTokens(tokens): string;
Defined in: costs/tracker.ts:276
Format tokens with commas for display
Parameters
| Parameter | Type |
|---|---|
tokens | number |
Returns
string
getBudgetStatus()
getBudgetStatus(): BudgetStatus;
Defined in: costs/tracker.ts:193
Get budget status
Returns
getRecords()
getRecords(): readonly UsageRecord[];
Defined in: costs/tracker.ts:262
Get all records
Returns
readonly UsageRecord[]
getSessionRecords()
getSessionRecords(sessionId): UsageRecord[];
Defined in: costs/tracker.ts:269
Get records for a specific session
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
getSessionStats()
getSessionStats(sessionId): UsageStats;
Defined in: costs/tracker.ts:160
Get stats for a specific session
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
getStats()
getStats(): UsageStats;
Defined in: costs/tracker.ts:96
Get aggregated usage statistics
Returns
getSummary()
getSummary(): string;
Defined in: costs/tracker.ts:283
Get a human-readable summary
Returns
string
getTotalInputTokens()
getTotalInputTokens(): number;
Defined in: costs/tracker.ts:179
Get total input tokens
Returns
number
getTotalOutputTokens()
getTotalOutputTokens(): number;
Defined in: costs/tracker.ts:186
Get total output tokens
Returns
number
getTotalTokens()
getTotalTokens(): number;
Defined in: costs/tracker.ts:172
Get total tokens used
Returns
number
isBudgetExceeded()
isBudgetExceeded(): boolean;
Defined in: costs/tracker.ts:224
Check if budget is exceeded
Returns
boolean
onEvent()
onEvent(handler): () => void;
Defined in: costs/tracker.ts:317
Register an event handler
Parameters
| Parameter | Type |
|---|---|
handler | UsageEventHandler |
Returns
() => void
record()
record(input): UsageRecord | undefined;
Defined in: costs/tracker.ts:68
Record token usage from an LLM call
Parameters
| Parameter | Type |
|---|---|
input | RecordUsageInput |
Returns
UsageRecord | undefined
reset()
reset(): void;
Defined in: costs/tracker.ts:252
Reset all tracking data
Returns
void