@sebspark/opentelemetry-instrumentation-opensearch 0.1.1 → 0.2.1

package/README.md

@@ -78,13 +78,76 @@ new OpenSearchInstrumentation({ suppressInternalInstrumentation: true })
 
 ## Produced spans
 
-| Attribute | Example | Notes |
-|---|---|---|
-| `db.system.name` | `opensearch` | Always set |
-| `db.operation.name` | `search` | Parsed from path (`_search` → `search`) |
-| `db.opensearch.index` | `asset_v0.1.3` | Omitted for cluster-level operations like `bulk` |
-| `db.query.text` | `{"query":{"match_all":{}}}` | Omitted when `dbStatementSerializer: false` |
-| `server.address` | `localhost` | Set from the connection used for the request |
-| `server.port` | `9200` | Omitted when using the default port for the protocol |
-
 Span name follows the pattern `<operation> <index>` (e.g. `search asset_v0.1.3`) or just `<operation>` for index-less operations like `bulk`. Falls back to the raw path when the path does not contain an underscore-prefixed operation segment.
+
+### Request attributes
+
+Set at span creation, before the request is sent.
+
+| Attribute | Type | Example | Notes |
+|---|---|---|---|
+| `db.system.name` | string | `opensearch` | Always set |
+| `db.operation.name` | string | `search` | Parsed from path (`_search` → `search`). Omitted when path has no operation segment |
+| `db.opensearch.index` | string | `asset_v0.1.3` | Omitted for cluster-level operations like `_bulk` |
+| `db.query.text` | string | `{"query":{"match_all":{}}}` | The serialized request body. Omitted for bodyless requests or when `dbStatementSerializer: false` |
+
+### Response attributes
+
+Set on the span after a successful response.
+
+#### Always present on search responses
+
+| Attribute | Type | Example | Description |
+|---|---|---|---|
+| `server.address` | string | `opensearch.example.com` | Hostname of the node that handled the request |
+| `server.port` | number | `9200` | Omitted when using the default port for the protocol |
+| `http.response.status_code` | number | `200` | HTTP status code of the response |
+| `db.opensearch.took` | number | `5` | Time in milliseconds OpenSearch spent executing the request |
+| `db.opensearch.timed_out` | boolean | `false` | Whether the request hit the `timeout` threshold |
+| `db.opensearch.shards.total` | number | `5` | Total number of shards the request was executed against |
+| `db.opensearch.shards.successful` | number | `5` | Number of shards that responded successfully |
+| `db.opensearch.shards.failed` | number | `0` | Number of shards that failed |
+| `db.opensearch.hits.total` | number | `42` | Total number of matching documents |
+
+#### Conditionally present
+
+These attributes only appear when specific conditions are met, either because OpenSearch omits them by default or because they require the query to opt in.
+
+| Attribute | Type | Condition | When to use |
+|---|---|---|---|
+| `db.opensearch.shards.skipped` | number | Present when OpenSearch skips shards, e.g. when using `_routing` or shard-level filtering | Useful for verifying that routing is working as intended — a high skipped count means fewer shards are doing work |
+| `db.opensearch.terminated_early` | boolean | Present when the query includes `terminate_after: N` in the request body | Use `terminate_after` when you want to cap result collection for performance reasons (e.g. existence checks). The attribute tells you whether the cap was actually hit |
+| `db.opensearch.phase_took.*` | number | Present when the request uses `search_type: 'dfs_query_then_fetch'` | Use DFS search type when accurate relevance scoring across shards matters (e.g. small indices or cross-shard ranking). The phase breakdown lets you identify which phase dominates latency |
+
+To enable `phase_took`, set `search_type` on the request:
+
+```ts
+client.search({
+  index: 'my_index',
+  search_type: 'dfs_query_then_fetch',
+  body: { query: { ... } },
+})
+```
+
+To enable `terminated_early`, set `terminate_after` in the query body:
+
+```ts
+client.search({
+  index: 'my_index',
+  body: {
+    terminate_after: 1000,
+    query: { ... },
+  },
+})
+```
+
+#### `db.opensearch.phase_took.*` fields
+
+| Attribute | Description |
+|---|---|
+| `db.opensearch.phase_took.can_match` | Time spent determining which shards can match the query |
+| `db.opensearch.phase_took.dfs_pre_query` | Time spent collecting term statistics across shards before the query phase |
+| `db.opensearch.phase_took.dfs_query` | Time spent executing the query using globally collected term statistics |
+| `db.opensearch.phase_took.expand` | Time spent expanding results (e.g. for collapse/inner hits) |
+| `db.opensearch.phase_took.fetch` | Time spent fetching document source and fields |
+| `db.opensearch.phase_took.query` | Time spent in the standard query phase |

package/dist/index.d.mts

@@ -1,57 +1,25 @@
 import { ApiResponse, TransportRequestParams } from "@opensearch-project/opensearch/lib/Transport.js";
-import { Span } from "@opentelemetry/api";
 import { InstrumentationBase, InstrumentationConfig } from "@opentelemetry/instrumentation";
+import { Span } from "@opentelemetry/api";
 
-//#region src/index.d.ts
-/** Configuration for {@link OpenSearchInstrumentation}. */
+//#region src/types.d.ts
 interface OpenSearchInstrumentationConfig extends InstrumentationConfig {
-  /**
-   * Serialize the request body into `db.query.text`.
-   * Set to `false` to disable capture entirely.
-   * Defaults to `JSON.stringify`.
-   */
   dbStatementSerializer?: false | ((params: TransportRequestParams) => string);
-  /**
-   * Hook called after span attributes are set, before the request is made.
-   * Use to add custom attributes.
-   */
   requestHook?: (span: Span, params: TransportRequestParams) => void;
-  /**
-   * Hook called after a successful response is received.
-   * Use to add custom attributes derived from the response.
-   */
   responseHook?: (span: Span, response: ApiResponse) => void;
-  /**
-   * When `true`, child span creation inside the Transport call is suppressed so
-   * HTTP instrumentation cannot produce a duplicate span.
-   * When `false` (default), the db span is set as the active context so HTTP
-   * child spans are properly parented and W3C trace headers are propagated.
-   */
   suppressInternalInstrumentation?: boolean;
-  /**
-   * If set, the value of the `@opensearch-project/opensearch` client version is
-   * recorded as a span attribute under this name.
-   * e.g. `'db.opensearch.client.version'`
-   */
   moduleVersionAttributeName?: string;
 }
