Interface TelemetrySettings

interface TelemetrySettings {
    functionId?: string;
    isEnabled?: boolean;
    metadata?: Record<string, AttributeValue>;
    recordInputs?: boolean;
    recordOutputs?: boolean;
    runId?: string;
    runName?: string;
    tracer?: Tracer;
}

Hierarchy (View Summary)

Properties

functionId? isEnabled? metadata? recordInputs? recordOutputs? runId? runName? tracer?

Properties

OptionalfunctionId

functionId?: string

Identifier for this function. Used to group telemetry data by function.

OptionalisEnabled

isEnabled?: boolean

Enable or disable telemetry. Disabled by default while experimental.

Optionalmetadata

metadata?: Record<string, AttributeValue>

Additional information to include in the telemetry data.

OptionalrecordInputs

recordInputs?: boolean

Enable or disable input recording. Enabled by default.

You might want to disable input recording to avoid recording sensitive information, to reduce data transfers, or to increase performance.

OptionalrecordOutputs

recordOutputs?: boolean

Enable or disable output recording. Enabled by default.

You might want to disable output recording to avoid recording sensitive information, to reduce data transfers, or to increase performance.

OptionalrunId

runId?: string

ID of the run sent to LangSmith

OptionalrunName

runName?: string

Name of the run sent to LangSmith

Optionaltracer

tracer?: Tracer

A custom tracer to use for the telemetry data.

Settings

Member Visibility

On This Page

Properties