@vtex/api 6.45.21 → 6.45.23

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [6.45.23] - 2023-10-04
+
+### Fixed
+- Fix metrics being restricted by tracing restrictions
+
+## [6.45.22] - 2023-09-20
+
+### Removed
+
+- Remove reference of how to search for the app's errors on now-defunct Splunk.
+
+### Fixed
+
+- Error tracing spans not logging the details.
+
 ## [6.45.21] - 2023-09-19
 ### Changed
 - Fix tracingMiddleware shouldTrace decision
@@ -1789,11 +1804,12 @@ instead
 - `HttpClient` now adds `'Accept-Encoding': 'gzip'` header by default.
 
 
-[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.21...HEAD
+[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.22...HEAD
 [6.45.15]: https://github.com/vtex/node-vtex-api/compare/v6.45.14...v6.45.15
 [6.45.14]: https://github.com/vtex/node-vtex-api/compare/v6.45.13...v6.45.14
 [6.45.13]: https://github.com/vtex/node-vtex-api/compare/v6.45.12...v6.45.13
 
+[6.45.22]: https://github.com/vtex/node-vtex-api/compare/v6.45.21...v6.45.22
 [6.45.21]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.2...v6.45.21
 [6.45.21-beta.2]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.1...v6.45.21-beta.2
 [6.45.21-beta.1]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.0...v6.45.21-beta.1

package/lib/service/logger/logger.d.ts

@@ -25,11 +25,5 @@ export declare class Logger {
     warn: (warning: any) => void;
     error: (error: any) => void;
     log: (message: any, level: LogLevel) => void;
-    /**
-     * Logs splunk query so the developer can search for the errors in splunk.
-     * This function runs only once in the lifetime of the Logger class so we
-     * don't mess up with the developer's terminal
-     */
-    private logSplunkQuery;
 }
 export {};

package/lib/service/logger/logger.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const constants_1 = require("../../constants");
 const error_1 = require("../../utils/error");
 const log_1 = require("../../utils/log");
-const console_1 = require("./console");
 const linked = !!process.env.VTEX_APP_LINK;
 const app = constants_1.APP.ID;
 const EMPTY_MESSAGE = 'Logger.log was called with null or undefined message';
@@ -45,19 +44,6 @@ class Logger {
                 });
             }
             console.log(JSON.stringify(inflatedLog));
-            // Warn the developer how to retrieve the error in splunk
-            this.logSplunkQuery();
-        };
-        /**
-         * Logs splunk query so the developer can search for the errors in splunk.
-         * This function runs only once in the lifetime of the Logger class so we
-         * don't mess up with the developer's terminal
-         */
-        this.logSplunkQuery = () => {
-            if (linked) {
-                const message = `Try this query at Splunk to retrieve error log: 'index=io_vtex_logs app="${app}" account=${this.account} workspace=${this.workspace} level=error OR level=warn'`;
-                console_1.logOnceToDevConsole(message, LogLevel.Info);
-            }
         };
         this.account = ctx.account;
         this.workspace = ctx.workspace;

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

@@ -0,0 +1,2 @@
+import { ServiceContext } from '../worker/runtime/typings';
+export declare const addRequestMetricsMiddleware: () => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;

package/lib/service/metrics/requestMetricsMiddleware.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stream_1 = require("stream");
+const utils_1 = require("../../utils");
+const instruments_1 = require("../tracing/metrics/instruments");
+exports.addRequestMetricsMiddleware = () => {
+    const concurrentRequests = instruments_1.createConcurrentRequestsInstrument();
+    const requestTimings = instruments_1.createRequestsTimingsInstrument();
+    const totalRequests = instruments_1.createTotalRequestsInstrument();
+    const responseSizes = instruments_1.createRequestsResponseSizesInstrument();
+    const abortedRequests = instruments_1.createTotalAbortedRequestsInstrument();
+    return async function addRequestMetrics(ctx, next) {
+        const start = process.hrtime();
+        concurrentRequests.inc(1);
+        ctx.req.once('aborted', () => abortedRequests.inc({ ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName }, 1));
+        let responseClosed = false;
+        ctx.res.once('close', () => (responseClosed = true));
+        try {
+            await next();
+        }
+        finally {
+            const responseLength = ctx.response.length;
+            if (responseLength) {
+                responseSizes.observe({ ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName }, responseLength);
+            }
+            totalRequests.inc({
+                ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName,
+                ["status_code" /* STATUS_CODE */]: ctx.response.status,
+            }, 1);
+            const onResFinished = () => {
+                requestTimings.observe({
+                    ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName,
+                }, utils_1.hrToMillisFloat(process.hrtime(start)));
+                concurrentRequests.dec(1);
+            };
+            if (responseClosed) {
+                onResFinished();
+            }
+            else {
+                stream_1.finished(ctx.res, onResFinished);
+            }
+        }
+    };
+};

