Class InsightsClientNode

Node.js InsightsClient that writes directly to database

Hierarchy

InsightsClient
- InsightsClientNode

Index

Constructors

Methods

_getEmitContext addEvent addExecution addInChain addLLMInvocation addSessionTags addUserInput createScope endChain exportSession flushBatch getChainDepth getSessionId getSessionTags setEnabled shutdown startChain

Constructors

constructor

new InsightsClientNode(config): InsightsClientNode
Parameters
- config: node.apis.insights.InsightsConfig
Returns InsightsClientNode
Inherited from InsightsClient.constructor
- Defined in packages/ts_common/dist/apis/insights.d.ts:51

Methods

_getEmitContext

_getEmitContext(): EmitContext
Internal: expose context for InsightsScope

Returns EmitContext
Inherited from InsightsClient._getEmitContext
- Defined in packages/ts_common/dist/apis/insights.d.ts:134

addEvent

addEvent(event_type, payload, options?): Promise<string>
Add a generic event
Parameters
- event_type: string
- payload: Record<string, any>
- Optionaloptions: node.common.insights.AddEventOptions
Returns Promise<string>
Inherited from InsightsClient.addEvent
- Defined in packages/ts_common/dist/apis/insights.d.ts:63

addExecution

addExecution(data): Promise<string>
Convenience method: Add execution event
Parameters
- data: node.common.insights.ExecutionData
Returns Promise<string>
Inherited from InsightsClient.addExecution
- Defined in packages/ts_common/dist/apis/insights.d.ts:84

addInChain

addInChain(event_type, payload, options?): Promise<string>
Add an event in the current chain
Parameters
- event_type: string
- payload: Record<string, any>
- Optionaloptions: node.common.insights.AddEventOptions
Returns Promise<string>
Inherited from InsightsClient.addInChain
- Defined in packages/ts_common/dist/apis/insights.d.ts:76

addLLMInvocation

addLLMInvocation(data): Promise<string>
Convenience method: Add LLM invocation event
Parameters
- data: node.common.insights.LLMInvocationData
Returns Promise<string>
Inherited from InsightsClient.addLLMInvocation
- Defined in packages/ts_common/dist/apis/insights.d.ts:80

addSessionTags

addSessionTags(tags): void
Add tags to the current session
Parameters
- tags: string[]
Returns void
Inherited from InsightsClient.addSessionTags
- Defined in packages/ts_common/dist/apis/insights.d.ts:104

addUserInput

addUserInput(data): Promise<string>
Convenience method: Add user input event
Parameters
- data: node.common.insights.UserInputData
Returns Promise<string>
Inherited from InsightsClient.addUserInput
- Defined in packages/ts_common/dist/apis/insights.d.ts:88

createScope

createScope(config): node.common.insights.InsightsScope
Create a scoped insights context with its own trace and chain stack
Parameters
- config: node.common.insights.InsightsScopeConfig
Returns node.common.insights.InsightsScope
Inherited from InsightsClient.createScope
- Defined in packages/ts_common/dist/apis/insights.d.ts:138

endChain

endChain(): void
End the current event chain

Returns void
Inherited from InsightsClient.endChain
- Defined in packages/ts_common/dist/apis/insights.d.ts:72

exportSession

exportSession(): {
    app_name: string;
    events: node.apis.insights.InsightsEvent[];
    exported_at: number;
    session_id: string;
    tags: string[];
}
Export cumulative session data (never cleared by flushBatch)

Returns {
    app_name: string;
    events: node.apis.insights.InsightsEvent[];
    exported_at: number;
    session_id: string;
    tags: string[];
}
- app_name: string
- events: node.apis.insights.InsightsEvent[]
- exported_at: number
- session_id: string
- tags: string[]
Inherited from InsightsClient.exportSession
- Defined in packages/ts_common/dist/apis/insights.d.ts:120

flushBatch

flushBatch(): Promise<void>
Override flushBatch to use direct database connection

Returns Promise<void>
Overrides InsightsClient.flushBatch
- Defined in packages/ts_node/src/apis/insights_node.ts:23

getChainDepth

getChainDepth(): number
Get current chain depth

Returns number
Inherited from InsightsClient.getChainDepth
- Defined in packages/ts_common/dist/apis/insights.d.ts:116

getSessionId

getSessionId(): string
Get current session ID

Returns string
Inherited from InsightsClient.getSessionId
- Defined in packages/ts_common/dist/apis/insights.d.ts:112

getSessionTags

getSessionTags(): string[]
Get current session tags

Returns string[]
Inherited from InsightsClient.getSessionTags
- Defined in packages/ts_common/dist/apis/insights.d.ts:108

setEnabled

setEnabled(enabled): void
Enable/disable event tracking
Parameters
- enabled: boolean
Returns void
Inherited from InsightsClient.setEnabled
- Defined in packages/ts_common/dist/apis/insights.d.ts:130

shutdown

shutdown(): Promise<void>
Manually flush and cleanup

Returns Promise<void>
Inherited from InsightsClient.shutdown
- Defined in packages/ts_common/dist/apis/insights.d.ts:100

startChain

startChain(event_type, payload): Promise<string>
Start an event chain Returns the event_id which becomes the parent for subsequent events
Parameters
- event_type: string
- payload: Record<string, any>
Returns Promise<string>
Inherited from InsightsClient.startChain
- Defined in packages/ts_common/dist/apis/insights.d.ts:68

Class InsightsClientNode

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns InsightsClientNode

Methods

_getEmitContext

Returns EmitContext

addEvent

Parameters

Returns Promise<string>

addExecution

Parameters

Returns Promise<string>

addInChain

Parameters

Returns Promise<string>

addLLMInvocation

Parameters

Returns Promise<string>

addSessionTags

Parameters

Returns void

addUserInput

Parameters

Returns Promise<string>

createScope

Parameters

Returns node.common.insights.InsightsScope

endChain

Returns void

exportSession

Returns { app_name: string; events: node.apis.insights.InsightsEvent[]; exported_at: number; session_id: string; tags: string[]; }

app_name: string

events: node.apis.insights.InsightsEvent[]

exported_at: number

session_id: string

tags: string[]

flushBatch

Returns Promise<void>

getChainDepth

Returns number

getSessionId

Returns string

getSessionTags

Returns string[]

setEnabled

Parameters

Returns void

shutdown

Returns Promise<void>

startChain

Parameters

Returns Promise<string>

Settings

On This Page

Returns {
app_name: string;
events: node.apis.insights.InsightsEvent[];
exported_at: number;
session_id: string;
tags: string[];
}