@pingops/core 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/dist/index.cjs +844 -0
  2. package/dist/index.cjs.map +1 -0
  3. package/dist/index.d.cts +305 -0
  4. package/dist/index.d.cts.map +1 -0
  5. package/dist/index.d.mts +305 -0
  6. package/dist/index.d.mts.map +1 -0
  7. package/dist/index.mjs +824 -0
  8. package/dist/index.mjs.map +1 -0
  9. package/package.json +17 -5
  10. package/dist/context-keys.d.ts +0 -42
  11. package/dist/context-keys.d.ts.map +0 -1
  12. package/dist/context-keys.js +0 -43
  13. package/dist/context-keys.js.map +0 -1
  14. package/dist/filtering/domain-filter.d.ts +0 -9
  15. package/dist/filtering/domain-filter.d.ts.map +0 -1
  16. package/dist/filtering/domain-filter.js +0 -136
  17. package/dist/filtering/domain-filter.js.map +0 -1
  18. package/dist/filtering/header-filter.d.ts +0 -31
  19. package/dist/filtering/header-filter.d.ts.map +0 -1
  20. package/dist/filtering/header-filter.js +0 -187
  21. package/dist/filtering/header-filter.js.map +0 -1
  22. package/dist/filtering/span-filter.d.ts +0 -13
  23. package/dist/filtering/span-filter.d.ts.map +0 -1
  24. package/dist/filtering/span-filter.js +0 -46
  25. package/dist/filtering/span-filter.js.map +0 -1
  26. package/dist/index.d.ts +0 -13
  27. package/dist/index.d.ts.map +0 -1
  28. package/dist/index.js +0 -13
  29. package/dist/index.js.map +0 -1
  30. package/dist/logger.d.ts +0 -21
  31. package/dist/logger.d.ts.map +0 -1
  32. package/dist/logger.js +0 -36
  33. package/dist/logger.js.map +0 -1
  34. package/dist/types.d.ts +0 -46
  35. package/dist/types.d.ts.map +0 -1
  36. package/dist/types.js +0 -5
  37. package/dist/types.js.map +0 -1
  38. package/dist/utils/context-extractor.d.ts +0 -13
  39. package/dist/utils/context-extractor.d.ts.map +0 -1
  40. package/dist/utils/context-extractor.js +0 -44
  41. package/dist/utils/context-extractor.js.map +0 -1
  42. package/dist/utils/span-extractor.d.ts +0 -10
  43. package/dist/utils/span-extractor.d.ts.map +0 -1
  44. package/dist/utils/span-extractor.js +0 -156
  45. package/dist/utils/span-extractor.js.map +0 -1
  46. package/dist/wrap-http.d.ts +0 -55
  47. package/dist/wrap-http.d.ts.map +0 -1
  48. package/dist/wrap-http.js +0 -135
  49. package/dist/wrap-http.js.map +0 -1
