agents / Exports / UsagePlugin

Class: UsagePlugin

Plugin for tracking usage statistics Collects and stores usage data including tokens, costs, performance metrics

Hierarchy

• BasePlugin<UsagePluginOptions, UsagePluginStats>

  ↳ UsagePlugin

Table of contents

Constructors

• constructor

Properties

• enabled
• category
• priority
• name
• version

Methods

• initialize
• subscribeToModuleEvents
• unsubscribeFromModuleEvents
• dispose
• enable
• disable
• isEnabled
• getConfig
• updateConfig
• getData
• clearData
• getStatus
• getStats
• beforeRun
• afterRun
• beforeExecution
• afterExecution
• beforeConversation
• afterConversation
• beforeToolCall
• beforeToolExecution
• afterToolCall
• afterToolExecution
• beforeProviderCall
• afterProviderCall
• onStreamingChunk
• onError
• onMessageAdded
• onModuleEvent
• recordUsage
• getUsageStats
• getAggregatedStats
• clearStats
• flush
• destroy

Constructors

constructor

• new UsagePlugin(options): UsagePlugin

Parameters

Name	Type
options	UsagePluginOptions

Returns

UsagePlugin

Overrides

BasePlugin.constructor

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:32

Properties

enabled

• enabled: boolean = true

Plugin enabled state

Inherited from

BasePlugin.enabled

Defined in

packages/agents/src/abstracts/base-plugin.ts:297

---

category

• category: PluginCategory = PluginCategory.CUSTOM

Plugin category for classification

Inherited from

BasePlugin.category

Defined in

packages/agents/src/abstracts/base-plugin.ts:300

---

priority

• priority: number = PluginPriority.NORMAL

Plugin priority for execution order

Inherited from

BasePlugin.priority

Defined in

packages/agents/src/abstracts/base-plugin.ts:303

---

name

• name: string = 'UsagePlugin'

Plugin name

Overrides

BasePlugin.name

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:24

---

version

• version: string = '1.0.0'

Plugin version

Overrides

BasePlugin.version

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:25

Methods

initialize

▸ initialize(options?): Promise<void>

Initialize the plugin with type-safe options

Parameters

Name	Type
options?	UsagePluginOptions

Returns

Promise<void>

Inherited from

BasePlugin.initialize

Defined in

packages/agents/src/abstracts/base-plugin.ts:328

---

subscribeToModuleEvents

▸ subscribeToModuleEvents(eventEmitter): Promise<void>

Subscribe to module events through EventEmitter

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

BasePlugin.subscribeToModuleEvents

Defined in

packages/agents/src/abstracts/base-plugin.ts:356

---

unsubscribeFromModuleEvents

▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>

Unsubscribe from module events

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

BasePlugin.unsubscribeFromModuleEvents

Defined in

packages/agents/src/abstracts/base-plugin.ts:415

---

dispose

▸ dispose(): Promise<void>

Cleanup plugin resources

Returns

Promise<void>

Inherited from

BasePlugin.dispose

Defined in

packages/agents/src/abstracts/base-plugin.ts:430

---

enable

▸ enable(): void

Enable the plugin

Returns

void

Inherited from

BasePlugin.enable

Defined in

packages/agents/src/abstracts/base-plugin.ts:442

---

disable

▸ disable(): void

Disable the plugin

Returns

void

Inherited from

BasePlugin.disable

Defined in

packages/agents/src/abstracts/base-plugin.ts:449

---

isEnabled

▸ isEnabled(): boolean

Check if plugin is enabled

Returns

boolean

Inherited from

BasePlugin.isEnabled

Defined in

packages/agents/src/abstracts/base-plugin.ts:456

---

getConfig

▸ getConfig(): PluginConfig

Get plugin configuration

Returns

PluginConfig

Inherited from

BasePlugin.getConfig

Defined in

packages/agents/src/abstracts/base-plugin.ts:463

