@vtex/api 6.45.21 → 6.45.22

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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 +1799,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/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.22",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",