refactor: use JSON.stringify to format log messages

Author: mwear

packages/opentelemetry-core/src/common/logging-error-handler.ts

@@ -38,9 +38,7 @@ function stringifyException(ex: Exception | string): string {
   if (typeof ex === 'string') {
     return ex;
   } else {
-    return Object.entries(flattenException(ex))
-      .map(([k, v]) => `${k}: ${v}`)
-      .join('\n');
+    return JSON.stringify(flattenException(ex));
   }
 }
 

packages/opentelemetry-core/test/common/logging-error-handler.test.ts

@@ -52,13 +52,13 @@ describe('loggingErrorHandler', () => {
 
     const [result] = errorStub.lastCall.args;
 
-    assert.ok(result.includes(`name: ${err.name}`));
-    assert.ok(result.includes(`message: ${err.message}`));
-    assert.ok(result.includes(`randomString: ${err.randomString}`));
-    assert.ok(result.includes(`randomNumber: ${err.randomNumber}`));
-    assert.ok(result.includes(`randomArray: ${err.randomArray}`));
-    assert.ok(result.includes(`randomObject: ${err.randomObject}`));
-    assert.ok(result.includes(`stack: ${err.stack}`));
+    assert.ok(result.includes(err.name));
+    assert.ok(result.includes(err.message));
+    assert.ok(result.includes(err.randomString));
+    assert.ok(result.includes(err.randomNumber));
+    assert.ok(result.includes(err.randomArray));
+    assert.ok(result.includes(err.randomObject));
+    assert.ok(result.includes(JSON.stringify(err.stack)));
   });
 
   it('logs from an error', () => {
@@ -68,8 +68,8 @@ describe('loggingErrorHandler', () => {
 
     const [result] = errorStub.lastCall.args;
 
-    assert.ok(result.includes(`name: ${err.name}`));
-    assert.ok(result.includes(`message: ${err.message}`));
-    assert.ok(result.includes(`stack: ${err.stack}`));
+    assert.ok(result.includes(err.name));
+    assert.ok(result.includes(err.message));
+    assert.ok(result.includes(JSON.stringify(err.stack)));
   });
 });

packages/opentelemetry-exporter-collector-proto/test/CollectorMetricExporter.test.ts

@@ -195,7 +195,7 @@ describe('CollectorMetricExporter - node with proto over http', () => {
         callback(mockResError);
         setTimeout(() => {
           const response = spyLoggerError.args[0][0] as string;
-          assert.ok(response.includes('code: 400'));
+          assert.ok(response.includes('"code":"400"'));
           assert.strictEqual(responseSpy.args[0][0], 1);
           done();
         });

packages/opentelemetry-exporter-collector-proto/test/CollectorTraceExporter.test.ts

@@ -163,7 +163,7 @@ describe('CollectorTraceExporter - node with proto over http', () => {
         setTimeout(() => {
           const response = spyLoggerError.args[0][0] as string;
 
-          assert.ok(response.includes('code: 400'));
+          assert.ok(response.includes('"code":"400"'));
           assert.strictEqual(responseSpy.args[0][0], 1);
           done();
         });

packages/opentelemetry-exporter-collector/test/browser/CollectorMetricExporter.test.ts

@@ -332,7 +332,7 @@ describe('CollectorMetricExporter - web', () => {
           request.respond(400);
 
           const response = spyLoggerError.args[0][0] as string;
-          assert.ok(response.includes('code: 400'));
+          assert.ok(response.includes('"code":"400"'));
 
           assert.strictEqual(spyBeacon.callCount, 0);
           done();

packages/opentelemetry-exporter-collector/test/browser/CollectorTraceExporter.test.ts

@@ -253,7 +253,7 @@ describe('CollectorTraceExporter - web', () => {
 
           const response = spyLoggerError.args[0][0] as string;
 
-          assert.ok(response.includes('code: 400'));
+          assert.ok(response.includes('"code":"400"'));
 
           assert.strictEqual(spyBeacon.callCount, 0);
           done();