@pingops/otel 0.2.4 → 0.2.6

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { HTTP_RESPONSE_CONTENT_ENCODING, PINGOPS_CAPTURE_REQUEST_BODY, PINGOPS_C
 import { INVALID_SPAN_CONTEXT, ROOT_CONTEXT, SpanKind, SpanStatusCode, ValueType, context, propagation, trace } from "@opentelemetry/api";
 import "@opentelemetry/sdk-trace-node";
 import "@opentelemetry/resources";
-import { ATTR_ERROR_TYPE, ATTR_HTTP_REQUEST_METHOD, ATTR_HTTP_REQUEST_METHOD_ORIGINAL, ATTR_HTTP_RESPONSE_STATUS_CODE, ATTR_HTTP_URL, ATTR_NETWORK_PEER_ADDRESS, ATTR_NETWORK_PEER_PORT, ATTR_SERVER_ADDRESS, ATTR_SERVER_PORT, ATTR_URL_FULL, ATTR_URL_PATH, ATTR_URL_QUERY, ATTR_URL_SCHEME, ATTR_USER_AGENT_ORIGINAL, METRIC_HTTP_CLIENT_REQUEST_DURATION } from "@opentelemetry/semantic-conventions";
+import { ATTR_ERROR_TYPE, ATTR_HTTP_REQUEST_METHOD, ATTR_HTTP_REQUEST_METHOD_ORIGINAL, ATTR_HTTP_RESPONSE_STATUS_CODE, ATTR_NETWORK_PEER_ADDRESS, ATTR_NETWORK_PEER_PORT, ATTR_SERVER_ADDRESS, ATTR_SERVER_PORT, ATTR_URL_FULL, ATTR_URL_PATH, ATTR_URL_QUERY, ATTR_URL_SCHEME, ATTR_USER_AGENT_ORIGINAL, METRIC_HTTP_CLIENT_REQUEST_DURATION } from "@opentelemetry/semantic-conventions";
 import { ClientRequest, IncomingMessage } from "http";
 import { HttpInstrumentation } from "@opentelemetry/instrumentation-http";
 import { hrTime, hrTimeDuration, hrTimeToMilliseconds, isTracingSuppressed } from "@opentelemetry/core";
@@ -411,6 +411,7 @@ function resolveOutboundSpanParentContext(activeContext, requestUrl) {
 */
 const DEFAULT_MAX_REQUEST_BODY_SIZE$1 = 4 * 1024;
 const DEFAULT_MAX_RESPONSE_BODY_SIZE$1 = 4 * 1024;
+const LEGACY_ATTR_HTTP_URL = "http.url";
 const PingopsSemanticAttributes = {
 	HTTP_REQUEST_BODY: "http.request.body",
 	HTTP_RESPONSE_BODY: "http.response.body"
@@ -418,12 +419,18 @@ const PingopsSemanticAttributes = {
 /**
 * Manually flattens a nested object into dot-notation keys
 */
+function isPlainObject(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value) && !(value instanceof Buffer);
+}
+function isPrimitiveArray(value) {
+	return value.every((item) => typeof item === "string" || typeof item === "number" || typeof item === "boolean");
+}
 function flatten(obj, prefix = "") {
 	const result = {};
 	for (const key in obj) if (Object.prototype.hasOwnProperty.call(obj, key)) {
 		const newKey = prefix ? `${prefix}.${key}` : key;
 		const value = obj[key];
-		if (value !== null && typeof value === "object" && !Array.isArray(value) && !(value instanceof Buffer)) Object.assign(result, flatten(value, newKey));
+		if (isPlainObject(value)) Object.assign(result, flatten(value, newKey));
 		else result[newKey] = value;
 	}
 	return result;
@@ -434,11 +441,9 @@ function flatten(obj, prefix = "") {
 function setAttributeValue(span, attrName, attrValue) {
 	if (typeof attrValue === "string" || typeof attrValue === "number" || typeof attrValue === "boolean") span.setAttribute(attrName, attrValue);
 	else if (attrValue instanceof Buffer) span.setAttribute(attrName, attrValue.toString("utf8"));
-	else if (typeof attrValue == "object") span.setAttributes(flatten({ [attrName]: attrValue }));
-	else if (Array.isArray(attrValue)) if (attrValue.length) {
-		const firstElement = attrValue[0];
-		if (typeof firstElement === "string" || typeof firstElement === "number" || typeof firstElement === "boolean") span.setAttribute(attrName, attrValue);
-	} else span.setAttribute(attrName, attrValue);
+	else if (Array.isArray(attrValue)) {
+		if (attrValue.length === 0 || isPrimitiveArray(attrValue)) span.setAttribute(attrName, attrValue);
+	} else if (isPlainObject(attrValue)) span.setAttributes(flatten({ [attrName]: attrValue }));
 }
 /**
 * Extracts domain from URL
@@ -504,9 +509,16 @@ function captureRequestBody(span, data, maxSize, semanticAttr, url) {
 /**
 * Captures response body from chunks
 */
-function captureResponseBody(span, chunks, semanticAttr, responseHeaders, url) {
+function captureResponseBody(span, chunks, semanticAttr, responseHeaders, url, maxSize) {
 	if (!shouldCaptureResponseBody$1(url)) return;
-	if (chunks && chunks.length) try {
+	if (chunks === null) {
+		const contentEncoding = responseHeaders?.["content-encoding"];
+		const contentType = responseHeaders?.["content-type"];
+		const toHeaderString = (value) => typeof value === "string" ? value : Array.isArray(value) ? value.join(", ") : "unknown";
+		setAttributeValue(span, semanticAttr, `[truncated response body; exceeded maxResponseBodySize=${maxSize ?? DEFAULT_MAX_RESPONSE_BODY_SIZE$1}; content-type=${toHeaderString(contentType)}; content-encoding=${toHeaderString(contentEncoding)}]`);
+		return;
+	}
+	if (chunks.length) try {
 		const concatedChunks = Buffer.concat(chunks);
 		const contentEncoding = responseHeaders?.["content-encoding"];
 		if (isCompressedContentEncoding(contentEncoding)) {
@@ -569,12 +581,27 @@ function extractRequestUrlFromSpanOptions(options) {
 	const attrs = options.attributes;
 	if (!attrs) return;
 	if (typeof attrs[ATTR_URL_FULL] === "string") return attrs[ATTR_URL_FULL];
-	if (typeof attrs[ATTR_HTTP_URL] === "string") return attrs[ATTR_HTTP_URL];
+	if (typeof attrs[LEGACY_ATTR_HTTP_URL] === "string") return attrs[LEGACY_ATTR_HTTP_URL];
 	const scheme = typeof attrs[ATTR_URL_SCHEME] === "string" ? attrs[ATTR_URL_SCHEME] : "http";
 	const host = typeof attrs[ATTR_SERVER_ADDRESS] === "string" ? attrs[ATTR_SERVER_ADDRESS] : void 0;
 	if (!host) return;
 	return `${scheme}://${host}${typeof attrs[ATTR_SERVER_PORT] === "number" ? `:${attrs[ATTR_SERVER_PORT]}` : ""}${typeof attrs[ATTR_URL_PATH] === "string" ? attrs[ATTR_URL_PATH] : "/"}${typeof attrs[ATTR_URL_QUERY] === "string" && attrs[ATTR_URL_QUERY].length > 0 ? `?${attrs[ATTR_URL_QUERY]}` : ""}`;
 }
+function parseRequestPathAndQuery(pathWithQuery) {
+	const queryIndex = pathWithQuery.indexOf("?");
+	if (queryIndex < 0) return { path: pathWithQuery || "/" };
+	const path = pathWithQuery.slice(0, queryIndex) || "/";
+	const queryPart = pathWithQuery.slice(queryIndex);
+	return {
+		path,
+		query: queryPart.length > 0 ? queryPart : void 0
+	};
+}
+function extractClientRequestPath(request) {
+	if (!request || typeof request !== "object" || !("path" in request)) return;
+	const path = request.path;
+	return typeof path === "string" && path.length > 0 ? path : void 0;
+}
 const PingopsHttpSemanticAttributes = PingopsSemanticAttributes;
 var PingopsHttpInstrumentation = class extends HttpInstrumentation {
 	constructor(config) {
@@ -608,17 +635,25 @@ var PingopsHttpInstrumentation = class extends HttpInstrumentation {
 			if (headers) captureRequestHeaders(span, headers);
 			if (request instanceof ClientRequest) {
 				const maxRequestBodySize = config?.maxRequestBodySize || DEFAULT_MAX_REQUEST_BODY_SIZE$1;
-				const url = request.path && request.getHeader("host") ? `${request.protocol || "http:"}//${request.getHeader("host")}${request.path}` : void 0;
+				const hostHeader = request.getHeader("host");
+				const host = typeof hostHeader === "string" ? hostHeader : Array.isArray(hostHeader) ? hostHeader.join(",") : typeof hostHeader === "number" ? String(hostHeader) : void 0;
+				const url = request.path && host ? `${request.protocol || "http:"}//${host}${request.path}` : void 0;
+				if (typeof request.path === "string" && request.path.length > 0) {
+					const { path, query } = parseRequestPathAndQuery(request.path);
+					span.setAttribute(ATTR_URL_PATH, path);
+					if (query) span.setAttribute(ATTR_URL_QUERY, query);
+				}
+				if (url) span.setAttribute(ATTR_URL_FULL, url);
 				const originalWrite = request.write.bind(request);
 				const originalEnd = request.end.bind(request);
-				request.write = (data) => {
+				request.write = ((data, ...rest) => {
 					if (typeof data === "string" || data instanceof Buffer) captureRequestBody(span, data, maxRequestBodySize, PingopsSemanticAttributes.HTTP_REQUEST_BODY, url);
-					return originalWrite(data);
-				};
-				request.end = (data) => {
+					return originalWrite(data, ...rest);
+				});
+				request.end = ((data, ...rest) => {
 					if (typeof data === "string" || data instanceof Buffer) captureRequestBody(span, data, maxRequestBodySize, PingopsSemanticAttributes.HTTP_REQUEST_BODY, url);
-					return originalEnd(data);
-				};
+					return originalEnd(data, ...rest);
+				});
 			}
 			if (originalRequestHook) originalRequestHook(span, request);
 		};
@@ -628,6 +663,12 @@ var PingopsHttpInstrumentation = class extends HttpInstrumentation {
 			const headers = extractResponseHeaders(response);
 			if (headers) captureResponseHeaders(span, headers);
 			if (response instanceof IncomingMessage) {
+				const requestPath = response.req instanceof ClientRequest ? extractClientRequestPath(response.req) : void 0;
+				if (requestPath) {
+					const { path, query } = parseRequestPathAndQuery(requestPath);
+					span.setAttribute(ATTR_URL_PATH, path);
+					if (query) span.setAttribute(ATTR_URL_QUERY, query);
+				}
 				const maxResponseBodySize = config?.maxResponseBodySize || DEFAULT_MAX_RESPONSE_BODY_SIZE$1;
 				const url = response.url || void 0;
 				let chunks = [];
@@ -635,15 +676,24 @@ var PingopsHttpInstrumentation = class extends HttpInstrumentation {
 				const shouldCapture = shouldCaptureResponseBody$1(url);
 				response.prependListener("data", (chunk) => {
 					if (!chunk || !shouldCapture) return;
-					if (typeof chunk === "string" || chunk instanceof Buffer) {
-						totalSize += chunk.length;
-						if (chunks && totalSize <= maxResponseBodySize) chunks.push(typeof chunk === "string" ? Buffer.from(chunk) : chunk);
-						else chunks = null;
-					}
-				});
-				response.prependOnceListener("end", () => {
-					captureResponseBody(span, chunks, PingopsSemanticAttributes.HTTP_RESPONSE_BODY, headers, url);
+					let chunkBuffer = null;
+					if (typeof chunk === "string") chunkBuffer = Buffer.from(chunk);
+					else if (Buffer.isBuffer(chunk)) chunkBuffer = chunk;
+					else if (chunk instanceof Uint8Array) chunkBuffer = Buffer.from(chunk);
+					if (!chunkBuffer) return;
+					totalSize += chunkBuffer.length;
+					if (chunks && totalSize <= maxResponseBodySize) chunks.push(chunkBuffer);
+					else chunks = null;
 				});
+				let finalized = false;
+				const finalizeCapture = () => {
+					if (finalized) return;
+					finalized = true;
+					captureResponseBody(span, chunks, PingopsSemanticAttributes.HTTP_RESPONSE_BODY, headers, url, maxResponseBodySize);
+				};
+				response.prependOnceListener("end", finalizeCapture);
+				response.prependOnceListener("close", finalizeCapture);
+				response.prependOnceListener("aborted", finalizeCapture);
 			}
 			if (originalResponseHook) originalResponseHook(span, response);
 		};
@@ -897,11 +947,11 @@ var UndiciInstrumentation = class extends InstrumentationBase {
 		const record = this._recordFromReq.get(request);
 		if (!record) return;
 		const { span } = record;
-		const { remoteAddress, remotePort } = socket;
-		const spanAttributes = {
-			[ATTR_NETWORK_PEER_ADDRESS]: remoteAddress,
-			[ATTR_NETWORK_PEER_PORT]: remotePort
-		};
+		const spanAttributes = {};
+		const remoteAddress = typeof socket.remoteAddress === "string" ? socket.remoteAddress : void 0;
+		const remotePort = typeof socket.remotePort === "number" ? socket.remotePort : void 0;
+		if (remoteAddress) spanAttributes[ATTR_NETWORK_PEER_ADDRESS] = remoteAddress;
+		if (remotePort !== void 0) spanAttributes[ATTR_NETWORK_PEER_PORT] = remotePort;
 		const headersMap = this.parseRequestHeaders(request);
 		for (const [name, value] of headersMap.entries()) {
 			const attrValue = Array.isArray(value) ? value.join(", ") : value;
@@ -970,14 +1020,15 @@ var UndiciInstrumentation = class extends InstrumentationBase {
 				this._diag.error("Error occurred while capturing request body:", e);
 			}
 		}
+		const errorMessage = error.message;
 		span.recordException(error);
 		span.setStatus({
 			code: SpanStatusCode.ERROR,
-			message: error.message
+			message: errorMessage
 		});
 		span.end();
 		this._recordFromReq.delete(request);
-		attributes[ATTR_ERROR_TYPE] = error.message;
+		attributes[ATTR_ERROR_TYPE] = errorMessage;
 		this.recordRequestDuration(attributes, startTime);
 	}
 	onBodyChunkSent({ request, chunk }) {