Beignet API reference
    Preparing search index...

    Interface JobProviderInstrumentationEvent

    Background job instrumentation.

    interface JobProviderInstrumentationEvent {
        details?: unknown;
        id?: string;
        jobName: string;
        parentSpanId?: string;
        requestId?: string;
        spanId?: string;
        status: "completed" | "scheduled" | "started" | "failed";
        timestamp?: string;
        traceId?: string;
        traceparent?: string;
        type: "job";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    details? id? jobName parentSpanId? requestId? spanId? status timestamp? traceId? traceparent? type watcher?

    Properties

    details?: unknown

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

    id?: string

    Optional event identifier supplied by the caller.

    jobName: string

    Job name.

    parentSpanId?: string

    Parent span identifier for nested operations.

    requestId?: string

    Request correlation ID for events emitted during request handling.

    spanId?: string

    Span identifier for the current operation.

    status: "completed" | "scheduled" | "started" | "failed"

    Job lifecycle status.

    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: "job"
    watcher?: string

    Watcher category used by devtools and instrumentation sinks.

    Settings

    Member Visibility

    On This Page

    Properties