-/**
- * OpenTelemetry instrumentation for `@opensearch-project/opensearch`.
- *
- * Patches `Transport.prototype.request` to create a `db` CLIENT span for every
- * request. Tracing is suppressed inside the call so the HTTP instrumentation
- * does not produce a duplicate child span.
- */
+//#endregion
+//#region src/index.d.ts
 declare class OpenSearchInstrumentation extends InstrumentationBase {
   private readonly osConfig;
   private _original;
   constructor(config?: OpenSearchInstrumentationConfig);
   protected init(): void;
-  /** Patches `Transport.prototype.request` with span instrumentation. */
   enable(): void;
-  /** Restores the original `Transport.prototype.request`. */
   disable(): void;
 }
 //#endregion
-export { OpenSearchInstrumentation, OpenSearchInstrumentationConfig };
+export { OpenSearchInstrumentation, type OpenSearchInstrumentationConfig };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;UA+CiB,+BAAA,SAAwC,qBAAA;EAAxC;;;;;EAMf,qBAAA,aAAkC,MAAA,EAAQ,sBAAA;EAYpB;;;;EANtB,WAAA,IAAe,IAAA,EAAM,IAAA,EAAM,MAAA,EAAQ,sBAAA;EAZoB;;;;EAkBvD,YAAA,IAAgB,IAAA,EAAM,IAAA,EAAM,QAAA,EAAU,WAAA;EANjB;;;;;;EAcrB,+BAAA;EARsC;;;;;EAetC,0BAAA;AAAA;;;;;;;;cAUW,yBAAA,SAAkC,mBAAA;EAAA,iBAC5B,QAAA;EAAA,QACD,SAAA;cAEJ,MAAA,GAAQ,+BAAA;EAAA,UASV,IAAA,CAAA;EA8GM;EA3GP,MAAA,CAAA;;EA2GA,OAAA,CAAA;AAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;;UAOiB,+BAAA,SAAwC,qBAAA;EACvD,qBAAA,aAAkC,MAAA,EAAQ,sBAAA;EAC1C,WAAA,IAAe,IAAA,EAAM,IAAA,EAAM,MAAA,EAAQ,sBAAA;EACnC,YAAA,IAAgB,IAAA,EAAM,IAAA,EAAM,QAAA,EAAU,WAAA;EACtC,+BAAA;EACA,0BAAA;AAAA;;;cCGW,yBAAA,SAAkC,mBAAA;EAAA,iBAC5B,QAAA;EAAA,QACT,SAAA;cAEI,MAAA,GAAQ,+BAAA;EAAA,UAQV,IAAA,CAAA;EAED,MAAA,CAAA;EAWA,OAAA,CAAA;AAAA"}

package/dist/index.mjs

@@ -1,91 +1,136 @@
 import Transport from "@opensearch-project/opensearch/lib/Transport.js";
 import opensearchPkg from "@opensearch-project/opensearch/package.json" with { type: "json" };
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
 import { SpanKind, SpanStatusCode, context, trace } from "@opentelemetry/api";
 import { suppressTracing } from "@opentelemetry/core";
-import { InstrumentationBase } from "@opentelemetry/instrumentation";
 import { ATTR_DB_OPERATION_NAME, ATTR_DB_QUERY_TEXT, ATTR_DB_SYSTEM_NAME, ATTR_SERVER_ADDRESS, ATTR_SERVER_PORT } from "@opentelemetry/semantic-conventions";
+//#region package.json
+var name = "@sebspark/opentelemetry-instrumentation-opensearch";
+var version = "0.2.1";
 //#endregion
