fix: Preserve agent attributes for log payloads (#1594)

Author: ptang-nr

src/features/logging/aggregate/index.js

@@ -110,6 +110,7 @@ export class Aggregate extends AggregateBase {
       common: {
         /** Attributes in the `common` section are added to `all` logs generated in the payload */
         attributes: {
+          ...this.agentRef.info.jsAttributes, // user-provided custom attributes
           'entity.guid': target.entityGuid, // browser entity guid as provided API target OR the default from RUM response if not supplied
           ...(sessionEntity && {
             session: sessionEntity.state.value || '0', // The session ID that we generate and keep across page loads
@@ -123,9 +124,7 @@ export class Aggregate extends AggregateBase {
           // The following 3 attributes are evaluated and dropped at ingest processing time and do not get stored on NRDB:
           'instrumentation.provider': 'browser',
           'instrumentation.version': this.agentRef.runtime.version,
-          'instrumentation.name': this.agentRef.runtime.loaderType,
-          // Custom attributes
-          ...this.agentRef.info.jsAttributes
+          'instrumentation.name': this.agentRef.runtime.loaderType
         }
       },
       /** logs section contains individual unique log entries */

tests/unit/features/logging/index.test.js

@@ -0,0 +1,76 @@
+import { Aggregate } from '../../../../src/features/logging/aggregate'
+import { LOGGING_MODE } from '../../../../src/features/logging/constants'
+
+describe('Logging aggregate', () => {
+  test('serializer should not overwrite agent reserved attributes with user-provided attributes', () => {
+    const agentInst = {
+      agentIdentifier: 'abcd',
+      info: {
+        licenseKey: 'licenseKey',
+        applicationID: '123',
+        errorBeacon: 'someValue',
+        jsAttributes: {
+          agentVersion: 'foobar',
+          appId: 'foobar',
+          'entity.guid': 'foobar',
+          'instrumentation.provider': 'foobar',
+          'instrumentation.version': 'foobar',
+          'instrumentation.name': 'foobar',
+          ptid: 'foobar',
+          session: 'foobar',
+          hasReplay: 'foobar',
+          hasTrace: 'foobar',
+          standalone: 'foobar',
+          customAttr: 'customVal'
+        }
+      },
+      init: {
+        privacy: {
+          cookies_enabled: true
+        }
+      },
+      runtime: {
+        version: '1.0.0',
+        loaderType: 'loaderTypeX',
+        ptid: 'ptid123',
+        session: {
+          state: {
+            value: '12345',
+            loggingMode: LOGGING_MODE.INFO,
+            sessionReplayMode: 1,
+            sessionTraceMode: 1
+          }
+        }
+      }
+    }
+
+    const logAgg = new Aggregate(agentInst)
+    const actual = logAgg.serializer([
+      {
+        timestamp: 1234,
+        message: 'test message',
+        level: 'INFO',
+        attributes: {
+          pageUrl: 'http://example.com'
+        }
+      }
+    ])
+
+    expect(actual[0].common).toEqual({
+      attributes: {
+        agentVersion: '1.0.0',
+        appId: '123',
+        'entity.guid': undefined,
+        hasReplay: true,
+        hasTrace: true,
+        'instrumentation.name': 'loaderTypeX',
+        'instrumentation.provider': 'browser',
+        'instrumentation.version': '1.0.0',
+        ptid: 'ptid123',
+        session: '12345',
+        standalone: false,
+        customAttr: 'customVal'
+      }
+    })
+  })
+})