@envelop/opentelemetry 3.4.0-alpha-aca44e1.0 → 3.4.0-alpha-e9434aa.0

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

@@ -1,8 +1,12 @@
-import { isAsyncIterable } from '@envelop/core';
-import { SpanKind, trace, context } from '@opentelemetry/api';
-import { BasicTracerProvider, SimpleSpanProcessor, ConsoleSpanExporter } from '@opentelemetry/tracing';
-import { print } from 'graphql';
-
+"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");
 var AttributeName;
 (function (AttributeName) {
     AttributeName["EXECUTION_ERROR"] = "graphql.execute.error";
@@ -15,21 +19,21 @@ var AttributeName;
     AttributeName["EXECUTION_OPERATION_NAME"] = "graphql.execute.operationName";
     AttributeName["EXECUTION_OPERATION_DOCUMENT"] = "graphql.execute.document";
     AttributeName["EXECUTION_VARIABLES"] = "graphql.execute.variables";
-})(AttributeName || (AttributeName = {}));
+})(AttributeName = exports.AttributeName || (exports.AttributeName = {}));
 const tracingSpanSymbol = Symbol('OPEN_TELEMETRY_GRAPHQL');
-const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
+const useOpenTelemetry = (options, tracingProvider, spanKind = api_1.SpanKind.SERVER, spanAdditionalAttributes = {}, serviceName = 'graphql') => {
     if (!tracingProvider) {
-        tracingProvider = new BasicTracerProvider();
-        tracingProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+        tracingProvider = new tracing_1.BasicTracerProvider();
+        tracingProvider.addSpanProcessor(new tracing_1.SimpleSpanProcessor(new tracing_1.ConsoleSpanExporter()));
         tracingProvider.register();
     }
     const tracer = tracingProvider.getTracer(serviceName);
     return {
         onResolverCalled: options.resolvers
-            ? ({ info, context: context$1, args }) => {
-                if (context$1 && typeof context$1 === 'object' && context$1[tracingSpanSymbol]) {
+            ? ({ info, context, args }) => {
+                if (context && typeof context === 'object' && context[tracingSpanSymbol]) {
                     tracer.getActiveSpanProcessor();
-                    const ctx = trace.setSpan(context.active(), context$1[tracingSpanSymbol]);
+                    const ctx = opentelemetry.trace.setSpan(opentelemetry.context.active(), context[tracingSpanSymbol]);
                     const { fieldName, returnType, parentType } = info;
                     const resolverSpan = tracer.startSpan(`${parentType.name}.${fieldName}`, {
                         attributes: {
@@ -61,13 +65,13 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER,
                 attributes: {
                     ...spanAdditionalAttributes,
                     [AttributeName.EXECUTION_OPERATION_NAME]: (_a = args.operationName) !== null && _a !== void 0 ? _a : undefined,
-                    [AttributeName.EXECUTION_OPERATION_DOCUMENT]: print(args.document),
+                    [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 (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.`);
@@ -94,5 +98,4 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = SpanKind.SERVER,
         },
     };
 };
-
-export { AttributeName, useOpenTelemetry };
+exports.useOpenTelemetry = useOpenTelemetry;

package/cjs/package.json

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

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

@@ -1,12 +1,35 @@
-'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');
-
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useOpenTelemetry = exports.AttributeName = void 0;
+const core_1 = require("@envelop/core");
+const api_1 = require("@opentelemetry/api");
+const opentelemetry = __importStar(require("@opentelemetry/api"));
+const tracing_1 = require("@opentelemetry/tracing");
+const graphql_1 = require("graphql");
+var AttributeName;
 (function (AttributeName) {
     AttributeName["EXECUTION_ERROR"] = "graphql.execute.error";
     AttributeName["EXECUTION_RESULT"] = "graphql.execute.result";
@@ -18,12 +41,12 @@ const graphql = require('graphql');
     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);
@@ -36,16 +59,16 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
                     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),
                             });
                         }
@@ -63,25 +86,25 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
                 kind: spanKind,
                 attributes: {
                     ...spanAdditionalAttributes,
-                    [exports.AttributeName.EXECUTION_OPERATION_NAME]: (_a = args.operationName) !== null && _a !== void 0 ? _a : undefined,
-                    [exports.AttributeName.EXECUTION_OPERATION_DOCUMENT]: graphql.print(args.document),
-                    ...(options.variables ? { [exports.AttributeName.EXECUTION_VARIABLES]: JSON.stringify((_b = args.variableValues) !== null && _b !== void 0 ? _b : {}) } : {}),
+                    [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),
                         });
                     }
@@ -97,5 +120,4 @@ const useOpenTelemetry = (options, tracingProvider, spanKind = opentelemetry.Spa
         },
     };
 };
-
 exports.useOpenTelemetry = useOpenTelemetry;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/opentelemetry",
-  "version": "3.4.0-alpha-aca44e1.0",
+  "version": "3.4.0-alpha-e9434aa.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-aca44e1.0",
+    "@envelop/core": "2.4.0-alpha-e9434aa.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
@@ -12,26 +12,47 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/opentelemetry"
   },
   "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": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
     "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
+      "require": {
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "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 {};

package/README.md

@@ -1,62 +0,0 @@
-## `@envelop/opentelemetry`
-
-This plugins integrates [Open Telemetry](https://opentelemetry.io/) tracing with your GraphQL execution. It also collects GraphQL execution errors and reports it as Exceptions.
-
-You can use this plugin with any kind of Open Telemetry [tracer](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#tracer), and integrate it to any tracing/metric platform that supports this standard.
-
-## Getting Started
-
-```
-yarn add @envelop/opentelemetry
-```
-
-## Usage Example
-
-By default, this plugin prints the collected telemetry to the console:
-
-```ts
-import { envelop } from '@envelop/core';
-import { useOpenTelemetry } from '@envelop/opentelemetry';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    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
-    }),
-  ],
-});
-```
-
-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';
-
-const exporter = new JaegerExporter({
-  serviceName: 'my-service-name',
-});
-
-const provider = new BasicTracerProvider();
-provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
-provider.register();
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    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
-      },
-      provider
-    ),
-  ],
-});
-```