@vtex/api 7.3.0-beta.4 → 7.3.0

package/CHANGELOG.md

@@ -7,7 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [7.2.8-beta.0] - 2025-12-05
+## [7.2.9-beta.1] - 2025-12-12
+### Changed
+- Increase maximum attributes limit for diagnostics metrics
+
+## [7.2.9-beta.0] - 2025-12-11
+### Fix
+- Add account attribute to diagnostics metrics for improved observability
+
+## [7.2.8-beta.4] - 2025-12-08
 ### Changed
 - New deploy pipeline. No functional changes in the code
 

package/lib/HttpClient/HttpClient.js

@@ -102,7 +102,7 @@ class HttpClient {
             ...config,
             url,
         });
-        const { baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, asyncSetCache, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
+        const { account, baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, asyncSetCache, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
         this.name = name || baseURL || 'unknown';
         this.logger = logger;
         this.cacheableType = cacheableType;
@@ -112,6 +112,7 @@ class HttpClient {
             ...defaultHeaders,
             'Accept-Encoding': 'gzip',
             'User-Agent': userAgent,
+            ...account ? { [constants_1.HeaderKeys.ACCOUNT]: account } : null,
             ...host ? { [constants_1.HeaderKeys.FORWARDED_HOST]: host } : null,
             ...tenant ? { [constants_1.HeaderKeys.TENANT]: (0, tenant_1.formatTenantHeaderValue)(tenant) } : null,
             ...binding ? { [constants_1.HeaderKeys.BINDING]: (0, binding_1.formatBindingHeaderValue)(binding) } : null,

package/lib/HttpClient/middlewares/metrics.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.metricsMiddleware = void 0;
+const constants_1 = require("../../constants");
 const RequestCancelledError_1 = require("../../errors/RequestCancelledError");
 const requestStats_1 = require("../../service/worker/runtime/http/middlewares/requestStats");
 const utils_1 = require("../../utils");
 const retry_1 = require("../../utils/retry");
 const status_1 = require("../../utils/status");
+const DEFAULT_ACCOUNT = 'unknown';
 const metricsMiddleware = ({ metrics, serverTiming, name }) => {
     const serverTimingStart = process.hrtime();
     const serverTimingLabel = (0, utils_1.shrinkTimings)((0, utils_1.formatTimingName)({
@@ -14,7 +16,7 @@ const metricsMiddleware = ({ metrics, serverTiming, name }) => {
         target: name || 'unknown',
     }));
     return async (ctx, next) => {
-        var _a;
+        var _a, _b;
         const start = process.hrtime();
         let status = 'unknown';
         let errorCode;
@@ -90,7 +92,10 @@ const metricsMiddleware = ({ metrics, serverTiming, name }) => {
                 if (global.diagnosticsMetrics) {
                     const elapsed = process.hrtime(start);
                     const rawStatusCode = ((_a = ctx.response) === null || _a === void 0 ? void 0 : _a.status) || errorStatus;
+                    // Extract account from request headers, fallback to default
+                    const account = ((_b = ctx.config.headers) === null || _b === void 0 ? void 0 : _b[constants_1.HeaderKeys.ACCOUNT]) || DEFAULT_ACCOUNT;
                     const baseAttributes = {
+                        [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: account,
                         component: 'http-client',
                         client_metric: ctx.config.metric,
                         status_code: rawStatusCode,

package/lib/metrics/DiagnosticsMetrics.js

@@ -7,7 +7,7 @@ const constants_1 = require("../constants");
  * Maximum number of attributes allowed per metric to control cardinality.
  * This limit applies to external usage (VTEX IO Apps) to prevent unbounded metric dimensions.
  */
-const MAX_ATTRIBUTES = 5;
+const MAX_ATTRIBUTES = 7;
 /**
  * Converts an hrtime tuple [seconds, nanoseconds] to milliseconds.
  */

package/lib/service/metrics/metrics.d.ts

@@ -1,8 +1,9 @@
 import { Types } from '@vtex/diagnostics-nodejs';
-export declare const enum RequestsMetricLabels {
-    STATUS_CODE = "status_code",
-    REQUEST_HANDLER = "handler"
-}
+export declare const RequestsMetricLabels: {
+    readonly STATUS_CODE: "status_code";
+    readonly REQUEST_HANDLER: "handler";
+    readonly ACCOUNT_NAME: "vtex.account.name";
+};
 export interface OtelRequestInstruments {
     concurrentRequests: Types.Gauge;
     requestTimings: Types.Histogram;

package/lib/service/metrics/metrics.js

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOtelInstruments = void 0;
+exports.getOtelInstruments = exports.RequestsMetricLabels = void 0;
 const client_1 = require("./client");
+const constants_1 = require("../../constants");
+exports.RequestsMetricLabels = {
+    STATUS_CODE: 'status_code',
+    REQUEST_HANDLER: 'handler',
+    ACCOUNT_NAME: constants_1.AttributeKeys.VTEX_ACCOUNT_NAME,
+};
 const createOtelConcurrentRequestsInstrument = async () => {
     const metricsClient = await (0, client_1.getMetricClient)();
     return metricsClient.createGauge('io_http_requests_current', {

package/lib/service/metrics/otelRequestMetricsMiddleware.js

@@ -21,6 +21,7 @@ const addOtelRequestMetricsMiddleware = () => {
         }
     };
     return async function addOtelRequestMetrics(ctx, next) {
+        var _a, _b;
         instruments = instruments ? instruments : await tryGetInstruments(ctx);
         if (!instruments) {
             await next();
@@ -30,7 +31,7 @@ const addOtelRequestMetricsMiddleware = () => {
         instruments.concurrentRequests.add(1);
         ctx.req.once('aborted', () => {
             if (instruments) {
-                instruments.abortedRequests.add(1, { ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName });
+                instruments.abortedRequests.add(1, { [metrics_1.RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName });
             }
         });
         let responseClosed = false;
@@ -42,21 +43,25 @@ const addOtelRequestMetricsMiddleware = () => {
             const responseLength = ctx.response.length;
             if (responseLength && instruments) {
                 instruments.responseSizes.record(responseLength, {
-                    ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName,
-                    ["status_code" /* RequestsMetricLabels.STATUS_CODE */]: ctx.response.status,
+                    [metrics_1.RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName,
+                    [metrics_1.RequestsMetricLabels.STATUS_CODE]: ctx.response.status,
+                    [metrics_1.RequestsMetricLabels.ACCOUNT_NAME]: ((_a = ctx.vtex) === null || _a === void 0 ? void 0 : _a.account) || 'unknown',
                 });
             }
             if (instruments) {
                 instruments.totalRequests.add(1, {
-                    ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName,
-                    ["status_code" /* RequestsMetricLabels.STATUS_CODE */]: ctx.response.status,
+                    [metrics_1.RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName,
+                    [metrics_1.RequestsMetricLabels.STATUS_CODE]: ctx.response.status,
+                    [metrics_1.RequestsMetricLabels.ACCOUNT_NAME]: ((_b = ctx.vtex) === null || _b === void 0 ? void 0 : _b.account) || 'unknown',
                 });
             }
             const onResFinished = () => {
+                var _a;
                 if (instruments) {
                     instruments.requestTimings.record((0, utils_1.hrToMillisFloat)(process.hrtime(start)), {
-                        ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName,
-                        ["status_code" /* RequestsMetricLabels.STATUS_CODE */]: ctx.response.status,
+                        [metrics_1.RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName,
+                        [metrics_1.RequestsMetricLabels.STATUS_CODE]: ctx.response.status,
+                        [metrics_1.RequestsMetricLabels.ACCOUNT_NAME]: ((_a = ctx.vtex) === null || _a === void 0 ? void 0 : _a.account) || 'unknown',
                     });
                     instruments.concurrentRequests.subtract(1);
                 }

package/lib/service/telemetry/client.js

@@ -45,7 +45,7 @@ class TelemetryClientSingleton {
                     'vendor': constants_1.APP.VENDOR,
                     'version': constants_1.APP.VERSION || '',
                     [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_NAME]: constants_1.WORKSPACE,
-                    [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_TYPE]: constants_1.PRODUCTION.toString(),
+                    [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_TYPE]: constants_1.PRODUCTION ? 'production' : 'development',
                 },
             });
             const [tracesClient, metricsClient, logsClient] = await Promise.all([

package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Metric.js

@@ -31,6 +31,7 @@ class Metric extends graphql_tools_1.SchemaDirectiveVisitor {
             // New diagnostics metrics with stable names and attributes
             if (global.diagnosticsMetrics) {
                 const attributes = {
+                    [__1.AttributeKeys.VTEX_ACCOUNT_NAME]: ctx.vtex.account,
                     component: 'graphql',
                     field_name: name,
                     status,

package/lib/service/worker/runtime/http/middlewares/requestStats.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.trackIncomingRequestStats = exports.incomingRequestStats = exports.cancelMessage = void 0;
+const constants_1 = require("../../../../../constants");
 exports.cancelMessage = 'Request cancelled';
 class IncomingRequestStats {
     constructor() {
@@ -25,9 +26,10 @@ exports.incomingRequestStats = new IncomingRequestStats();
 const requestClosed = (ctx) => () => {
     exports.incomingRequestStats.closed++;
     // Report to diagnostics metrics (cumulative counter)
-    const { status: statusCode, vtex: { route: { id, type } } } = ctx;
+    const { status: statusCode, vtex: { account, route: { id, type } } } = ctx;
     if (global.diagnosticsMetrics) {
         global.diagnosticsMetrics.incrementCounter('http_server_requests_closed_total', 1, {
+            [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: account,
             route_id: id,
             route_type: type,
             status_code: statusCode,
@@ -40,9 +42,10 @@ const requestClosed = (ctx) => () => {
 const requestAborted = (ctx) => () => {
     exports.incomingRequestStats.aborted++;
     // Report to diagnostics metrics (cumulative counter)
-    const { status: statusCode, vtex: { route: { id, type } } } = ctx;
+    const { status: statusCode, vtex: { account, route: { id, type } } } = ctx;
     if (global.diagnosticsMetrics) {
         global.diagnosticsMetrics.incrementCounter('http_server_requests_aborted_total', 1, {
+            [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: account,
             route_id: id,
             route_type: type,
             status_code: statusCode,
@@ -61,9 +64,10 @@ async function trackIncomingRequestStats(ctx, next) {
     ctx.req.on('aborted', requestAborted(ctx));
     exports.incomingRequestStats.total++;
     // Report total requests to diagnostics metrics (cumulative counter)
-    const { status: statusCode, vtex: { route: { id, type } } } = ctx;
+    const { status: statusCode, vtex: { account, route: { id, type } } } = ctx;
     if (global.diagnosticsMetrics) {
         global.diagnosticsMetrics.incrementCounter('http_server_requests_total', 1, {
+            [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: account,
             route_id: id,
             route_type: type,
             status_code: statusCode,

package/lib/service/worker/runtime/http/middlewares/timings.js

@@ -46,6 +46,7 @@ async function timings(ctx, next) {
     // New diagnostics metrics with stable names and attributes
     if (global.diagnosticsMetrics) {
         const attributes = {
+            [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: vtex.account,
             component: 'http-handler',
             route_id: id,
             route_type: type,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "7.3.0-beta.4",
+  "version": "7.3.0",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -53,7 +53,7 @@
     "@opentelemetry/instrumentation-koa": "0.47.1",
     "@types/koa": "^2.11.0",
     "@types/koa-compose": "^3.2.3",
-    "@vtex/diagnostics-nodejs": "0.1.0-io-beta.26",
+    "@vtex/diagnostics-nodejs": "0.1.8-io",
     "@vtex/diagnostics-semconv": "^1.1.2",
     "@vtex/node-error-report": "^0.0.3",
     "@wry/equality": "^0.1.9",
@@ -88,7 +88,7 @@
     "ramda": "^0.26.0",
     "rwlock": "^5.0.0",
     "semver": "^5.5.1",
-    "stats-lite": "vtex/node-stats-lite#dist",
+    "stats-lite": "vtex/node-stats-lite#v2.2.1",
     "tar-fs": "^2.0.0",
     "tokenbucket": "^0.3.2",
     "uuid": "^3.3.3",