@sentry/node 9.39.0 → 10.0.0-alpha.0

package/build/types/integrations/tracing/express-v5/types.d.ts

@@ -1,39 +0,0 @@
-import type { Span } from '@opentelemetry/api';
-import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
-import type { ExpressLayerType } from './enums/ExpressLayerType';
-export type LayerPathSegment = string | RegExp | number;
-export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);
-export type ExpressRequestInfo<T = any> = {
-    /** An express request object */
-    request: T;
-    route: string;
-    layerType: ExpressLayerType;
-};
-export type SpanNameHook = (info: ExpressRequestInfo, 
-/**
- * If no decision is taken based on RequestInfo, the default name
- * supplied by the instrumentation can be used instead.
- */
-defaultName: string) => string;
-/**
- * Function that can be used to add custom attributes to the current span or the root span on
- * a Express request
- * @param span - The Express middleware layer span.
- * @param info - An instance of ExpressRequestInfo that contains info about the request such as the route, and the layer type.
- */
-export interface ExpressRequestCustomAttributeFunction {
-    (span: Span, info: ExpressRequestInfo): void;
-}
-/**
- * Options available for the Express Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express#express-instrumentation-options))
- */
-export interface ExpressInstrumentationConfig extends InstrumentationConfig {
-    /** Ignore specific based on their name */
-    ignoreLayers?: IgnoreMatcher[];
-    /** Ignore specific layers based on their type */
-    ignoreLayersType?: ExpressLayerType[];
-    spanNameHook?: SpanNameHook;
-    /** Function for adding custom attributes on Express request */
-    requestHook?: ExpressRequestCustomAttributeFunction;
-}
-//# sourceMappingURL=types.d.ts.map

package/build/types/integrations/tracing/express-v5/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/integrations/tracing/express-v5/types.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAExD,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;AAE1E,MAAM,MAAM,kBAAkB,CAAC,CAAC,GAAG,GAAG,IAAI;IACxC,gCAAgC;IAChC,OAAO,EAAE,CAAC,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,CACzB,IAAI,EAAE,kBAAkB;AACxB;;;GAGG;AACH,WAAW,EAAE,MAAM,KAChB,MAAM,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,WAAW,qCAAqC;IACpD,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,qBAAqB;IACzE,0CAA0C;IAC1C,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAC/B,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACtC,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,qCAAqC,CAAC;CACrD"}

package/build/types/integrations/tracing/express-v5/utils.d.ts

@@ -1,51 +0,0 @@
-import type { Attributes } from '@opentelemetry/api';
-import { ExpressLayerType } from './enums/ExpressLayerType';
-import type { ExpressLayer, PatchedRequest } from './internal-types';
-import type { ExpressInstrumentationConfig, LayerPathSegment } from './types';
-/**
- * Store layers path in the request to be able to construct route later
- * @param request The request where
- * @param [value] the value to push into the array
- */
-export declare const storeLayerPath: (request: PatchedRequest, value?: string) => void;
-/**
- * Recursively search the router path from layer stack
- * @param path The path to reconstruct
- * @param layer The layer to reconstruct from
- * @returns The reconstructed path
- */
-export declare const getRouterPath: (path: string, layer: ExpressLayer) => string;
-/**
- * Parse express layer context to retrieve a name and attributes.
- * @param route The route of the layer
- * @param layer Express layer
- * @param [layerPath] if present, the path on which the layer has been mounted
- */
-export declare const getLayerMetadata: (route: string, layer: ExpressLayer, layerPath?: string) => {
-    attributes: Attributes;
-    name: string;
-};
-/**
- * Check whether the given request is ignored by configuration
- * It will not re-throw exceptions from `list` provided by the client
- * @param constant e.g URL of request
- * @param [list] List of ignore patterns
- * @param [onException] callback for doing something when an exception has
- *     occurred
- */
-export declare const isLayerIgnored: (name: string, type: ExpressLayerType, config?: ExpressInstrumentationConfig) => boolean;
-/**
- * Converts a user-provided error value into an error and error message pair
- *
- * @param error - User-provided error value
- * @returns Both an Error or string representation of the value and an error message
- */
-export declare const asErrorAndMessage: (error: unknown) => [error: string | Error, message: string];
-/**
- * Extracts the layer path from the route arguments
- *
- * @param args - Arguments of the route
- * @returns The layer path
- */
-export declare const getLayerPath: (args: [LayerPathSegment | LayerPathSegment[], ...unknown[]]) => string | undefined;
-//# sourceMappingURL=utils.d.ts.map