package/lib/service/tracing/tracingMiddlewares.js

@@ -7,23 +7,14 @@ const tracing_1 = require("../../tracing");
 const Tags_1 = require("../../tracing/Tags");
 const utils_1 = require("../../tracing/utils");
 const utils_2 = require("../../utils");
-const instruments_1 = require("./metrics/instruments");
 const PATHS_BLACKLISTED_FOR_TRACING = ['/_status', '/healthcheck'];
 exports.addTracingMiddleware = (tracer) => {
-    const concurrentRequests = instruments_1.createConcurrentRequestsInstrument();
-    const requestTimings = instruments_1.createRequestsTimingsInstrument();
-    const totalRequests = instruments_1.createTotalRequestsInstrument();
-    const responseSizes = instruments_1.createRequestsResponseSizesInstrument();
-    const abortedRequests = instruments_1.createTotalAbortedRequestsInstrument();
     return async function addTracing(ctx, next) {
         var _a;
-        const start = process.hrtime();
-        concurrentRequests.inc(1);
         const rootSpan = tracer.extract(opentracing_1.FORMAT_HTTP_HEADERS, ctx.request.headers);
         ctx.tracing = { tracer, currentSpan: undefined };
         if (!shouldTrace(ctx, rootSpan)) {
             await next();
-            concurrentRequests.dec(1);
             return;
         }
         const currentSpan = tracer.startSpan('unknown-operation', {
@@ -32,7 +23,6 @@ exports.addTracingMiddleware = (tracer) => {
         });
         const initialSamplingDecision = tracing_1.getTraceInfo(currentSpan).isSampled;
         ctx.tracing = { currentSpan, tracer };
-        ctx.req.once('aborted', () => abortedRequests.inc({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, 1));
         let responseClosed = false;
         ctx.res.once('close', () => (responseClosed = true));
         try {
@@ -43,14 +33,6 @@ exports.addTracingMiddleware = (tracer) => {
             throw err;
         }
         finally {
-            const responseLength = ctx.response.length;
-            if (responseLength) {
-                responseSizes.observe({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, responseLength);
-            }
-            totalRequests.inc({
-                ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
-                ["status_code" /* STATUS_CODE */]: ctx.response.status,
-            }, 1);
             const traceInfo = tracing_1.getTraceInfo(currentSpan);
             if (traceInfo === null || traceInfo === void 0 ? void 0 : traceInfo.isSampled) {
                 if (!initialSamplingDecision) {
@@ -70,10 +52,6 @@ exports.addTracingMiddleware = (tracer) => {
                 ctx.set(constants_1.TRACE_ID_HEADER, traceInfo.traceId);
             }
             const onResFinished = () => {
-                requestTimings.observe({
-                    ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
-                }, utils_2.hrToMillisFloat(process.hrtime(start)));
-                concurrentRequests.dec(1);
                 currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.finish();
             };
             if (responseClosed) {
@@ -88,7 +66,8 @@ exports.addTracingMiddleware = (tracer) => {
 exports.nameSpanOperationMiddleware = (operationType, operationName) => {
     return function nameSpanOperation(ctx, next) {
         var _a, _b;
-        (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(`${operationType}:${operationName}`);
+        ctx.requestHandlerName = `${operationType}:${operationName}`;
+        (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
         return next();
     };
 };

package/lib/service/worker/index.js

@@ -13,6 +13,7 @@ const MetricsAccumulator_1 = require("../../metrics/MetricsAccumulator");
 const loaders_1 = require("../loaders");
 const console_1 = require("../logger/console");
 const logger_1 = require("../logger/logger");
+const requestMetricsMiddleware_1 = require("../metrics/requestMetricsMiddleware");
 const TracerSingleton_1 = require("../tracing/TracerSingleton");
 const tracingMiddlewares_1 = require("../tracing/tracingMiddlewares");
 const listeners_1 = require("./listeners");
@@ -157,6 +158,7 @@ exports.startWorker = (serviceJSON) => {
         .use(error_1.error)
         .use(middlewares_1.prometheusLoggerMiddleware())
         .use(tracingMiddlewares_1.addTracingMiddleware(tracer))
+        .use(requestMetricsMiddleware_1.addRequestMetricsMiddleware())
         .use(middlewares_1.addMetricsLoggerMiddleware())
         .use(rateLimit_1.concurrentRateLimiter((_a = serviceJSON === null || serviceJSON === void 0 ? void 0 : serviceJSON.rateLimitPerReplica) === null || _a === void 0 ? void 0 : _a.concurrent))
         .use(koa_compress_1.default())

package/lib/service/worker/runtime/typings.d.ts

@@ -29,6 +29,7 @@ export interface Context<T extends IOClients> {
     timings: Record<string, [number, number]>;
     metrics: Record<string, [number, number]>;
     previousTimerStart: [number, number];
+    requestHandlerName?: string;
     serverTiming?: ServerTiming;
     tracing?: TracingContext;
 }

package/lib/tracing/LogFields.d.ts

@@ -12,6 +12,11 @@ export declare const enum ErrorReportLogFields {
      */
     ERROR_KIND = "error.kind",
     ERROR_ID = "error.id",
+    ERROR_MESSAGE = "error.message",
+    ERROR_CODE = "error.code",
+    ERROR_STACK = "error.stack",
+    ERROR_METADATA_REPORT_COUNT = "error.metadata.reportCount",
+    ERROR_METADATA_METRICS_INSTANTIATION_TIME = "error.metadata.metrics.InstantiationTime",
     /**
      * VTEX's Infra errors adds error details to the response
      * The following log fields are supposed to hold these fields

package/lib/tracing/errorReporting/ErrorReport.js

@@ -34,7 +34,7 @@ class ErrorReport extends node_error_report_1.ErrorReportBase {
      * span is part of a **sampled** trace, then the error will be logged.
      */
     injectOnSpan(span, logger) {
-        var _a;
+        var _a, _b, _c, _d;
         span === null || span === void 0 ? void 0 : span.setTag(__1.TracingTags.ERROR, 'true');
         const indexedLogs = {
             ["error.kind" /* ERROR_KIND */]: this.kind,
@@ -47,7 +47,15 @@ class ErrorReport extends node_error_report_1.ErrorReportBase {
             indexedLogs["error.server.request_id" /* ERROR_SERVER_REQUEST_ID */] = this.parsedInfo.response.data.requestId;
         }
         const serializableError = this.toObject();
-        span === null || span === void 0 ? void 0 : span.log({ event: 'error', ...indexedLogs, error: serializableError });
+        span === null || span === void 0 ? void 0 : span.log({
+            event: 'error',
+            ...indexedLogs,
+            ["error.message" /* ERROR_MESSAGE */]: serializableError.message,
+            ["error.metadata.metrics.InstantiationTime" /* ERROR_METADATA_METRICS_INSTANTIATION_TIME */]: (_b = serializableError.metadata) === null || _b === void 0 ? void 0 : _b.reportCount,
+            ["error.metadata.reportCount" /* ERROR_METADATA_REPORT_COUNT */]: (_d = (_c = serializableError.metadata) === null || _c === void 0 ? void 0 : _c.metrics) === null || _d === void 0 ? void 0 : _d.instantiationTime,
+            ["error.stack" /* ERROR_STACK */]: serializableError.stack,
+            ["error.code" /* ERROR_CODE */]: serializableError.code,
+        });
         if (logger && this.shouldLogToSplunk(span)) {
             logger.error(serializableError);
             this.markErrorAsReported();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.45.21",
+  "version": "6.45.23",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",