@netlify/opentelemetry-sdk-setup 1.0.1 → 1.0.2

package/lib/bin.js

@@ -1,8 +1,9 @@
 import process from 'node:process';
+import { setGlobalContext } from '@netlify/opentelemetry-utils';
 import { diag } from '@opentelemetry/api';
 import argsParser from 'yargs-parser';
 import { startTracing, stopTracing } from './sdk-setup.js';
-import { findExecutablePackageJSON, setGlobalContext } from './util.js';
+import { findExecutablePackageJSON } from './util.js';
 const DEFAULT_OTEL_TRACING_PORT = 4317;
 const DEFAULT_OTEL_ENDPOINT_PROTOCOL = 'http';
 const defaultOptions = {

package/lib/sdk-setup.d.ts

@@ -23,10 +23,3 @@ export type TracingOptions = {
 export declare const startTracing: (options: TracingOptions, packageJson: PackageJson) => Promise<import("@opentelemetry/api").Context | undefined>;
 /** Stops the tracing service if there's one running. This will flush any ongoing events */
 export declare const stopTracing: () => Promise<void>;
-/** Sets attributes to be propagated across child spans under the current active context
- * TODO this method will be removed from this package once we move it to a dedicated one to be shared between build,
- * this setup and any other node module which might use our open telemetry setup
- * */
-export declare const setMultiSpanAttributes: (attributes: {
-    [key: string]: string;
-}) => import("@opentelemetry/api").Context;

package/lib/sdk-setup.js

@@ -1,5 +1,6 @@
 import { HoneycombSDK } from '@honeycombio/opentelemetry-node';
-import { trace, diag, context, propagation, DiagLogLevel, TraceFlags } from '@opentelemetry/api';
+import { setMultiSpanAttributes } from '@netlify/opentelemetry-utils';
+import { trace, diag, context, DiagLogLevel, TraceFlags } from '@opentelemetry/api';
 import { Resource } from '@opentelemetry/resources';
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 import { getDiagLogger, loadBaggageFromFile } from './util.js';
@@ -59,16 +60,3 @@ export const stopTracing = async function () {
         diag.error(e);
     }
 };
-/** Sets attributes to be propagated across child spans under the current active context
- * TODO this method will be removed from this package once we move it to a dedicated one to be shared between build,
- * this setup and any other node module which might use our open telemetry setup
- * */
-export const setMultiSpanAttributes = function (attributes) {
-    const currentBaggage = propagation.getBaggage(context.active());
-    // Create a baggage if there's none
-    let baggage = currentBaggage === undefined ? propagation.createBaggage() : currentBaggage;
-    Object.entries(attributes).forEach(([key, value]) => {
-        baggage = baggage.setEntry(key, { value });
-    });
-    return propagation.setBaggage(context.active(), baggage);
-};

package/lib/util.d.ts

@@ -1,19 +1,10 @@
-import { DiagLogger, Context } from '@opentelemetry/api';
+import { DiagLogger } from '@opentelemetry/api';
 import { PackageJson } from 'read-pkg-up';
 /** Given a simple logging function return a `DiagLogger`. Used to setup our system logger as the diag logger.*/
 export declare const getDiagLogger: (debug: boolean, systemLogFile?: number) => DiagLogger;
+/** Loads the baggage attributes from a baggage file which follows W3C Baggage specification */
 export declare const loadBaggageFromFile: (baggageFilePath?: string) => Promise<Record<string, string>>;
 /**
  * Given a path to a node executable (potentially a symlink) get the module packageJson
  */
 export declare const findExecutablePackageJSON: (path: string) => Promise<PackageJson>;
-/**
- * Sets global context to be used when initialising our root span
- * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
- */
-export declare const setGlobalContext: (ctx: Context) => void;
-/**
- * Gets the global context to be used when initialising our root span
- * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
- */
-export declare const getGlobalContext: () => Context;

package/lib/util.js

@@ -1,6 +1,6 @@
 import { createWriteStream } from 'node:fs';
 import { realpath, readFile } from 'node:fs/promises';
-import { diag, context } from '@opentelemetry/api';
+import { diag } from '@opentelemetry/api';
 import { parseKeyPairsIntoRecord } from '@opentelemetry/core/build/src/baggage/utils.js';
 import { readPackageUp } from 'read-pkg-up';
 /**
@@ -50,7 +50,7 @@ systemLogFile) {
         warn: otelLogger,
     };
 };
-//** Loads the baggage attributes from a baggage file which follows W3C Baggage specification */
+/** Loads the baggage attributes from a baggage file which follows W3C Baggage specification */
 export const loadBaggageFromFile = async function (baggageFilePath) {
     if (baggageFilePath === undefined || baggageFilePath.length === 0) {
         diag.warn('No baggage file path provided, no context loaded');
@@ -91,20 +91,3 @@ export const findExecutablePackageJSON = async function (path) {
         return {};
     }
 };
-/**
- * Sets global context to be used when initialising our root span
- * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
- */
-export const setGlobalContext = function (ctx) {
-    global['NETLIFY_GLOBAL_CONTEXT'] = ctx;
-};
-/**
- * Gets the global context to be used when initialising our root span
- * TODO this will move to a shared package (opentelemetry-utils) to scope the usage of this global property there
- */
-export const getGlobalContext = function () {
-    if (global['NETLIFY_GLOBAL_CONTEXT'] === undefined) {
-        return context.active();
-    }
-    return global['NETLIFY_GLOBAL_CONTEXT'];
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/opentelemetry-sdk-setup",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Opentelemetry SDK setup script",
   "type": "module",
   "bin": {
@@ -30,6 +30,7 @@
   "author": "Netlify Inc.",
   "dependencies": {
     "@honeycombio/opentelemetry-node": "^0.6.0",
+    "@netlify/opentelemetry-utils": "^1.0.1",
     "@opentelemetry/api": "~1.6.0",
     "@opentelemetry/core": "^1.17.1",
     "@opentelemetry/resources": "^1.18.1",
@@ -47,5 +48,5 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "gitHead": "5aef135bf29606313b5e2547c4c7d77c8ff64d56"
+  "gitHead": "9c4fb7ba7f7cecedfbeced71de24e01ef0828b90"
 }