@pingops/core 0.1.0 → 0.1.2

package/dist/wrap-http.d.ts

@@ -1,55 +0,0 @@
-/**
- * wrapHttp - Wraps a function to set attributes on HTTP spans created within the wrapped block.
- *
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
- * context, which are automatically propagated to all spans created within the wrapped function.
- *
- * Instrumentation behavior:
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
- *   `wrapHttp` only adds attributes to spans created within the wrapped block.
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
- *   are instrumented. Requests outside `wrapHttp` are not instrumented.
- */
-import type { WrapHttpAttributes } from "./types";
-/**
- * Options for wrapHttp function
- */
-export interface WrapHttpOptions {
-    attributes?: WrapHttpAttributes;
-    /**
-     * Callback to check if SDK is initialized.
-     * Required to determine if global instrumentation is enabled.
-     */
-    checkInitialized: () => boolean;
-    /**
-     * Callback to check if global instrumentation is enabled.
-     * Required to determine instrumentation behavior.
-     */
-    isGlobalInstrumentationEnabled: () => boolean;
-    /**
-     * Optional callback to ensure SDK is initialized (auto-initialization).
-     * If not provided, wrapHttp will try to auto-initialize from environment variables.
-     */
-    ensureInitialized?: () => Promise<void>;
-}
-/**
- * Wraps a function to set attributes on HTTP spans created within the wrapped block.
- *
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
- * context, which are automatically propagated to all spans created within the wrapped function.
- *
- * Instrumentation behavior:
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
- *   `wrapHttp` only adds attributes to spans created within the wrapped block.
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
- *   are instrumented. Requests outside `wrapHttp` are not instrumented.
- *
- * Note: This is the low-level API. For a simpler API with automatic setup,
- * use `wrapHttp` from `@pingops/sdk` instead.
- *
- * @param options - Options including attributes and required callbacks
- * @param fn - Function to execute within the attribute context
- * @returns The result of the function
- */
-export declare function wrapHttp<T>(options: WrapHttpOptions, fn: () => T | Promise<T>): T | Promise<T>;
-//# sourceMappingURL=wrap-http.d.ts.map

package/dist/wrap-http.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wrap-http.d.ts","sourceRoot":"","sources":["../src/wrap-http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAWH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAIlD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAC;IAChC;;;OAGG;IACH,8BAA8B,EAAE,MAAM,OAAO,CAAC;IAC9C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,OAAO,EAAE,eAAe,EACxB,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACvB,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAoDhB"}

package/dist/wrap-http.js

@@ -1,129 +0,0 @@
-/**
- * wrapHttp - Wraps a function to set attributes on HTTP spans created within the wrapped block.
- *
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
- * context, which are automatically propagated to all spans created within the wrapped function.
- *
- * Instrumentation behavior:
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
- *   `wrapHttp` only adds attributes to spans created within the wrapped block.
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
- *   are instrumented. Requests outside `wrapHttp` are not instrumented.
- */
-import { context } from "@opentelemetry/api";
-import { createLogger } from "./logger";
-import { PINGOPS_HTTP_ENABLED, PINGOPS_USER_ID, PINGOPS_SESSION_ID, PINGOPS_TAGS, PINGOPS_METADATA, } from "./context-keys";
-const logger = createLogger("[PingOps wrapHttp]");
-/**
- * Wraps a function to set attributes on HTTP spans created within the wrapped block.
- *
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
- * context, which are automatically propagated to all spans created within the wrapped function.
- *
- * Instrumentation behavior:
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
- *   `wrapHttp` only adds attributes to spans created within the wrapped block.
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
- *   are instrumented. Requests outside `wrapHttp` are not instrumented.
- *
- * Note: This is the low-level API. For a simpler API with automatic setup,
- * use `wrapHttp` from `@pingops/sdk` instead.
- *
- * @param options - Options including attributes and required callbacks
- * @param fn - Function to execute within the attribute context
- * @returns The result of the function
- */
-export function wrapHttp(options, fn) {
-    logger.debug("wrapHttp called", {
-        hasAttributes: !!options.attributes,
-        hasUserId: !!options.attributes?.userId,
-        hasSessionId: !!options.attributes?.sessionId,
-        hasTags: !!options.attributes?.tags,
-        hasMetadata: !!options.attributes?.metadata,
-    });
-    // Normalize options - if just attributes provided, it means callbacks are required
-    // This is a type error at compile time, but we handle it gracefully
-    const normalizedOptions = "checkInitialized" in options && "isGlobalInstrumentationEnabled" in options
-        ? options
-        : (() => {
-            throw new Error("wrapHttp requires checkInitialized and isGlobalInstrumentationEnabled callbacks. Use wrapHttp from @pingops/sdk for automatic setup.");
-        })();
-    const { checkInitialized, ensureInitialized } = normalizedOptions;
-    // Ensure SDK is initialized so that span processor can extract attributes
-    // If already initialized, execute synchronously
-    if (checkInitialized()) {
-        logger.debug("SDK already initialized, executing wrapHttp synchronously");
-        return executeWrapHttpWithContext(normalizedOptions, fn);
-    }
-    // If not initialized, we need to initialize first (async)
-    if (ensureInitialized) {
-        logger.debug("SDK not initialized, using provided ensureInitialized callback");
-        return ensureInitialized()
-            .then(() => {
-            logger.debug("SDK initialized, executing wrapHttp");
-            return executeWrapHttpWithContext(normalizedOptions, fn);
-        })
-            .catch((error) => {
-            logger.error("Failed to initialize SDK for wrapHttp", {
-                error: error instanceof Error ? error.message : String(error),
-            });
-            throw error;
-        });
-    }
-    // No ensureInitialized callback provided, execute without initialization
-    logger.debug("SDK not initialized and no ensureInitialized callback provided, executing wrapHttp");
-    return executeWrapHttpWithContext(normalizedOptions, fn);
-}
-function executeWrapHttpWithContext(options, fn) {
-    const { attributes, isGlobalInstrumentationEnabled } = options;
-    const globalInstrumentationEnabled = isGlobalInstrumentationEnabled();
-    logger.debug("Executing wrapHttp context", {
-        hasAttributes: !!attributes,
-        globalInstrumentationEnabled,
-    });
-    const activeContext = context.active();
-    // If global instrumentation is not enabled, enable HTTP instrumentation
-    // for this block only. If it's enabled, all requests are already instrumented.
-    let contextWithAttributes = activeContext;
-    if (!globalInstrumentationEnabled) {
-        contextWithAttributes = contextWithAttributes.setValue(PINGOPS_HTTP_ENABLED, true);
-    }
-    // Set attributes in context if provided
-    // These will be propagated to all spans created within the wrapped function
-    if (attributes) {
-        if (attributes.userId !== undefined) {
-            contextWithAttributes = contextWithAttributes.setValue(PINGOPS_USER_ID, attributes.userId);
-        }
-        if (attributes.sessionId !== undefined) {
-            contextWithAttributes = contextWithAttributes.setValue(PINGOPS_SESSION_ID, attributes.sessionId);
-        }
-        if (attributes.tags !== undefined) {
-            contextWithAttributes = contextWithAttributes.setValue(PINGOPS_TAGS, attributes.tags);
-        }
-        if (attributes.metadata !== undefined) {
-            contextWithAttributes = contextWithAttributes.setValue(PINGOPS_METADATA, attributes.metadata);
-        }
-    }
-    // Run user code inside the context with attributes
-    return context.with(contextWithAttributes, () => {
-        try {
-            const result = fn();
-            if (result instanceof Promise) {
-                return result.catch((err) => {
-                    logger.error("Error in wrapHttp async execution", {
-                        error: err instanceof Error ? err.message : String(err),
-                    });
-                    throw err;
-                });
-            }
-            return result;
-        }
-        catch (err) {
-            logger.error("Error in wrapHttp sync execution", {
-                error: err instanceof Error ? err.message : String(err),
-            });
-            throw err;
-        }
-    });
-}
-//# sourceMappingURL=wrap-http.js.map

