Flatten the error object details

vtex · Sep 19, 2023 · 0dd7bf3 · 0dd7bf3
1 parent 0edfbe4
commit 0dd7bf3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/src/HttpClient/middlewares/request/setupAxios/__tests__/axiosTracingTestSuite.ts b/src/HttpClient/middlewares/request/setupAxios/__tests__/axiosTracingTestSuite.ts
@@ -167,7 +167,7 @@ export const registerSharedTestSuite = (testSuiteConfig: TestSuiteConfig) => {
           expect((requestSpan as any)._logs[len - 1].fields[ErrorReportLogFields.ERROR_ID]).toBeDefined()
           expect((requestSpan as any)._logs[len - 1].fields[ErrorReportLogFields.ERROR_KIND]).toBeDefined()
           expect(
-            ((requestSpan as any)._logs[len - 1].fields[ErrorReportLogFields.ERROR_DETAILS].message as string).startsWith(
+            ((requestSpan as any)._logs[len - 1].fields[ErrorReportLogFields.ERROR_MESSAGE] as string).startsWith(
               testSuiteConfig.expects.error!.errorMessagePrefix
             )
           ).toBeTruthy()

diff --git a/src/tracing/LogFields.ts b/src/tracing/LogFields.ts
@@ -15,7 +15,10 @@ export const enum ErrorReportLogFields {
    */
   ERROR_KIND = 'error.kind',
   ERROR_ID = 'error.id',
-  ERROR_DETAILS = 'error.details',
+  ERROR_MESSAGE = 'error.message',
+  ERROR_CODE = 'error.code',
+  ERROR_STACK = 'error.stack',
+  ERROR_METADATA = 'error.metadata',
 
   /**
    * VTEX's Infra errors adds error details to the response

diff --git a/src/tracing/errorReporting/ErrorReport.ts b/src/tracing/errorReporting/ErrorReport.ts
@@ -61,7 +61,14 @@ export class ErrorReport extends ErrorReportBase {
     }
 
     const serializableError = this.toObject()
-    span.log({ event: 'error', ...indexedLogs, [ErrorReportLogFields.ERROR_DETAILS]: serializableError })
+    span.log({
+      event: 'error',
+      ...indexedLogs,
+      [ErrorReportLogFields.ERROR_MESSAGE]: serializableError.message,
+      [ErrorReportLogFields.ERROR_METADATA]: serializableError.metadata,
+      [ErrorReportLogFields.ERROR_STACK]: serializableError.stack,
+      [ErrorReportLogFields.ERROR_CODE]: serializableError.code,
+    })
 
     if (logger && this.shouldLogToSplunk(span)) {
       logger.error(serializableError)