agents / Exports / LoggingPlugin

Class: LoggingPlugin

Plugin for logging agent operations Supports multiple logging strategies: console, file, remote, silent

Hierarchy

• AbstractPlugin<LoggingPluginOptions, LoggingPluginStats>

  ↳ LoggingPlugin

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
• log
• debug
• info
• warn
• error
• logExecutionStart
• logExecutionComplete
• logToolExecution
• flush
• destroy

Constructors

constructor

• new LoggingPlugin(options): LoggingPlugin

Parameters

Name	Type
options	LoggingPluginOptions

Returns

LoggingPlugin

Overrides

AbstractPlugin.constructor

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:55

Properties

enabled

• enabled: boolean = true

Plugin enabled state

Inherited from

AbstractPlugin.enabled

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:307

---

category

• category: PluginCategory = PluginCategory.CUSTOM

Plugin category for classification

Inherited from

AbstractPlugin.category

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:310

---

priority

• priority: number = PluginPriority.NORMAL

Plugin priority for execution order

Inherited from

AbstractPlugin.priority

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:313

---

name

• name: string = 'LoggingPlugin'

Plugin name

Overrides

AbstractPlugin.name

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:46

---

version

• version: string = '1.0.0'

Plugin version

Overrides

AbstractPlugin.version

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:47

Methods

initialize

▸ initialize(options?): Promise<void>

Initialize the plugin with type-safe options

Parameters

Name	Type
options?	LoggingPluginOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.initialize

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:338

---

subscribeToModuleEvents

▸ subscribeToModuleEvents(eventEmitter): Promise<void>

Subscribe to module events through EventEmitter

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.subscribeToModuleEvents

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:366

---

unsubscribeFromModuleEvents

▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>

Unsubscribe from module events

Parameters

Name	Type
eventEmitter	EventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.unsubscribeFromModuleEvents

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:423

---

dispose

▸ dispose(): Promise<void>

Cleanup plugin resources

Returns

Promise<void>

Inherited from

AbstractPlugin.dispose

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:438

---

enable

▸ enable(): void

Enable the plugin

Returns

void

Inherited from

AbstractPlugin.enable

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:450

---

disable

▸ disable(): void

Disable the plugin

Returns

void

Inherited from

AbstractPlugin.disable

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:457

---

isEnabled

▸ isEnabled(): boolean

Check if plugin is enabled

Returns

boolean

Inherited from

AbstractPlugin.isEnabled

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:464

---

getConfig

▸ getConfig(): IPluginConfig

Get plugin configuration

Returns

IPluginConfig

Inherited from

AbstractPlugin.getConfig

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:471

---

updateConfig

▸ updateConfig(_config): void

Update plugin configuration

Parameters

Name	Type
_config	IPluginConfig

Returns

void

Inherited from

AbstractPlugin.updateConfig

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:478

---

getData

▸ getData(): IPluginData

Get plugin data - enhanced with classification information

Returns

IPluginData

Inherited from

AbstractPlugin.getData

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:485

---

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

AbstractPlugin.clearData

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:505

---

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

AbstractPlugin.getStatus

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:510

---

getStats

▸ getStats(): LoggingPluginStats

Get plugin statistics - enhanced with module event tracking

Returns

LoggingPluginStats

Inherited from

AbstractPlugin.getStats

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:535

---

beforeRun

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

Called before agent run

Parameters

Name	Type
input	string
options?	IRunOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeRun

Defined in

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

---

afterRun

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

Called after agent run

Parameters

Name	Type
input	string
response	string
options?	IRunOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.afterRun

Defined in

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

---

beforeExecution

▸ beforeExecution(context): Promise<void>

Called before execution with context

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeExecution

Defined in

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

---

afterExecution

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

Called after execution with context and result

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterExecution

Defined in

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

---

beforeConversation

▸ beforeConversation(context): Promise<void>

Called before conversation with context

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeConversation

Defined in

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

---

afterConversation

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

Called after conversation with context and result

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterConversation

Defined in

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

---

beforeToolCall

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

Called before tool execution

Parameters

Name	Type
toolName	string
parameters	TToolParameters

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeToolCall

Defined in

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

---

beforeToolExecution

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

Called before tool execution with context

Parameters

Name	Type
context	IPluginExecutionContext
toolData	IToolExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeToolExecution

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:571

---

afterToolCall

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

Called after tool execution

Parameters

Name	Type
toolName	string
parameters	TToolParameters
result	IToolExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterToolCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:572

---

afterToolExecution

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

Called after tool execution with context

Parameters

Name	Type
context	IPluginExecutionContext
toolResults	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterToolExecution

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:573

---

beforeProviderCall

▸ beforeProviderCall(messages): Promise<void>

Called before AI provider call

Parameters

Name	Type
messages	TUniversalMessage[]

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeProviderCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:574

---

afterProviderCall

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

Called after AI provider call

Parameters

Name	Type
messages	TUniversalMessage[]
response	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.afterProviderCall

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:575

---

onStreamingChunk

▸ onStreamingChunk(chunk): Promise<void>

Called on streaming chunk

Parameters

Name	Type
chunk	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onStreamingChunk

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:576

---

onError

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

Called on error

Parameters

Name	Type
error	Error
context?	IPluginErrorContext

Returns

Promise<void>

Inherited from

AbstractPlugin.onError

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:577

---

onMessageAdded

▸ onMessageAdded(message): Promise<void>

Called on message added to history

Parameters

Name	Type
message	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onMessageAdded

Defined in

packages/agents/src/abstracts/abstract-plugin.ts:578

---

onModuleEvent

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

Handle module events for logging

Parameters

Name	Type
eventType	EventType
eventData	EventData

Returns

Promise<void>

Overrides

AbstractPlugin.onModuleEvent

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:100

---

log

▸ log(level, message, context?, metadata?): Promise<void>

Log a message

Parameters

Name	Type
level	LogLevel
message	string
context?	LoggingContextData
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

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

---

debug

▸ debug(message, context?, metadata?): Promise<void>

Log debug message

Parameters

Name	Type
message	string
context?	LoggingContextData
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:236

---

info

▸ info(message, context?, metadata?): Promise<void>

Log info message

Parameters

Name	Type
message	string
context?	LoggingContextData
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:243

---

warn

▸ warn(message, context?, metadata?): Promise<void>

Log warning message

Parameters

Name	Type
message	string
context?	LoggingContextData
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:250

---

error

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

Log error message

Parameters

Name	Type
message	string
error?	Error
context?	LoggingContextData
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:257

---

logExecutionStart

▸ logExecutionStart(executionId, userInput, metadata?): Promise<void>

Log execution start

Parameters

Name	Type
executionId	string
userInput	string
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:272

---

logExecutionComplete

▸ logExecutionComplete(executionId, duration, metadata?): Promise<void>

Log execution completion

Parameters

Name	Type
executionId	string
duration	number
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:283

---

logToolExecution

▸ logToolExecution(toolName, executionId, duration?, success?, metadata?): Promise<void>

Log tool execution

Parameters

Name	Type
toolName	string
executionId	string
duration?	number
success?	boolean
metadata?	Object
metadata.executionId?	string
metadata.conversationId?	string
metadata.userId?	string
metadata.sessionId?	string
metadata.operation?	string
metadata.duration?	number

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:295

---

flush

▸ flush(): Promise<void>

Flush any pending logs

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:312

---

destroy

▸ destroy(): Promise<void>

Cleanup resources

Returns

Promise<void>

Defined in

packages/agents/src/plugins/logging/logging-plugin.ts:325