Make api wraplogger also be controlled by logapi flag

Author: cwli24

src/common/wrap/wrap-logger.js

@@ -20,10 +20,11 @@ const contextMap = new Map()
  * @param {Object} sharedEE - The shared event emitter on which a new scoped event emitter will be based.
  * @param {Object} parent - The parent object housing the logger function
  * @param {string} loggerFn - The name of the function in the parent object to wrap
+ * @param {boolean} [autoCaptured=true] - True if log was captured from auto wrapping. False if it was captured from the API manual usage.
  * @returns {Object} Scoped event emitter with a debug ID of `logger`.
  */
 // eslint-disable-next-line
-export function wrapLogger(sharedEE, parent, loggerFn, context) {
+export function wrapLogger(sharedEE, parent, loggerFn, context, autoCaptured = true) {
   if (!(typeof parent === 'object' && !!parent && typeof loggerFn === 'string' && !!loggerFn && typeof parent[loggerFn] === 'function')) return warn(29)
   const ee = scopedEE(sharedEE)
   const wrapFn = wfn(ee)
@@ -35,6 +36,7 @@ export function wrapLogger(sharedEE, parent, loggerFn, context) {
   const ctx = new EventContext(contextId)
   ctx.level = context.level
   ctx.customAttributes = context.customAttributes
+  ctx.autoCaptured = autoCaptured
 
   const contextLookupKey = parent[loggerFn]?.[flag] || parent[loggerFn]
   contextMap.set(contextLookupKey, ctx)

src/features/logging/instrument/index.js

@@ -32,8 +32,8 @@ export class Instrument extends InstrumentBase {
 
     /** emitted by wrap-logger function */
     this.ee.on('wrap-logger-end', function handleLog ([message]) {
-      const { level, customAttributes } = this
-      bufferLog(instanceEE, message, customAttributes, level)
+      const { level, customAttributes, autoCaptured } = this
+      bufferLog(instanceEE, message, customAttributes, level, autoCaptured)
     })
     this.importAggregator(agentRef, () => import(/* webpackChunkName: "logging-aggregate" */ '../aggregate'))
   }

src/loaders/api/wrapLogger.js

@@ -9,6 +9,6 @@ import { setupAPI } from './sharedHandlers'
 
 export function setupWrapLoggerAPI (agent) {
   setupAPI(WRAP_LOGGER, (parent, functionName, { customAttributes = {}, level = LOG_LEVELS.INFO } = {}) => {
-    wrapLogger(agent.ee, parent, functionName, { customAttributes, level })
+    wrapLogger(agent.ee, parent, functionName, { customAttributes, level }, false)
   }, agent)
 }

tests/components/api.test.js

@@ -812,7 +812,7 @@ describe('API tests', () => {
           })])
 
           expectHandled(SUPPORTABILITY_METRIC_CHANNEL, ['API/logging/info/called'])
-          expectHandled('log', [expect.any(Number), 'test1', {}, 'INFO', true, undefined])
+          expectHandled('log', [expect.any(Number), 'test1', {}, 'INFO', false, undefined])
 
           const callCount = agent.ee.emit.mock.calls.length
           /** does NOT emit data for observed fn */
@@ -845,7 +845,7 @@ describe('API tests', () => {
           })])
 
           expectHandled(SUPPORTABILITY_METRIC_CHANNEL, ['API/logging/warn/called'])
-          expectHandled('log', [expect.any(Number), 'test1', {}, 'warn', true, undefined])
+          expectHandled('log', [expect.any(Number), 'test1', {}, 'warn', false, undefined])
         })
 
         test('should emit events with concat string for multiple args', () => {

tests/components/logging/instrument.test.js

@@ -32,7 +32,7 @@ test('should subscribe to wrap-logger events and buffer them', async () => {
 
   const message = faker.string.uuid()
   myLoggerSuite.myTestLogger(message)
-  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, customAttributes, 'error')
+  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, customAttributes, 'error', true)
 })
 
 test('wrapLogger should not re-wrap or overwrite context if called more than once', async () => {
@@ -44,12 +44,12 @@ test('wrapLogger should not re-wrap or overwrite context if called more than onc
 
   let message = faker.string.uuid()
   myLoggerSuite.myTestLogger(message)
-  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, customAttributes, 'error') // ignores args: 2
+  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, customAttributes, 'error', true) // ignores args: 2
 
   const newCustomAttributes = { args: faker.string.uuid() }
   /** re-wrap the logger with a NEW context, new events should NOT get that context because the wrapper should early-exit */
   wrapLogger(loggingInstrument.ee, myLoggerSuite, 'myTestLogger', { customAttributes: newCustomAttributes, level: 'info' })
   message = faker.string.uuid()
   myLoggerSuite.myTestLogger(message)
-  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, newCustomAttributes, 'info')
+  expect(loggingUtilsModule.bufferLog).toHaveBeenCalledWith(loggingInstrument.ee, message, newCustomAttributes, 'info', true)
 })

tests/specs/logging/modes.e2e.js

@@ -27,6 +27,11 @@ describe('logging mode from RUM flags', () => {
         console.log("It's a-me, Mario")
         console.debug('Mamma mia')
         newrelic.log('Here we go')
+        const printer = {
+          log: function (message) {} // other args are ignored
+        }
+        newrelic.wrapLogger(printer, 'log', { level: 'info' })
+        printer.log('Wahoo!')
       })
     ])
 
@@ -35,6 +40,7 @@ describe('logging mode from RUM flags', () => {
     expect(logPayload.logs[0].message).toEqual("It's a-me, Mario")
     // The console.debug should not be captured because it's above verbosity level.
     // The newrelic.log should not be captured because logapi flag is set to OFF.
+    // The printer.log should not be captured because logapi flag is set to OFF.
   })
 
   it('only captures api logs when log flag is 0', async () => {
@@ -47,13 +53,19 @@ describe('logging mode from RUM flags', () => {
         console.log("It's a-me, Mario")
         newrelic.log('Mamma mia')
         newrelic.log('Here we go', { level: 'trace' })
+        const printer = {
+          log: function (message) {} // other args are ignored
+        }
+        newrelic.wrapLogger(printer, 'log', { level: 'info' })
+        printer.log('Wahoo!')
       })
     ])
 
     const logPayload = JSON.parse(logsHarvests[0].request.body)[0]
-    expect(logPayload.logs.length).toEqual(1)
+    expect(logPayload.logs.length).toEqual(2)
     // The console.log should not be captured because log flag is set to OFF.
     expect(logPayload.logs[0].message).toEqual('Mamma mia')
     // The second newrelic.log should not be captured because the level is above INFO flag.
+    expect(logPayload.logs[1].message).toEqual('Wahoo!')
   })
 })