agent-plugin-performance / Exports / IPerformancePluginOptions
Interface: IPerformancePluginOptions
Configuration options for performance plugin
Hierarchy
IPluginOptions↳
IPerformancePluginOptions
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
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: TPerformanceMonitoringStrategy
Performance monitoring strategy to use
Defined in
agent-plugin-performance/src/types.ts:89
filePath
• Optional filePath: string
File path for file strategy
Defined in
agent-plugin-performance/src/types.ts:91
remoteEndpoint
• Optional remoteEndpoint: string
Remote endpoint for remote strategy
Defined in
agent-plugin-performance/src/types.ts:93
prometheusEndpoint
• Optional prometheusEndpoint: string
Prometheus endpoint for prometheus strategy
Defined in
agent-plugin-performance/src/types.ts:95
remoteHeaders
• Optional remoteHeaders: Record<string, string>
Headers for remote monitoring
Defined in
agent-plugin-performance/src/types.ts:97
maxEntries
• Optional maxEntries: number
Maximum number of performance entries to keep in memory
Defined in
agent-plugin-performance/src/types.ts:99
monitorMemory
• Optional monitorMemory: boolean
Whether to monitor memory usage
Defined in
agent-plugin-performance/src/types.ts:101
monitorCPU
• Optional monitorCPU: boolean
Whether to monitor CPU usage
Defined in
agent-plugin-performance/src/types.ts:103
monitorNetwork
• Optional monitorNetwork: boolean
Whether to monitor network stats
Defined in
agent-plugin-performance/src/types.ts:105
batchSize
• Optional batchSize: number
Batch size for remote reporting
Defined in
agent-plugin-performance/src/types.ts:107
flushInterval
• Optional flushInterval: number
Flush interval for batched reporting in milliseconds
Defined in
agent-plugin-performance/src/types.ts:109
aggregateStats
• Optional aggregateStats: boolean
Whether to aggregate statistics
Defined in
agent-plugin-performance/src/types.ts:111
aggregationInterval
• Optional aggregationInterval: number
Aggregation interval in milliseconds
Defined in
agent-plugin-performance/src/types.ts:113
performanceThreshold
• Optional performanceThreshold: number
Performance threshold in milliseconds to log warnings