@vtex/api 6.51.3 → 6.53.0-beta.0

package/lib/service/telemetry/resourceAttributes.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClusterResourceAttributes = void 0;
+const constants_1 = require("../../constants");
+const normalizeAttribute = (value) => {
+    const normalized = value === null || value === void 0 ? void 0 : value.trim();
+    return normalized || undefined;
+};
+const getClusterResourceAttributes = (clusterId, clusterRole) => {
+    const attributes = {};
+    const normalizedClusterId = normalizeAttribute(clusterId);
+    const normalizedClusterRole = normalizeAttribute(clusterRole);
+    if (normalizedClusterId) {
+        attributes[constants_1.AttributeKeys.VTEX_IO_CLUSTER_ID] = normalizedClusterId;
+    }
+    if (normalizedClusterRole) {
+        attributes[constants_1.AttributeKeys.VTEX_IO_CLUSTER_ROLE] = normalizedClusterRole;
+    }
+    return attributes;
+};
+exports.getClusterResourceAttributes = getClusterResourceAttributes;

package/lib/service/worker/index.d.ts

@@ -1,6 +1,7 @@
 import Koa from 'koa';
 import { MetricsAccumulator } from '../../metrics/MetricsAccumulator';
 import { ServiceJSON } from './runtime/typings';
