@envelop/opentelemetry 4.0.0-alpha-d0d0776.0 → 4.0.0-alpha-ccec0fc.0

package/README.md

@@ -15,8 +15,8 @@ yarn add @envelop/opentelemetry
 By default, this plugin prints the collected telemetry to the console:
 
 ```ts
-import { envelop } from '@envelop/core';
-import { useOpenTelemetry } from '@envelop/opentelemetry';
+import { envelop } from '@envelop/core'
+import { useOpenTelemetry } from '@envelop/opentelemetry'
 
 const getEnveloped = envelop({
   plugins: [
@@ -24,27 +24,27 @@ const getEnveloped = envelop({
     useOpenTelemetry({
       resolvers: true, // Tracks resolvers calls, and tracks resolvers thrown errors
       variables: true, // Includes the operation variables values as part of the metadata collected
-      result: true, // Includes execution result object as part of the metadata collected
-    }),
-  ],
-});
+      result: true // Includes execution result object as part of the metadata collected
+    })
+  ]
+})
 ```
 
 If you wish to use custom tracer/exporter, create it and pass it. This example integrates Jaeger tracer:
 
 ```ts
-import { envelop } from '@envelop/core';
-import { useOpenTelemetry } from '@envelop/opentelemetry';
-import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
-import { SimpleSpanProcessor, BasicTracerProvider } from '@opentelemetry/tracing';
+import { envelop } from '@envelop/core'
+import { useOpenTelemetry } from '@envelop/opentelemetry'
+import { JaegerExporter } from '@opentelemetry/exporter-jaeger'
+import { SimpleSpanProcessor, BasicTracerProvider } from '@opentelemetry/tracing'
 
 const exporter = new JaegerExporter({
-  serviceName: 'my-service-name',
-});
+  serviceName: 'my-service-name'
+})
 
-const provider = new BasicTracerProvider();
-provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
-provider.register();
+const provider = new BasicTracerProvider()
+provider.addSpanProcessor(new SimpleSpanProcessor(exporter))
+provider.register()
 
 const getEnveloped = envelop({
   plugins: [
@@ -53,10 +53,10 @@ const getEnveloped = envelop({
       {
         resolvers: true, // Tracks resolvers calls, and tracks resolvers thrown errors
         variables: true, // Includes the operation variables values as part of the metadata collected
-        result: true, // Includes execution result object as part of the metadata collected
+        result: true // Includes execution result object as part of the metadata collected
       },
       provider
-    ),
-  ],
-});
+    )
+  ]
+})
 ```

package/{index.js → cjs/index.js}

@@ -1,33 +1,13 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const core = require('@envelop/core');
-const opentelemetry = require('@opentelemetry/api');
-const tracing = require('@opentelemetry/tracing');
-const graphql = require('graphql');
-
-function _interopNamespace(e) {
-    if (e && e.__esModule) return e;
-    const n = Object.create(null);
-    if (e) {
-        for (const k in e) {
-            if (k !== 'default') {
-                const d = Object.getOwnPropertyDescriptor(e, k);
-                Object.defineProperty(n, k, d.get ? d : {
-                    enumerable: true,
-                    get: function () { return e[k]; }
-                });
-            }
-        }
-    }
-    n["default"] = e;
-    return Object.freeze(n);
-}
-
-const opentelemetry__namespace = /*#__PURE__*/_interopNamespace(opentelemetry);
-
-exports.AttributeName = void 0;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useOpenTelemetry = exports.AttributeName = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@envelop/core");
+const api_1 = require("@opentelemetry/api");
+const opentelemetry = tslib_1.__importStar(require("@opentelemetry/api"));
+const tracing_1 = require("@opentelemetry/tracing");
+const graphql_1 = require("@graphql-tools/graphql");
+var AttributeName;
 (function (AttributeName) {
     AttributeName["EXECUTION_ERROR"] = "graphql.execute.error";
     AttributeName["EXECUTION_RESULT"] = "graphql.execute.result";
@@ -39,12 +19,12 @@ exports.AttributeName = void 0;
     AttributeName["EXECUTION_OPERATION_NAME"] = "graphql.execute.operationName";
     AttributeName["EXECUTION_OPERATION_DOCUMENT"] = "graphql.execute.document";
     AttributeName["EXECUTION_VARIABLES"] = "graphql.execute.variables";
-})(exports.AttributeName || (exports.AttributeName = {}));
+})(AttributeName = exports.AttributeName || (exports.AttributeName = {}));
 const tracingSpanSymbol = Symbol('OPEN_TELEMETRY_GRAPHQL');
