@envelop/opentelemetry 3.4.0-alpha-26c4ae2.0 → 3.4.0

package/README.md

@@ -0,0 +1,62 @@
+## `@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
+    ),
+  ],
+});
+```

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/opentelemetry",
-  "version": "3.4.0-alpha-26c4ae2.0",
+  "version": "3.4.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-26c4ae2.0",
+    "@envelop/core": "^2.4.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {