@m1212e/rumble 0.23.17 → 0.23.19

package/out/index.d.mts

@@ -3,9 +3,9 @@ import { EnvelopArmorPlugin } from "@escape.tech/graphql-armor";
 import { Tracer } from "@opentelemetry/api";
 import { YogaServerOptions, createPubSub } from "graphql-yoga";
 import { Table } from "drizzle-orm";
+import { TracingWrapperOptions } from "@pothos/tracing-opentelemetry";
 import { PgAsyncDatabase } from "drizzle-orm/pg-core";
 import { MySqlAsyncDatabase } from "drizzle-orm/mysql-core";
-import { TracingWrapperOptions } from "@pothos/tracing-opentelemetry";
 import { SQLiteAsyncDatabase } from "drizzle-orm/sqlite-core";
 import SchemaBuilder from "@pothos/core";
 import { IncomingMessage, RequestListener, ServerResponse } from "node:http";
@@ -4415,6 +4415,10 @@ type RumbleInput<UserContext extends Record<string, any>, DB extends DrizzleInst
   } | undefined;
   /**
    * rumble can set up otel tracing if you want to. This will provide details of execution time and outcome to the provided tracer. See https://pothos-graphql.dev/docs/plugins/tracing#install for more information.
+   *
+   * The emitted spans and attributes are identical for every transport, so an
+   * operation served via GraphQL, the SOFA REST adapter or WebSockets produces
+   * the same trace shape (see `rumble.transport` to tell them apart).
    */
   otel?: {
     /**
@@ -4429,6 +4433,33 @@ type RumbleInput<UserContext extends Record<string, any>, DB extends DrizzleInst
      * You can pass options to the tracing wrapper
      */
     options?: TracingWrapperOptions<unknown>;
+    /**
+     * Whether the operation source is attached to operation spans as
+     * `graphql.document`.
+     *
+     * Keep in mind that a document can carry inline argument literals, so this
+     * may contain user data.
+     * @default true
+     */
+    includeDocument?: boolean;
+    /**
+     * Whether the incoming operation variables are attached to operation spans
+     * as `graphql.variables.<name>` attributes.
+     *
+     * Variables regularly carry personal data, so you can turn this off
+     * entirely (`false`) or pass a function to redact or drop single entries
+     * before they leave the process.
+     *
+     * @example
+     * ```ts
+     * otel: {
+     *   enabled: true,
+     *   includeVariables: ({ password, ...rest }) => rest,
+     * }
+     * ```
+     * @default true
+     */
+    includeVariables?: boolean | ((variables: Record<string, unknown>) => Record<string, unknown> | undefined);
   };
   /**
    * Structured logging for rumble internals. Pass a pino (or compatible) logger instance.
@@ -4445,12 +4476,31 @@ type RumbleInput<UserContext extends Record<string, any>, DB extends DrizzleInst
      */
     logger: RumbleLogger;
     /**
-     * When both logger and otel are enabled, inject `traceId` and `spanId` fields into every
-     * log entry emitted during a GraphQL operation. Useful for correlating log lines with
-     * traces in backends like Jaeger or Grafana Tempo.
+     * When both logger and otel are enabled, inject `trace_id`, `span_id` and `trace_flags`
+     * fields into every log entry emitted during a GraphQL operation. Useful for correlating
+     * log lines with traces in backends like Jaeger or Grafana Tempo.
      * @default true
      */
     injectTraceId?: boolean;
+    /**
+     * Whether the incoming operation variables are attached to the operation
+     * start log entry as a `graphql.variables` object.
+     *
+     * Variables regularly carry personal data, so you can turn this off
+     * entirely (`false`) or pass a function to redact or drop single entries
+     * before they are logged.
+     *
+     * @example
+     * ```ts
+     * logger: {
+     *   enabled: true,
+     *   logger: pino(),
+     *   includeVariables: ({ password, ...rest }) => rest,
+     * }
+     * ```
+     * @default true
+     */
+    includeVariables?: boolean | ((variables: Record<string, unknown>) => Record<string, unknown> | undefined);
   };
 };
 //#endregion