@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface TelemetryConfig

    BotConfig.telemetry (opt-in): where spans go and what they may contain.

    interface TelemetryConfig {
        tracer: BotTracer;
        ids?: "hash" | "raw" | "omit";
        idKey?: string | Uint8Array<ArrayBufferLike>;
        errorMessages?: boolean;
        spans?: { persist?: boolean; pace?: boolean; streamUpdates?: boolean };
    }
    Index
    tracer ids? idKey? errorMessages? spans?
    tracer: BotTracer
    ids?: "hash" | "raw" | "omit"

    How chat, sender and message ids appear on spans:

    • 'hash' (default): HMAC-SHA256 with idKey, base64url, 16 chars;
    • 'raw': the opaque id as the provider gave it (personal data on most channels);
    • 'omit': not recorded.
    idKey?: string | Uint8Array<ArrayBufferLike>

    HMAC key of ids: 'hash'. Default: 32 random bytes per process, so hashes do not correlate across replicas or restarts — set it from a secret for that.

    errorMessages?: boolean

    Record Error.message on spans (it may contain user text). Default false: error name and code only.

    spans?: { persist?: boolean; pace?: boolean; streamUpdates?: boolean }

    Granularity toggles. Defaults: persist true, pace true, streamUpdates false (stream edits are span events).

    Settings
    Member Visibility

    On This Page
    Properties