@tracemole/nextjs-mongodb-explain 1.0.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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
+      translation or transformation 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 distributed 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

package/README.md

@@ -0,0 +1,60 @@
+# @tracemole/nextjs-mongodb-explain
+
+Attach `executionStats` from MongoDB explain queries to your active OpenTelemetry spans. This allows APM dashboards (such as TraceMole) to render database execution plans, highlighting index usage, document scan ratios, and collection scan warnings in query waterfalls.
+
+## Installation
+
+```sh
+npm install @tracemole/nextjs-mongodb-explain
+```
+
+Make sure you also have `@opentelemetry/api` and `mongodb` installed in your project.
+
+## Usage
+
+### 1. Wrap query executions with `withMongoExplain`
+
+The easiest way to measure query efficiency is to wrap your database commands with `withMongoExplain`:
+
+```ts
+import { withMongoExplain } from "@tracemole/nextjs-mongodb-explain";
+
+const users = await withMongoExplain({
+  // Run your actual query instrumented by OTel
+  run: () => db.collection("users").find({ status: "active" }).limit(10).toArray(),
+
+  // Run the same query filter with .explain("executionStats")
+  explain: () =>
+    db.collection("users").find({ status: "active" }).limit(10).explain("executionStats"),
+
+  // Optional label shown in the APM trace
+  label: "find active users",
+});
+```
+
+### 2. Manual Attachment
+
+If you already have an explain result block, you can attach it manually to the active span:
+
+```ts
+import {
+  attachExplainToActiveSpan,
+  parseExplainStats,
+} from "@tracemole/nextjs-mongodb-explain";
+
+const explainResult = await collection.find(filter).explain("executionStats");
+const stats = parseExplainStats(explainResult);
+
+// Attaches database explain attributes to the current span
+await attachExplainToActiveSpan(stats);
+```
+
+## Features
+
+- **Zero overhead in production**: Set `TRACE_MOLE_MONGO_EXPLAIN=0` to skip the explain queries entirely in production environments.
+- **Automatic Parsing**: Formats verbose MongoDB execution plan trees into standardized `db.mongodb.explain.*` OpenTelemetry span attributes.
+- **Supports pipelines**: Works with both `find` operations and `aggregate` stages.
+
+## License
+
+[Apache-2.0](LICENSE)

package/dist/chunk-P6U6LTVD.js