-//#region src/index.ts
-const PACKAGE_VERSION = "0.1.1";
-const OPENSEARCH_CLIENT_VERSION = opensearchPkg.version;
-/**
-* Parses an OpenSearch path into its index and operation components.
-* e.g. `/my_index/_search` → `{ index: 'my_index', operation: 'search' }`
-* e.g. `/_bulk` → `{ operation: 'bulk' }`
-*/
-function parsePath(path) {
+//#region src/parse-path.ts
+const parsePath = (path) => {
 	const match = path.match(/^\/(?:([^/_][^/]*)\/)?_([^/]+)/);
 	if (!match) return {};
 	return {
 		index: match[1],
 		operation: match[2]
 	};
-}
-/**
-* OpenTelemetry instrumentation for `@opensearch-project/opensearch`.
-*
-* Patches `Transport.prototype.request` to create a `db` CLIENT span for every
-* request. Tracing is suppressed inside the call so the HTTP instrumentation
-* does not produce a duplicate child span.
-*/
+};
+//#endregion
+//#region src/response-attributes.ts
+const ATTR_DB_OPENSEARCH_DURATION_MS = "db.opensearch.duration_ms";
+const extractResponseAttributes = (res) => {
+	const attrs = {};
+	const { hostname, port } = res.meta.connection.url;
+	attrs[ATTR_SERVER_ADDRESS] = hostname;
+	if (port) attrs[ATTR_SERVER_PORT] = Number(port);
+	if (res.statusCode != null) attrs["http.response.status_code"] = res.statusCode;
+	const body = res.body;
+	if (body == null) return attrs;
+	if (body.took != null) attrs["db.opensearch.took"] = body.took;
+	if (body.timed_out != null) attrs["db.opensearch.timed_out"] = body.timed_out;
+	if (body.terminated_early != null) attrs["db.opensearch.terminated_early"] = body.terminated_early;
+	const shards = body._shards;
+	if (shards != null) {
+		attrs["db.opensearch.shards.total"] = shards.total;
+		attrs["db.opensearch.shards.successful"] = shards.successful;
+		attrs["db.opensearch.shards.failed"] = shards.failed;
+		if (shards.skipped != null) attrs["db.opensearch.shards.skipped"] = shards.skipped;
+	}
+	const phaseTook = body.phase_took;
+	if (phaseTook != null) {
+		attrs["db.opensearch.phase_took.can_match"] = phaseTook.can_match;
+		attrs["db.opensearch.phase_took.dfs_pre_query"] = phaseTook.dfs_pre_query;
+		attrs["db.opensearch.phase_took.dfs_query"] = phaseTook.dfs_query;
+		attrs["db.opensearch.phase_took.expand"] = phaseTook.expand;
+		attrs["db.opensearch.phase_took.fetch"] = phaseTook.fetch;
+		attrs["db.opensearch.phase_took.query"] = phaseTook.query;
+	}
+	const total = body.hits?.total;
+	if (total != null && typeof total === "object") attrs["db.opensearch.hits.total"] = total.value;
+	return attrs;
+};
+//#endregion
+//#region src/serialize-body.ts
+const serializeBody = (params, config) => {
+	if (!params.body) return void 0;
+	if (config.dbStatementSerializer === false) return void 0;
+	if (typeof config.dbStatementSerializer === "function") return config.dbStatementSerializer(params);
+	return typeof params.body === "string" ? params.body : JSON.stringify(params.body);
+};
+//#endregion
+//#region src/patch-request.ts
+const createPatchedRequest = (getTracer, config = {}, original, clientVersion) => {
+	function patchedRequest(params, options, callback) {
+		const { index, operation } = parsePath(params.path);
+		const queryText = serializeBody(params, config);
+		const span = getTracer().startSpan([operation, index].filter(Boolean).join(" ") || params.path, {
+			kind: SpanKind.CLIENT,
+			attributes: {
+				[ATTR_DB_SYSTEM_NAME]: "opensearch",
+				...operation && { [ATTR_DB_OPERATION_NAME]: operation },
+				...index && { "db.opensearch.index": index },
+				...queryText && { [ATTR_DB_QUERY_TEXT]: queryText }
+			}
+		});
+		config.requestHook?.(span, params);
+		const startTime = Date.now();
+		const onSuccess = (res) => {
+			span.setAttribute(ATTR_DB_OPENSEARCH_DURATION_MS, Date.now() - startTime);
+			for (const [key, value] of Object.entries(extractResponseAttributes(res))) span.setAttribute(key, value);
+			if (config.moduleVersionAttributeName) span.setAttribute(config.moduleVersionAttributeName, clientVersion);
+			config.responseHook?.(span, res);
+			span.end();
+		};
+		const onError = (err) => {
+			span.setAttribute(ATTR_DB_OPENSEARCH_DURATION_MS, Date.now() - startTime);
+			if (err instanceof Error) span.recordException(err);
+			span.setStatus({ code: SpanStatusCode.ERROR });
+			span.end();
+		};
+		const callCtx = config.suppressInternalInstrumentation ? suppressTracing(context.active()) : trace.setSpan(context.active(), span);
+		if (typeof callback === "function") {
+			const originalWithCallback = original.bind(this);
+			return context.with(callCtx, () => originalWithCallback(params, options, (err, res) => {
+				err ? onError(err) : onSuccess(res);
+				callback(err, res);
+			}));
+		}
+		const result = context.with(callCtx, () => original.call(this, params, options));
+		const settled = result.then((res) => {
+			onSuccess(res);
+			return res;
+		}, (err) => {
+			onError(err);
+			throw err;
+		});
+		return Object.assign(settled, { abort: result.abort });
+	}
+	return patchedRequest;
+};
+//#endregion
+//#region src/index.ts
+const PACKAGE_NAME = name;
+const PACKAGE_VERSION = version;
+const OPENSEARCH_CLIENT_VERSION = opensearchPkg.version;
 var OpenSearchInstrumentation = class extends InstrumentationBase {
 	osConfig;
+	_original;
 	constructor(config = {}) {
-		super("@sebspark/opentelemetry-instrumentation-opensearch", PACKAGE_VERSION, config);
+		super(PACKAGE_NAME, PACKAGE_VERSION, {
+			...config,
+			enabled: false
+		});
 		this.osConfig = config;
+		if (config.enabled !== false) this.enable();
 	}
 	init() {}
-	/** Patches `Transport.prototype.request` with span instrumentation. */
 	enable() {
 		if (this._original) return;
-		const self = this;
-		const original = Transport.prototype.request;
-		this._original = original;
-		function patchedRequest(params, options, callback) {
-			const { index, operation } = parsePath(params.path);
-			const spanName = [operation, index].filter(Boolean).join(" ") || params.path;
-			const span = self.tracer.startSpan(spanName, {
-				kind: SpanKind.CLIENT,
-				attributes: {
-					[ATTR_DB_SYSTEM_NAME]: "opensearch",
-					...operation && { [ATTR_DB_OPERATION_NAME]: operation },
-					...index && { "db.opensearch.index": index },
-					...params.body && self.osConfig?.dbStatementSerializer !== false && { [ATTR_DB_QUERY_TEXT]: typeof self.osConfig?.dbStatementSerializer === "function" ? self.osConfig.dbStatementSerializer(params) : typeof params.body === "string" ? params.body : JSON.stringify(params.body) }
-				}
-			});
-			self.osConfig?.requestHook?.(span, params);
-			const endSpanOnSuccess = (res) => {
-				const { hostname, port } = res.meta.connection.url;
-				span.setAttribute(ATTR_SERVER_ADDRESS, hostname);
-				if (port) span.setAttribute(ATTR_SERVER_PORT, Number(port));
-				if (self.osConfig?.moduleVersionAttributeName) span.setAttribute(self.osConfig.moduleVersionAttributeName, OPENSEARCH_CLIENT_VERSION);
-				self.osConfig?.responseHook?.(span, res);
-				span.end();
-			};
-			const endSpanOnError = (err) => {
-				if (err instanceof Error) span.recordException(err);
-				span.setStatus({ code: SpanStatusCode.ERROR });
-				span.end();
-			};
-			const callCtx = self.osConfig?.suppressInternalInstrumentation ? suppressTracing(context.active()) : trace.setSpan(context.active(), span);
-			if (typeof callback === "function") return context.with(callCtx, () => original.call(this, params, options, (err, res) => {
-				if (err) endSpanOnError(err);
-				else endSpanOnSuccess(res);
-				callback(err, res);
-			}));
-			const result = context.with(callCtx, () => original.call(this, params, options));
-			const settled = result.then((res) => {
-				endSpanOnSuccess(res);
-				return res;
-			}, (err) => {
-				endSpanOnError(err);
-				throw err;
-			});
-			return Object.assign(settled, { abort: result.abort });
-		}
-		Transport.prototype.request = patchedRequest;
+		this._original = Transport.prototype.request;
+		Transport.prototype.request = createPatchedRequest(() => this.tracer, this.osConfig, this._original, OPENSEARCH_CLIENT_VERSION);
 	}
-	/** Restores the original `Transport.prototype.request`. */
 	disable() {
 		if (this._original) {
 			Transport.prototype.request = this._original;

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["pkg.version"],"sources":["../package.json","../src/index.ts"],"sourcesContent":["","import Transport, {\n  type ApiError,\n  type ApiResponse,\n  type TransportRequestCallback,\n  type TransportRequestOptions,\n  type TransportRequestParams,\n  type TransportRequestPromise,\n} from '@opensearch-project/opensearch/lib/Transport.js'\nimport opensearchPkg from '@opensearch-project/opensearch/package.json' with {\n  type: 'json',\n}\nimport {\n  context,\n  type Span,\n  SpanKind,\n  SpanStatusCode,\n  trace,\n} from '@opentelemetry/api'\nimport { suppressTracing } from '@opentelemetry/core'\nimport {\n  InstrumentationBase,\n  type InstrumentationConfig,\n} from '@opentelemetry/instrumentation'\nimport {\n  ATTR_DB_OPERATION_NAME,\n  ATTR_DB_QUERY_TEXT,\n  ATTR_DB_SYSTEM_NAME,\n  ATTR_SERVER_ADDRESS,\n  ATTR_SERVER_PORT,\n} from '@opentelemetry/semantic-conventions'\nimport pkg from '../package.json' with { type: 'json' }\n\nconst PACKAGE_VERSION: string = pkg.version\nconst OPENSEARCH_CLIENT_VERSION: string = opensearchPkg.version\n\n/**\n * Parses an OpenSearch path into its index and operation components.\n * e.g. `/my_index/_search` → `{ index: 'my_index', operation: 'search' }`\n * e.g. `/_bulk` → `{ operation: 'bulk' }`\n */\nfunction parsePath(path: string): { index?: string; operation?: string } {\n  const match = path.match(/^\\/(?:([^/_][^/]*)\\/)?_([^/]+)/)\n  if (!match) return {}\n  return { index: match[1], operation: match[2] }\n}\n\n/** Configuration for {@link OpenSearchInstrumentation}. */\nexport interface OpenSearchInstrumentationConfig extends InstrumentationConfig {\n  /**\n   * Serialize the request body into `db.query.text`.\n   * Set to `false` to disable capture entirely.\n   * Defaults to `JSON.stringify`.\n   */\n  dbStatementSerializer?: false | ((params: TransportRequestParams) => string)\n\n  /**\n   * Hook called after span attributes are set, before the request is made.\n   * Use to add custom attributes.\n   */\n  requestHook?: (span: Span, params: TransportRequestParams) => void\n\n  /**\n   * Hook called after a successful response is received.\n   * Use to add custom attributes derived from the response.\n   */\n  responseHook?: (span: Span, response: ApiResponse) => void\n\n  /**\n   * When `true`, child span creation inside the Transport call is suppressed so\n   * HTTP instrumentation cannot produce a duplicate span.\n   * When `false` (default), the db span is set as the active context so HTTP\n   * child spans are properly parented and W3C trace headers are propagated.\n   */\n  suppressInternalInstrumentation?: boolean\n\n  /**\n   * If set, the value of the `@opensearch-project/opensearch` client version is\n   * recorded as a span attribute under this name.\n   * e.g. `'db.opensearch.client.version'`\n   */\n  moduleVersionAttributeName?: string\n}\n\n/**\n * OpenTelemetry instrumentation for `@opensearch-project/opensearch`.\n *\n * Patches `Transport.prototype.request` to create a `db` CLIENT span for every\n * request. Tracing is suppressed inside the call so the HTTP instrumentation\n * does not produce a duplicate child span.\n */\nexport class OpenSearchInstrumentation extends InstrumentationBase {\n  private readonly osConfig: OpenSearchInstrumentationConfig\n  private declare _original: typeof Transport.prototype.request | undefined\n\n  constructor(config: OpenSearchInstrumentationConfig = {}) {\n    super(\n      '@sebspark/opentelemetry-instrumentation-opensearch',\n      PACKAGE_VERSION,\n      config\n    )\n    this.osConfig = config\n  }\n\n  protected init() {}\n\n  /** Patches `Transport.prototype.request` with span instrumentation. */\n  override enable() {\n    if (this._original) return\n    const self = this\n    const original: (\n      this: Transport,\n      params: TransportRequestParams,\n      options?: TransportRequestOptions\n    ) => TransportRequestPromise<ApiResponse> = Transport.prototype.request\n    this._original = original\n\n    function patchedRequest(\n      params: TransportRequestParams,\n      options?: TransportRequestOptions\n    ): TransportRequestPromise<ApiResponse>\n    function patchedRequest(\n      params: TransportRequestParams,\n      options: TransportRequestOptions | undefined,\n      callback: (err: ApiError, result: ApiResponse) => void\n    ): TransportRequestCallback\n    function patchedRequest(\n      this: Transport,\n      params: TransportRequestParams,\n      options?: TransportRequestOptions,\n      callback?: (err: ApiError, result: ApiResponse) => void\n    ): TransportRequestPromise<ApiResponse> | TransportRequestCallback {\n      const { index, operation } = parsePath(params.path)\n      const spanName =\n        [operation, index].filter(Boolean).join(' ') || params.path\n      const span = self.tracer.startSpan(spanName, {\n        kind: SpanKind.CLIENT,\n        attributes: {\n          [ATTR_DB_SYSTEM_NAME]: 'opensearch',\n          ...(operation && { [ATTR_DB_OPERATION_NAME]: operation }),\n          ...(index && { 'db.opensearch.index': index }),\n          ...(params.body &&\n            self.osConfig?.dbStatementSerializer !== false && {\n              [ATTR_DB_QUERY_TEXT]:\n                typeof self.osConfig?.dbStatementSerializer === 'function'\n                  ? self.osConfig.dbStatementSerializer(params)\n                  : typeof params.body === 'string'\n                    ? params.body\n                    : JSON.stringify(params.body),\n            }),\n        },\n      })\n      self.osConfig?.requestHook?.(span, params)\n\n      const endSpanOnSuccess = (res: ApiResponse) => {\n        const { hostname, port } = res.meta.connection.url\n        span.setAttribute(ATTR_SERVER_ADDRESS, hostname)\n        if (port) span.setAttribute(ATTR_SERVER_PORT, Number(port))\n        if (self.osConfig?.moduleVersionAttributeName) {\n          span.setAttribute(\n            self.osConfig.moduleVersionAttributeName,\n            OPENSEARCH_CLIENT_VERSION\n          )\n        }\n        self.osConfig?.responseHook?.(span, res)\n        span.end()\n      }\n      const endSpanOnError = (err: unknown) => {\n        if (err instanceof Error) span.recordException(err)\n        span.setStatus({ code: SpanStatusCode.ERROR })\n        span.end()\n      }\n\n      const callCtx = self.osConfig?.suppressInternalInstrumentation\n        ? suppressTracing(context.active())\n        : trace.setSpan(context.active(), span)\n\n      if (typeof callback === 'function') {\n        return context.with(callCtx, () =>\n          (\n            original as (\n              this: Transport,\n              params: TransportRequestParams,\n              options: TransportRequestOptions | undefined,\n              callback: (err: ApiError, result: ApiResponse) => void\n            ) => TransportRequestCallback\n          ).call(this, params, options, (err, res) => {\n            if (err) endSpanOnError(err)\n            else endSpanOnSuccess(res)\n            callback(err, res)\n          })\n        )\n      }\n\n      const result = context.with(callCtx, () =>\n        original.call(this, params, options)\n      )\n      const settled = result.then(\n        (res: ApiResponse) => {\n          endSpanOnSuccess(res)\n          return res\n        },\n        (err: unknown) => {\n          endSpanOnError(err)\n          throw err\n        }\n      )\n      return Object.assign(settled, { abort: result.abort })\n    }\n\n    Transport.prototype.request = patchedRequest\n  }\n\n  /** Restores the original `Transport.prototype.request`. */\n  override disable() {\n    if (this._original) {\n      Transport.prototype.request = this._original\n      this._original = undefined\n    }\n  }\n}\n"],"mappings":";;;;;;;;ACgCA,MAAM;AACN,MAAM,4BAAoC,cAAc;;;;;;AAOxD,SAAS,UAAU,MAAsD;CACvE,MAAM,QAAQ,KAAK,MAAM,iCAAiC;AAC1D,KAAI,CAAC,MAAO,QAAO,EAAE;AACrB,QAAO;EAAE,OAAO,MAAM;EAAI,WAAW,MAAM;EAAI;;;;;;;;;AA+CjD,IAAa,4BAAb,cAA+C,oBAAoB;CACjE;CAGA,YAAY,SAA0C,EAAE,EAAE;AACxD,QACE,sDACA,iBACA,OACD;AACD,OAAK,WAAW;;CAGlB,OAAiB;;CAGjB,SAAkB;AAChB,MAAI,KAAK,UAAW;EACpB,MAAM,OAAO;EACb,MAAM,WAIsC,UAAU,UAAU;AAChE,OAAK,YAAY;EAWjB,SAAS,eAEP,QACA,SACA,UACiE;GACjE,MAAM,EAAE,OAAO,cAAc,UAAU,OAAO,KAAK;GACnD,MAAM,WACJ,CAAC,WAAW,MAAM,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,IAAI,OAAO;GACzD,MAAM,OAAO,KAAK,OAAO,UAAU,UAAU;IAC3C,MAAM,SAAS;IACf,YAAY;MACT,sBAAsB;KACvB,GAAI,aAAa,GAAG,yBAAyB,WAAW;KACxD,GAAI,SAAS,EAAE,uBAAuB,OAAO;KAC7C,GAAI,OAAO,QACT,KAAK,UAAU,0BAA0B,SAAS,GAC/C,qBACC,OAAO,KAAK,UAAU,0BAA0B,aAC5C,KAAK,SAAS,sBAAsB,OAAO,GAC3C,OAAO,OAAO,SAAS,WACrB,OAAO,OACP,KAAK,UAAU,OAAO,KAAK,EACpC;KACJ;IACF,CAAC;AACF,QAAK,UAAU,cAAc,MAAM,OAAO;GAE1C,MAAM,oBAAoB,QAAqB;IAC7C,MAAM,EAAE,UAAU,SAAS,IAAI,KAAK,WAAW;AAC/C,SAAK,aAAa,qBAAqB,SAAS;AAChD,QAAI,KAAM,MAAK,aAAa,kBAAkB,OAAO,KAAK,CAAC;AAC3D,QAAI,KAAK,UAAU,2BACjB,MAAK,aACH,KAAK,SAAS,4BACd,0BACD;AAEH,SAAK,UAAU,eAAe,MAAM,IAAI;AACxC,SAAK,KAAK;;GAEZ,MAAM,kBAAkB,QAAiB;AACvC,QAAI,eAAe,MAAO,MAAK,gBAAgB,IAAI;AACnD,SAAK,UAAU,EAAE,MAAM,eAAe,OAAO,CAAC;AAC9C,SAAK,KAAK;;GAGZ,MAAM,UAAU,KAAK,UAAU,kCAC3B,gBAAgB,QAAQ,QAAQ,CAAC,GACjC,MAAM,QAAQ,QAAQ,QAAQ,EAAE,KAAK;AAEzC,OAAI,OAAO,aAAa,WACtB,QAAO,QAAQ,KAAK,eAEhB,SAMA,KAAK,MAAM,QAAQ,UAAU,KAAK,QAAQ;AAC1C,QAAI,IAAK,gBAAe,IAAI;QACvB,kBAAiB,IAAI;AAC1B,aAAS,KAAK,IAAI;KAClB,CACH;GAGH,MAAM,SAAS,QAAQ,KAAK,eAC1B,SAAS,KAAK,MAAM,QAAQ,QAAQ,CACrC;GACD,MAAM,UAAU,OAAO,MACpB,QAAqB;AACpB,qBAAiB,IAAI;AACrB,WAAO;OAER,QAAiB;AAChB,mBAAe,IAAI;AACnB,UAAM;KAET;AACD,UAAO,OAAO,OAAO,SAAS,EAAE,OAAO,OAAO,OAAO,CAAC;;AAGxD,YAAU,UAAU,UAAU;;;CAIhC,UAAmB;AACjB,MAAI,KAAK,WAAW;AAClB,aAAU,UAAU,UAAU,KAAK;AACnC,QAAK,YAAY,KAAA"}
+{"version":3,"file":"index.mjs","names":["pkg.name","pkg.version"],"sources":["../package.json","../src/parse-path.ts","../src/response-attributes.ts","../src/serialize-body.ts","../src/patch-request.ts","../src/index.ts"],"sourcesContent":["","export const parsePath = (\n  path: string\n): { index?: string; operation?: string } => {\n  const match = path.match(/^\\/(?:([^/_][^/]*)\\/)?_([^/]+)/)\n  if (!match) return {}\n  return { index: match[1], operation: match[2] }\n}\n","import type { Types } from '@opensearch-project/opensearch'\nimport type { ApiResponse } from '@opensearch-project/opensearch/lib/Transport.js'\nimport {\n  ATTR_SERVER_ADDRESS,\n  ATTR_SERVER_PORT,\n} from '@opentelemetry/semantic-conventions'\n\nexport const ATTR_DB_OPENSEARCH_DURATION_MS = 'db.opensearch.duration_ms'\n\nexport const extractResponseAttributes = (\n  res: ApiResponse\n): Record<string, string | number | boolean> => {\n  const attrs: Record<string, string | number | boolean> = {}\n\n  const { hostname, port } = res.meta.connection.url\n  attrs[ATTR_SERVER_ADDRESS] = hostname\n  if (port) attrs[ATTR_SERVER_PORT] = Number(port)\n  if (res.statusCode != null)\n    attrs['http.response.status_code'] = res.statusCode\n\n  const body = res.body as Types.Core_Search.ResponseBody | null | undefined\n  if (body == null) return attrs\n\n  if (body.took != null) attrs['db.opensearch.took'] = body.took\n  if (body.timed_out != null) attrs['db.opensearch.timed_out'] = body.timed_out\n  if (body.terminated_early != null)\n    attrs['db.opensearch.terminated_early'] = body.terminated_early\n\n  const shards = body._shards\n  if (shards != null) {\n    attrs['db.opensearch.shards.total'] = shards.total\n    attrs['db.opensearch.shards.successful'] = shards.successful\n    attrs['db.opensearch.shards.failed'] = shards.failed\n    if (shards.skipped != null)\n      attrs['db.opensearch.shards.skipped'] = shards.skipped\n  }\n\n  const phaseTook = body.phase_took\n  if (phaseTook != null) {\n    attrs['db.opensearch.phase_took.can_match'] = phaseTook.can_match\n    attrs['db.opensearch.phase_took.dfs_pre_query'] = phaseTook.dfs_pre_query\n    attrs['db.opensearch.phase_took.dfs_query'] = phaseTook.dfs_query\n    attrs['db.opensearch.phase_took.expand'] = phaseTook.expand\n    attrs['db.opensearch.phase_took.fetch'] = phaseTook.fetch\n    attrs['db.opensearch.phase_took.query'] = phaseTook.query\n  }\n\n  const total = body.hits?.total\n  if (total != null && typeof total === 'object') {\n    attrs['db.opensearch.hits.total'] = total.value\n  }\n\n  return attrs\n}\n","import type { TransportRequestParams } from '@opensearch-project/opensearch/lib/Transport.js'\nimport type { OpenSearchInstrumentationConfig } from './types'\n\nexport const serializeBody = (\n  params: TransportRequestParams,\n  config: Pick<OpenSearchInstrumentationConfig, 'dbStatementSerializer'>\n): string | undefined => {\n  if (!params.body) return undefined\n  if (config.dbStatementSerializer === false) return undefined\n  if (typeof config.dbStatementSerializer === 'function') {\n    return config.dbStatementSerializer(params)\n  }\n  return typeof params.body === 'string'\n    ? params.body\n    : JSON.stringify(params.body)\n}\n","import type Transport from '@opensearch-project/opensearch/lib/Transport.js'\nimport type {\n  ApiError,\n  ApiResponse,\n  TransportRequestCallback,\n  TransportRequestOptions,\n  TransportRequestParams,\n  TransportRequestPromise,\n} from '@opensearch-project/opensearch/lib/Transport.js'\nimport {\n  context,\n  SpanKind,\n  SpanStatusCode,\n  type Tracer,\n  trace,\n} from '@opentelemetry/api'\nimport { suppressTracing } from '@opentelemetry/core'\nimport {\n  ATTR_DB_OPERATION_NAME,\n  ATTR_DB_QUERY_TEXT,\n  ATTR_DB_SYSTEM_NAME,\n} from '@opentelemetry/semantic-conventions'\nimport { parsePath } from './parse-path'\nimport {\n  ATTR_DB_OPENSEARCH_DURATION_MS,\n  extractResponseAttributes,\n} from './response-attributes'\nimport { serializeBody } from './serialize-body'\nimport type { OpenSearchInstrumentationConfig } from './types'\n\nexport type OriginalRequest = (\n  this: Transport,\n  params: TransportRequestParams,\n  options?: TransportRequestOptions\n) => TransportRequestPromise<ApiResponse>\n\ntype OriginalRequestWithCallback = (\n  this: Transport,\n  params: TransportRequestParams,\n  options: TransportRequestOptions | undefined,\n  callback: (err: ApiError, result: ApiResponse) => void\n) => TransportRequestCallback\n\nexport const createPatchedRequest = (\n  getTracer: () => Tracer,\n  config: OpenSearchInstrumentationConfig = {},\n  original: OriginalRequest,\n  clientVersion: string\n) => {\n  function patchedRequest(\n    params: TransportRequestParams,\n    options?: TransportRequestOptions\n  ): TransportRequestPromise<ApiResponse>\n  function patchedRequest(\n    params: TransportRequestParams,\n    options: TransportRequestOptions | undefined,\n    callback: (err: ApiError, result: ApiResponse) => void\n  ): TransportRequestCallback\n  function patchedRequest(\n    this: Transport,\n    params: TransportRequestParams,\n    options?: TransportRequestOptions,\n    callback?: (err: ApiError, result: ApiResponse) => void\n  ): TransportRequestPromise<ApiResponse> | TransportRequestCallback {\n    const { index, operation } = parsePath(params.path)\n    const queryText = serializeBody(params, config)\n\n    const span = getTracer().startSpan(\n      [operation, index].filter(Boolean).join(' ') || params.path,\n      {\n        kind: SpanKind.CLIENT,\n        attributes: {\n          [ATTR_DB_SYSTEM_NAME]: 'opensearch',\n          ...(operation && { [ATTR_DB_OPERATION_NAME]: operation }),\n          ...(index && { 'db.opensearch.index': index }),\n          ...(queryText && { [ATTR_DB_QUERY_TEXT]: queryText }),\n        },\n      }\n    )\n    config.requestHook?.(span, params)\n\n    const startTime = Date.now()\n\n    const onSuccess = (res: ApiResponse) => {\n      span.setAttribute(ATTR_DB_OPENSEARCH_DURATION_MS, Date.now() - startTime)\n      for (const [key, value] of Object.entries(\n        extractResponseAttributes(res)\n      )) {\n        span.setAttribute(key, value)\n      }\n      if (config.moduleVersionAttributeName) {\n        span.setAttribute(config.moduleVersionAttributeName, clientVersion)\n      }\n      config.responseHook?.(span, res)\n      span.end()\n    }\n\n    const onError = (err: unknown) => {\n      span.setAttribute(ATTR_DB_OPENSEARCH_DURATION_MS, Date.now() - startTime)\n      if (err instanceof Error) span.recordException(err)\n      span.setStatus({ code: SpanStatusCode.ERROR })\n      span.end()\n    }\n\n    const callCtx = config.suppressInternalInstrumentation\n      ? suppressTracing(context.active())\n      : trace.setSpan(context.active(), span)\n\n    if (typeof callback === 'function') {\n      const originalWithCallback = (\n        original as OriginalRequestWithCallback\n      ).bind(this)\n      return context.with(callCtx, () =>\n        originalWithCallback(params, options, (err, res) => {\n          err ? onError(err) : onSuccess(res)\n          callback(err, res)\n        })\n      )\n    }\n\n    const result = context.with(callCtx, () =>\n      original.call(this, params, options)\n    )\n    const settled = result.then(\n      (res: ApiResponse) => {\n        onSuccess(res)\n        return res\n      },\n      (err: unknown) => {\n        onError(err)\n        throw err\n      }\n    )\n    return Object.assign(settled, { abort: result.abort })\n  }\n\n  return patchedRequest\n}\n","import Transport from '@opensearch-project/opensearch/lib/Transport.js'\nimport opensearchPkg from '@opensearch-project/opensearch/package.json' with {\n  type: 'json',\n}\nimport { InstrumentationBase } from '@opentelemetry/instrumentation'\nimport pkg from '../package.json' with { type: 'json' }\nimport { createPatchedRequest, type OriginalRequest } from './patch-request'\nimport type { OpenSearchInstrumentationConfig } from './types'\n\nexport type { OpenSearchInstrumentationConfig } from './types'\n\nconst PACKAGE_NAME: string = pkg.name\nconst PACKAGE_VERSION: string = pkg.version\nconst OPENSEARCH_CLIENT_VERSION: string = opensearchPkg.version\n\nexport class OpenSearchInstrumentation extends InstrumentationBase {\n  private readonly osConfig: OpenSearchInstrumentationConfig\n  private _original: OriginalRequest | undefined\n\n  constructor(config: OpenSearchInstrumentationConfig = {}) {\n    super(PACKAGE_NAME, PACKAGE_VERSION, { ...config, enabled: false })\n    this.osConfig = config\n    if (config.enabled !== false) {\n      this.enable()\n    }\n  }\n\n  protected init() {}\n\n  override enable() {\n    if (this._original) return\n    this._original = Transport.prototype.request as OriginalRequest\n    Transport.prototype.request = createPatchedRequest(\n      () => this.tracer,\n      this.osConfig,\n      this._original,\n      OPENSEARCH_CLIENT_VERSION\n    )\n  }\n\n  override disable() {\n    if (this._original) {\n      Transport.prototype.request = this._original\n      this._original = undefined\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;ACAA,MAAa,aACX,SAC2C;CAC3C,MAAM,QAAQ,KAAK,MAAM,iCAAiC;AAC1D,KAAI,CAAC,MAAO,QAAO,EAAE;AACrB,QAAO;EAAE,OAAO,MAAM;EAAI,WAAW,MAAM;EAAI;;;;ACEjD,MAAa,iCAAiC;AAE9C,MAAa,6BACX,QAC8C;CAC9C,MAAM,QAAmD,EAAE;CAE3D,MAAM,EAAE,UAAU,SAAS,IAAI,KAAK,WAAW;AAC/C,OAAM,uBAAuB;AAC7B,KAAI,KAAM,OAAM,oBAAoB,OAAO,KAAK;AAChD,KAAI,IAAI,cAAc,KACpB,OAAM,+BAA+B,IAAI;CAE3C,MAAM,OAAO,IAAI;AACjB,KAAI,QAAQ,KAAM,QAAO;AAEzB,KAAI,KAAK,QAAQ,KAAM,OAAM,wBAAwB,KAAK;AAC1D,KAAI,KAAK,aAAa,KAAM,OAAM,6BAA6B,KAAK;AACpE,KAAI,KAAK,oBAAoB,KAC3B,OAAM,oCAAoC,KAAK;CAEjD,MAAM,SAAS,KAAK;AACpB,KAAI,UAAU,MAAM;AAClB,QAAM,gCAAgC,OAAO;AAC7C,QAAM,qCAAqC,OAAO;AAClD,QAAM,iCAAiC,OAAO;AAC9C,MAAI,OAAO,WAAW,KACpB,OAAM,kCAAkC,OAAO;;CAGnD,MAAM,YAAY,KAAK;AACvB,KAAI,aAAa,MAAM;AACrB,QAAM,wCAAwC,UAAU;AACxD,QAAM,4CAA4C,UAAU;AAC5D,QAAM,wCAAwC,UAAU;AACxD,QAAM,qCAAqC,UAAU;AACrD,QAAM,oCAAoC,UAAU;AACpD,QAAM,oCAAoC,UAAU;;CAGtD,MAAM,QAAQ,KAAK,MAAM;AACzB,KAAI,SAAS,QAAQ,OAAO,UAAU,SACpC,OAAM,8BAA8B,MAAM;AAG5C,QAAO;;;;ACjDT,MAAa,iBACX,QACA,WACuB;AACvB,KAAI,CAAC,OAAO,KAAM,QAAO,KAAA;AACzB,KAAI,OAAO,0BAA0B,MAAO,QAAO,KAAA;AACnD,KAAI,OAAO,OAAO,0BAA0B,WAC1C,QAAO,OAAO,sBAAsB,OAAO;AAE7C,QAAO,OAAO,OAAO,SAAS,WAC1B,OAAO,OACP,KAAK,UAAU,OAAO,KAAK;;;;AC6BjC,MAAa,wBACX,WACA,SAA0C,EAAE,EAC5C,UACA,kBACG;CAUH,SAAS,eAEP,QACA,SACA,UACiE;EACjE,MAAM,EAAE,OAAO,cAAc,UAAU,OAAO,KAAK;EACnD,MAAM,YAAY,cAAc,QAAQ,OAAO;EAE/C,MAAM,OAAO,WAAW,CAAC,UACvB,CAAC,WAAW,MAAM,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,IAAI,OAAO,MACvD;GACE,MAAM,SAAS;GACf,YAAY;KACT,sBAAsB;IACvB,GAAI,aAAa,GAAG,yBAAyB,WAAW;IACxD,GAAI,SAAS,EAAE,uBAAuB,OAAO;IAC7C,GAAI,aAAa,GAAG,qBAAqB,WAAW;IACrD;GACF,CACF;AACD,SAAO,cAAc,MAAM,OAAO;EAElC,MAAM,YAAY,KAAK,KAAK;EAE5B,MAAM,aAAa,QAAqB;AACtC,QAAK,aAAa,gCAAgC,KAAK,KAAK,GAAG,UAAU;AACzE,QAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAChC,0BAA0B,IAAI,CAC/B,CACC,MAAK,aAAa,KAAK,MAAM;AAE/B,OAAI,OAAO,2BACT,MAAK,aAAa,OAAO,4BAA4B,cAAc;AAErE,UAAO,eAAe,MAAM,IAAI;AAChC,QAAK,KAAK;;EAGZ,MAAM,WAAW,QAAiB;AAChC,QAAK,aAAa,gCAAgC,KAAK,KAAK,GAAG,UAAU;AACzE,OAAI,eAAe,MAAO,MAAK,gBAAgB,IAAI;AACnD,QAAK,UAAU,EAAE,MAAM,eAAe,OAAO,CAAC;AAC9C,QAAK,KAAK;;EAGZ,MAAM,UAAU,OAAO,kCACnB,gBAAgB,QAAQ,QAAQ,CAAC,GACjC,MAAM,QAAQ,QAAQ,QAAQ,EAAE,KAAK;AAEzC,MAAI,OAAO,aAAa,YAAY;GAClC,MAAM,uBACJ,SACA,KAAK,KAAK;AACZ,UAAO,QAAQ,KAAK,eAClB,qBAAqB,QAAQ,UAAU,KAAK,QAAQ;AAClD,UAAM,QAAQ,IAAI,GAAG,UAAU,IAAI;AACnC,aAAS,KAAK,IAAI;KAClB,CACH;;EAGH,MAAM,SAAS,QAAQ,KAAK,eAC1B,SAAS,KAAK,MAAM,QAAQ,QAAQ,CACrC;EACD,MAAM,UAAU,OAAO,MACpB,QAAqB;AACpB,aAAU,IAAI;AACd,UAAO;MAER,QAAiB;AAChB,WAAQ,IAAI;AACZ,SAAM;IAET;AACD,SAAO,OAAO,OAAO,SAAS,EAAE,OAAO,OAAO,OAAO,CAAC;;AAGxD,QAAO;;;;AC7HT,MAAM,eAAuBA;AAC7B,MAAM,kBAA0BC;AAChC,MAAM,4BAAoC,cAAc;AAExD,IAAa,4BAAb,cAA+C,oBAAoB;CACjE;CACA;CAEA,YAAY,SAA0C,EAAE,EAAE;AACxD,QAAM,cAAc,iBAAiB;GAAE,GAAG;GAAQ,SAAS;GAAO,CAAC;AACnE,OAAK,WAAW;AAChB,MAAI,OAAO,YAAY,MACrB,MAAK,QAAQ;;CAIjB,OAAiB;CAEjB,SAAkB;AAChB,MAAI,KAAK,UAAW;AACpB,OAAK,YAAY,UAAU,UAAU;AACrC,YAAU,UAAU,UAAU,2BACtB,KAAK,QACX,KAAK,UACL,KAAK,WACL,0BACD;;CAGH,UAAmB;AACjB,MAAI,KAAK,WAAW;AAClB,aAAU,UAAU,UAAU,KAAK;AACnC,QAAK,YAAY,KAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/opentelemetry-instrumentation-opensearch",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.mjs",
@@ -34,6 +34,8 @@
   "devDependencies": {
     "@opensearch-project/opensearch": "3.5.1",
     "@opentelemetry/api": "1.9.0",
+    "@opentelemetry/instrumentation-http": "0.213.0",
+    "@opentelemetry/instrumentation-undici": "0.23.0",
     "@opentelemetry/sdk-trace-base": "2.6.0",
     "@opentelemetry/sdk-trace-node": "2.6.0",
     "@testcontainers/opensearch": "11.13.0"