+export declare const onMessage: (service: ServiceJSON) => (message: any) => void;
 export declare const startWorker: (serviceJSON: ServiceJSON) => Koa<Koa.DefaultState, Koa.DefaultContext>;
 declare global {
     namespace NodeJS {

package/lib/service/worker/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startWorker = void 0;
+exports.startWorker = exports.onMessage = void 0;
 const http_1 = require("http");
 const koa_1 = __importDefault(require("koa"));
 const koa_compress_1 = __importDefault(require("koa-compress"));
@@ -14,6 +14,7 @@ const MetricsAccumulator_1 = require("../../metrics/MetricsAccumulator");
 const loaders_1 = require("../loaders");
 const console_1 = require("../logger/console");
 const loggerTypes_1 = require("../logger/loggerTypes");
+const clusterMetricsAggregator_1 = require("../metrics/clusterMetricsAggregator");
 const requestMetricsMiddleware_1 = require("../metrics/requestMetricsMiddleware");
 const TracerSingleton_1 = require("../tracing/TracerSingleton");
 const tracingMiddlewares_1 = require("../tracing/tracingMiddlewares");
@@ -54,7 +55,12 @@ const onMessage = (service) => (message) => {
     else if ((0, statusTrack_1.isStatusTrack)(message)) {
         (0, statusTrack_1.trackStatus)();
     }
-    else {
+    else if ((0, clusterMetricsAggregator_1.isAggMetricsResponse)(message)) {
+        (0, clusterMetricsAggregator_1.handleMasterMetricsResponse)(message);
+    }
+    else if (!(0, clusterMetricsAggregator_1.isPromClientMessage)(message)) {
+        // prom-client's own cluster messages are handled by its worker listener;
+        // anything else that reaches here is genuinely unexpected.
         listeners_1.logger.warn({
             content: message,
             message: 'Master sent message',
@@ -62,6 +68,7 @@ const onMessage = (service) => (message) => {
         });
     }
 };
+exports.onMessage = onMessage;
 const createAppHttpHandlers = ({ config: { routes, clients } }, serviceJSON, globalLimiter) => {
     if (routes && clients) {
         return Object.keys(routes).reduce((acc, routeId) => {
@@ -153,11 +160,16 @@ const startWorker = (serviceJSON) => {
     var _a, _b;
     (0, listeners_1.addProcessListeners)();
     const tracer = TracerSingleton_1.TracerSingleton.getTracer();
+    // In multi-worker mode install prom-client's worker-side cluster responder so
+    // the master can collect this worker's registry for the aggregated /metrics.
+    if (serviceJSON.workers > 1) {
+        (0, clusterMetricsAggregator_1.ensureWorkerAggregatorRegistry)();
+    }
     const app = new koa_1.default();
     app.proxy = true;
     app
         .use(error_1.error)
-        .use((0, middlewares_1.prometheusLoggerMiddleware)())
+        .use((0, middlewares_1.prometheusLoggerMiddleware)(serviceJSON.workers))
         .use((0, tracingMiddlewares_1.addTracingMiddleware)(tracer))
         .use((0, requestMetricsMiddleware_1.addRequestMetricsMiddleware)())
         .use((0, middlewares_1.addMetricsLoggerMiddleware)())
@@ -190,7 +202,7 @@ const startWorker = (serviceJSON) => {
         const privateHandlersRouter = routerFromPrivateHttpHandlers(httpHandlers.pvt);
         app.use(privateHandlersRouter.routes());
     }
-    process.on('message', onMessage(serviceJSON));
+    process.on('message', (0, exports.onMessage)(serviceJSON));
     return app;
 };
 exports.startWorker = startWorker;

package/lib/service/worker/runtime/builtIn/middlewares.d.ts

@@ -1,4 +1,4 @@
 import { ServiceContext } from '../typings';
 export declare function recorderMiddleware(ctx: ServiceContext, next: () => Promise<void>): Promise<void>;
 export declare const addMetricsLoggerMiddleware: () => (ctx: ServiceContext, next: () => Promise<void>) => Promise<void>;
-export declare const prometheusLoggerMiddleware: () => (ctx: ServiceContext, next: () => Promise<void>) => Promise<void>;
+export declare const prometheusLoggerMiddleware: (workers?: number) => (ctx: ServiceContext, next: () => Promise<void>) => Promise<void>;

package/lib/service/worker/runtime/builtIn/middlewares.js

@@ -4,6 +4,7 @@ exports.prometheusLoggerMiddleware = exports.addMetricsLoggerMiddleware = export
 const prom_client_1 = require("prom-client");
 const constants_1 = require("../../../../constants");
 const metricsLogger_1 = require("../../../logger/metricsLogger");
+const clusterMetricsAggregator_1 = require("../../../metrics/clusterMetricsAggregator");
 const EventLoopLagMeasurer_1 = require("../../../tracing/metrics/measurers/EventLoopLagMeasurer");
 const recorder_1 = require("../utils/recorder");
 async function recorderMiddleware(ctx, next) {
@@ -22,10 +23,14 @@ const addMetricsLoggerMiddleware = () => {
     };
 };
 exports.addMetricsLoggerMiddleware = addMetricsLoggerMiddleware;
-const prometheusLoggerMiddleware = () => {
+const prometheusLoggerMiddleware = (workers = 1) => {
     (0, prom_client_1.collectDefaultMetrics)();
     const eventLoopLagMeasurer = new EventLoopLagMeasurer_1.EventLoopLagMeasurer();
     eventLoopLagMeasurer.start();
+    // In multi-worker mode each worker holds only its own registry, so /metrics
+    // must serve the cluster-wide aggregate requested from the master over IPC.
+    // In single-worker mode (LINKED / workers:1) the local registry is complete.
+    const isMultiWorker = workers > 1;
     return async (ctx, next) => {
         if (ctx.request.path !== '/metrics') {
             return next();
@@ -36,7 +41,7 @@ const prometheusLoggerMiddleware = () => {
         }
         await eventLoopLagMeasurer.updateInstrumentsAndReset();
         ctx.set('Content-Type', prom_client_1.register.contentType);
-        ctx.body = await prom_client_1.register.metrics();
+        ctx.body = isMultiWorker ? await (0, clusterMetricsAggregator_1.requestAggregatedMetrics)() : await prom_client_1.register.metrics();
         ctx.status = 200;
     };
 };

package/lib/service/worker/runtime/statusTrack.js

@@ -14,7 +14,10 @@ const isStatusTrackBroadcast = (message) => message === BROADCAST_STATUS_TRACK;
 exports.isStatusTrackBroadcast = isStatusTrackBroadcast;
 const statusTrackHandler = async (ctx) => {
     var _a, _b, _c;
-    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:status-track');
+    // Parity with the other builtin handlers: name the request so its samples don't
+    // land in the catch-all `handler="undefined"` bucket.
+    ctx.requestHandlerName = 'builtin:status-track';
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
     if (!constants_1.LINKED) {
         (_c = process.send) === null || _c === void 0 ? void 0 : _c.call(process, BROADCAST_STATUS_TRACK);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.51.3",
+  "version": "6.53.0-beta.0",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -47,9 +47,14 @@
   },
   "license": "MIT",
   "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/host-metrics": "0.35.5",
+    "@opentelemetry/instrumentation": "0.57.2",
+    "@opentelemetry/instrumentation-koa": "0.47.1",
     "@types/koa": "^2.11.0",
     "@types/koa-compose": "^3.2.3",
-    "@vtex/diagnostics-nodejs": "0.1.0-beta.10",
+    "@vtex/diagnostics-nodejs": "0.1.8-io",
+    "@vtex/diagnostics-semconv": "5.5.2",
     "@vtex/node-error-report": "^0.0.3",
     "@wry/equality": "^0.1.9",
     "agentkeepalive": "^4.0.2",