package/build/types/integrations/tracing/express-v5/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../src/integrations/tracing/express-v5/utils.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,KAAK,EAAE,4BAA4B,EAAiB,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE7F;;;;GAIG;AACH,eAAO,MAAM,cAAc,YAAa,cAAc,UAAU,MAAM,KAAG,IASxE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAU,MAAM,SAAS,YAAY,KAAG,MAYjE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,UACpB,MAAM,SACN,YAAY,cACP,MAAM,KACjB;IACD,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,MAAM,CAAC;CA8Bd,CAAC;AAoBF;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,SACnB,MAAM,QACN,gBAAgB,WACb,4BAA4B,KACpC,OAgBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,UAAW,OAAO,6CACkC,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,CAAC,gBAAgB,GAAG,gBAAgB,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,KAAG,MAAM,GAAG,SAQnG,CAAC"}

package/build/types-ts3.8/integrations/tracing/express-v5/enums/AttributeNames.d.ts

@@ -1,5 +0,0 @@
-export declare enum AttributeNames {
-    EXPRESS_TYPE = "express.type",
-    EXPRESS_NAME = "express.name"
-}
-//# sourceMappingURL=AttributeNames.d.ts.map

package/build/types-ts3.8/integrations/tracing/express-v5/enums/ExpressLayerType.d.ts

@@ -1,6 +0,0 @@
-export declare enum ExpressLayerType {
-    ROUTER = "router",
-    MIDDLEWARE = "middleware",
-    REQUEST_HANDLER = "request_handler"
-}
-//# sourceMappingURL=ExpressLayerType.d.ts.map

package/build/types-ts3.8/integrations/tracing/express-v5/instrumentation.d.ts

@@ -1,27 +0,0 @@
-import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
-import { ExpressInstrumentationConfig, ExpressRequestInfo } from './types';
-export declare const PACKAGE_VERSION = "0.1.0";
-export declare const PACKAGE_NAME = "@sentry/instrumentation-express-v5";
-/** Express instrumentation for OpenTelemetry */
-export declare class ExpressInstrumentationV5 extends InstrumentationBase<ExpressInstrumentationConfig> {
-    constructor(config?: ExpressInstrumentationConfig);
-    init(): InstrumentationNodeModuleDefinition[];
-    private _setup;
-    private _tearDown;
-    /**
-     * Get the patch for Router.route function
-     */
-    private _getRoutePatch;
-    /**
-     * Get the patch for Router.use function
-     */
-    private _getRouterUsePatch;
-    /**
-     * Get the patch for Application.use function
-     */
-    private _getAppUsePatch;
-    /** Patch each express layer to create span and propagate context */
-    private _applyPatch;
-    _getSpanName(info: ExpressRequestInfo, defaultName: string): string;
-}
-//# sourceMappingURL=instrumentation.d.ts.map

package/build/types-ts3.8/integrations/tracing/express-v5/internal-types.d.ts

@@ -1,38 +0,0 @@
-import { Request } from 'express';
-/**
- * This symbol is used to mark express layer as being already instrumented
- * since its possible to use a given layer multiple times (ex: middlewares)
- */
-export declare const kLayerPatched: unique symbol;
-/**
- * This const define where on the `request` object the Instrumentation will mount the
- * current stack of express layer.
- *
- * It is necessary because express doesn't store the different layers
- * (ie: middleware, router etc) that it called to get to the current layer.
- * Given that, the only way to know the route of a given layer is to
- * store the path of where each previous layer has been mounted.
- *
- * ex: bodyParser > auth middleware > /users router > get /:id
- *  in this case the stack would be: ["/users", "/:id"]
- *
- * ex2: bodyParser > /api router > /v1 router > /users router > get /:id
- *  stack: ["/api", "/v1", "/users", ":id"]
- *
- */
-export declare const _LAYERS_STORE_PROPERTY = "__ot_middlewares";
-export type PatchedRequest = {
-    [_LAYERS_STORE_PROPERTY]?: string[];
-} & Request;
-export type PathParams = string | RegExp | Array<string | RegExp>;
-export type ExpressRouter = {
-    stack: ExpressLayer[];
-};
-export type ExpressLayer = {
-    handle: Function & Record<string, any>;
-    [kLayerPatched]?: boolean;
-    name: string;
-    path: string;
-    route?: ExpressLayer;
-};
-//# sourceMappingURL=internal-types.d.ts.map