package/dist/wrap-http.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wrap-http.js","sourceRoot":"","sources":["../src/wrap-http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAGxB,MAAM,MAAM,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAwBlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAwB,EACxB,EAAwB;IAExB,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;QAC9B,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU;QACnC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM;QACvC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS;QAC7C,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI;QACnC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ;KAC5C,CAAC,CAAC;IAEH,mFAAmF;IACnF,oEAAoE;IACpE,MAAM,iBAAiB,GACrB,kBAAkB,IAAI,OAAO,IAAI,gCAAgC,IAAI,OAAO;QAC1E,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,CAAC,GAAG,EAAE;YACJ,MAAM,IAAI,KAAK,CACb,sIAAsI,CACvI,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;IAEX,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,GAAG,iBAAiB,CAAC;IAElE,0EAA0E;IAC1E,gDAAgD;IAChD,IAAI,gBAAgB,EAAE,EAAE,CAAC;QACvB,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC1E,OAAO,0BAA0B,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,0DAA0D;IAC1D,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CACV,gEAAgE,CACjE,CAAC;QACF,OAAO,iBAAiB,EAAE;aACvB,IAAI,CAAC,GAAG,EAAE;YACT,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACpD,OAAO,0BAA0B,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE;gBACpD,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC9D,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,KAAK,CACV,oFAAoF,CACrF,CAAC;IACF,OAAO,0BAA0B,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,0BAA0B,CACjC,OAAwB,EACxB,EAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,8BAA8B,EAAE,GAAG,OAAO,CAAC;IAC/D,MAAM,4BAA4B,GAAG,8BAA8B,EAAE,CAAC;IAEtE,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;QACzC,aAAa,EAAE,CAAC,CAAC,UAAU;QAC3B,4BAA4B;KAC7B,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAEvC,wEAAwE;IACxE,+EAA+E;IAC/E,IAAI,qBAAqB,GAAG,aAAa,CAAC;IAC1C,IAAI,CAAC,4BAA4B,EAAE,CAAC;QAClC,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,oBAAoB,EACpB,IAAI,CACL,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxC,4EAA4E;IAC5E,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACpC,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,eAAe,EACf,UAAU,CAAC,MAAM,CAClB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACvC,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,kBAAkB,EAClB,UAAU,CAAC,SAAS,CACrB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAClC,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,YAAY,EACZ,UAAU,CAAC,IAAI,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,gBAAgB,EAChB,UAAU,CAAC,QAAQ,CACpB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,mDAAmD;IACnD,OAAO,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC9C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;YAEpB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;gBAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC1B,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE;wBAChD,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;qBACxD,CAAC,CAAC;oBACH,MAAM,GAAG,CAAC;gBACZ,CAAC,CAAC,CAAC;YACL,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE;gBAC/C,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACxD,CAAC,CAAC;YACH,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}