@@ -1,156 +0,0 @@
1
- /**
2
- * Extracts structured data from spans for PingOps backend
3
- */
4
- import { filterHeaders, extractHeadersFromAttributes, } from "../filtering/header-filter";
5
- /**
6
- * Extracts domain from URL
7
- */
8
- function extractDomainFromUrl(url) {
9
- try {
10
- const urlObj = new URL(url);
11
- return urlObj.hostname;
12
- }
13
- catch {
14
- const match = url.match(/^(?:https?:\/\/)?([^/]+)/);
15
- return match ? match[1] : "";
16
- }
17
- }
18
- /**
19
- * Gets domain rule configuration for a given URL
20
- */
21
- function getDomainRule(url, domainAllowList) {
22
- if (!domainAllowList) {
23
- return undefined;
24
- }
25
- const domain = extractDomainFromUrl(url);
26
- for (const rule of domainAllowList) {
27
- if (domain === rule.domain ||
28
- domain.endsWith(`.${rule.domain}`) ||
29
- domain === rule.domain.slice(1)) {
30
- return rule;
31
- }
32
- }
33
- return undefined;
34
- }
35
- /**
36
- * Determines if body should be captured based on priority:
37
- * domain rule > global config > default (false)
38
- */
39
- function shouldCaptureBody(domainRule, globalConfig, bodyType) {
40
- // Check domain-specific rule first
41
- if (domainRule) {
42
- const domainValue = bodyType === "request"
43
- ? domainRule.captureRequestBody
44
- : domainRule.captureResponseBody;
45
- if (domainValue !== undefined) {
46
- return domainValue;
47
- }
48
- }
49
- // Fall back to global config
50
- if (globalConfig !== undefined) {
51
- return globalConfig;
52
- }
53
- // Default to false
54
- return false;
55
- }
56
- /**
57
- * Extracts structured payload from a span
58
- */
59
- export function extractSpanPayload(span, domainAllowList, globalHeadersAllowList, globalHeadersDenyList, globalCaptureRequestBody, globalCaptureResponseBody) {
60
- const attributes = span.attributes;
61
- const url = attributes["http.url"] || attributes["url.full"];
62
- // Get domain-specific rule if available
63
- const domainRule = url ? getDomainRule(url, domainAllowList) : undefined;
64
- // Merge global and domain-specific header rules
65
- const headersAllowList = domainRule?.headersAllowList ?? globalHeadersAllowList;
66
- const headersDenyList = domainRule?.headersDenyList ?? globalHeadersDenyList;
67
- // Determine if bodies should be captured
68
- const shouldCaptureReqBody = shouldCaptureBody(domainRule, globalCaptureRequestBody, "request");
69
- const shouldCaptureRespBody = shouldCaptureBody(domainRule, globalCaptureResponseBody, "response");
70
- // Extract HTTP headers if available
71
- let requestHeaders = {};
72
- let responseHeaders = {};
73
- // First, try to extract flat array format headers (e.g., 'http.request.header.0', 'http.request.header.1')
74
- const flatRequestHeaders = extractHeadersFromAttributes(attributes, "http.request.header");
75
- const flatResponseHeaders = extractHeadersFromAttributes(attributes, "http.response.header");
76
- // Try to get headers from attributes (format may vary by instrumentation)
77
- const httpRequestHeadersValue = attributes["http.request.header"];
78
- const httpResponseHeadersValue = attributes["http.response.header"];
79
- // Type guard: check if value is a record/object with string keys
80
- const isHeadersRecord = (value) => {
81
- return (typeof value === "object" &&
82
- value !== null &&
83
- !Array.isArray(value) &&
84
- Object.values(value).every((v) => typeof v === "string" ||
85
- (Array.isArray(v) && v.every((item) => typeof item === "string")) ||
86
- v === undefined));
87
- };
88
- // Use flat array format if available, otherwise use direct attribute
89
- if (flatRequestHeaders) {
90
- requestHeaders = filterHeaders(flatRequestHeaders, headersAllowList, headersDenyList);
91
- }
92
- else if (isHeadersRecord(httpRequestHeadersValue)) {
93
- requestHeaders = filterHeaders(httpRequestHeadersValue, headersAllowList, headersDenyList);
94
- }
95
- if (flatResponseHeaders) {
96
- responseHeaders = filterHeaders(flatResponseHeaders, headersAllowList, headersDenyList);
97
- }
98
- else if (isHeadersRecord(httpResponseHeadersValue)) {
99
- responseHeaders = filterHeaders(httpResponseHeadersValue, headersAllowList, headersDenyList);
100
- }
101
- // Build attributes object
102
- const extractedAttributes = {
103
- ...attributes,
104
- };
105
- // Remove flat array format headers (e.g., 'http.request.header.0', 'http.request.header.1', etc.)
106
- // We'll replace them with the proper key-value format
107
- for (const key in extractedAttributes) {
108
- if ((key.startsWith("http.request.header.") &&
109
- key !== "http.request.header") ||
110
- (key.startsWith("http.response.header.") &&
111
- key !== "http.response.header")) {
112
- // Check if it's a numeric index (flat array format)
113
- const match = key.match(/^(http\.(?:request|response)\.header)\.(\d+)$/);
114
- if (match) {
115
- delete extractedAttributes[key];
116
- }
117
- }
118
- }
119
- // Add filtered headers in proper key-value format
120
- if (Object.keys(requestHeaders).length > 0) {
121
- extractedAttributes["http.request.header"] = requestHeaders;
122
- }
123
- if (Object.keys(responseHeaders).length > 0) {
124
- extractedAttributes["http.response.header"] = responseHeaders;
125
- }
126
- // Remove body attributes if capture is disabled
127
- if (!shouldCaptureReqBody) {
128
- delete extractedAttributes["http.request.body"];
129
- }
130
- if (!shouldCaptureRespBody) {
131
- delete extractedAttributes["http.response.body"];
132
- }
133
- // Build span payload
134
- const spanContext = span.spanContext();
135
- // parentSpanId may not be available in all versions of ReadableSpan
136
- const parentSpanId = "parentSpanId" in span
137
- ? span.parentSpanId
138
- : undefined;
139
- return {
140
- traceId: spanContext.traceId,
141
- spanId: spanContext.spanId,
142
- parentSpanId,
143
- name: span.name,
144
- kind: span.kind.toString(),
145
- startTime: new Date(span.startTime[0] * 1000 + span.startTime[1] / 1000000).toISOString(),
146
- endTime: new Date(span.endTime[0] * 1000 + span.endTime[1] / 1000000).toISOString(),
147
- duration: (span.endTime[0] - span.startTime[0]) * 1000 +
148
- (span.endTime[1] - span.startTime[1]) / 1000000,
149
- attributes: extractedAttributes,
150
- status: {
151
- code: span.status.code.toString(),
152
- message: span.status.message,
153
- },
154
- };
155
- }
156
- //# sourceMappingURL=span-extractor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"span-extractor.js","sourceRoot":"","sources":["../../src/utils/span-extractor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EACL,aAAa,EACb,4BAA4B,GAC7B,MAAM,4BAA4B,CAAC;AAEpC;;GAEG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACvC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CACpB,GAAW,EACX,eAA8B;IAE9B,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,IACE,MAAM,KAAK,IAAI,CAAC,MAAM;YACtB,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAClC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAC/B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CACxB,UAAkC,EAClC,YAAiC,EACjC,QAAgC;IAEhC,mCAAmC;IACnC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,WAAW,GACf,QAAQ,KAAK,SAAS;YACpB,CAAC,CAAC,UAAU,CAAC,kBAAkB;YAC/B,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC;QACrC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;IACD,6BAA6B;IAC7B,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,mBAAmB;IACnB,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAkB,EAClB,eAA8B,EAC9B,sBAAiC,EACjC,qBAAgC,EAChC,wBAAkC,EAClC,yBAAmC;IAEnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACnC,MAAM,GAAG,GACN,UAAU,CAAC,UAAU,CAAY,IAAK,UAAU,CAAC,UAAU,CAAY,CAAC;IAE3E,wCAAwC;IACxC,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEzE,gDAAgD;IAChD,MAAM,gBAAgB,GACpB,UAAU,EAAE,gBAAgB,IAAI,sBAAsB,CAAC;IACzD,MAAM,eAAe,GAAG,UAAU,EAAE,eAAe,IAAI,qBAAqB,CAAC;IAE7E,yCAAyC;IACzC,MAAM,oBAAoB,GAAG,iBAAiB,CAC5C,UAAU,EACV,wBAAwB,EACxB,SAAS,CACV,CAAC;IACF,MAAM,qBAAqB,GAAG,iBAAiB,CAC7C,UAAU,EACV,yBAAyB,EACzB,UAAU,CACX,CAAC;IAEF,oCAAoC;IACpC,IAAI,cAAc,GAAkD,EAAE,CAAC;IACvE,IAAI,eAAe,GAAkD,EAAE,CAAC;IAExE,2GAA2G;IAC3G,MAAM,kBAAkB,GAAG,4BAA4B,CACrD,UAAU,EACV,qBAAqB,CACtB,CAAC;IACF,MAAM,mBAAmB,GAAG,4BAA4B,CACtD,UAAU,EACV,sBAAsB,CACvB,CAAC;IAEF,0EAA0E;IAC1E,MAAM,uBAAuB,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,wBAAwB,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAEpE,iEAAiE;IACjE,MAAM,eAAe,GAAG,CACtB,KAAc,EAC0C,EAAE;QAC1D,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YACrB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CACxB,CAAC,CAAC,EAAE,EAAE,CACJ,OAAO,CAAC,KAAK,QAAQ;gBACrB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;gBACjE,CAAC,KAAK,SAAS,CAClB,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,qEAAqE;IACrE,IAAI,kBAAkB,EAAE,CAAC;QACvB,cAAc,GAAG,aAAa,CAC5B,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACJ,CAAC;SAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACpD,cAAc,GAAG,aAAa,CAC5B,uBAAuB,EACvB,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACJ,CAAC;IAED,IAAI,mBAAmB,EAAE,CAAC;QACxB,eAAe,GAAG,aAAa,CAC7B,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACJ,CAAC;SAAM,IAAI,eAAe,CAAC,wBAAwB,CAAC,EAAE,CAAC;QACrD,eAAe,GAAG,aAAa,CAC7B,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,CAChB,CAAC;IACJ,CAAC;IAED,0BAA0B;IAC1B,MAAM,mBAAmB,GAA4B;QACnD,GAAG,UAAU;KACd,CAAC;IAEF,kGAAkG;IAClG,sDAAsD;IACtD,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACtC,IACE,CAAC,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACrC,GAAG,KAAK,qBAAqB,CAAC;YAChC,CAAC,GAAG,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBACtC,GAAG,KAAK,sBAAsB,CAAC,EACjC,CAAC;YACD,oDAAoD;YACpD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACzE,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;IAED,kDAAkD;IAClD,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,mBAAmB,CAAC,qBAAqB,CAAC,GAAG,cAAc,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,mBAAmB,CAAC,sBAAsB,CAAC,GAAG,eAAe,CAAC;IAChE,CAAC;IAED,gDAAgD;IAChD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,OAAO,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,OAAO,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IACnD,CAAC;IAED,qBAAqB;IACrB,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACvC,oEAAoE;IACpE,MAAM,YAAY,GAChB,cAAc,IAAI,IAAI;QACpB,CAAC,CAAE,IAAiD,CAAC,YAAY;QACjE,CAAC,CAAC,SAAS,CAAC;IAChB,OAAO;QACL,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,MAAM,EAAE,WAAW,CAAC,MAAM;QAC1B,YAAY;QACZ,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC1B,SAAS,EAAE,IAAI,IAAI,CACjB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CACvD,CAAC,WAAW,EAAE;QACf,OAAO,EAAE,IAAI,IAAI,CACf,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CACnD,CAAC,WAAW,EAAE;QACf,QAAQ,EACN,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;YAC5C,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO;QACjD,UAAU,EAAE,mBAAmB;QAC/B,MAAM,EAAE;YACN,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE;YACjC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;SAC7B;KACF,CAAC;AACJ,CAAC"}
@@ -1,55 +0,0 @@
1
- /**
2
- * wrapHttp - Wraps a function to set attributes on HTTP spans created within the wrapped block.
3
- *
4
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
5
- * context, which are automatically propagated to all spans created within the wrapped function.
6
- *
7
- * Instrumentation behavior:
8
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
9
- * `wrapHttp` only adds attributes to spans created within the wrapped block.
10
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
11
- * are instrumented. Requests outside `wrapHttp` are not instrumented.
12
- */
13
- import type { WrapHttpAttributes } from "./types";
14
- /**
15
- * Options for wrapHttp function
16
- */
17
- export interface WrapHttpOptions {
18
- attributes?: WrapHttpAttributes;
19
- /**
20
- * Callback to check if SDK is initialized.
21
- * Required to determine if global instrumentation is enabled.
22
- */
23
- checkInitialized: () => boolean;
24
- /**
25
- * Callback to check if global instrumentation is enabled.
26
- * Required to determine instrumentation behavior.
27
- */
28
- isGlobalInstrumentationEnabled: () => boolean;
29
- /**
30
- * Optional callback to ensure SDK is initialized (auto-initialization).
31
- * If not provided, wrapHttp will try to auto-initialize from environment variables.
32
- */
33
- ensureInitialized?: () => Promise<void>;
34
- }
35
- /**
36
- * Wraps a function to set attributes on HTTP spans created within the wrapped block.
37
- *
38
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
39
- * context, which are automatically propagated to all spans created within the wrapped function.
40
- *
41
- * Instrumentation behavior:
42
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
43
- * `wrapHttp` only adds attributes to spans created within the wrapped block.
44
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
45
- * are instrumented. Requests outside `wrapHttp` are not instrumented.
46
- *
47
- * Note: This is the low-level API. For a simpler API with automatic setup,
48
- * use `wrapHttp` from `@pingops/sdk` instead.
49
- *
50
- * @param options - Options including attributes and required callbacks
51
- * @param fn - Function to execute within the attribute context
52
- * @returns The result of the function
53
- */
54
- export declare function wrapHttp<T>(options: WrapHttpOptions, fn: () => T | Promise<T>): T | Promise<T>;
55
- //# sourceMappingURL=wrap-http.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wrap-http.d.ts","sourceRoot":"","sources":["../src/wrap-http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAaH,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 DELETED
@@ -1,135 +0,0 @@
1
- /**
2
- * wrapHttp - Wraps a function to set attributes on HTTP spans created within the wrapped block.
3
- *
4
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
5
- * context, which are automatically propagated to all spans created within the wrapped function.
6
- *
7
- * Instrumentation behavior:
8
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
9
- * `wrapHttp` only adds attributes to spans created within the wrapped block.
10
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
11
- * are instrumented. Requests outside `wrapHttp` are not instrumented.
12
- */
13
- import { context } from "@opentelemetry/api";
14
- import { createLogger } from "./logger";
15
- import { PINGOPS_HTTP_ENABLED, PINGOPS_USER_ID, PINGOPS_SESSION_ID, PINGOPS_TAGS, PINGOPS_METADATA, PINGOPS_CAPTURE_REQUEST_BODY, PINGOPS_CAPTURE_RESPONSE_BODY, } from "./context-keys";
16
- const logger = createLogger("[PingOps wrapHttp]");
17
- /**
18
- * Wraps a function to set attributes on HTTP spans created within the wrapped block.
19
- *
20
- * This function sets attributes (userId, sessionId, tags, metadata) in the OpenTelemetry
21
- * context, which are automatically propagated to all spans created within the wrapped function.
22
- *
23
- * Instrumentation behavior:
24
- * - If `initializePingops` was called: All HTTP requests are instrumented by default.
25
- * `wrapHttp` only adds attributes to spans created within the wrapped block.
26
- * - If `initializePingops` was NOT called: Only HTTP requests within `wrapHttp` blocks
27
- * are instrumented. Requests outside `wrapHttp` are not instrumented.
28
- *
29
- * Note: This is the low-level API. For a simpler API with automatic setup,
30
- * use `wrapHttp` from `@pingops/sdk` instead.
31
- *
32
- * @param options - Options including attributes and required callbacks
33
- * @param fn - Function to execute within the attribute context
34
- * @returns The result of the function
35
- */
36
- export function wrapHttp(options, fn) {
37
- logger.debug("wrapHttp called", {
38
- hasAttributes: !!options.attributes,
39
- hasUserId: !!options.attributes?.userId,
40
- hasSessionId: !!options.attributes?.sessionId,
41
- hasTags: !!options.attributes?.tags,
42
- hasMetadata: !!options.attributes?.metadata,
43
- });
44
- // Normalize options - if just attributes provided, it means callbacks are required
45
- // This is a type error at compile time, but we handle it gracefully
46
- const normalizedOptions = "checkInitialized" in options && "isGlobalInstrumentationEnabled" in options
47
- ? options
48
- : (() => {
49
- throw new Error("wrapHttp requires checkInitialized and isGlobalInstrumentationEnabled callbacks. Use wrapHttp from @pingops/sdk for automatic setup.");
50
- })();
51
- const { checkInitialized, ensureInitialized } = normalizedOptions;
52
- // Ensure SDK is initialized so that span processor can extract attributes
53
- // If already initialized, execute synchronously
54
- if (checkInitialized()) {
55
- logger.debug("SDK already initialized, executing wrapHttp synchronously");
56
- return executeWrapHttpWithContext(normalizedOptions, fn);
57
- }
58
- // If not initialized, we need to initialize first (async)
59
- if (ensureInitialized) {
60
- logger.debug("SDK not initialized, using provided ensureInitialized callback");
61
- return ensureInitialized()
62
- .then(() => {
63
- logger.debug("SDK initialized, executing wrapHttp");
64
- return executeWrapHttpWithContext(normalizedOptions, fn);
65
- })
66
- .catch((error) => {
67
- logger.error("Failed to initialize SDK for wrapHttp", {
68
- error: error instanceof Error ? error.message : String(error),
69
- });
70
- throw error;
71
- });
72
- }
73
- // No ensureInitialized callback provided, execute without initialization
74
- logger.debug("SDK not initialized and no ensureInitialized callback provided, executing wrapHttp");
75
- return executeWrapHttpWithContext(normalizedOptions, fn);
76
- }
77
- function executeWrapHttpWithContext(options, fn) {
78
- const { attributes, isGlobalInstrumentationEnabled } = options;
79
- const globalInstrumentationEnabled = isGlobalInstrumentationEnabled();
80
- logger.debug("Executing wrapHttp context", {
81
- hasAttributes: !!attributes,
82
- globalInstrumentationEnabled,
83
- });
84
- const activeContext = context.active();
85
- // If global instrumentation is not enabled, enable HTTP instrumentation
86
- // for this block only. If it's enabled, all requests are already instrumented.
87
- let contextWithAttributes = activeContext;
88
- if (!globalInstrumentationEnabled) {
89
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_HTTP_ENABLED, true);
90
- }
91
- // Set attributes in context if provided
92
- // These will be propagated to all spans created within the wrapped function
93
- if (attributes) {
94
- if (attributes.userId !== undefined) {
95
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_USER_ID, attributes.userId);
96
- }
97
- if (attributes.sessionId !== undefined) {
98
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_SESSION_ID, attributes.sessionId);
99
- }
100
- if (attributes.tags !== undefined) {
101
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_TAGS, attributes.tags);
102
- }
103
- if (attributes.metadata !== undefined) {
104
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_METADATA, attributes.metadata);
105
- }
106
- if (attributes.captureRequestBody !== undefined) {
107
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_CAPTURE_REQUEST_BODY, attributes.captureRequestBody);
108
- }
109
- if (attributes.captureResponseBody !== undefined) {
110
- contextWithAttributes = contextWithAttributes.setValue(PINGOPS_CAPTURE_RESPONSE_BODY, attributes.captureResponseBody);
111
- }
112
- }
113
- // Run user code inside the context with attributes
114
- return context.with(contextWithAttributes, () => {
115
- try {
116
- const result = fn();
117
- if (result instanceof Promise) {
118
- return result.catch((err) => {
119
- logger.error("Error in wrapHttp async execution", {
120
- error: err instanceof Error ? err.message : String(err),
121
- });
122
- throw err;
123
- });
124
- }
125
- return result;
126
- }
127
- catch (err) {
128
- logger.error("Error in wrapHttp sync execution", {
129
- error: err instanceof Error ? err.message : String(err),
130
- });
131
- throw err;
132
- }
133
- });
134
- }
135
- //# sourceMappingURL=wrap-http.js.map
@@ -1 +0,0 @@
1
- {"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,EAChB,4BAA4B,EAC5B,6BAA6B,GAC9B,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;QACD,IAAI,UAAU,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAChD,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,4BAA4B,EAC5B,UAAU,CAAC,kBAAkB,CAC9B,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;YACjD,qBAAqB,GAAG,qBAAqB,CAAC,QAAQ,CACpD,6BAA6B,EAC7B,UAAU,CAAC,mBAAmB,CAC/B,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"}