Interface ClientConfig

interface ClientConfig {
    anonymizer?: (values: KVMap) => KVMap | Promise<KVMap>;
    apiKey?: string;
    apiUrl?: string;
    autoBatchTracing?: boolean;
    batchSizeBytesLimit?: number;
    blockOnRootRunFinalization?: boolean;
    callerOptions?: AsyncCallerParams;
    debug?: boolean;
    fetchImplementation?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
    fetchOptions?: RequestInit;
    hideInputs?: boolean
    | (inputs: KVMap) => KVMap | Promise<KVMap>;
    hideOutputs?: boolean | (outputs: KVMap) => KVMap | Promise<KVMap>;
    manualFlushMode?: boolean;
    timeout_ms?: number;
    traceBatchConcurrency?: number;
    tracingSamplingRate?: number;
    webUrl?: string;
    workspaceId?: string;
}

Properties

anonymizer? apiKey? apiUrl? autoBatchTracing? batchSizeBytesLimit? blockOnRootRunFinalization? callerOptions? debug? fetchImplementation? fetchOptions? hideInputs? hideOutputs? manualFlushMode? timeout_ms? traceBatchConcurrency? tracingSamplingRate? webUrl? workspaceId?

Properties

Optionalanonymizer

anonymizer?: (values: KVMap) => KVMap | Promise<KVMap>

OptionalapiKey

apiKey?: string

OptionalapiUrl

apiUrl?: string

OptionalautoBatchTracing

autoBatchTracing?: boolean

OptionalbatchSizeBytesLimit

batchSizeBytesLimit?: number

OptionalblockOnRootRunFinalization

blockOnRootRunFinalization?: boolean

OptionalcallerOptions

callerOptions?: AsyncCallerParams

Optionaldebug

debug?: boolean

Enable debug mode for the client. If set, all sent HTTP requests will be logged.

OptionalfetchImplementation

fetchImplementation?: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Custom fetch implementation. Useful for testing.

Type declaration

    • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input: string | URL | Request, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: string | URL | Request
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalfetchOptions

fetchOptions?: RequestInit

OptionalhideInputs

hideInputs?: boolean | (inputs: KVMap) => KVMap | Promise<KVMap>

OptionalhideOutputs

hideOutputs?: boolean | (outputs: KVMap) => KVMap | Promise<KVMap>

OptionalmanualFlushMode

manualFlushMode?: boolean

Whether to require manual .flush() calls before sending traces. Useful if encountering network rate limits at trace high volumes.

Optionaltimeout_ms

timeout_ms?: number

OptionaltraceBatchConcurrency

traceBatchConcurrency?: number

OptionaltracingSamplingRate

tracingSamplingRate?: number

OptionalwebUrl

webUrl?: string

OptionalworkspaceId

workspaceId?: string

The workspace ID. Required for org-scoped API keys.

Settings

Member Visibility

On This Page

Properties