Class ConsoleCallbackHandler

A tracer that logs all events to the console. It extends from the BaseTracer class and overrides its methods to provide custom logging functionality.

Example


const llm = new ChatAnthropic({
  temperature: 0,
  tags: ["example", "callbacks", "constructor"],
  callbacks: [new ConsoleCallbackHandler()],
});

Hierarchy (View Summary)

BaseTracer
- ConsoleCallbackHandler

Index

Constructors

constructor

new ConsoleCallbackHandler(
_fields?: BaseCallbackHandlerInput,
): ConsoleCallbackHandler
Parameters
- Optional_fields: BaseCallbackHandlerInput
Returns ConsoleCallbackHandler
Inherited from BaseTracer.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:98

Properties

awaitHandlers

awaitHandlers: boolean = ...

ignoreAgent

ignoreAgent: boolean = false

ignoreChain

ignoreChain: boolean = false

ignoreCustomEvent

ignoreCustomEvent: boolean = false

ignoreLLM

ignoreLLM: boolean = false

ignoreRetriever

ignoreRetriever: boolean = false

lc_kwargs

lc_kwargs: SerializedFields

lc_serializable

lc_serializable: boolean = false

name

name: "console_callback_handler" = ...

raiseError

raiseError: boolean = false

`Protected`runMap

runMap: Map<string, Run> = ...

Deprecated

Use runTreeMap instead.

`Protected`runTreeMap

runTreeMap: Map<string, RunTree> = ...

`Protected`usesRunTreeMap

usesRunTreeMap: boolean = false

Accessors

lc_aliases

get lc_aliases(): undefined | { [key: string]: string }
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | { [key: string]: string }
Inherited from BaseTracer.lc_aliases
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:327

lc_attributes

get lc_attributes(): undefined | { [key: string]: string }
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | { [key: string]: string }
Inherited from BaseTracer.lc_attributes
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:323

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from BaseTracer.lc_id
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:348

lc_namespace

get lc_namespace(): ["langchain_core", "callbacks", string]
A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

Returns ["langchain_core", "callbacks", string]
Inherited from SingleRunExtractor.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:315

lc_secrets

get lc_secrets(): undefined | { [key: string]: string }
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | { [key: string]: string }
Inherited from BaseTracer.lc_secrets
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:319

lc_serializable_keys

get lc_serializable_keys(): undefined | string[]
A manual list of keys that should be serialized. If not overridden, all fields passed into the constructor will be serialized.

Returns undefined | string[]
Inherited from SingleRunExtractor.lc_serializable_keys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:331

Methods

`Protected`_addChildRun

_addChildRun(parentRun: Run, childRun: Run): void
Parameters
- parentRun: Run
- childRun: Run
Returns void
Inherited from BaseTracer._addChildRun
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:130

_addRunToRunMap

