agent-plugin-execution-analytics / Exports / ExecutionAnalyticsPlugin

Class: ExecutionAnalyticsPlugin

Tracks timing and success/failure of agent runs, provider calls, and tool executions.

Hierarchy

• AbstractPlugin<IExecutionAnalyticsOptions, IExecutionAnalyticsPluginStats>

  ↳ ExecutionAnalyticsPlugin

Table of contents

Constructors

• constructor

Properties

• enabled
• category
• priority
• name
• version

Methods

• initialize
• subscribeToModuleEvents
• unsubscribeFromModuleEvents
• dispose
• enable
• disable
• isEnabled
• getConfig
• updateConfig
• getData
• clearData
• beforeExecution
• afterExecution
• beforeConversation
• afterConversation
• beforeToolExecution
• afterToolExecution
• onStreamingChunk
• onMessageAdded
• onModuleEvent
• beforeRun
• afterRun
• beforeProviderCall
• afterProviderCall
• beforeToolCall
• afterToolCall
• onError
• getExecutionStats
• getAggregatedStats
• clearStats
• getActiveExecutions
• getPluginStats
• destroy
• getExecutionData
• getAnalyticsStats
• clearExecutionData
• getStatus
• getStats

Constructors

constructor

• new ExecutionAnalyticsPlugin(options?): ExecutionAnalyticsPlugin

Parameters

Name	Type
options	IExecutionAnalyticsOptions

Returns

ExecutionAnalyticsPlugin

Overrides

AbstractPlugin&lt; IExecutionAnalyticsOptions, IExecutionAnalyticsPluginStats &gt;.constructor

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:45

Properties

enabled

• enabled: boolean

Inherited from

AbstractPlugin.enabled

Defined in

agent-core/dist/node/index.d.ts:1049

---

category

• category: PluginCategory

Inherited from

AbstractPlugin.category

Defined in

agent-core/dist/node/index.d.ts:1050

---

priority

• priority: number

Inherited from

AbstractPlugin.priority

Defined in

agent-core/dist/node/index.d.ts:1051

---

name

• name: string = 'ExecutionAnalyticsPlugin'

Overrides

AbstractPlugin.name

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:34

---

version

• version: string = '1.0.0'

Overrides

AbstractPlugin.version

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:35

Methods

initialize

▸ initialize(options?): Promise<void>

Parameters

Name	Type
options?	IExecutionAnalyticsOptions

Returns

Promise<void>

Inherited from

AbstractPlugin.initialize

Defined in

agent-core/dist/node/index.d.ts:1063

---

subscribeToModuleEvents

▸ subscribeToModuleEvents(eventEmitter): Promise<void>

Parameters

Name	Type
eventEmitter	IEventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.subscribeToModuleEvents

Defined in

agent-core/dist/node/index.d.ts:1064

---

unsubscribeFromModuleEvents

▸ unsubscribeFromModuleEvents(eventEmitter): Promise<void>

Parameters

Name	Type
eventEmitter	IEventEmitterPlugin

Returns

Promise<void>

Inherited from

AbstractPlugin.unsubscribeFromModuleEvents

Defined in

agent-core/dist/node/index.d.ts:1065

---

dispose

▸ dispose(): Promise<void>

Returns

Promise<void>

Inherited from

AbstractPlugin.dispose

Defined in

agent-core/dist/node/index.d.ts:1066

---

enable

▸ enable(): void

Returns

void

Inherited from

AbstractPlugin.enable

Defined in

agent-core/dist/node/index.d.ts:1067

---

disable

▸ disable(): void

Returns

void

Inherited from

AbstractPlugin.disable

Defined in

agent-core/dist/node/index.d.ts:1068

---

isEnabled

▸ isEnabled(): boolean

Returns

boolean

Inherited from

AbstractPlugin.isEnabled

Defined in

agent-core/dist/node/index.d.ts:1069

---

getConfig

▸ getConfig(): IPluginConfig

Returns

IPluginConfig

Inherited from

AbstractPlugin.getConfig

Defined in

agent-core/dist/node/index.d.ts:1070

---

updateConfig

▸ updateConfig(_config): void

Parameters

Name	Type
_config	IPluginConfig

Returns

void

Inherited from

AbstractPlugin.updateConfig

Defined in

agent-core/dist/node/index.d.ts:1071

---

getData

▸ getData(): IPluginData

Returns

IPluginData

Inherited from

AbstractPlugin.getData

Defined in

agent-core/dist/node/index.d.ts:1072

---

clearData

▸ clearData(): void

Returns

void

Inherited from

AbstractPlugin.clearData

Defined in

agent-core/dist/node/index.d.ts:1073

---

beforeExecution

▸ beforeExecution(context): Promise<void>

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeExecution

Defined in

agent-core/dist/node/index.d.ts:1089

---

afterExecution

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

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterExecution

Defined in

agent-core/dist/node/index.d.ts:1090

---

beforeConversation

▸ beforeConversation(context): Promise<void>

Parameters

