@sentry/node/build/types/types.d.ts

Sentry Node SDK using OpenTelemetry for performance instrumentation

import type { ClientOptions, Options, Scope } from '@sentry/core';
import type { ServerRuntimeOptions } from '@sentry/core/server';
import type { NodeTransportOptions } from './transports';
/**
 * Base options for the Sentry Node SDK.
 */
export interface BaseNodeOptions extends ServerRuntimeOptions {
    /**
     * Controls whether the SDK registers its own Sentry OpenTelemetry tracer provider.
     *
     * When `false` (the default for most SDKs), no tracer provider is set up. The SDK isolates scopes
     * with a native AsyncLocalStorage context strategy and still emits spans via its own
     * instrumentation, but spans created through `@opentelemetry/api` are not captured.
     *
     * When `true`, the SDK registers its own `SentryTracerProvider` (and `SentryPropagator`) as the
     * global OpenTelemetry tracer provider, so spans created through `@opentelemetry/api` become Sentry
     * spans. This is the default for the Next.js and SvelteKit SDKs. If you run your own tracer provider,
     * keep this `false` so the SDK does not register a competing provider; note the SDK no longer feeds
     * spans into a user-owned provider, so those spans stay in your OpenTelemetry pipeline.
     *
     * @default false
     */
    enableOpenTelemetrySetup?: boolean;
    /**
     * Controls whether the SDK installs its runtime diagnostics-channel injection hooks. These hooks
     * transform supported modules (e.g. Express) at load time so they emit the diagnostics channels
     * that the channel-based integrations subscribe to.
     *
     * Set this to `false` to opt out — for example when the channels are injected at build
     * time via the bundler plugin, or when the runtime module hooks are unavailable.
     *
     * @default true
     */
    enableRuntimeChannelInjection?: boolean;
    /**
     * Override the runtime name reported in events.
     * Defaults to 'node' with the current process version if not specified.
     *
     * @hidden This is primarily used internally to support platforms like Next on OpenNext/Cloudflare.
     */
    runtime?: {
        name: string;
        version?: string;
    };
    /**
     * Sets profiling session sample rate for the entire profiling session (evaluated once per SDK initialization).
     *
     * @default 0
     */
    profileSessionSampleRate?: number;
    /**
     * Set the lifecycle mode of the profiler.
     * - **manual**: The profiler will be manually started and stopped via `startProfiler`/`stopProfiler`.
     *    If a session is sampled, is dependent on the `profileSessionSampleRate`.
     * - **trace**: The profiler will be automatically started when a root span exists and stopped when there are no
     *    more sampled root spans. Whether a session is sampled, is dependent on the `profileSessionSampleRate` and the
     *    existing sampling configuration for tracing (`tracesSampleRate`/`tracesSampler`).
     *
     * @default 'manual'
     */
    profileLifecycle?: 'manual' | 'trace';
    /**
     * Include local variables with stack traces.
     *
     * Requires the `LocalVariables` integration.
     */
    includeLocalVariables?: boolean;
}
/**
 * Configuration options for the Sentry Node SDK
 * @see @sentry/core Options for more information.
 */
export interface NodeOptions extends Options<NodeTransportOptions>, BaseNodeOptions {
}
/**
 * Configuration options for the Sentry Node SDK Client class
 * @see NodeClient for more information.
 */
export interface NodeClientOptions extends ClientOptions<NodeTransportOptions>, BaseNodeOptions {
}
export interface CurrentScopes {
    scope: Scope;
    isolationScope: Scope;
}
//# sourceMappingURL=types.d.ts.map