-const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
+const useOpenTelemetry = (options, tracingProvider, spanKind = api_1.SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
     if (!tracingProvider) {
-        tracingProvider = new tracing.BasicTracerProvider();
-        tracingProvider.addSpanProcessor(new tracing.SimpleSpanProcessor(new tracing.ConsoleSpanExporter()));
+        tracingProvider = new tracing_1.BasicTracerProvider();
+        tracingProvider.addSpanProcessor(new tracing_1.SimpleSpanProcessor(new tracing_1.ConsoleSpanExporter()));
         tracingProvider.register();
     }
     const tracer = tracingProvider.getTracer(serviceName);
@@ -53,20 +33,20 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
             ? ({ info, context, args }) => {
                 if (context && typeof context === 'object' && context[tracingSpanSymbol]) {
                     tracer.getActiveSpanProcessor();
-                    const ctx = opentelemetry__namespace.trace.setSpan(opentelemetry__namespace.context.active(), context[tracingSpanSymbol]);
+                    const ctx = opentelemetry.trace.setSpan(opentelemetry.context.active(), context[tracingSpanSymbol]);
                     const { fieldName, returnType, parentType } = info;
                     const resolverSpan = tracer.startSpan(`${parentType.name}.${fieldName}`, {
                         attributes: {
-                            [exports.AttributeName.RESOLVER_FIELD_NAME]: fieldName,
-                            [exports.AttributeName.RESOLVER_TYPE_NAME]: parentType.toString(),
-                            [exports.AttributeName.RESOLVER_RESULT_TYPE]: returnType.toString(),
-                            [exports.AttributeName.RESOLVER_ARGS]: JSON.stringify(args || {}),
+                            [AttributeName.RESOLVER_FIELD_NAME]: fieldName,
+                            [AttributeName.RESOLVER_TYPE_NAME]: parentType.toString(),
+                            [AttributeName.RESOLVER_RESULT_TYPE]: returnType.toString(),
+                            [AttributeName.RESOLVER_ARGS]: JSON.stringify(args || {}),
                         },
                     }, ctx);
                     return ({ result }) => {
                         if (result instanceof Error) {
                             resolverSpan.recordException({
-                                name: exports.AttributeName.RESOLVER_EXCEPTION,
+                                name: AttributeName.RESOLVER_EXCEPTION,
                                 message: JSON.stringify(result),
                             });
                         }
@@ -79,29 +59,32 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
             }
             : undefined,
         onExecute({ args, extendContext }) {
+            var _a, _b;
             const executionSpan = tracer.startSpan(`${args.operationName || 'Anonymous Operation'}`, {
                 kind: spanKind,
                 attributes: {
                     ...spanAdditionalAttributes,
-                    [exports.AttributeName.EXECUTION_OPERATION_NAME]: args.operationName ?? undefined,
-                    [exports.AttributeName.EXECUTION_OPERATION_DOCUMENT]: graphql.print(args.document),
-                    ...(options.variables ? { [exports.AttributeName.EXECUTION_VARIABLES]: JSON.stringify(args.variableValues ?? {}) } : {}),
+                    [AttributeName.EXECUTION_OPERATION_NAME]: (_a = args.operationName) !== null && _a !== void 0 ? _a : undefined,
+                    [AttributeName.EXECUTION_OPERATION_DOCUMENT]: (0, graphql_1.print)(args.document),
+                    ...(options.variables
+                        ? { [AttributeName.EXECUTION_VARIABLES]: JSON.stringify((_b = args.variableValues) !== null && _b !== void 0 ? _b : {}) }
+                        : {}),
                 },
             });
             const resultCbs = {
                 onExecuteDone({ result }) {
-                    if (core.isAsyncIterable(result)) {
+                    if ((0, core_1.isAsyncIterable)(result)) {
                         executionSpan.end();
                         // eslint-disable-next-line no-console
                         console.warn(`Plugin "newrelic" encountered a AsyncIterator which is not supported yet, so tracing data is not available for the operation.`);
                         return;
                     }
                     if (result.data && options.result) {
-                        executionSpan.setAttribute(exports.AttributeName.EXECUTION_RESULT, JSON.stringify(result));
+                        executionSpan.setAttribute(AttributeName.EXECUTION_RESULT, JSON.stringify(result));
                     }
                     if (result.errors && result.errors.length > 0) {
                         executionSpan.recordException({
-                            name: exports.AttributeName.EXECUTION_ERROR,
+                            name: AttributeName.EXECUTION_ERROR,
                             message: JSON.stringify(result.errors),
                         });
                     }
@@ -117,5 +100,4 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
         },
     };
 };
-
 exports.useOpenTelemetry = useOpenTelemetry;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/{index.mjs → esm/index.js}

@@ -1,10 +1,9 @@
 import { isAsyncIterable } from '@envelop/core';
-import * as opentelemetry from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
-import { BasicTracerProvider, SimpleSpanProcessor, ConsoleSpanExporter } from '@opentelemetry/tracing';
-import { print } from 'graphql';
-
-var AttributeName;
+import * as opentelemetry from '@opentelemetry/api';
+import { BasicTracerProvider, ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
+import { print } from '@graphql-tools/graphql';
+export var AttributeName;
 (function (AttributeName) {
     AttributeName["EXECUTION_ERROR"] = "graphql.execute.error";
     AttributeName["EXECUTION_RESULT"] = "graphql.execute.result";
@@ -18,7 +17,7 @@ var AttributeName;
     AttributeName["EXECUTION_VARIABLES"] = "graphql.execute.variables";
 })(AttributeName || (AttributeName = {}));
 const tracingSpanSymbol = Symbol('OPEN_TELEMETRY_GRAPHQL');
-const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
+export const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
     if (!tracingProvider) {
         tracingProvider = new BasicTracerProvider();
         tracingProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
@@ -56,13 +55,16 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER,
             }
             : undefined,
         onExecute({ args, extendContext }) {
+            var _a, _b;
             const executionSpan = tracer.startSpan(`${args.operationName || 'Anonymous Operation'}`, {
                 kind: spanKind,
                 attributes: {
                     ...spanAdditionalAttributes,
-                    [AttributeName.EXECUTION_OPERATION_NAME]: args.operationName ?? undefined,
+                    [AttributeName.EXECUTION_OPERATION_NAME]: (_a = args.operationName) !== null && _a !== void 0 ? _a : undefined,
                     [AttributeName.EXECUTION_OPERATION_DOCUMENT]: print(args.document),
-                    ...(options.variables ? { [AttributeName.EXECUTION_VARIABLES]: JSON.stringify(args.variableValues ?? {}) } : {}),
+                    ...(options.variables
+                        ? { [AttributeName.EXECUTION_VARIABLES]: JSON.stringify((_b = args.variableValues) !== null && _b !== void 0 ? _b : {}) }
+                        : {}),
                 },
             });
             const resultCbs = {
@@ -94,5 +96,3 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER,
         },
     };
 };
-
-export { AttributeName, useOpenTelemetry };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@envelop/opentelemetry",
-  "version": "4.0.0-alpha-d0d0776.0",
+  "version": "4.0.0-alpha-ccec0fc.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "3.0.0-alpha-d0d0776.0",
-    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
+    "@envelop/core": "3.0.0-alpha-ccec0fc.0",
+    "@graphql-tools/graphql": "0.1.0-alpha-e7752ba5.0"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.0.0",
@@ -17,33 +17,42 @@
   },
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
       "require": {
-        "default": "./index.js",
-        "types": "./index.d.ts"
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
       },
       "import": {
-        "default": "./index.mjs",
-        "types": "./index.d.ts"
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
       }
     },
     "./*": {
       "require": {
-        "default": "./*.js",
-        "types": "./*.d.ts"
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
       },
       "import": {
-        "default": "./*.mjs",
-        "types": "./*.d.ts"
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
       }
     },
     "./package.json": "./package.json"
   }
-}
+}

package/{index.d.ts → typings/index.d.ts}

@@ -23,5 +23,5 @@ export declare type TracingOptions = {
 declare type PluginContext = {
     [tracingSpanSymbol]: opentelemetry.Span;
 };
-export declare const useOpenTelemetry: (options: TracingOptions, tracingProvider?: BasicTracerProvider | undefined, spanKind?: SpanKind, spanAdditionalAttributes?: SpanAttributes, serviceName?: string) => Plugin<PluginContext>;
+export declare const useOpenTelemetry: (options: TracingOptions, tracingProvider?: BasicTracerProvider, spanKind?: SpanKind, spanAdditionalAttributes?: SpanAttributes, serviceName?: string) => Plugin<PluginContext>;
 export {};