agents / Exports / PerformancePluginOptions
Interface: PerformancePluginOptions
Configuration options for performance plugin
Hierarchy
↳
PerformancePluginOptions
Table of contents
Properties
- enabled
- category
- priority
- moduleEvents
- subscribeToAllModuleEvents
- strategy
- filePath
- remoteEndpoint
- prometheusEndpoint
- remoteHeaders
- maxEntries
- monitorMemory
- monitorCPU
- monitorNetwork
- batchSize
- flushInterval
- aggregateStats
- aggregationInterval
- performanceThreshold
Properties
enabled
• Optional enabled: boolean
Whether the plugin is enabled
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:125
category
• Optional category: PluginCategory
Plugin category for classification
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:127
priority
• Optional priority: number
Plugin priority for execution order
Inherited from
Defined in
packages/agents/src/abstracts/base-plugin.ts:129
moduleEvents
• Optional moduleEvents: EventType[]
Events to subscribe to from modules
Inherited from
BasePluginOptions.moduleEvents
Defined in
packages/agents/src/abstracts/base-plugin.ts:131
subscribeToAllModuleEvents
• Optional subscribeToAllModuleEvents: boolean
Whether to subscribe to all module events
Inherited from
BasePluginOptions.subscribeToAllModuleEvents
Defined in
packages/agents/src/abstracts/base-plugin.ts:133
strategy
• strategy: PerformanceMonitoringStrategy
Performance monitoring strategy to use
Defined in
packages/agents/src/plugins/performance/types.ts:86
filePath
• Optional filePath: string
File path for file strategy
Defined in
packages/agents/src/plugins/performance/types.ts:88
remoteEndpoint
• Optional remoteEndpoint: string
Remote endpoint for remote strategy
Defined in
packages/agents/src/plugins/performance/types.ts:90
prometheusEndpoint
• Optional prometheusEndpoint: string
Prometheus endpoint for prometheus strategy
Defined in
packages/agents/src/plugins/performance/types.ts:92
remoteHeaders
• Optional remoteHeaders: Record<string, string>
Headers for remote monitoring
Defined in
packages/agents/src/plugins/performance/types.ts:94
maxEntries
• Optional maxEntries: number
Maximum number of performance entries to keep in memory
Defined in
packages/agents/src/plugins/performance/types.ts:96
monitorMemory
• Optional monitorMemory: boolean
Whether to monitor memory usage
Defined in
packages/agents/src/plugins/performance/types.ts:98
monitorCPU
• Optional monitorCPU: boolean
Whether to monitor CPU usage
Defined in
packages/agents/src/plugins/performance/types.ts:100
monitorNetwork
• Optional monitorNetwork: boolean
Whether to monitor network stats
Defined in
packages/agents/src/plugins/performance/types.ts:102
batchSize
• Optional batchSize: number
Batch size for remote reporting
Defined in
packages/agents/src/plugins/performance/types.ts:104
flushInterval
• Optional flushInterval: number
Flush interval for batched reporting in milliseconds
Defined in
packages/agents/src/plugins/performance/types.ts:106
aggregateStats
• Optional aggregateStats: boolean
Whether to aggregate statistics
Defined in
packages/agents/src/plugins/performance/types.ts:108
aggregationInterval
• Optional aggregationInterval: number
Aggregation interval in milliseconds
Defined in
packages/agents/src/plugins/performance/types.ts:110
performanceThreshold
• Optional performanceThreshold: number
Performance threshold in milliseconds to log warnings