@netlify/build 29.31.3 → 29.31.4

package/lib/core/build.d.ts

@@ -1,6 +1,5 @@
 import type { BuildFlags } from './types.js';
 export declare const startBuild: (flags: Partial<BuildFlags>) => {
-    rootTracingContext: import("@opentelemetry/api").Context | undefined;
     debug: boolean;
     systemLogFile: number | undefined;
     errorMonitor: any;

package/lib/core/build.js

@@ -12,7 +12,6 @@ import { reportStatuses } from '../status/report.js';
 import { getDevSteps, getSteps } from '../steps/get.js';
 import { runSteps } from '../steps/run_steps.js';
 import { initTimers, measureDuration } from '../time/main.js';
-import { startTracing } from '../tracing/main.js';
 import { getConfigOpts, loadConfig } from './config.js';
 import { getConstants } from './constants.js';
 import { doDryRun } from './dry.js';
@@ -28,10 +27,9 @@ export const startBuild = function (flags) {
     if (!flags.quiet) {
         logBuildStart(logs);
     }
-    const { bugsnagKey, tracingOpts, debug, systemLogFile, ...flagsA } = normalizeFlags(flags, logs);
-    const errorMonitor = startErrorMonitor({ flags: { tracingOpts, debug, systemLogFile, ...flagsA }, logs, bugsnagKey });
-    const rootTracingContext = startTracing(tracingOpts, getSystemLogger(logs, debug, systemLogFile));
-    return { ...flagsA, rootTracingContext, debug, systemLogFile, errorMonitor, logs, timers };
+    const { bugsnagKey, debug, systemLogFile, ...flagsA } = normalizeFlags(flags, logs);
+    const errorMonitor = startErrorMonitor({ flags: { debug, systemLogFile, ...flagsA }, logs, bugsnagKey });
+    return { ...flagsA, debug, systemLogFile, errorMonitor, logs, timers };
 };
 const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, packagePath, repositoryRoot, apiHost, token, siteId, context, branch, baseRelDir, env: envOpt, debug, systemLogFile, verbose, nodePath, functionsDistDir, edgeFunctionsDistDir, cacheDir, dry, mode, offline, deployId, buildId, testOpts, errorMonitor, errorParams, logs, timers, buildbotServerSocket, sendStatus, saveConfig, featureFlags, timeline, devCommand, quiet, framework, explicitSecretKeys, edgeFunctionsBootstrapURL, eventHandlers, }) {
     const configOpts = getConfigOpts({

package/lib/core/flags.d.ts

@@ -160,65 +160,6 @@ export const FLAGS: {
         describe: string;
         hidden: boolean;
     };
-    tracing: {
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.enabled': {
-        boolean: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.preloadingEnabled': {
-        boolean: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.apiKey': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.httpProtocol': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.host': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.port': {
-        number: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.traceId': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.parentSpanId': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.sampleRate': {
-        number: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.traceFlags': {
-        number: boolean;
-        describe: string;
-        hidden: boolean;
-    };
-    'tracing.baggageFilePath': {
-        string: boolean;
-        describe: string;
-        hidden: boolean;
-    };
     offline: {
         boolean: boolean;
         describe: string;

package/lib/core/flags.js

@@ -193,65 +193,6 @@ Default: false`,
         describe: 'Statsd port',
         hidden: true,
     },
-    tracing: {
-        describe: 'Tracing related options',
-        hidden: true,
-    },
-    'tracing.enabled': {
-        boolean: true,
-        describe: 'Enable distributed tracing for build',
-        hidden: true,
-    },
-    'tracing.preloadingEnabled': {
-        boolean: true,
-        describe: 'Enable distributed tracing for build via module preloading, to be removed once fully rolled out',
-        hidden: true,
-    },
-    'tracing.apiKey': {
-        string: true,
-        describe: 'API Key for the tracing backend provider',
-        hidden: true,
-    },
-    'tracing.httpProtocol': {
-        string: true,
-        describe: 'Traces backend protocol. HTTP or HTTPS.',
-        hidden: true,
-    },
-    'tracing.host': {
-        string: true,
-        describe: 'Traces backend host',
-        hidden: true,
-    },
-    'tracing.port': {
-        number: true,
-        describe: 'Traces backend port',
-        hidden: true,
-    },
-    'tracing.traceId': {
-        string: true,
-        describe: 'Trace ID used to stitch the emited traces to',
-        hidden: true,
-    },
-    'tracing.parentSpanId': {
-        string: true,
-        describe: 'Parent Span ID used to stitch the root parent span to',
-        hidden: true,
-    },
-    'tracing.sampleRate': {
-        number: true,
-        describe: 'Trace sample rate for the given trace ID',
-        hidden: true,
-    },
-    'tracing.traceFlags': {
-        number: true,
-        describe: 'Trace flags containing the trace settings for the given trace ID',
-        hidden: true,
-    },
-    'tracing.baggageFilePath': {
-        string: true,
-        describe: '',
-        hidden: true,
-    },
     offline: {
         boolean: true,
         describe: `Do not send requests to the Netlify API to retrieve site settings.

package/lib/core/main.js

@@ -1,3 +1,4 @@
+import { setMultiSpanAttributes, getGlobalContext } from '@netlify/opentelemetry-utils';
 import { trace, context } from '@opentelemetry/api';
 import { handleBuildError } from '../error/handle.js';
 import { reportError } from '../error/report.js';
@@ -5,7 +6,6 @@ import { getSystemLogger } from '../log/logger.js';
 import { logTimer, logBuildSuccess } from '../log/messages/core.js';
 import { trackBuildComplete } from '../telemetry/main.js';
 import { reportTimers } from '../time/report.js';
-import { stopTracing, setMultiSpanAttributes } from '../tracing/main.js';
 import { execBuild, startBuild } from './build.js';
 import { reportMetrics } from './report_metrics.js';
 import { getSeverity } from './severity.js';
@@ -17,7 +17,7 @@ const tracer = trace.getTracer('core');
  * @param flags - build configuration CLI flags
  */
 export async function buildSite(flags = {}) {
-    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, rootTracingContext, eventHandlers, ...flagsA } = startBuild(flags);
+    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, eventHandlers, ...flagsA } = startBuild(flags);
     const errorParams = { errorMonitor, mode, logs, debug, testOpts };
     const systemLog = getSystemLogger(logs, debug, systemLogFile);
     const attributes = {
@@ -27,7 +27,9 @@ export async function buildSite(flags = {}) {
         'site.id': flagsA.siteId,
         'build.info.primary_framework': framework,
     };
-    const rootCtx = context.with(rootTracingContext, () => setMultiSpanAttributes(attributes));
+    // Gets the initial root context passed to the build process and adds a series of attributes we're going to use across
+    // the trace
+    const rootCtx = context.with(getGlobalContext(), () => setMultiSpanAttributes(attributes));
     return await tracer.startActiveSpan('exec-build', {}, rootCtx, async (span) => {
         try {
             const { pluginsOptions, netlifyConfig: netlifyConfigA, siteInfo, userNodeVersion, stepsCount, timers, durationNs, configMutations, metrics, } = await execBuild({
@@ -103,8 +105,6 @@ export async function buildSite(flags = {}) {
         }
         finally {
             span.end();
-            // Ensure we flush the resulting spans
-            await stopTracing();
         }
     });
 }

package/lib/core/normalize_flags.d.ts

@@ -1,4 +1,4 @@
-import type { BuildFlags, Mode, TestOptions, TracingOptions } from './types.js';
+import type { BuildFlags, Mode, TestOptions } from './types.js';
 export type ResolvedFlags = {
     env: Record<string, unknown>;
     token: string;
@@ -32,7 +32,6 @@ export type ResolvedFlags = {
     };
     bugsnagKey?: string;
     systemLogFile?: number;
-    tracingOpts: TracingOptions;
 };
 /** Normalize CLI flags  */
 export declare const normalizeFlags: (flags: Partial<BuildFlags>, logs: any) => ResolvedFlags;

package/lib/core/normalize_flags.js

@@ -22,7 +22,6 @@ export const normalizeFlags = function (flags, logs) {
         ...rawFlags,
         ...telemetryFlag,
         statsdOpts: { ...defaultFlags.statsd, ...rawFlags.statsd },
-        tracingOpts: { ...defaultFlags.tracing, ...rawFlags.tracing },
         featureFlags: { ...defaultFlags.featureFlags, ...rawFlags.featureFlags },
     };
     const normalizedFlags = removeFalsy(mergedFlags);

package/lib/core/types.d.ts

@@ -19,8 +19,6 @@ export type BuildCLIFlags = {
     /** The invoking service of netlify build */
     mode: Mode;
     telemetry: boolean;
-    /** Distributed tracing properties for this build*/
-    tracing: TracingOptions;
     /**
      * Buffer output instead of printing it
      * @default false
@@ -76,20 +74,4 @@ export type ErrorParam = {
     childEnv?: any;
     netlifyConfig?: NetlifyConfig;
 };
-export type TracingOptions = {
-    enabled: boolean;
-    preloadingEnabled: boolean;
-    httpProtocol: string;
-    host: string;
-    port: number;
-    /** API Key used for a dedicated trace provider */
-    apiKey: string;
-    /** Sample rate being used for this trace, this allows for consistent probability sampling */
-    sampleRate: number;
-    /** Properties of the root span and trace id used to stitch context */
-    traceId: string;
-    traceFlags: number;
-    parentSpanId: string;
-    baggageFilePath: string;
-};
 export {};

package/lib/error/report.js

@@ -1,6 +1,6 @@
 import { isNetlifyMaintainedPlugin } from '../plugins/internal.js';
 import { closeClient, formatTags, normalizeTagName, startClient, validateStatsDOptions, } from '../report/statsd.js';
-import { addErrorToActiveSpan } from '../tracing/main.js';
+import { addBuildErrorToActiveSpan } from '../tracing/main.js';
 import { getErrorInfo } from './info.js';
 const TOP_PARENT_TAG = 'run_netlify_build';
 /**
@@ -8,7 +8,7 @@ const TOP_PARENT_TAG = 'run_netlify_build';
  * Sends to statsd daemon.
  */
 export const reportError = async function (error, statsdOpts, framework) {
-    addErrorToActiveSpan(error);
+    addBuildErrorToActiveSpan(error);
     if (!validateStatsDOptions(statsdOpts)) {
         return;
     }

package/lib/steps/error.js

@@ -1,10 +1,11 @@
+import { addEventToActiveSpan } from '@netlify/opentelemetry-utils';
 import { cancelBuild } from '../error/cancel.js';
 import { handleBuildError } from '../error/handle.js';
 import { getFullErrorInfo, parseErrorInfo } from '../error/parse/parse.js';
 import { serializeErrorStatus } from '../error/parse/serialize_status.js';
 import { isPluginLocation } from '../error/types.js';
 import { isSoftFailEvent } from '../plugins/events.js';
-import { addErrorToActiveSpan, addEventToActiveSpan } from '../tracing/main.js';
+import { addBuildErrorToActiveSpan } from '../tracing/main.js';
 import { isTrustedPlugin } from './plugin.js';
 /**
  * Handle build command errors and plugin errors:
@@ -16,7 +17,7 @@ import { isTrustedPlugin } from './plugin.js';
  * This also computes error statuses that are sent to the API.
  */
 export const handleStepError = function ({ event, newError, childEnv, mode, api, errorMonitor, deployId, coreStep, netlifyConfig, logs, debug, testOpts, }) {
-    addErrorToActiveSpan(newError);
+    addBuildErrorToActiveSpan(newError);
     // Core steps do not report error statuses
     if (coreStep !== undefined) {
         return { newError };

package/lib/steps/run_step.js

@@ -1,10 +1,10 @@
+import { setMultiSpanAttributes } from '@netlify/opentelemetry-utils';
 import { trace } from '@opentelemetry/api';
 import { addMutableConstants } from '../core/constants.js';
 import { logStepStart } from '../log/messages/steps.js';
 import { runsAlsoOnBuildFailure, runsOnlyOnBuildFailure } from '../plugins/events.js';
 import { normalizeTagName } from '../report/statsd.js';
 import { measureDuration } from '../time/main.js';
-import { setMultiSpanAttributes } from '../tracing/main.js';
 import { fireCoreStep } from './core_step.js';
 import { firePluginStep } from './plugin.js';
 import { getStepReturn } from './return.js';

package/lib/tracing/main.d.ts

@@ -1,29 +1,5 @@
-import { Context } from '@opentelemetry/api';
-import type { TracingOptions } from '../core/types.js';
-/**
- * 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;
-/**
- * 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;
-/** Starts the tracing SDK, if there's already a tracing service this will be a no-op */
-export declare const startTracing: (options: TracingOptions, logger: (...args: any[]) => void) => 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 */
-export declare const setMultiSpanAttributes: (attributes: {
-    [key: string]: string;
-}) => Context;
 /** Add error information to the current active span (if any) */
-export declare const addErrorToActiveSpan: (error: Error) => void;
-export declare const addEventToActiveSpan: (eventName: string, attributes?: {
-    [key: string]: string;
-} | undefined) => void;
-export declare const loadBaggageFromFile: (baggageFilePath: string) => Context;
+export declare const addBuildErrorToActiveSpan: (error: Error) => void;
 /** Attributes used for the root span of our execution */
 export type RootExecutionAttributes = {
     'build.id': string;

package/lib/tracing/main.js

@@ -1,141 +1,15 @@
-import { readFileSync } from 'node:fs';
-import { HoneycombSDK } from '@honeycombio/opentelemetry-node';
-import { context, trace, propagation, SpanStatusCode, diag, DiagLogLevel, } from '@opentelemetry/api';
-import { parseKeyPairsIntoRecord } from '@opentelemetry/core/build/src/baggage/utils.js';
+import { addErrorToActiveSpan } from '@netlify/opentelemetry-utils';
 import { isBuildError } from '../error/info.js';
 import { parseErrorInfo } from '../error/parse/parse.js';
 import { buildErrorToTracingAttributes } from '../error/types.js';
-import { ROOT_PACKAGE_JSON } from '../utils/json.js';
-let sdk;
-/** Given a simple logging function return a `DiagLogger`. Used to setup our system logger as the diag logger.*/
-const getOtelLogger = function (logger) {
-    const otelLogger = (...args) => {
-        // Debug log msgs can be an array of 1 or 2 elements with the second element being an array fo multiple elements
-        const msgs = args.flat(1);
-        logger('[otel-traces]', ...msgs);
-    };
-    return {
-        debug: otelLogger,
-        info: otelLogger,
-        error: otelLogger,
-        verbose: otelLogger,
-        warn: otelLogger,
-    };
-};
-/**
- * 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'];
-};
-/**
- * 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;
-};
-/** Starts the tracing SDK, if there's already a tracing service this will be a no-op */
-export const startTracing = function (options, logger) {
-    // As we roll out the new way to initialise the SDK, if we detect preloading is enabled,
-    // it means we're using `@netlify/opentelemetry-sdk-setup` so we must get the initial context from the global store
-    if (options.preloadingEnabled) {
-        return getGlobalContext();
-    }
-    if (!options.enabled)
-        return;
-    if (sdk)
-        return;
-    sdk = new HoneycombSDK({
-        serviceName: ROOT_PACKAGE_JSON.name,
-        protocol: 'grpc',
-        apiKey: options.apiKey,
-        endpoint: `${options.httpProtocol}://${options.host}:${options.port}`,
-        sampleRate: options.sampleRate,
-        // Turn off auto resource detection so that we fully control the attributes we export
-        autoDetectResources: false,
-    });
-    // Set the diagnostics logger to our system logger. We also need to suppress the override msg
-    // in case there's a default console logger already registered (it would log a msg to it)
-    diag.setLogger(getOtelLogger(logger), { logLevel: DiagLogLevel.INFO, suppressOverrideMessage: true });
-    sdk.start();
-    // Loads the contents of the passed baggageFilePath into the baggage
-    const baggageCtx = loadBaggageFromFile(options.baggageFilePath);
-    // Sets the current trace ID and span ID based on the options received
-    // this is used as a way to propagate trace context from Buildbot
-    const ctx = trace.setSpanContext(baggageCtx, {
-        traceId: options.traceId,
-        spanId: options.parentSpanId,
-        traceFlags: options.traceFlags,
-        isRemote: true,
-    });
-    return ctx;
-};
-/** Stops the tracing service if there's one running. This will flush any ongoing events */
-export const stopTracing = async function () {
-    if (!sdk)
-        return;
-    try {
-        // The shutdown method might return an error if we fail to flush the traces
-        // We handle it and use our diagnostics logger
-        await sdk.shutdown();
-        sdk = undefined;
-    }
-    catch (e) {
-        diag.error(e);
-    }
-};
-/** Sets attributes to be propagated across child spans under the current active context */
-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);
-};
 /** Add error information to the current active span (if any) */
-export const addErrorToActiveSpan = function (error) {
-    const span = trace.getActiveSpan();
-    if (!span)
-        return;
+export const addBuildErrorToActiveSpan = function (error) {
+    let buildErrorAttributes;
     if (isBuildError(error)) {
         const buildError = parseErrorInfo(error);
         if (buildError.severity == 'none')
             return;
-        span.setAttributes(buildErrorToTracingAttributes(buildError));
-    }
-    span.recordException(error);
-    span.setStatus({
-        code: SpanStatusCode.ERROR,
-        message: error.message,
-    });
-};
-export const addEventToActiveSpan = function (eventName, attributes) {
-    const span = trace.getActiveSpan();
-    if (!span)
-        return;
-    span.addEvent(eventName, attributes);
-};
-//** Loads the baggage attributes from a baggabe file which follows W3C Baggage specification */
-export const loadBaggageFromFile = function (baggageFilePath) {
-    if (baggageFilePath.length === 0) {
-        diag.warn('Empty baggage file path provided, no context loaded');
-        return context.active();
-    }
-    let baggageString;
-    try {
-        baggageString = readFileSync(baggageFilePath, 'utf-8');
-    }
-    catch (error) {
-        diag.error(error);
-        return context.active();
+        buildErrorAttributes = buildErrorToTracingAttributes(buildError);
     }
-    const parsedBaggage = parseKeyPairsIntoRecord(baggageString);
-    return setMultiSpanAttributes(parsedBaggage);
+    addErrorToActiveSpan(error, buildErrorAttributes);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.31.3",
+  "version": "29.31.4",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/index.js",
@@ -65,19 +65,18 @@
   "license": "MIT",
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
-    "@honeycombio/opentelemetry-node": "^0.5.0",
     "@netlify/blobs": "^6.3.1",
     "@netlify/cache-utils": "^5.1.5",
-    "@netlify/config": "^20.10.0",
+    "@netlify/config": "^20.10.1",
     "@netlify/edge-bundler": "10.1.3",
     "@netlify/framework-info": "^9.8.10",
     "@netlify/functions-utils": "^5.2.46",
     "@netlify/git-utils": "^5.1.1",
+    "@netlify/opentelemetry-utils": "^1.0.1",
     "@netlify/plugins-list": "^6.73.0",
     "@netlify/run-utils": "^5.1.1",
     "@netlify/zip-it-and-ship-it": "9.28.2",
-    "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/core": "^1.17.1",
+    "@opentelemetry/api": "~1.6.0",
     "@sindresorhus/slugify": "^2.0.0",
     "ansi-escapes": "^6.0.0",
     "chalk": "^5.0.0",
@@ -126,6 +125,7 @@
   },
   "devDependencies": {
     "@netlify/nock-udp": "^3.1.2",
+    "@opentelemetry/sdk-trace-base": "^1.18.1",
     "@types/node": "^14.18.53",
     "atob": "^2.1.2",
     "ava": "^4.0.0",
@@ -147,7 +147,7 @@
     "yarn": "^1.22.4"
   },
   "peerDependencies": {
-    "@netlify/opentelemetry-sdk-setup": "^1.0.1"
+    "@netlify/opentelemetry-sdk-setup": "^1.0.2"
   },
   "peerDependenciesMeta": {
     "@netlify/opentelemetry-sdk-setup": {
@@ -157,5 +157,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "a623ef20d9da0c1ce753e5c97db1de8dd987c857"
+  "gitHead": "9c4fb7ba7f7cecedfbeced71de24e01ef0828b90"
 }