package/build/types-ts3.8/integrations/tracing/express-v5/types.d.ts

@@ -1,39 +0,0 @@
-import { Span } from '@opentelemetry/api';
-import { InstrumentationConfig } from '@opentelemetry/instrumentation';
-import { ExpressLayerType } from './enums/ExpressLayerType';
-export type LayerPathSegment = string | RegExp | number;
-export type IgnoreMatcher = string | RegExp | ((name: string) => boolean);
-export type ExpressRequestInfo<T = any> = {
-    /** An express request object */
-    request: T;
-    route: string;
-    layerType: ExpressLayerType;
-};
-export type SpanNameHook = (info: ExpressRequestInfo, 
-/**
- * If no decision is taken based on RequestInfo, the default name
- * supplied by the instrumentation can be used instead.
- */
-defaultName: string) => string;
-/**
- * Function that can be used to add custom attributes to the current span or the root span on
- * a Express request
- * @param span - The Express middleware layer span.
- * @param info - An instance of ExpressRequestInfo that contains info about the request such as the route, and the layer type.
- */
-export interface ExpressRequestCustomAttributeFunction {
-    (span: Span, info: ExpressRequestInfo): void;
-}
-/**
- * Options available for the Express Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express#express-instrumentation-options))
- */
-export interface ExpressInstrumentationConfig extends InstrumentationConfig {
-    /** Ignore specific based on their name */
-    ignoreLayers?: IgnoreMatcher[];
-    /** Ignore specific layers based on their type */
-    ignoreLayersType?: ExpressLayerType[];
-    spanNameHook?: SpanNameHook;
-    /** Function for adding custom attributes on Express request */
-    requestHook?: ExpressRequestCustomAttributeFunction;
-}
-//# sourceMappingURL=types.d.ts.map

package/build/types-ts3.8/integrations/tracing/express-v5/utils.d.ts

@@ -1,57 +0,0 @@
-import { Attributes } from '@opentelemetry/api';
-import { ExpressLayerType } from './enums/ExpressLayerType';
-import { ExpressLayer, PatchedRequest } from './internal-types';
-import { ExpressInstrumentationConfig, LayerPathSegment } from './types';
-/**
- * Store layers path in the request to be able to construct route later
- * @param request The request where
- * @param [value] the value to push into the array
- */
-export declare const storeLayerPath: (request: PatchedRequest, value?: string) => void;
-/**
- * Recursively search the router path from layer stack
- * @param path The path to reconstruct
- * @param layer The layer to reconstruct from
- * @returns The reconstructed path
- */
-export declare const getRouterPath: (path: string, layer: ExpressLayer) => string;
-/**
- * Parse express layer context to retrieve a name and attributes.
- * @param route The route of the layer
- * @param layer Express layer
- * @param [layerPath] if present, the path on which the layer has been mounted
- */
-export declare const getLayerMetadata: (route: string, layer: ExpressLayer, layerPath?: string) => {
-    attributes: Attributes;
-    name: string;
-};
-/**
- * Check whether the given request is ignored by configuration
- * It will not re-throw exceptions from `list` provided by the client
- * @param constant e.g URL of request
- * @param [list] List of ignore patterns
- * @param [onException] callback for doing something when an exception has
- *     occurred
- */
-export declare const isLayerIgnored: (name: string, type: ExpressLayerType, config?: ExpressInstrumentationConfig) => boolean;
-/**
- * Converts a user-provided error value into an error and error message pair
- *
- * @param error - User-provided error value
- * @returns Both an Error or string representation of the value and an error message
- */
-export declare const asErrorAndMessage: (error: unknown) => [
-    /*error*/ string | Error,
-    /*message*/ string
-];
-/**
- * Extracts the layer path from the route arguments
- *
- * @param args - Arguments of the route
- * @returns The layer path
- */
-export declare const getLayerPath: (args: [
-    LayerPathSegment | LayerPathSegment[],
-    ...unknown[]
-]) => string | undefined;
-//# sourceMappingURL=utils.d.ts.map