---

updateConfig

▸ updateConfig(_config): void

Update plugin configuration

Parameters

Name	Type
_config	PluginConfig

Returns

void

Inherited from

BasePlugin.updateConfig

Defined in

packages/agents/src/abstracts/base-plugin.ts:470

---

getData

▸ getData(): PluginData

Get plugin data - enhanced with classification information

Returns

PluginData

Inherited from

BasePlugin.getData

Defined in

packages/agents/src/abstracts/base-plugin.ts:477

---

clearData

▸ clearData(): void

Clear plugin data - common interface for all plugins This method should be implemented by plugins that store data

Returns

void

Inherited from

BasePlugin.clearData

Defined in

packages/agents/src/abstracts/base-plugin.ts:497

---

getStatus

▸ getStatus(): Object

Get plugin status - enhanced with classification information

Returns

Object

Name	Type
name	string
version	string
enabled	boolean
initialized	boolean
category	PluginCategory
priority	number
subscribedEventsCount	number
hasEventEmitter	boolean

Inherited from

BasePlugin.getStatus

Defined in

packages/agents/src/abstracts/base-plugin.ts:502

---

getStats

▸ getStats(): UsagePluginStats

Get plugin statistics - enhanced with module event tracking

Returns

UsagePluginStats

Inherited from

BasePlugin.getStats

Defined in

packages/agents/src/abstracts/base-plugin.ts:527

---

beforeRun

▸ beforeRun(input, options?): Promise<void>

Called before agent run

Parameters

Name	Type
input	string
options?	RunOptions

Returns

Promise<void>

Inherited from

BasePlugin.beforeRun

Defined in

packages/agents/src/abstracts/base-plugin.ts:556

---

afterRun

▸ afterRun(input, response, options?): Promise<void>

Called after agent run

Parameters

Name	Type
input	string
response	string
options?	RunOptions

Returns

Promise<void>

Inherited from

BasePlugin.afterRun

Defined in

packages/agents/src/abstracts/base-plugin.ts:557

---

beforeExecution

▸ beforeExecution(context): Promise<void>

Called before execution with context

Parameters

Name	Type
context	BaseExecutionContext

Returns

Promise<void>

Inherited from

BasePlugin.beforeExecution

Defined in

packages/agents/src/abstracts/base-plugin.ts:558

---

afterExecution

▸ afterExecution(context, result): Promise<void>

Called after execution with context and result

Parameters

Name	Type
context	BaseExecutionContext
result	BaseExecutionResult

Returns

Promise<void>

Inherited from

BasePlugin.afterExecution

Defined in

packages/agents/src/abstracts/base-plugin.ts:559

---

beforeConversation

▸ beforeConversation(context): Promise<void>

Called before conversation with context

Parameters

Name	Type
context	BaseExecutionContext

Returns

Promise<void>

Inherited from

BasePlugin.beforeConversation

Defined in

packages/agents/src/abstracts/base-plugin.ts:560

---

afterConversation

▸ afterConversation(context, result): Promise<void>

Called after conversation with context and result

Parameters

Name	Type
context	BaseExecutionContext
result	BaseExecutionResult

Returns

Promise<void>

Inherited from

BasePlugin.afterConversation

Defined in

packages/agents/src/abstracts/base-plugin.ts:561

---

beforeToolCall

▸ beforeToolCall(toolName, parameters): Promise<void>

Called before tool execution

Parameters

Name	Type
toolName	string
parameters	ToolParameters

Returns

Promise<void>

Inherited from

BasePlugin.beforeToolCall

Defined in

packages/agents/src/abstracts/base-plugin.ts:562

---

beforeToolExecution

▸ beforeToolExecution(context, toolData): Promise<void>

Called before tool execution with context

Parameters

Name	Type
context	BaseExecutionContext
toolData	ToolExecutionContext

Returns

Promise<void>

Inherited from

