agent-plugin-logging / Exports / ILoggingPluginOptions
Interface: ILoggingPluginOptions
Configuration options for logging plugin
Hierarchy
IPluginOptions↳
ILoggingPluginOptions
Table of contents
Properties
- enabled
- category
- priority
- moduleEvents
- subscribeToAllModuleEvents
- strategy
- level
- filePath
- remoteEndpoint
- remoteHeaders
- maxLogs
- includeStackTrace
- formatter
- logger
- batchSize
- flushInterval
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: TLoggingStrategy
Logging strategy to use
Defined in
agent-plugin-logging/src/types.ts:36
level
• Optional level: TLogLevel
Minimum log level to capture
Defined in
agent-plugin-logging/src/types.ts:38
filePath
• Optional filePath: string
File path for file strategy
Defined in
agent-plugin-logging/src/types.ts:40
remoteEndpoint
• Optional remoteEndpoint: string
Remote endpoint for remote strategy
Defined in
agent-plugin-logging/src/types.ts:42
remoteHeaders
• Optional remoteHeaders: Record<string, string>
Headers for remote logging
Defined in
agent-plugin-logging/src/types.ts:44
maxLogs
• Optional maxLogs: number
Maximum number of logs to keep in memory
Defined in
agent-plugin-logging/src/types.ts:46
includeStackTrace
• Optional includeStackTrace: boolean
Whether to include stack traces in error logs
Defined in
agent-plugin-logging/src/types.ts:48
formatter
• Optional formatter: ILogFormatter
Custom log formatter
Defined in
agent-plugin-logging/src/types.ts:50
logger
• Optional logger: ILogger
Logger instance for internal plugin logging
Defined in
agent-plugin-logging/src/types.ts:52
batchSize
• Optional batchSize: number
Batch size for remote logging
Defined in
agent-plugin-logging/src/types.ts:54
flushInterval
• Optional flushInterval: number
Flush interval for batched logging in milliseconds