Beignet API reference
    Preparing search index...

    Interface UseCaseProviderInstrumentationEvent

    Use-case lifecycle instrumentation.

    interface UseCaseProviderInstrumentationEvent {
        details?: unknown;
        durationMs?: number;
        error?: string;
        id?: string;
        kind?: "command" | "query";
        name: string;
        parentSpanId?: string;
        phase: "start" | "end" | "error";
        requestId?: string;
        spanId?: string;
        timestamp?: string;
        traceId?: string;
        traceparent?: string;
        type: "usecase";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    details? durationMs? error? id? kind? name parentSpanId? phase requestId? spanId? timestamp? traceId? traceparent? type watcher?

    Properties

    details?: unknown

    Provider-specific structured details. Values are redacted before being recorded by createProviderInstrumentation(...).

    durationMs?: number

    Duration in milliseconds for completed phases.

    error?: string

    Error summary for failed phases.

    id?: string

    Optional event identifier supplied by the caller.

    kind?: "command" | "query"

    Optional classification used by devtools.

    name: string

    Use-case name.

    parentSpanId?: string

    Parent span identifier for nested operations.

    phase: "start" | "end" | "error"

    Lifecycle phase.

    requestId?: string

    Request correlation ID for events emitted during request handling.

    spanId?: string

    Span identifier for the current operation.

    timestamp?: string

    ISO timestamp supplied by the caller. Devtools can also assign a timestamp when one is omitted.

    traceId?: string

    Trace identifier for distributed tracing integrations.

    traceparent?: string

    W3C traceparent header value, when available.

    type: "usecase"
    watcher?: string

    Watcher category used by devtools and instrumentation sinks.

    Settings

    Member Visibility

    On This Page

    Properties