Name	Type
context	IPluginExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeConversation

Defined in

agent-core/dist/node/index.d.ts:1091

---

afterConversation

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

Parameters

Name	Type
context	IPluginExecutionContext
result	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterConversation

Defined in

agent-core/dist/node/index.d.ts:1092

---

beforeToolExecution

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

Parameters

Name	Type
context	IPluginExecutionContext
toolData	IToolExecutionContext

Returns

Promise<void>

Inherited from

AbstractPlugin.beforeToolExecution

Defined in

agent-core/dist/node/index.d.ts:1094

---

afterToolExecution

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

Parameters

Name	Type
context	IPluginExecutionContext
toolResults	IPluginExecutionResult

Returns

Promise<void>

Inherited from

AbstractPlugin.afterToolExecution

Defined in

agent-core/dist/node/index.d.ts:1096

---

onStreamingChunk

▸ onStreamingChunk(chunk): Promise<void>

Parameters

Name	Type
chunk	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onStreamingChunk

Defined in

agent-core/dist/node/index.d.ts:1099

---

onMessageAdded

▸ onMessageAdded(message): Promise<void>

Parameters

Name	Type
message	TUniversalMessage

Returns

Promise<void>

Inherited from

AbstractPlugin.onMessageAdded

Defined in

agent-core/dist/node/index.d.ts:1101

---

onModuleEvent

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

Parameters

Name	Type
eventName	TEventName
eventData	IEventEmitterEventData

Returns

Promise<void>

Inherited from

AbstractPlugin.onModuleEvent

Defined in

agent-core/dist/node/index.d.ts:1102

---

beforeRun

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

Parameters

Name	Type
input	string
_options?	IRunOptions

Returns

Promise<void>

Overrides

AbstractPlugin.beforeRun

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:69

---

afterRun

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

Parameters

Name	Type
input	string
response	string
options?	IRunOptions

Returns

Promise<void>

Overrides

AbstractPlugin.afterRun

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:77

---

beforeProviderCall

▸ beforeProviderCall(messages): Promise<void>

Parameters

Name	Type
messages	TUniversalMessage[]

Returns

Promise<void>

Overrides

AbstractPlugin.beforeProviderCall

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:110

---

afterProviderCall

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

Parameters

Name	Type
messages	TUniversalMessage[]
response	TUniversalMessage

Returns

Promise<void>

Overrides

AbstractPlugin.afterProviderCall

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:118

---

beforeToolCall

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

Parameters

Name	Type
toolName	string
_parameters	TToolParameters

Returns

Promise<void>

Overrides

AbstractPlugin.beforeToolCall

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:155

---

afterToolCall

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

Parameters

Name	Type
toolName	string
parameters	TToolParameters
result	IToolExecutionResult

Returns

Promise<void>

Overrides

AbstractPlugin.afterToolCall

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:163

---

onError

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

Parameters

Name	Type
error	Error
context?	IPluginErrorContext

Returns

Promise<void>

Overrides

AbstractPlugin.onError

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:195

---

getExecutionStats

▸ getExecutionStats(operation?, timeRange?): IExecutionStats[]

Parameters

Name	Type
operation?	string
timeRange?	Object
timeRange.start	Date
timeRange.end	Date

Returns

IExecutionStats[]

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:225

---

getAggregatedStats

▸ getAggregatedStats(timeRange?): IAggregatedExecutionStats

Parameters

Name	Type
timeRange?	Object
timeRange.start	Date
timeRange.end	Date

Returns

IAggregatedExecutionStats

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:235

---

clearStats

▸ clearStats(): void

Returns

void

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:239

---

getActiveExecutions

▸ getActiveExecutions(): { executionId: string ; operation: string ; duration: number }[]

Returns

{ executionId: string ; operation: string ; duration: number }[]

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:245

---

getPluginStats

▸ getPluginStats(): Object

Returns

Object

Name	Type
totalRecorded	number
activeExecutions	number
memoryUsage	number
oldestRecord?	Date
newestRecord?	Date

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:254

---

destroy

▸ destroy(): Promise<void>

Returns

Promise<void>

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:279

---

getExecutionData

▸ getExecutionData(): IExecutionStats[]

Returns

IExecutionStats[]

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:282

---

getAnalyticsStats

▸ getAnalyticsStats(): IAggregatedExecutionStats

Returns

IAggregatedExecutionStats

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:285

---

clearExecutionData

▸ clearExecutionData(): void

Returns

void

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:288

---

getStatus

▸ getStatus(): Object

Returns

Object

Name	Type
name	string
version	string
enabled	boolean
initialized	boolean
category	PluginCategory
priority	number
subscribedEventsCount	number
hasEventEmitter	boolean

Overrides

AbstractPlugin.getStatus

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:292

---

getStats

▸ getStats(): IExecutionAnalyticsPluginStats

Returns

IExecutionAnalyticsPluginStats

Overrides

AbstractPlugin.getStats

Defined in

agent-plugin-execution-analytics/src/execution-analytics-plugin.ts:314