@graphql-hive/plugin-opentelemetry 1.2.1-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d → 1.2.1-alpha-ddc12a9e4831789ab7d677ef93157e9fb5f92edc

package/CHANGELOG.md

@@ -1,15 +1,15 @@
 # @graphql-hive/plugin-opentelemetry
 
-## 1.2.1-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d
+## 1.2.1-alpha-ddc12a9e4831789ab7d677ef93157e9fb5f92edc
 ### Patch Changes
 
 
 
-- [#1715](https://github.com/graphql-hive/gateway/pull/1715) [`8c330b3`](https://github.com/graphql-hive/gateway/commit/8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d) Thanks [@dependabot](https://github.com/apps/dependabot)! - dependencies updates:
-  
-  - Updated dependency [`@graphql-hive/core@^0.15.0` ↗︎](https://www.npmjs.com/package/@graphql-hive/core/v/0.15.0) (from `^0.13.2`, in `dependencies`)
-- Updated dependencies [[`8c330b3`](https://github.com/graphql-hive/gateway/commit/8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d)]:
-  - @graphql-hive/gateway-runtime@2.3.6-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d
+- [#1721](https://github.com/graphql-hive/gateway/pull/1721) [`ddc12a9`](https://github.com/graphql-hive/gateway/commit/ddc12a9e4831789ab7d677ef93157e9fb5f92edc) Thanks [@enisdenjo](https://github.com/enisdenjo)! - Have a default endpoint for Hive Tracing
+
+
+
+- [#1721](https://github.com/graphql-hive/gateway/pull/1721) [`ddc12a9`](https://github.com/graphql-hive/gateway/commit/ddc12a9e4831789ab7d677ef93157e9fb5f92edc) Thanks [@enisdenjo](https://github.com/enisdenjo)! - Improved default resource service name and version to use Hive Gateway
 
 ## 1.2.0
 ### Minor Changes

package/dist/setup.cjs

@@ -224,7 +224,7 @@ function getContextForRequest(attributes) {
   return plugin.otelCtxForRequestId.get(attributes.requestId) ?? api.ROOT_CONTEXT;
 }
 
-globalThis.__OTEL_PLUGIN_VERSION__ = '1.2.1-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d';
+globalThis.__OTEL_PLUGIN_VERSION__ = '1.2.1-alpha-ddc12a9e4831789ab7d677ef93157e9fb5f92edc';
 let initialized = false;
 function openTelemetrySetup(options) {
   const log = options.log || new logger.Logger();
@@ -289,15 +289,7 @@ function openTelemetrySetup(options) {
         logMessage += " in addition to an stdout debug exporter";
         logAttributes["console"] = true;
       }
-      const resource = createResource(
-        resources.resourceFromAttributes({
-          [semanticConventions.ATTR_SERVICE_NAME]: plugin.getEnvStr("OTEL_SERVICE_NAME") || "@graphql-hive/plugin-opentelemetry",
-          [semanticConventions.ATTR_SERVICE_VERSION]: plugin.getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__OTEL_PLUGIN_VERSION__ || "unknown",
-          ["hive.gateway.version"]: globalThis.__VERSION__,
-          ["hive.otel.version"]: globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
-        }),
-        options.resource
-      );
+      const resource = createResource(options);
       logAttributes["resource"] = resource.attributes;
       logAttributes["sampling"] = options.sampler ? "custom" : options.samplingRate;
       logAttributes["registrationResults"].tracerProvider = api.trace.setGlobalTracerProvider(
@@ -339,33 +331,41 @@ function hiveTracingSetup(options) {
     ...options._initialization?.logAttributes,
     target: options.target
   };
-  if (!options.processor) {
+  let processorOptions;
+  if (options.processor) {
+    processorOptions = { processor: options.processor };
+  } else {
     options.accessToken ??= plugin.getEnvStr("HIVE_TRACING_ACCESS_TOKEN") ?? plugin.getEnvStr("HIVE_ACCESS_TOKEN");
     if (!options.accessToken) {
       throw new Error(
-        "You must specify the Hive Registry `accessToken`. Either provide `accessToken` option or `HIVE_ACCESS_TOKEN`/`HIVE_TRACE_ACCESS_TOKEN` environment variable."
+        'You must specify the Hive Registry access token. Either provide the "accessToken" option or "HIVE_ACCESS_TOKEN"/"HIVE_TRACE_ACCESS_TOKEN" environment variable.'
+      );
+    }
+    options.endpoint ??= plugin.getEnvStr("HIVE_TRACING_ENDPOINT") ?? "https://api.graphql-hive.com/otel/v1/traces";
+    if (!options.endpoint) {
+      throw new Error(
+        'You must specify the Hive Tracing endpoint. Either provide the "endpoint" option or the "HIVE_TRACING_ENDPOINT" environment variable.'
       );
     }
+    processorOptions = {
+      target: options.target,
+      accessToken: options.accessToken,
+      endpoint: options.endpoint,
+      batching: options.batching
+    };
     logAttributes["endpoint"] = options.endpoint;
     logAttributes["batching"] = options.batching;
   }
   openTelemetrySetup({
     ...options,
     log,
-    resource: createResource(
+    resource: createResource(options).merge(
       resources.resourceFromAttributes({
-        "hive.target_id": options.target,
-        [semanticConventions.ATTR_SERVICE_NAME]: plugin.getEnvStr("OTEL_SERVICE_NAME") || "hive-gateway",
-        [semanticConventions.ATTR_SERVICE_VERSION]: plugin.getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
-      }),
-      options.resource
+        "hive.target_id": options.target
+      })
     ),
     traces: {
-      processors: [
-        new HiveTracingSpanProcessor(
-          options
-        )
-      ],
+      processors: [new HiveTracingSpanProcessor(processorOptions)],
       spanLimits: options.spanLimits,
       console: options.console
     },
@@ -386,19 +386,16 @@ function resolveBatchingConfig(exporter, batchingConfig) {
     return new sdkTraceBase.BatchSpanProcessor(exporter, value);
   }
 }
-function createResource(baseResource, userResource) {
-  if (!userResource) {
-    return baseResource;
-  }
-  if ("serviceName" in userResource) {
-    return baseResource.merge(
-      resources.resourceFromAttributes({
-        [semanticConventions.ATTR_SERVICE_NAME]: userResource.serviceName,
-        [semanticConventions.ATTR_SERVICE_VERSION]: userResource.serviceVersion
-      })
-    );
+function createResource(opts) {
+  let resource = resources.resourceFromAttributes({
+    [semanticConventions.ATTR_SERVICE_NAME]: opts.resource && "serviceName" in opts.resource ? opts.resource.serviceName : plugin.getEnvStr("OTEL_SERVICE_NAME") || "hive-gateway",
+    [semanticConventions.ATTR_SERVICE_VERSION]: opts.resource && "serviceVersion" in opts.resource ? opts.resource.serviceVersion : plugin.getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__VERSION__ || "unknown",
+    ["hive.otel.version"]: globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
+  });
+  if (opts.resource && "attributes" in opts.resource) {
+    resource = resource.merge(opts.resource);
   }
-  return baseResource.merge(userResource);
+  return resource;
 }
 function getStackTrace() {
   return (new Error().stack ?? "").split("\n").slice(3).join("\n").trim();

package/dist/setup.d.cts

@@ -133,7 +133,7 @@ type BaseOptions = {
      */
     resource?: Resource | {
         serviceName: string;
-        serviceVersion: string;
+        serviceVersion?: string;
     };
     /**
      * The Context Manager to be used to track OTEL Context.
@@ -179,6 +179,7 @@ type HiveTracingOptions = {
     accessToken?: string;
     batching?: BufferConfig;
     processor?: never;
+    /** @default 'https://api.graphql-hive.com/otel/v1/traces' */
     endpoint?: string;
 } | {
     processor: SpanProcessor;

package/dist/setup.d.ts

@@ -133,7 +133,7 @@ type BaseOptions = {
      */
     resource?: Resource | {
         serviceName: string;
-        serviceVersion: string;
+        serviceVersion?: string;
     };
     /**
      * The Context Manager to be used to track OTEL Context.
@@ -179,6 +179,7 @@ type HiveTracingOptions = {
     accessToken?: string;
     batching?: BufferConfig;
     processor?: never;
+    /** @default 'https://api.graphql-hive.com/otel/v1/traces' */
     endpoint?: string;
 } | {
     processor: SpanProcessor;

package/dist/setup.js

@@ -224,7 +224,7 @@ function getContextForRequest(attributes) {
   return otelCtxForRequestId.get(attributes.requestId) ?? ROOT_CONTEXT;
 }
 
-globalThis.__OTEL_PLUGIN_VERSION__ = '1.2.1-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d';
+globalThis.__OTEL_PLUGIN_VERSION__ = '1.2.1-alpha-ddc12a9e4831789ab7d677ef93157e9fb5f92edc';
 let initialized = false;
 function openTelemetrySetup(options) {
   const log = options.log || new Logger();
@@ -289,15 +289,7 @@ function openTelemetrySetup(options) {
         logMessage += " in addition to an stdout debug exporter";
         logAttributes["console"] = true;
       }
-      const resource = createResource(
-        resourceFromAttributes({
-          [ATTR_SERVICE_NAME]: getEnvStr("OTEL_SERVICE_NAME") || "@graphql-hive/plugin-opentelemetry",
-          [ATTR_SERVICE_VERSION]: getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__OTEL_PLUGIN_VERSION__ || "unknown",
-          ["hive.gateway.version"]: globalThis.__VERSION__,
-          ["hive.otel.version"]: globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
-        }),
-        options.resource
-      );
+      const resource = createResource(options);
       logAttributes["resource"] = resource.attributes;
       logAttributes["sampling"] = options.sampler ? "custom" : options.samplingRate;
       logAttributes["registrationResults"].tracerProvider = trace.setGlobalTracerProvider(
@@ -339,33 +331,41 @@ function hiveTracingSetup(options) {
     ...options._initialization?.logAttributes,
     target: options.target
   };
-  if (!options.processor) {
+  let processorOptions;
+  if (options.processor) {
+    processorOptions = { processor: options.processor };
+  } else {
     options.accessToken ??= getEnvStr("HIVE_TRACING_ACCESS_TOKEN") ?? getEnvStr("HIVE_ACCESS_TOKEN");
     if (!options.accessToken) {
       throw new Error(
-        "You must specify the Hive Registry `accessToken`. Either provide `accessToken` option or `HIVE_ACCESS_TOKEN`/`HIVE_TRACE_ACCESS_TOKEN` environment variable."
+        'You must specify the Hive Registry access token. Either provide the "accessToken" option or "HIVE_ACCESS_TOKEN"/"HIVE_TRACE_ACCESS_TOKEN" environment variable.'
+      );
+    }
+    options.endpoint ??= getEnvStr("HIVE_TRACING_ENDPOINT") ?? "https://api.graphql-hive.com/otel/v1/traces";
+    if (!options.endpoint) {
+      throw new Error(
+        'You must specify the Hive Tracing endpoint. Either provide the "endpoint" option or the "HIVE_TRACING_ENDPOINT" environment variable.'
       );
     }
+    processorOptions = {
+      target: options.target,
+      accessToken: options.accessToken,
+      endpoint: options.endpoint,
+      batching: options.batching
+    };
     logAttributes["endpoint"] = options.endpoint;
     logAttributes["batching"] = options.batching;
   }
   openTelemetrySetup({
     ...options,
     log,
-    resource: createResource(
+    resource: createResource(options).merge(
       resourceFromAttributes({
-        "hive.target_id": options.target,
-        [ATTR_SERVICE_NAME]: getEnvStr("OTEL_SERVICE_NAME") || "hive-gateway",
-        [ATTR_SERVICE_VERSION]: getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
-      }),
-      options.resource
+        "hive.target_id": options.target
+      })
     ),
     traces: {
-      processors: [
-        new HiveTracingSpanProcessor(
-          options
-        )
-      ],
+      processors: [new HiveTracingSpanProcessor(processorOptions)],
       spanLimits: options.spanLimits,
       console: options.console
     },
@@ -386,19 +386,16 @@ function resolveBatchingConfig(exporter, batchingConfig) {
     return new BatchSpanProcessor(exporter, value);
   }
 }
-function createResource(baseResource, userResource) {
-  if (!userResource) {
-    return baseResource;
-  }
-  if ("serviceName" in userResource) {
-    return baseResource.merge(
-      resourceFromAttributes({
-        [ATTR_SERVICE_NAME]: userResource.serviceName,
-        [ATTR_SERVICE_VERSION]: userResource.serviceVersion
-      })
-    );
+function createResource(opts) {
+  let resource = resourceFromAttributes({
+    [ATTR_SERVICE_NAME]: opts.resource && "serviceName" in opts.resource ? opts.resource.serviceName : getEnvStr("OTEL_SERVICE_NAME") || "hive-gateway",
+    [ATTR_SERVICE_VERSION]: opts.resource && "serviceVersion" in opts.resource ? opts.resource.serviceVersion : getEnvStr("OTEL_SERVICE_VERSION") || globalThis.__VERSION__ || "unknown",
+    ["hive.otel.version"]: globalThis.__OTEL_PLUGIN_VERSION__ || "unknown"
+  });
+  if (opts.resource && "attributes" in opts.resource) {
+    resource = resource.merge(opts.resource);
   }
-  return baseResource.merge(userResource);
+  return resource;
 }
 function getStackTrace() {
   return (new Error().stack ?? "").split("\n").slice(3).join("\n").trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/plugin-opentelemetry",
-  "version": "1.2.1-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d",
+  "version": "1.2.1-alpha-ddc12a9e4831789ab7d677ef93157e9fb5f92edc",
   "type": "module",
   "repository": {
     "type": "git",
@@ -62,8 +62,8 @@
     "graphql": "^15.9.0 || ^16.9.0"
   },
   "dependencies": {
-    "@graphql-hive/core": "^0.15.0",
-    "@graphql-hive/gateway-runtime": "2.3.6-alpha-8c330b3f61e8a326c501f954ef2be8ff8a4f1d7d",
+    "@graphql-hive/core": "^0.13.2",
+    "@graphql-hive/gateway-runtime": "^2.3.5",
     "@graphql-hive/logger": "^1.0.9",
     "@graphql-mesh/cross-helpers": "^0.4.10",
     "@graphql-mesh/transport-common": "^1.0.12",
@@ -90,7 +90,7 @@
     "@whatwg-node/server": "^0.10.17",
     "graphql": "^16.12.0",
     "graphql-yoga": "^5.16.2",
-    "pkgroll": "2.21.1",
+    "pkgroll": "2.20.1",
     "rimraf": "^6.1.0",
     "rollup": "^4.53.2",
     "tsx": "^4.20.6"