@@ -0,0 +1,62 @@
+// src/attributes.ts
+var MONGO_EXPLAIN_PREFIX = "db.mongodb.explain";
+var MONGO_EXPLAIN_ATTR = {
+  operation: `${MONGO_EXPLAIN_PREFIX}.operation`,
+  collection: `${MONGO_EXPLAIN_PREFIX}.collection`,
+  docsExamined: `${MONGO_EXPLAIN_PREFIX}.docs_examined`,
+  docsReturned: `${MONGO_EXPLAIN_PREFIX}.docs_returned`,
+  keysExamined: `${MONGO_EXPLAIN_PREFIX}.keys_examined`,
+  executionTimeMs: `${MONGO_EXPLAIN_PREFIX}.execution_time_ms`,
+  indexUsed: `${MONGO_EXPLAIN_PREFIX}.index_used`,
+  indexName: `${MONGO_EXPLAIN_PREFIX}.index_name`,
+  stage: `${MONGO_EXPLAIN_PREFIX}.stage`
+};
+function explainAttributes(stats) {
+  const attrs = {
+    [MONGO_EXPLAIN_ATTR.operation]: stats.operation,
+    [MONGO_EXPLAIN_ATTR.docsExamined]: stats.docsExamined,
+    [MONGO_EXPLAIN_ATTR.docsReturned]: stats.docsReturned,
+    [MONGO_EXPLAIN_ATTR.keysExamined]: stats.keysExamined,
+    [MONGO_EXPLAIN_ATTR.executionTimeMs]: stats.executionTimeMs,
+    [MONGO_EXPLAIN_ATTR.indexUsed]: stats.indexUsed,
+    [MONGO_EXPLAIN_ATTR.stage]: stats.stage
+  };
+  if (stats.collection) attrs[MONGO_EXPLAIN_ATTR.collection] = stats.collection;
+  if (stats.indexName) attrs[MONGO_EXPLAIN_ATTR.indexName] = stats.indexName;
+  return attrs;
+}
+function readExplainFromAttributes(attributes) {
+  const operation = attributes[MONGO_EXPLAIN_ATTR.operation];
+  if (typeof operation !== "string" || !operation) return null;
+  const docsExamined = attributes[MONGO_EXPLAIN_ATTR.docsExamined];
+  const docsReturned = attributes[MONGO_EXPLAIN_ATTR.docsReturned];
+  const keysExamined = attributes[MONGO_EXPLAIN_ATTR.keysExamined];
+  const executionTimeMs = attributes[MONGO_EXPLAIN_ATTR.executionTimeMs];
+  const indexUsed = attributes[MONGO_EXPLAIN_ATTR.indexUsed];
+  const stage = attributes[MONGO_EXPLAIN_ATTR.stage];
+  const collection = attributes[MONGO_EXPLAIN_ATTR.collection];
+  const indexName = attributes[MONGO_EXPLAIN_ATTR.indexName];
+  return {
+    operation,
+    collection: typeof collection === "string" ? collection : void 0,
+    docsExamined: typeof docsExamined === "number" ? docsExamined : Number(docsExamined ?? 0),
+    docsReturned: typeof docsReturned === "number" ? docsReturned : Number(docsReturned ?? 0),
+    keysExamined: typeof keysExamined === "number" ? keysExamined : Number(keysExamined ?? 0),
+    executionTimeMs: typeof executionTimeMs === "number" ? executionTimeMs : Number(executionTimeMs ?? 0),
+    indexUsed: indexUsed === true || indexUsed === "true",
+    indexName: typeof indexName === "string" ? indexName : void 0,
+    stage: typeof stage === "string" ? stage : "unknown",
+    scanType: indexUsed === true || indexUsed === "true" ? "index" : stage === "COLLSCAN" ? "collection" : "other"
+  };
+}
+function hasMongoExplainAttributes(attributes) {
+  return MONGO_EXPLAIN_ATTR.operation in attributes;
+}
+
+export {
+  MONGO_EXPLAIN_PREFIX,
+  MONGO_EXPLAIN_ATTR,
+  explainAttributes,
+  readExplainFromAttributes,
+  hasMongoExplainAttributes
+};

package/dist/client.d.ts

@@ -0,0 +1,38 @@
+type MongoExplainStats = {
+    /** MongoDB command type: find, aggregate, count, etc. */
+    operation: string;
+    collection?: string;
+    /** Documents examined (scanned) during execution. */
+    docsExamined: number;
+    /** Documents returned to the client. */
+    docsReturned: number;
+    /** Index keys examined (0 when no index used). */
+    keysExamined: number;
+    executionTimeMs: number;
+    /** True when the winning plan used an index (IXSCAN). */
+    indexUsed: boolean;
+    indexName?: string;
+    /** Winning plan stage: IXSCAN, COLLSCAN, FETCH, etc. */
+    stage: string;
+    scanType: "index" | "collection" | "other";
+};
+
+/** OpenTelemetry span attribute prefix for MongoDB explain stats. */
+declare const MONGO_EXPLAIN_PREFIX = "db.mongodb.explain";
+declare const MONGO_EXPLAIN_ATTR: {
+    readonly operation: "db.mongodb.explain.operation";
+    readonly collection: "db.mongodb.explain.collection";
+    readonly docsExamined: "db.mongodb.explain.docs_examined";
+    readonly docsReturned: "db.mongodb.explain.docs_returned";
+    readonly keysExamined: "db.mongodb.explain.keys_examined";
+    readonly executionTimeMs: "db.mongodb.explain.execution_time_ms";
+    readonly indexUsed: "db.mongodb.explain.index_used";
+    readonly indexName: "db.mongodb.explain.index_name";
+    readonly stage: "db.mongodb.explain.stage";
+};
+type MongoExplainAttributeValue = string | number | boolean;
+declare function explainAttributes(stats: MongoExplainStats): Record<string, MongoExplainAttributeValue>;
+declare function readExplainFromAttributes(attributes: Record<string, string | number | boolean>): MongoExplainStats | null;
+declare function hasMongoExplainAttributes(attributes: Record<string, string | number | boolean>): boolean;
+
+export { MONGO_EXPLAIN_ATTR, MONGO_EXPLAIN_PREFIX, type MongoExplainAttributeValue, type MongoExplainStats, explainAttributes, hasMongoExplainAttributes, readExplainFromAttributes };

