@sentry/node/build/types/integrations/node-fetch/types.d.ts

Sentry Node SDK using OpenTelemetry for performance instrumentation

import type { Span } from '@sentry/core';
export interface UndiciRequest {
    origin: string;
    method: string;
    path: string;
    /**
     * Serialized string of headers in the form `name: value\r\n` for v5
     * Array of strings `[key1, value1, key2, value2]`, where values are
     * `string | string[]` for v6
     */
    headers: string | (string | string[])[];
    /**
     * Helper method to add headers (from v6)
     */
    addHeader: (name: string, value: string) => void;
    throwOnError: boolean;
    completed: boolean;
    aborted: boolean;
    idempotent: boolean;
    contentLength: number | null;
    contentType: string | null;
    body: any;
}
export interface UndiciResponse {
    headers: Buffer[];
    statusCode: number;
    statusText: string;
}
export interface RequestHookFunction<T = UndiciRequest> {
    (span: Span, request: T): void;
}
export interface ResponseHookFunction<RequestType = UndiciRequest, ResponseType = UndiciResponse> {
    (span: Span, info: {
        request: RequestType;
        response: ResponseType;
    }): void;
}
export interface RequestMessage {
    request: UndiciRequest;
}
export interface RequestHeadersMessage {
    request: UndiciRequest;
    socket: any;
}
export interface ResponseHeadersMessage {
    request: UndiciRequest;
    response: UndiciResponse;
}
export interface RequestTrailersMessage {
    request: UndiciRequest;
    response: UndiciResponse;
}
export interface RequestErrorMessage {
    request: UndiciRequest;
    error: Error;
}
export interface UndiciInstrumentationConfig<RequestType = UndiciRequest, ResponseType = UndiciResponse> {
    /**
     * Do not capture spans or breadcrumbs for outgoing fetch requests to URLs where the given callback returns `true`.
     * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
     */
    ignoreOutgoingRequests?: (url: string) => boolean;
    /** Function for adding custom attributes before request is handled */
    requestHook?: RequestHookFunction<RequestType>;
    /** Function called once response headers have been received */
    responseHook?: ResponseHookFunction<RequestType, ResponseType>;
    /**
     * Capture the listed HTTP headers as span attributes
     * (`http.request.header.<name>` / `http.response.header.<name>`).
     *
     * Privacy filtering still applies to every header listed here. A header keeps its value only if
     * `dataCollection.httpHeaders` permits it:
     * - Sensitive names (`authorization`, `cookie`, ...) always show up as `[Filtered]`.
     * - Names on the `deny` list show up as `[Filtered]`.
     * - If an `allow` list is configured, a header must appear there as well, or it shows up as `[Filtered]`.
     */
    headersToSpanAttributes?: {
        requestHeaders?: string[];
        responseHeaders?: string[];
    };
}
export interface NodeFetchOptions extends UndiciInstrumentationConfig {
    /**
     * Whether breadcrumbs should be recorded for requests.
     *
     * @default `true`
     */
    breadcrumbs?: boolean;
    /**
     * If set to false, do not emit any spans.
     * Breadcrumbs and trace propagation for outgoing fetch requests are still applied.
     *
     * Defaults to `true` when tracing is enabled.
     */
    spans?: boolean;
    /**
     * This option only has an effect when `spans` is set to false. When spans are enabled, you cannot disable trace propagation here.
     * Instead, configure `tracePropagationTargets` in the client options.
     *
     * @default `true`
     */
    tracePropagation?: boolean;
}
//# sourceMappingURL=types.d.ts.map