Langfuse JS/TS SDKs
    Preparing search index...

    Interface PropagateAttributesParams

    Parameters for propagateAttributes function.

    interface PropagateAttributesParams {
        _internalExperiment?: PropagatedExperimentAttributes;
        asBaggage?: boolean;
        metadata?: Record<string, string>;
        sessionId?: string;
        tags?: string[];
        userId?: string;
        version?: string;
    }
    Index

    Properties

    _internalExperiment?: PropagatedExperimentAttributes

    INTERNAL USE ONLY - For Langfuse experiment framework.

    This parameter is used internally by the Langfuse experiment system to propagate experiment context to child spans. It should NOT be used by external code.

    asBaggage?: boolean

    If true, propagates attributes using OpenTelemetry baggage for cross-process/service propagation.

    Security warning: When enabled, attribute values are added to HTTP headers on ALL outbound requests. Only enable if values are safe to transmit via HTTP headers and you need cross-service tracing.

    false
    
    metadata?: Record<string, string>

    Additional key-value metadata to propagate to all spans.

    • Keys and values must be strings
    • All values must be ≤200 characters
    • Use for dimensions like internal correlating identifiers
    • AVOID: large payloads, sensitive data, non-string values (will be dropped with warning)
    sessionId?: string

    Session identifier to associate with all spans in this context. Must be a string ≤200 characters. Use this to group related traces within a user session (e.g., a conversation thread, multi-turn interaction).

    tags?: string[]

    List of tags to categorize the group of observations

    userId?: string

    User identifier to associate with all spans in this context. Must be a string ≤200 characters. Use this to track which user generated each trace and enable e.g. per-user cost/performance analysis.

    version?: string

    Version identifier for parts of your application that are independently versioned, e.g. agents