BasePlugin.beforeToolExecution

Defined in

packages/agents/src/abstracts/base-plugin.ts:563

---

afterToolCall

▸ afterToolCall(toolName, parameters, result): Promise<void>

Called after tool execution

Parameters

Name	Type
toolName	string
parameters	ToolParameters
result	ToolExecutionResult

Returns

Promise<void>

Inherited from

BasePlugin.afterToolCall

Defined in

packages/agents/src/abstracts/base-plugin.ts:564

---

afterToolExecution

▸ afterToolExecution(context, toolResults): Promise<void>

Called after tool execution with context

Parameters

Name	Type
context	BaseExecutionContext
toolResults	BaseExecutionResult

Returns

Promise<void>

Inherited from

BasePlugin.afterToolExecution

Defined in

packages/agents/src/abstracts/base-plugin.ts:565

---

beforeProviderCall

▸ beforeProviderCall(messages): Promise<void>

Called before AI provider call

Parameters

Name	Type
messages	UniversalMessage[]

Returns

Promise<void>

Inherited from

BasePlugin.beforeProviderCall

Defined in

packages/agents/src/abstracts/base-plugin.ts:566

---

afterProviderCall

▸ afterProviderCall(messages, response): Promise<void>

Called after AI provider call

Parameters

Name	Type
messages	UniversalMessage[]
response	UniversalMessage

Returns

Promise<void>

Inherited from

BasePlugin.afterProviderCall

Defined in

packages/agents/src/abstracts/base-plugin.ts:567

---

onStreamingChunk

▸ onStreamingChunk(chunk): Promise<void>

Called on streaming chunk

Parameters

Name	Type
chunk	UniversalMessage

Returns

Promise<void>

Inherited from

BasePlugin.onStreamingChunk

Defined in

packages/agents/src/abstracts/base-plugin.ts:568

---

onError

▸ onError(error, context?): Promise<void>

Called on error

Parameters

Name	Type
error	Error
context?	ErrorContext

Returns

Promise<void>

Inherited from

BasePlugin.onError

Defined in

packages/agents/src/abstracts/base-plugin.ts:569

---

onMessageAdded

▸ onMessageAdded(message): Promise<void>

Called on message added to history

Parameters

Name	Type
message	Message

Returns

Promise<void>

Inherited from

BasePlugin.onMessageAdded

Defined in

packages/agents/src/abstracts/base-plugin.ts:570

---

onModuleEvent

▸ onModuleEvent(eventType, eventData): Promise<void>

Handle module events for usage tracking

Parameters

Name	Type
eventType	EventType
eventData	EventData

Returns

Promise<void>

Overrides

BasePlugin.onModuleEvent

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:82

---

recordUsage

▸ recordUsage(usage): Promise<void>

Record usage statistics

Parameters

Name	Type
usage	Omit<UsageStats, "timestamp" | "cost">

Returns

Promise<void>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:154

---

getUsageStats

▸ getUsageStats(conversationId?, timeRange?): Promise<UsageStats[]>

Get usage statistics

Parameters

Name	Type
conversationId?	string
timeRange?	Object
timeRange.start	Date
timeRange.end	Date

Returns

Promise<UsageStats[]>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:183

---

getAggregatedStats

▸ getAggregatedStats(timeRange?): Promise<AggregatedUsageStats>

Get aggregated usage statistics

Parameters

Name	Type
timeRange?	Object
timeRange.start	Date
timeRange.end	Date

Returns

Promise<AggregatedUsageStats>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:198

---

clearStats

▸ clearStats(): Promise<void>

Clear all usage statistics

Returns

Promise<void>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:212

---

flush

▸ flush(): Promise<void>

Flush pending statistics

Returns

Promise<void>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:226

---

destroy

▸ destroy(): Promise<void>

Cleanup resources

Returns

Promise<void>

Defined in

packages/agents/src/plugins/usage/usage-plugin.ts:239