@julr/otel-instrumentation-clickhouse 1.0.1 → 1.0.2

package/build/src/constants.d.ts

@@ -0,0 +1,25 @@
+import type { ClickHouseInstrumentationConfig } from './types.js';
+export declare const MODULE_NAME = "@clickhouse/client-common";
+export declare const INSTRUMENTATION_NAME = "@julr/otel-instrumentation-clickhouse";
+export declare const INSTRUMENTATION_VERSION = "1.0.0";
+/**
+ * Stable semantic convention attributes for database spans
+ * @see https://opentelemetry.io/docs/specs/semconv/database/database-spans/
+ */
+export declare const ATTR_DB_SYSTEM_NAME = "db.system.name";
+export declare const ATTR_DB_QUERY_TEXT = "db.query.text";
+export declare const ATTR_DB_OPERATION_NAME = "db.operation.name";
+export declare const ATTR_DB_NAMESPACE = "db.namespace";
+export declare const ATTR_DB_COLLECTION_NAME = "db.collection.name";
+export declare const ATTR_SERVER_ADDRESS = "server.address";
+export declare const ATTR_SERVER_PORT = "server.port";
+/**
+ * Deprecated attributes - kept for backward compatibility
+ * Can be removed once consumers migrate to stable attributes
+ */
+export declare const ATTR_DB_SYSTEM = "db.system";
+export declare const ATTR_DB_STATEMENT = "db.statement";
+export declare const ATTR_DB_OPERATION = "db.operation";
+export declare const ATTR_DB_NAME = "db.name";
+export declare const DEFAULT_CONFIG: ClickHouseInstrumentationConfig;
+//# sourceMappingURL=constants.d.ts.map

package/build/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAA;AAEjE,eAAO,MAAM,WAAW,8BAA8B,CAAA;AACtD,eAAO,MAAM,oBAAoB,0CAA0C,CAAA;AAC3E,eAAO,MAAM,uBAAuB,UAAU,CAAA;AAE9C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mBAAmB,CAAA;AACnD,eAAO,MAAM,kBAAkB,kBAAkB,CAAA;AACjD,eAAO,MAAM,sBAAsB,sBAAsB,CAAA;AACzD,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C,eAAO,MAAM,uBAAuB,uBAAuB,CAAA;AAC3D,eAAO,MAAM,mBAAmB,mBAAmB,CAAA;AACnD,eAAO,MAAM,gBAAgB,gBAAgB,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,cAAc,cAAc,CAAA;AACzC,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C,eAAO,MAAM,YAAY,YAAY,CAAA;AAErC,eAAO,MAAM,cAAc,EAAE,+BAI5B,CAAA"}

package/build/src/index.d.ts

@@ -0,0 +1,3 @@
+export { ClickHouseInstrumentation } from './instrumentation.js';
+export type { ClickHouseInstrumentationConfig } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/build/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAChE,YAAY,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAA"}

package/build/src/instrumentation.d.ts

@@ -0,0 +1,11 @@
+import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
+import type { ClickHouseInstrumentationConfig } from './types.js';
+export declare class ClickHouseInstrumentation extends InstrumentationBase<ClickHouseInstrumentationConfig> {
+    #private;
+    constructor(config?: ClickHouseInstrumentationConfig);
+    /**
+     * Initialize the instrumentation by defining module patches.
+     */
+    protected init(): InstrumentationNodeModuleDefinition;
+}
+//# sourceMappingURL=instrumentation.d.ts.map

package/build/src/instrumentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.d.ts","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,mBAAmB,EACnB,mCAAmC,EAEpC,MAAM,gCAAgC,CAAA;AAIvC,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAA;AAqBjE,qBAAa,yBAA0B,SAAQ,mBAAmB,CAAC,+BAA+B,CAAC;;gBACrF,MAAM,GAAE,+BAAoC;IAwNxD;;OAEG;IACH,SAAS,CAAC,IAAI;CA8Bf"}

package/build/src/internal_types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Internal representation of the ClickHouse client instance.
+ * Used for accessing connection parameters during instrumentation.
+ */
+export interface ClickHouseClient {
+    connectionParams?: {
+        url?: URL;
+        database?: string;
+    };
+}
+/**
+ * Parameters for query, command, and exec operations.
+ */
+export interface QueryParams {
+    query?: string;
+    query_id?: string;
+}
+/**
+ * Parameters for insert operations.
+ * Extends QueryParams with table name support.
+ */
+export interface InsertParams extends QueryParams {
+    table?: string;
+}
+//# sourceMappingURL=internal_types.d.ts.map

package/build/src/internal_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal_types.d.ts","sourceRoot":"","sources":["../../src/internal_types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE;QACjB,GAAG,CAAC,EAAE,GAAG,CAAA;QACT,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

package/build/src/types.d.ts

@@ -0,0 +1,26 @@
+import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
+/**
+ * Configuration options for ClickHouse instrumentation.
+ */
+export interface ClickHouseInstrumentationConfig extends InstrumentationConfig {
+    /**
+     * Maximum length of the query to include in the span.
+     * Queries longer than this will be truncated.
+     * Set to 0 to disable query capture.
+     * @default 2048
+     */
+    maxQueryLength?: number;
+    /**
+     * Whether to require a parent span to create child spans.
+     * @default false
+     */
+    requireParentSpan?: boolean;
+    /**
+     * Whether to suppress internal HTTP instrumentation.
+     * When true, the HTTP spans for ClickHouse requests will not be created
+     * by @opentelemetry/instrumentation-http, avoiding duplicate spans.
+     * @default true
+     */
+    suppressInternalInstrumentation?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAE3E;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,qBAAqB;IAC5E;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@julr/otel-instrumentation-clickhouse",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "OpenTelemetry automatic instrumentation for ClickHouse client",
   "main": "./build/src/index.js",
   "module": "./build/src/index.js",