@netlify/build 29.15.0 → 29.15.2

package/lib/core/build.js

@@ -30,8 +30,8 @@ export const startBuild = function (flags) {
     }
     const { bugsnagKey, tracingOpts, debug, systemLogFile, ...flagsA } = normalizeFlags(flags, logs);
     const errorMonitor = startErrorMonitor({ flags: { tracingOpts, debug, systemLogFile, ...flagsA }, logs, bugsnagKey });
-    startTracing(tracingOpts, getSystemLogger(logs, debug, systemLogFile));
-    return { ...flagsA, debug, systemLogFile, errorMonitor, logs, timers };
+    const rootTracingContext = startTracing(tracingOpts, getSystemLogger(logs, debug, systemLogFile));
+    return { ...flagsA, rootTracingContext, debug, systemLogFile, errorMonitor, logs, timers };
 };
 const tExecBuild = async function ({ config, defaultConfig, cachedConfig, cachedConfigPath, outputConfigPath, cwd, 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, }) {
     const configOpts = getConfigOpts({

package/lib/core/flags.js

@@ -198,6 +198,16 @@ Default: false`,
         describe: 'Enable distributed tracing for build',
         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',

package/lib/core/main.js

@@ -1,4 +1,4 @@
-import { trace } from '@opentelemetry/api';
+import { trace, context } from '@opentelemetry/api';
 import { handleBuildError } from '../error/handle.js';
 import { reportError } from '../error/report.js';
 import { getSystemLogger } from '../log/logger.js';
@@ -19,7 +19,7 @@ const tracer = trace.getTracer('core');
  * @param flags - build configuration CLI flags
  */
 export default async function buildSite(flags = {}) {
-    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, ...flagsA } = startBuild(flags);
+    const { errorMonitor, framework, mode, logs, debug, systemLogFile, testOpts, statsdOpts, dry, telemetry, buildId, deployId, rootTracingContext, ...flagsA } = startBuild(flags);
     const errorParams = { errorMonitor, mode, logs, debug, testOpts };
     const systemLog = getSystemLogger(logs, debug, systemLogFile);
     const attributes = {
@@ -28,7 +28,7 @@ export default async function buildSite(flags = {}) {
         'deploy.context': flagsA.context,
         'site.id': flagsA.siteId,
     };
-    const rootCtx = setMultiSpanAttributes(attributes);
+    const rootCtx = context.with(rootTracingContext, () => 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({

package/lib/core/normalize_flags.js

@@ -8,6 +8,7 @@ const DEFAULT_FUNCTIONS_DIST = '.netlify/functions/';
 const DEFAULT_CACHE_DIR = '.netlify/cache/';
 const DEFAULT_STATSD_PORT = 8125;
 const DEFAULT_OTEL_TRACING_PORT = 4317;
+const DEFAULT_OTEL_ENDPOINT_PROTOCOL = 'http';
 /** Normalize CLI flags  */
 export const normalizeFlags = function (flags, logs) {
     const rawFlags = removeFalsy(flags);
@@ -53,7 +54,14 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {
         testOpts: {},
         featureFlags: DEFAULT_FEATURE_FLAGS,
         statsd: { port: DEFAULT_STATSD_PORT },
-        tracing: { enabled: false, port: DEFAULT_OTEL_TRACING_PORT },
+        // tracing.apiKey defaults to '-' else we'll get warning logs if not using
+        // honeycomb directly - https://github.com/honeycombio/honeycomb-opentelemetry-node/issues/201
+        tracing: {
+            enabled: false,
+            apiKey: '-',
+            httpProtocol: DEFAULT_OTEL_ENDPOINT_PROTOCOL,
+            port: DEFAULT_OTEL_TRACING_PORT,
+        },
         timeline: 'build',
         quiet: false,
     };

package/lib/steps/run_step.js

@@ -14,7 +14,6 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
     // Add relevant attributes to the upcoming span context
     const attributes = {
         'build.execution.step.name': coreStepName,
-        'build.execution.step.description': coreStepDescription,
         'build.execution.step.package_name': packageName,
         'build.execution.step.id': coreStepId,
         'build.execution.step.loaded_from': loadedFrom,
@@ -22,7 +21,9 @@ export const runStep = async function ({ event, childProcess, packageName, coreS
         'build.execution.step.event': event,
     };
     const spanCtx = setMultiSpanAttributes(attributes);
-    return tracer.startActiveSpan(`run-step-${coreStepId}`, {}, spanCtx, async (span) => {
+    // If there's no `coreStepId` then this is a plugin execution
+    const spanName = `run-step-${coreStepId || 'plugin'}`;
+    return tracer.startActiveSpan(spanName, {}, spanCtx, async (span) => {
         const constantsA = await addMutableConstants({ constants, buildDir, netlifyConfig });
         const shouldRun = await shouldRunStep({
             event,

package/lib/tracing/main.js

@@ -1,12 +1,14 @@
+import { HoneycombSDK } from '@honeycombio/opentelemetry-node';
 import { context, trace, propagation, SpanStatusCode, diag, DiagLogLevel } from '@opentelemetry/api';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
-import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
-import { NodeSDK } from '@opentelemetry/sdk-node';
 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) => logger('[otel-traces]', ...args);
+    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,
@@ -21,13 +23,11 @@ export const startTracing = function (options, logger) {
         return;
     if (sdk)
         return;
-    const traceExporter = new OTLPTraceExporter({
-        url: `http://${options.host}:${options.port}`,
-    });
-    sdk = new NodeSDK({
+    sdk = new HoneycombSDK({
         serviceName: ROOT_PACKAGE_JSON.name,
-        traceExporter,
-        instrumentations: [new HttpInstrumentation()],
+        protocol: 'grpc',
+        apiKey: options.apiKey,
+        endpoint: `${options.httpProtocol}://${options.host}:${options.port}`,
     });
     // 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)
@@ -35,7 +35,7 @@ export const startTracing = function (options, logger) {
     sdk.start();
     // 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
-    trace.setSpanContext(context.active(), {
+    return trace.setSpanContext(context.active(), {
         traceId: options.traceId,
         spanId: options.parentSpanId,
         traceFlags: options.traceFlags,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "29.15.0",
+  "version": "29.15.2",
   "description": "Netlify build module",
   "type": "module",
   "exports": "./lib/core/main.js",
@@ -24,7 +24,6 @@
     "prebuild": "rm -rf lib",
     "postbuild": "npx copyfiles \"src/**/*.yml\" lib/ -u 1",
     "build": "tsc",
-    "pretest": "tsd .",
     "test": "ava",
     "test:dev": "ava -w",
     "test:ci": "c8 -r lcovonly -r text -r json ava",
@@ -64,19 +63,17 @@
   "license": "MIT",
   "dependencies": {
     "@bugsnag/js": "^7.0.0",
+    "@honeycombio/opentelemetry-node": "^0.4.0",
     "@netlify/cache-utils": "^5.1.5",
-    "@netlify/config": "^20.5.1",
+    "@netlify/config": "^20.5.2",
     "@netlify/edge-bundler": "8.16.2",
     "@netlify/framework-info": "^9.8.10",
-    "@netlify/functions-utils": "^5.2.14",
+    "@netlify/functions-utils": "^5.2.15",
     "@netlify/git-utils": "^5.1.1",
     "@netlify/plugins-list": "^6.68.0",
     "@netlify/run-utils": "^5.1.1",
-    "@netlify/zip-it-and-ship-it": "9.11.0",
+    "@netlify/zip-it-and-ship-it": "9.12.0",
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.40.0",
-    "@opentelemetry/instrumentation-http": "^0.40.0",
-    "@opentelemetry/sdk-node": "^0.40.0",
     "@sindresorhus/slugify": "^2.0.0",
     "ansi-escapes": "^6.0.0",
     "chalk": "^5.0.0",
@@ -151,5 +148,5 @@
       "module": "commonjs"
     }
   },
-  "gitHead": "aa46b8321d6f247a0b71e914f1c01291c9a19475"
+  "gitHead": "2bb08a1fb4ad1bca50cee1131b70cbd94a9f08a3"
 }