package/dist/client.js

@@ -0,0 +1,14 @@
+import {
+  MONGO_EXPLAIN_ATTR,
+  MONGO_EXPLAIN_PREFIX,
+  explainAttributes,
+  hasMongoExplainAttributes,
+  readExplainFromAttributes
+} from "./chunk-P6U6LTVD.js";
+export {
+  MONGO_EXPLAIN_ATTR,
+  MONGO_EXPLAIN_PREFIX,
+  explainAttributes,
+  hasMongoExplainAttributes,
+  readExplainFromAttributes
+};

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { MongoExplainStats } from './client.js';
+export { MONGO_EXPLAIN_ATTR, MONGO_EXPLAIN_PREFIX, MongoExplainAttributeValue, explainAttributes, hasMongoExplainAttributes, readExplainFromAttributes } from './client.js';
+import { Span } from '@opentelemetry/api';
+
+declare function attachExplainToSpan(span: Span, stats: MongoExplainStats): void;
+declare function attachExplainToActiveSpan(stats: MongoExplainStats): Promise<boolean>;
+
+/**
+ * Parse a MongoDB explain result (`verbosity: "executionStats"`) into summary stats.
+ * Supports find, aggregate (`stages` + `$cursor`), and profiler-style shapes.
+ */
+declare function parseExplainStats(explain: unknown): MongoExplainStats;
+
+type WithMongoExplainOptions<T> = {
+    /** Run the real query (already instrumented by OTel MongoDB driver). */
+    run: () => Promise<T>;
+    /** Run the same command with `.explain("executionStats")`. */
+    explain: () => Promise<unknown>;
+    /** Skip explain entirely (default: only when `TRACE_MOLE_MONGO_EXPLAIN=0`). */
+    enabled?: boolean;
+    /** Optional span label shown in the dashboard (e.g. "events aggregate"). */
+    label?: string;
+};
+/**
+ * Run a MongoDB operation and attach executionStats from a parallel explain call
+ * to a dedicated query span (one per `withMongoExplain` call).
+ *
+ * Explain runs after the query without creating a `mongodb.explain` driver span.
+ * Set `TRACE_MOLE_MONGO_EXPLAIN=0` to disable in production.
+ */
+declare function withMongoExplain<T>({ run, explain, enabled, label, }: WithMongoExplainOptions<T>): Promise<T>;
+
+export { MongoExplainStats, type WithMongoExplainOptions, attachExplainToActiveSpan, attachExplainToSpan, parseExplainStats, withMongoExplain };

package/dist/index.js

