@sebspark/opentelemetry-instrumentation-opensearch 0.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2026] [SEB]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,90 @@
+# `@sebspark/opentelemetry-instrumentation-opensearch`
+
+OTEL auto instrumentation for OpenSearch
+
+Patches `@opensearch-project/opensearch`'s `Transport` to create `db` CLIENT spans for every request. By default the db span is set as the active context so HTTP child spans are properly parented and W3C trace headers are propagated outbound.
+
+## Use
+
+```ts
+import { OpenSearchInstrumentation } from '@sebspark/opentelemetry-instrumentation-opensearch'
+import { registerInstrumentations } from '@opentelemetry/instrumentation'
+
+registerInstrumentations({
+  instrumentations: [new OpenSearchInstrumentation()],
+})
+```
+
+### Disabling query capture
+
+By default the request body is captured as `db.query.text`. Disable it if queries contain sensitive data:
+
+```ts
+new OpenSearchInstrumentation({ dbStatementSerializer: false })
+```
+
+Or provide a custom serializer to redact specific fields:
+
+```ts
+new OpenSearchInstrumentation({
+  dbStatementSerializer: (params) => {
+    const body = params.body as Record<string, unknown>
+    return JSON.stringify({ ...body, password: '[redacted]' })
+  },
+})
+```
+
+### Adding custom attributes before the request
+
+Use `requestHook` to attach attributes to each span before the request is sent:
+
+```ts
+new OpenSearchInstrumentation({
+  requestHook: (span, params) => {
+    span.setAttribute('app.opensearch.method', params.method)
+  },
+})
+```
+
+### Adding custom attributes from the response
+
+Use `responseHook` to attach attributes derived from the response (only called on success):
+
+```ts
+new OpenSearchInstrumentation({
+  responseHook: (span, response) => {
+    span.setAttribute('app.opensearch.hits', response.body?.hits?.total?.value ?? 0)
+  },
+})
+```
+
+### Recording the client library version
+
+Set `moduleVersionAttributeName` to record which version of `@opensearch-project/opensearch` made the request:
+
+```ts
+new OpenSearchInstrumentation({
+  moduleVersionAttributeName: 'db.opensearch.client.version',
+})
+```
+
+### Suppressing HTTP child spans
+
+By default the db span is set as the active context, so an HTTP instrumentation layer (if registered) will create a child span under it. To suppress all child spans instead:
+
+```ts
+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.

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { ApiResponse, TransportRequestParams } from "@opensearch-project/opensearch/lib/Transport.js";
+import { Span } from "@opentelemetry/api";
+import { InstrumentationBase, InstrumentationConfig } from "@opentelemetry/instrumentation";
+
+//#region src/index.d.ts
+/** Configuration for {@link OpenSearchInstrumentation}. */
+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.
+ */
+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 };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +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"}

package/dist/index.mjs

@@ -0,0 +1,99 @@
+import Transport from "@opensearch-project/opensearch/lib/Transport.js";
+import opensearchPkg from "@opensearch-project/opensearch/package.json" with { type: "json" };
+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";
+//#endregion
+//#region src/index.ts
+const PACKAGE_VERSION = "0.0.0";
+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) {
+	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.
+*/
+var OpenSearchInstrumentation = class extends InstrumentationBase {
+	osConfig;
+	constructor(config = {}) {
+		super("@sebspark/opentelemetry-instrumentation-opensearch", PACKAGE_VERSION, config);
+		this.osConfig = config;
+	}
+	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;
+	}
+	/** Restores the original `Transport.prototype.request`. */
+	disable() {
+		if (this._original) {
+			Transport.prototype.request = this._original;
+			this._original = void 0;
+		}
+	}
+};
+//#endregion
+export { OpenSearchInstrumentation };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@sebspark/opentelemetry-instrumentation-opensearch",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "spark-build src/index.ts",
+    "dev": "tsc --watch --noEmit",
+    "lint": "biome check .",
+    "test": "vitest run --passWithNoTests --coverage",
+    "test:e2e": "vitest --config vitest.config.e2e.ts --run",
+    "typecheck": "vitest --typecheck.only --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@opensearch-project/opensearch": ">=2",
+    "@opentelemetry/api": ">=1.9.0"
+  },
+  "dependencies": {
+    "@opentelemetry/core": "2.6.0",
+    "@opentelemetry/instrumentation": "0.213.0",
+    "@opentelemetry/semantic-conventions": "1.40.0"
+  },
+  "devDependencies": {
+    "@opensearch-project/opensearch": "3.5.1",
+    "@opentelemetry/api": "1.9.0",
+    "@opentelemetry/sdk-trace-base": "2.6.0",
+    "@opentelemetry/sdk-trace-node": "2.6.0",
+    "@testcontainers/opensearch": "11.13.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/seb-oss/Spark-packages.git"
+  }
+}