agent-plugin-usage / Exports / IUsagePluginOptions
Interface: IUsagePluginOptions
Configuration options for usage plugin
Hierarchy
IPluginOptions↳
IUsagePluginOptions
Table of contents
Properties
- enabled
- category
- priority
- moduleEvents
- subscribeToAllModuleEvents
- strategy
- filePath
- remoteEndpoint
- remoteHeaders
- maxEntries
- trackCosts
- costRates
- batchSize
- flushInterval
- aggregateStats
- aggregationInterval
Properties
enabled
• Optional enabled: boolean
Inherited from
IPluginOptions.enabled
Defined in
agent-core/dist/node/index.d.ts:971
category
• Optional category: PluginCategory
Inherited from
IPluginOptions.category
Defined in
agent-core/dist/node/index.d.ts:972
priority
• Optional priority: number
Inherited from
IPluginOptions.priority
Defined in
agent-core/dist/node/index.d.ts:973
moduleEvents
• Optional moduleEvents: TEventName[]
Inherited from
IPluginOptions.moduleEvents
Defined in
agent-core/dist/node/index.d.ts:974
subscribeToAllModuleEvents
• Optional subscribeToAllModuleEvents: boolean
Inherited from
IPluginOptions.subscribeToAllModuleEvents
Defined in
agent-core/dist/node/index.d.ts:975
strategy
• strategy: TUsageTrackingStrategy
Usage tracking strategy to use
Defined in
agent-plugin-usage/src/types.ts:81
filePath
• Optional filePath: string
File path for file strategy
Defined in
agent-plugin-usage/src/types.ts:83
remoteEndpoint
• Optional remoteEndpoint: string
Remote endpoint for remote strategy
Defined in
agent-plugin-usage/src/types.ts:85
remoteHeaders
• Optional remoteHeaders: Record<string, string>
Headers for remote logging
Defined in
agent-plugin-usage/src/types.ts:87
maxEntries
• Optional maxEntries: number
Maximum number of usage entries to keep in memory
Defined in
agent-plugin-usage/src/types.ts:89
trackCosts
• Optional trackCosts: boolean
Whether to track token costs
Defined in
agent-plugin-usage/src/types.ts:91
costRates
• Optional costRates: Record<string, { input: number ; output: number }>
Cost per token rates for different models
Defined in
agent-plugin-usage/src/types.ts:93
batchSize
• Optional batchSize: number
Batch size for remote reporting
Defined in
agent-plugin-usage/src/types.ts:95
flushInterval
• Optional flushInterval: number
Flush interval for batched reporting in milliseconds
Defined in
agent-plugin-usage/src/types.ts:97
aggregateStats
• Optional aggregateStats: boolean
Whether to aggregate statistics
Defined in
agent-plugin-usage/src/types.ts:99
aggregationInterval
• Optional aggregationInterval: number
Aggregation interval in milliseconds