@@ -0,0 +1,324 @@
+import {
+  MONGO_EXPLAIN_ATTR,
+  MONGO_EXPLAIN_PREFIX,
+  explainAttributes,
+  hasMongoExplainAttributes,
+  readExplainFromAttributes
+} from "./chunk-P6U6LTVD.js";
+
+// src/attach.ts
+function attachExplainToSpan(span, stats) {
+  span.setAttributes(explainAttributes(stats));
+}
+async function attachExplainToActiveSpan(stats) {
+  try {
+    const { trace } = await import("@opentelemetry/api");
+    const span = trace.getActiveSpan();
+    if (!span) return false;
+    attachExplainToSpan(span, stats);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// src/parse.ts
+function asRecord(value) {
+  return value != null && typeof value === "object" && !Array.isArray(value) ? value : null;
+}
+function asNumber(value) {
+  if (typeof value === "number" && Number.isFinite(value)) return value;
+  if (typeof value === "string" && value.trim() !== "") {
+    const n = Number(value);
+    if (Number.isFinite(n)) return n;
+  }
+  return void 0;
+}
+function asStage(value) {
+  const record = asRecord(value);
+  if (!record) return null;
+  return {
+    stage: typeof record.stage === "string" ? record.stage : void 0,
+    indexName: typeof record.indexName === "string" ? record.indexName : void 0,
+    docsExamined: asNumber(record.docsExamined),
+    keysExamined: asNumber(record.keysExamined),
+    inputStage: asStage(record.inputStage) ?? void 0,
+    inputStages: Array.isArray(record.inputStages) ? record.inputStages.map((s) => asStage(s)).filter((s) => s != null) : void 0
+  };
+}
+function walkStages(stage) {
+  if (!stage) return [];
+  const nested = stage.inputStage ? walkStages(stage.inputStage) : (stage.inputStages ?? []).flatMap((s) => walkStages(s));
+  return [stage, ...nested];
+}
+function findIndexStage(stages) {
+  return stages.find((s) => s.stage === "IXSCAN");
+}
+function findCollScanStage(stages) {
+  return stages.find((s) => s.stage === "COLLSCAN");
+}
+function readIndexesUsed(value) {
+  if (!Array.isArray(value)) return [];
+  return value.filter((v) => typeof v === "string" && v.length > 0);
+}
+function mergeExecution(current, next) {
+  if (!current) return next;
+  return {
+    nReturned: Math.max(current.nReturned, next.nReturned),
+    executionTimeMs: current.executionTimeMs + next.executionTimeMs,
+    keysExamined: current.keysExamined + next.keysExamined,
+    docsExamined: current.docsExamined + next.docsExamined,
+    executionStages: current.executionStages ?? next.executionStages,
+    indexesUsed: [.../* @__PURE__ */ new Set([...current.indexesUsed, ...next.indexesUsed])],
+    planSummary: current.planSummary ?? next.planSummary
+  };
+}
+function fromExecutionStatsBlock(stats) {
+  const executionStages = asStage(stats.executionStages) ?? (typeof stats.stage === "string" ? asStage(stats) : null);
+  return {
+    nReturned: asNumber(stats.nReturned) ?? 0,
+    executionTimeMs: asNumber(stats.executionTimeMillis) ?? asNumber(stats.executionTimeMillisEstimate) ?? 0,
+    keysExamined: asNumber(stats.totalKeysExamined) ?? 0,
+    docsExamined: asNumber(stats.totalDocsExamined) ?? 0,
+    executionStages: executionStages ?? void 0,
+    indexesUsed: readIndexesUsed(stats.indexesUsed),
+    planSummary: typeof stats.planSummary === "string" ? stats.planSummary : void 0
+  };
+}
+function fromStageTree(stats) {
+  const stageTree = asStage(stats.executionStages ?? stats) ?? void 0;
+  const walked = walkStages(stageTree);
+  const indexStage = findIndexStage(walked);
+  const collScan = findCollScanStage(walked);
+  const docsFromStages = walked.reduce(
+    (sum, s) => sum + (s.docsExamined ?? 0),
+    0
+  );
+  const keysFromStages = walked.reduce(
+    (sum, s) => sum + (s.keysExamined ?? 0),
+    0
+  );
+  return {
+    nReturned: asNumber(stats.nReturned) ?? 0,
+    executionTimeMs: asNumber(stats.executionTimeMillis) ?? asNumber(stats.executionTimeMillisEstimate) ?? 0,
+    keysExamined: asNumber(stats.totalKeysExamined) ?? keysFromStages,
+    docsExamined: asNumber(stats.totalDocsExamined) ?? docsFromStages,
+    executionStages: stageTree,
+    indexesUsed: [
+      ...readIndexesUsed(stats.indexesUsed),
+      ...indexStage?.indexName ? [indexStage.indexName] : []
+    ],
+    planSummary: typeof stats.planSummary === "string" ? stats.planSummary : void 0
+  };
+}
+function collectFromPipelineStages(stages) {
+  let merged = null;
+  for (const stageEntry of stages) {
+    const entry = asRecord(stageEntry);
+    if (!entry) continue;
+    for (const [stageName, stageBody] of Object.entries(entry)) {
+      const body = asRecord(stageBody);
+      if (!body) continue;
+      const stats = asRecord(body.executionStats);
+      if (stats) {
+        const normalized = asNumber(stats.totalDocsExamined) != null || asNumber(stats.totalKeysExamined) != null ? fromExecutionStatsBlock(stats) : fromStageTree(stats);
+        merged = mergeExecution(merged, normalized);
+      } else if (asNumber(body.executionTimeMillisEstimate) != null) {
+        merged = mergeExecution(merged, {
+          nReturned: 0,
+          executionTimeMs: asNumber(body.executionTimeMillisEstimate) ?? 0,
+          keysExamined: 0,
+          docsExamined: 0,
+          indexesUsed: []
+        });
+      }
+      if (stageName === "$cursor") {
+        const planner = asRecord(body.queryPlanner);
+        const winning = asRecord(planner?.winningPlan);
+        if (winning && !merged?.executionStages) {
+          const stageTree = asStage(winning) ?? void 0;
+          merged = mergeExecution(merged, {
+            nReturned: 0,
+            executionTimeMs: 0,
+            keysExamined: 0,
+            docsExamined: 0,
+            executionStages: stageTree,
+            indexesUsed: []
+          });
+        }
+      }
+    }
+  }
+  return merged;
+}
+function normalizeExecution(explain) {
+  const topStats = asRecord(explain.executionStats);
+  if (topStats) {
+    const normalized = asNumber(topStats.totalDocsExamined) != null || asNumber(topStats.totalKeysExamined) != null || topStats.executionStages != null ? fromExecutionStatsBlock(topStats) : fromStageTree(topStats);
+    return normalized;
+  }
+  if (Array.isArray(explain.stages)) {
+    return collectFromPipelineStages(explain.stages);
+  }
+  if (asNumber(explain.docsExamined) != null) {
+    return {
+      nReturned: asNumber(explain.nreturned) ?? asNumber(explain.nReturned) ?? 0,
+      executionTimeMs: asNumber(explain.millis) ?? asNumber(explain.durationMillis) ?? 0,
+      keysExamined: asNumber(explain.keysExamined) ?? 0,
+      docsExamined: asNumber(explain.docsExamined) ?? 0,
+      indexesUsed: [],
+      planSummary: typeof explain.planSummary === "string" ? explain.planSummary : void 0
+    };
+  }
+  return null;
+}
+function commandOperation(command) {
+  const ops = [
+    "find",
+    "aggregate",
+    "count",
+    "distinct",
+    "delete",
+    "update",
+    "findAndModify"
+  ];
+  for (const op of ops) {
+    if (op in command) return op;
+  }
+  if (Array.isArray(command.pipeline)) return "aggregate";
+  return "unknown";
+}
+function commandCollection(command, operation) {
+  const direct = command[operation];
+  if (typeof direct === "string" && direct) return direct;
+  const collection = command.collection;
+  if (typeof collection === "string" && collection) return collection;
+  return void 0;
+}
+function inferOperation(explain) {
+  const command = asRecord(explain.command);
+  if (command) {
+    const op = commandOperation(command);
+    if (op !== "unknown") return op;
+  }
+  if (Array.isArray(explain.stages)) return "aggregate";
+  return "unknown";
+}
+function inferCollection(explain, operation) {
+  const command = asRecord(explain.command);
+  if (command) {
+    const name = commandCollection(command, operation);
+    if (name) return name;
+  }
+  const namespace = explain.namespace;
+  if (typeof namespace === "string" && namespace.includes(".")) {
+    return namespace.split(".").slice(1).join(".");
+  }
+  return void 0;
+}
+function indexUsedFrom(execution, walked) {
+  const indexStage = findIndexStage(walked);
+  const collScanStage = findCollScanStage(walked);
+  const indexName = indexStage?.indexName ?? execution.indexesUsed[0];
+  const indexUsed = indexStage != null || execution.indexesUsed.length > 0 || execution.planSummary?.includes("IXSCAN") === true;
+  const winningStage = indexStage ?? collScanStage ?? walked[0] ?? { stage: execution.planSummary?.split(",")[0] ?? "unknown" };
+  const stage = winningStage.stage ?? "unknown";
+  const scanType = indexUsed ? "index" : collScanStage || stage === "COLLSCAN" || execution.planSummary === "COLLSCAN" ? "collection" : "other";
+  return { indexUsed, indexName, stage, scanType };
+}
+function parseExplainStats(explain) {
+  const root = asRecord(explain);
+  if (!root) {
+    return emptyStats("unknown");
+  }
+  const execution = normalizeExecution(root);
+  const operation = inferOperation(root);
+  const collection = inferCollection(root, operation);
+  const walked = walkStages(execution?.executionStages);
+  const index = indexUsedFrom(execution ?? emptyExecution(), walked);
+  return {
+    operation,
+    collection,
+    docsExamined: execution?.docsExamined ?? 0,
+    docsReturned: execution?.nReturned ?? 0,
+    keysExamined: execution?.keysExamined ?? 0,
+    executionTimeMs: execution?.executionTimeMs ?? 0,
+    indexUsed: index.indexUsed,
+    indexName: index.indexName,
+    stage: index.stage,
+    scanType: index.scanType
+  };
+}
+function emptyExecution() {
+  return {
+    nReturned: 0,
+    executionTimeMs: 0,
+    keysExamined: 0,
+    docsExamined: 0,
+    indexesUsed: []
+  };
+}
+function emptyStats(operation) {
+  return {
+    operation,
+    docsExamined: 0,
+    docsReturned: 0,
+    keysExamined: 0,
+    executionTimeMs: 0,
+    indexUsed: false,
+    stage: "unknown",
+    scanType: "other"
+  };
+}
+
+// src/suppress-tracing.ts
+import { context, createContextKey } from "@opentelemetry/api";
+var SUPPRESS_TRACING_KEY = createContextKey("suppress_tracing");
+function suppressTracing(ctx) {
+  return ctx.setValue(SUPPRESS_TRACING_KEY, true);
+}
+function runWithoutTracing(fn) {
+  return context.with(suppressTracing(context.active()), fn);
+}
+
+// src/with-mongo-explain.ts
+function isExplainEnabled(explicit) {
+  if (explicit != null) return explicit;
+  return process.env.TRACE_MOLE_MONGO_EXPLAIN !== "0";
+}
+async function withMongoExplain({
+  run,
+  explain,
+  enabled,
+  label
+}) {
+  const { trace } = await import("@opentelemetry/api");
+  const tracer = trace.getTracer("tracemole.mongo");
+  return tracer.startActiveSpan(label ?? "mongodb.query", async (span) => {
+    try {
+      const result = await run();
+      if (isExplainEnabled(enabled)) {
+        try {
+          const explainResult = await runWithoutTracing(() => explain());
+          const stats = parseExplainStats(explainResult);
+          attachExplainToSpan(span, stats);
+        } catch {
+        }
+      }
+      return result;
+    } finally {
+      span.end();
+    }
+  });
+}
+export {
+  MONGO_EXPLAIN_ATTR,
+  MONGO_EXPLAIN_PREFIX,
+  attachExplainToActiveSpan,
+  attachExplainToSpan,
+  explainAttributes,
+  hasMongoExplainAttributes,
+  parseExplainStats,
+  readExplainFromAttributes,
+  withMongoExplain
+};

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@tracemole/nextjs-mongodb-explain",
+  "version": "1.0.0",
+  "description": "Attach MongoDB executionStats explain plans to OpenTelemetry spans for Next.js and Node apps",
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": ["dist", "LICENSE", "README.md"],
+  "keywords": [
+    "mongodb",
+    "explain",
+    "opentelemetry",
+    "nextjs",
+    "tracing",
+    "apm",
+    "tracemole"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tracemole/nextjs-mongodb-explain.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tracemole/nextjs-mongodb-explain/issues"
+  },
+  "homepage": "https://github.com/tracemole/nextjs-mongodb-explain#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "client": ["dist/client.d.ts"],
+      "*": ["dist/index.d.ts"]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "prepare": "npm run build",
+    "check-types": "tsc --noEmit",
+    "test": "tsx --test src/parse.test.ts",
+    "prepublishOnly": "npm run check-types && npm run test && npm run build"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": ">=1.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@types/node": "^22.15.3",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.4",
+    "typescript": "5.9.2"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}