_addRunToRunMap(
    run: Run,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Parameters
- run: Run
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._addRunToRunMap
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:134

_createRunForChainStart

_createRunForChainStart(
    chain: Serialized,
    inputs: ChainValues,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    runType?: string,
    name?: string,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Create and add a run to the run map for chain start events. This must sometimes be done synchronously to avoid race conditions when callbacks are backgrounded, so we expose it as a separate method here.
Parameters
- chain: Serialized
- inputs: ChainValues
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- OptionalrunType: string
- Optionalname: string
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._createRunForChainStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:403

_createRunForChatModelStart

_createRunForChatModelStart(
    llm: Serialized,
    messages: BaseMessage<MessageStructure, MessageType>[][],
    runId: string,
    parentRunId?: string,
    extraParams?: KVMap,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Create and add a run to the run map for chat model start events. This must sometimes be done synchronously to avoid race conditions when callbacks are backgrounded, so we expose it as a separate method here.
Parameters
- llm: Serialized
- messages: BaseMessage<MessageStructure, MessageType>[][]
- runId: string
- OptionalparentRunId: string
- OptionalextraParams: KVMap
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._createRunForChatModelStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:287

_createRunForLLMStart

_createRunForLLMStart(
    llm: Serialized,
    prompts: string[],
    runId: string,
    parentRunId?: string,
    extraParams?: KVMap,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Create and add a run to the run map for LLM start events. This must sometimes be done synchronously to avoid race conditions when callbacks are backgrounded, so we expose it as a separate method here.
Parameters
- llm: Serialized
- prompts: string[]
- runId: string
- OptionalparentRunId: string
- OptionalextraParams: KVMap
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._createRunForLLMStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:217

_createRunForRetrieverStart

_createRunForRetrieverStart(
    retriever: Serialized,
    query: string,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Create and add a run to the run map for retriever start events. This must sometimes be done synchronously to avoid race conditions when callbacks are backgrounded, so we expose it as a separate method here.
Parameters
- retriever: Serialized
- query: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._createRunForRetrieverStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:646

_createRunForToolStart

_createRunForToolStart(
    tool: Serialized,
    input: string,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
Create and add a run to the run map for tool start events. This must sometimes be done synchronously to avoid race conditions when callbacks are backgrounded, so we expose it as a separate method here.
Parameters
- tool: Serialized
- input: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns {
    child_execution_order: number;
    child_runs: Run[];
    dotted_order?: string;
    end_time?: number;
    events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
    execution_order: number;
    id: string;
    start_time: number;
    trace_id?: string;
}
- child_execution_order: number
- child_runs: Run[]
- Optionaldotted_order?: string
  The dotted order for the run.
  
  This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
  
  Example:
  - Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
  - Children:
    
    20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
    
    20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
- Optionalend_time?: number
  The epoch time at which the run ended, if applicable.
- events: { kwargs?: Record<string, unknown>; name: string; time: string }[]
  Events like 'start', 'end' linked to the run.
- execution_order: number
- id: string
  Optionally, a unique identifier for the run.
- start_time: number
  The epoch time at which the run started, if available.
- Optionaltrace_id?: string
  Unique ID assigned to every run within this nested trace. *
Inherited from BaseTracer._createRunForToolStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:520

`Protected`_endTrace

_endTrace(run: Run): Promise<void>
Parameters
- run: Run
Returns Promise<void>
Inherited from BaseTracer._endTrace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:183

`Protected`_getExecutionOrder

_getExecutionOrder(parentRunId: undefined | string): number
Parameters
- parentRunId: undefined | string
Returns number
Inherited from BaseTracer._getExecutionOrder
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:202

copy

copy(): this
Returns this
Inherited from BaseTracer.copy
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:102

getBreadcrumbs

getBreadcrumbs(run: Run): string
Method used to get a string representation of the run's lineage, which is used in logging.
Parameters
- run: Run
  The run whose lineage is to be retrieved.
Returns string
A string representation of the run's lineage.
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:96

getParents

getParents(run: Run): Run[]
Method used to get all the parent runs of a given run.
Parameters
- run: Run
  The run whose parents are to be retrieved.
Returns Run[]
An array of parent runs.
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:75

`Protected`getRunById

getRunById(runId?: string): undefined | Run
Parameters
- OptionalrunId: string
Returns undefined | Run
Inherited from BaseTracer.getRunById
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:106

handleAgentAction

handleAgentAction(action: AgentAction, runId: string): Promise<void>
Called when an agent is about to execute an action, with the action and the run ID.
Parameters
- action: AgentAction
- runId: string
Returns Promise<void>
Inherited from BaseTracer.handleAgentAction
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:612

handleAgentEnd

handleAgentEnd(action: AgentFinish, runId: string): Promise<void>
Called when an agent finishes execution, before it exits. with the final output and the run ID.
Parameters
- action: AgentFinish
- runId: string
Returns Promise<void>
Inherited from BaseTracer.handleAgentEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:628

handleChainEnd

handleChainEnd(
    outputs: ChainValues,
    runId: string,
    _parentRunId?: string,
    _tags?: string[],
    kwargs?: { inputs?: Record<string, unknown> },
): Promise<Run>
Called at the end of a Chain run, with the outputs and the run ID.
Parameters
- outputs: ChainValues
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalkwargs: { inputs?: Record<string, unknown> }
Returns Promise<Run>
Inherited from BaseTracer.handleChainEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:465

handleChainError

handleChainError(
    error: unknown,
    runId: string,
    _parentRunId?: string,
    _tags?: string[],
    kwargs?: { inputs?: Record<string, unknown> },
): Promise<Run>
Called if a Chain run encounters an error
Parameters
- error: unknown
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalkwargs: { inputs?: Record<string, unknown> }
Returns Promise<Run>
Inherited from BaseTracer.handleChainError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:490

handleChainStart

handleChainStart(
    chain: Serialized,
    inputs: ChainValues,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    runType?: string,
    name?: string,
): Promise<Run>
Called at the start of a Chain run, with the chain name and inputs and the run ID.
Parameters
- chain: Serialized
- inputs: ChainValues
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- OptionalrunType: string
- Optionalname: string
Returns Promise<Run>
Inherited from BaseTracer.handleChainStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:438

handleChatModelStart

handleChatModelStart(
    llm: Serialized,
    messages: BaseMessage<MessageStructure, MessageType>[][],
    runId: string,
    parentRunId?: string,
    extraParams?: KVMap,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): Promise<Run>
Called at the start of a Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- messages: BaseMessage<MessageStructure, MessageType>[][]
- runId: string
- OptionalparentRunId: string
- OptionalextraParams: KVMap
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns Promise<Run>
Inherited from BaseTracer.handleChatModelStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:325

`Optional`handleCustomEvent

handleCustomEvent?(
    eventName: string,
    data: any,
    runId: string,
    tags?: string[],
    metadata?: Record<string, any>,
): any
Parameters
- eventName: string
- data: any
- runId: string
- Optionaltags: string[]
- Optionalmetadata: Record<string, any>
Returns any
Inherited from BaseTracer.handleCustomEvent
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:267

handleLLMEnd

handleLLMEnd(
    output: LLMResult,
    runId: string,
    _parentRunId?: string,
    _tags?: string[],
    extraParams?: Record<string, unknown>,
): Promise<Run>
Called at the end of an LLM/ChatModel run, with the output and the run ID.
Parameters
- output: LLMResult
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- OptionalextraParams: Record<string, unknown>
Returns Promise<Run>
Inherited from BaseTracer.handleLLMEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:352

handleLLMError

handleLLMError(
    error: unknown,
    runId: string,
    _parentRunId?: string,
    _tags?: string[],
    extraParams?: Record<string, unknown>,
): Promise<Run>
Called if an LLM/ChatModel run encounters an error
Parameters
- error: unknown
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- OptionalextraParams: Record<string, unknown>
Returns Promise<Run>
Inherited from BaseTracer.handleLLMError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:375

handleLLMNewToken

handleLLMNewToken(
    token: string,
    idx: NewTokenIndices,
    runId: string,
    _parentRunId?: string,
    _tags?: string[],
    fields?: HandleLLMNewTokenCallbackFields,
): Promise<Run>
Called when an LLM/ChatModel in streaming mode produces a new token
Parameters
- token: string
- idx: NewTokenIndices
  idx.prompt is the index of the prompt that produced the token (if there are multiple prompts) idx.completion is the index of the completion that produced the token (if multiple completions per prompt are requested)
- runId: string
- Optional_parentRunId: string
- Optional_tags: string[]
- Optionalfields: HandleLLMNewTokenCallbackFields
Returns Promise<Run>
Inherited from BaseTracer.handleLLMNewToken
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:753

handleLLMStart

handleLLMStart(
    llm: Serialized,
    prompts: string[],
    runId: string,
    parentRunId?: string,
    extraParams?: KVMap,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): Promise<Run>
Called at the start of an LLM or Chat Model run, with the prompt(s) and the run ID.
Parameters
- llm: Serialized
- prompts: string[]
- runId: string
- OptionalparentRunId: string
- OptionalextraParams: KVMap
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns Promise<Run>
Inherited from BaseTracer.handleLLMStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:255

handleRetrieverEnd

handleRetrieverEnd(
documents: Document<Record<string, unknown>>[],
runId: string,
): Promise<Run>
Parameters
- documents: Document<Record<string, unknown>>[]
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:705

handleRetrieverError

handleRetrieverError(error: unknown, runId: string): Promise<Run>
Parameters
- error: unknown
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:724

handleRetrieverStart

handleRetrieverStart(
    retriever: Serialized,
    query: string,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): Promise<Run>
Parameters
- retriever: Serialized
- query: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns Promise<Run>
Inherited from BaseTracer.handleRetrieverStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:680

handleText

handleText(text: string, runId: string): Promise<void>
Parameters
- text: string
- runId: string
Returns Promise<void>
Inherited from BaseTracer.handleText
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:740

handleToolEnd

handleToolEnd(output: any, runId: string): Promise<Run>
Called at the end of a Tool run, with the tool output and the run ID.
Parameters
- output: any
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleToolEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:580

handleToolError

handleToolError(error: unknown, runId: string): Promise<Run>
Called if a Tool run encounters an error
Parameters
- error: unknown
- runId: string
Returns Promise<Run>
Inherited from BaseTracer.handleToolError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:596

handleToolStart

handleToolStart(
    tool: Serialized,
    input: string,
    runId: string,
    parentRunId?: string,
    tags?: string[],
    metadata?: KVMap,
    name?: string,
): Promise<Run>
Called at the start of a Tool run, with the tool name and input and the run ID.
Parameters
- tool: Serialized
- input: string
- runId: string
- OptionalparentRunId: string
- Optionaltags: string[]
- Optionalmetadata: KVMap
- Optionalname: string
Returns Promise<Run>
Inherited from BaseTracer.handleToolStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:554

onAgentAction

onAgentAction(run: Run): void
Method used to log the action selected by the agent.
Parameters
- run: Run
  The run in which the agent action occurred.
Returns void
void
Overrides BaseTracer.onAgentAction
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:322

`Optional`onAgentEnd

onAgentEnd?(run: Run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onAgentEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:802

onChainEnd

onChainEnd(run: Run): void
Method used to log the end of a chain run.
Parameters
- run: Run
  The chain run that has ended.
Returns void
void
Overrides BaseTracer.onChainEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:132

onChainError

onChainError(run: Run): void
Method used to log any errors of a chain run.
Parameters
- run: Run
  The chain run that has errored.
Returns void
void
Overrides BaseTracer.onChainError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:149

onChainStart

onChainStart(run: Run): void
Method used to log the start of a chain run.
Parameters
- run: Run
  The chain run that has started.
Returns void
void
Overrides BaseTracer.onChainStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:114

onLLMEnd

onLLMEnd(run: Run): void
Method used to log the end of an LLM run.
Parameters
- run: Run
  The LLM run that has ended.
Returns void
void
Overrides BaseTracer.onLLMEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:188

onLLMError

onLLMError(run: Run): void
Method used to log any errors of an LLM run.
Parameters
- run: Run
  The LLM run that has errored.
Returns void
void
Overrides BaseTracer.onLLMError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:205

`Optional`onLLMNewToken

onLLMNewToken?(
    run: Run,
    token: string,
    kwargs?: { chunk: any },
): void | Promise<void>
Parameters
- run: Run
- token: string
- Optionalkwargs: { chunk: any }
Returns void | Promise<void>
Inherited from BaseTracer.onLLMNewToken
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:812

onLLMStart

onLLMStart(run: Run): void
Method used to log the start of an LLM run.
Parameters
- run: Run
  The LLM run that has started.
Returns void
void
Overrides BaseTracer.onLLMStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:166

onRetrieverEnd

onRetrieverEnd(run: Run): void
Method used to log the end of a retriever run.
Parameters
- run: Run
  The retriever run that has ended.
Returns void
void
Overrides BaseTracer.onRetrieverEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:288

onRetrieverError

onRetrieverError(run: Run): void
Method used to log any errors of a retriever run.
Parameters
- run: Run
  The retriever run that has errored.
Returns void
void
Overrides BaseTracer.onRetrieverError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:305

onRetrieverStart

onRetrieverStart(run: Run): void
Method used to log the start of a retriever run.
Parameters
- run: Run
  The retriever run that has started.
Returns void
void
Overrides BaseTracer.onRetrieverStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:270

`Optional`onRunCreate

onRunCreate?(run: Run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRunCreate
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:778

`Optional`onRunUpdate

onRunUpdate?(run: Run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onRunUpdate
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:780

`Optional`onText

onText?(run: Run): void | Promise<void>
Parameters
- run: Run
Returns void | Promise<void>
Inherited from BaseTracer.onText
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:810

onToolEnd

onToolEnd(run: Run): void
Method used to log the end of a tool run.
Parameters
- run: Run
  The tool run that has ended.
Returns void
void
Overrides BaseTracer.onToolEnd
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:236

onToolError

onToolError(run: Run): void
Method used to log any errors of a tool run.
Parameters
- run: Run
  The tool run that has errored.
Returns void
void
Overrides BaseTracer.onToolError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:253

onToolStart

onToolStart(run: Run): void
Method used to log the start of a tool run.
Parameters
- run: Run
  The tool run that has started.
Returns void
void
Overrides BaseTracer.onToolStart
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:219

`Protected`persistRun

persistRun(_run: Run): Promise<void>
Method used to persist the run. In this case, it simply returns a resolved promise as there's no persistence logic.
Parameters
- _run: Run
  The run to persist.
Returns Promise<void>
A resolved promise.
Overrides BaseTracer.persistRun
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/console.ts:64

`Protected`stringifyError

stringifyError(error: unknown): string
Parameters
- error: unknown
Returns string
Inherited from BaseTracer.stringifyError
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/tracers/base.ts:115

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseTracer.toJSON
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:396

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseTracer.toJSONNotImplemented
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:400

`Static`fromMethods

fromMethods(methods: BaseCallbackHandlerMethodsClass): Handler
Parameters
- methods: BaseCallbackHandlerMethodsClass
Returns Handler
Inherited from BaseTracer.fromMethods
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:404

`Static`lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from BaseTracer.lc_name
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/callbacks/base.ts:341

Class ConsoleCallbackHandler

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConsoleCallbackHandler

Properties

awaitHandlers

ignoreAgent

ignoreChain

ignoreCustomEvent

ignoreLLM

ignoreRetriever

lc_kwargs

lc_serializable

name

raiseError

ProtectedrunMap

Deprecated

ProtectedrunTreeMap

ProtectedusesRunTreeMap

Accessors

lc_aliases

Returns undefined | { [key: string]: string }

lc_attributes

Returns undefined | { [key: string]: string }

lc_id

Returns string[]

lc_namespace

Returns ["langchain_core", "callbacks", string]

lc_secrets

Returns undefined | { [key: string]: string }

lc_serializable_keys

Returns undefined | string[]

Methods

Protected_addChildRun

Parameters

Returns void

_addRunToRunMap

Parameters

Returns { child_execution_order: number; child_runs: Run[]; dotted_order?: string; end_time?: number; events: { kwargs?: Record<string, unknown>; name: string; time: string }[]; execution_order: number; id: string; start_time: number; trace_id?: string;}

child_execution_order: number

child_runs: Run[]

Optionaldotted_order?: string

Optionalend_time?: number

events: { kwargs?: Record<string, unknown>; name: string; time: string }[]

execution_order: number

id: string

start_time: number

Optionaltrace_id?: string

_createRunForChainStart

Parameters

Returns { child_execution_order: number; child_runs: Run[]; dotted_order?: string; end_time?: number; events: { kwargs?: Record<string, unknown>; name: string; time: string }[]; execution_order: number; id: string; start_time: number; trace_id?: string;}

child_execution_order: number

child_runs: Run[]

Optionaldotted_order?: string

Optionalend_time?: number

events: { kwargs?: Record<string, unknown>; name: string; time: string }[]

execution_order: number

id: string

start_time: number

Optionaltrace_id?: string

_createRunForChatModelStart

Parameters

Returns { child_execution_order: number; child_runs: Run[]; dotted_order?: string; end_time?: number; events: { kwargs?: Record<string, unknown>; name: string; time: string }[]; execution_order: number; id: string; start_time: number; trace_id?: string;}

child_execution_order: number

child_runs: Run[]

Optionaldotted_order?: string

Optionalend_time?: number

events: { kwargs?: Record<string, unknown>; name: string; time: string }[]

execution_order: number

id: string

start_time: number

Optionaltrace_id?: string

`Protected`runMap

`Protected`runTreeMap

`Protected`usesRunTreeMap

`Protected`_addChildRun

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

Returns {
child_execution_order: number;
child_runs: Run[];
dotted_order?: string;
end_time?: number;
events: { kwargs?: Record<string, unknown>; name: string; time: string }[];
execution_order: number;
id: string;
start_time: number;
trace_id?: string;
}

`Optional`dotted_order?: string

`Optional`end_time?: number

`Optional`trace_id?: string

`Protected`_endTrace

`Protected`_getExecutionOrder

`Protected`getRunById