Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Removed reference to pino internals #2805

Merged
merged 1 commit into from
Dec 2, 2024
Merged

chore: Removed reference to pino internals #2805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 35 additions & 31 deletions test/versioned/pino/pino.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@

const test = require('node:test')
const assert = require('node:assert')
const stream = require('node:stream')
const { once } = require('node:events')
const split = require('split2')
const semver = require('semver')

const { sink, once } = require('pino/test/helper')
const { truncate } = require('../../../lib/util/application-logging')
const helper = require('../../lib/agent_helper')
const { removeMatchedModules } = require('../../lib/cache-buster')
Expand All @@ -21,11 +22,19 @@ const { validateLogLine, validateCommonAttrs } = require('../../lib/logging-help
const { version: pinoVersion } = require('pino/package')

function setup(testContext, config) {
testContext.logs = []
const sink = new stream.Writable({
write(chunk, encoding, callback) {
testContext.logs.push(JSON.parse(chunk.toString('utf8')))
callback()
}
})
testContext.sink = sink

testContext.agent = helper.instrumentMockedAgent(config)
testContext.agent.config.entity_guid = 'test-guid'
testContext.pino = require('pino')
testContext.stream = sink()
testContext.logger = testContext.pino({ level: 'debug' }, testContext.stream)
testContext.logger = testContext.pino({ level: 'debug' }, testContext.sink)
testContext.config = testContext.agent.config
}

Expand All @@ -42,12 +51,12 @@ test.afterEach((ctx) => {

test('logging disabled', async (t) => {
setup(t.nr, { application_logging: { enabled: false } })
const { agent, pino, stream } = t.nr
const { agent, pino, sink } = t.nr

const disabledLogger = pino({ level: 'info' }, stream)
const disabledLogger = pino({ level: 'info' }, sink)
const message = 'logs are not enriched'
disabledLogger.info(message)
const line = await once(stream, 'data')
const line = t.nr.logs[0]
originalMsgAssertion({
logLine: line,
hostname: agent.config.getHostnameSafe()
Expand Down Expand Up @@ -77,11 +86,11 @@ test('local_decorating', (t, end) => {
metrics: { enabled: false }
}
})
const { agent, logger, stream } = t.nr
const { agent, logger } = t.nr
const message = 'pino decorating test'
helper.runInTransaction(agent, 'pino-test', async () => {
logger.info(message)
let line = await once(stream, 'data')
let line = t.nr.logs.shift()
originalMsgAssertion({
includeLocalDecorating: true,
hostname: agent.config.getHostnameSafe(),
Expand All @@ -91,7 +100,7 @@ test('local_decorating', (t, end) => {

// Verify that merging object only logs get decorated:
logger.info({ msg: message })
line = await once(stream, 'data')
line = t.nr.logs.shift()
assert.equal(line.msg.startsWith(`${message} NR-LINKING|test-guid`), true)
originalMsgAssertion({
includeLocalDecorating: true,
Expand Down Expand Up @@ -120,11 +129,11 @@ test('forwarding', async (t) => {
})

await t.test('should have proper metadata outside of a transaction', async (t) => {
const { agent, config, logger, stream } = t.nr
const { agent, config, logger } = t.nr
const message = 'pino unit test'
const level = 'info'
logger[level](message)
const line = await once(stream, 'data')
const line = t.nr.logs.shift()
originalMsgAssertion({
hostname: agent.config.getHostnameSafe(),
logLine: line
Expand Down Expand Up @@ -168,11 +177,11 @@ test('forwarding', async (t) => {
})

await t.test('should have proper error keys when error is present', async (t) => {
const { agent, config, logger, stream } = t.nr
const { agent, config, logger } = t.nr
const err = new Error('This is a test')
const level = 'error'
logger[level](err)
const line = await once(stream, 'data')
const line = t.nr.logs.shift()
originalMsgAssertion({
hostname: agent.config.getHostnameSafe(),
logLine: line,
Expand Down Expand Up @@ -200,13 +209,13 @@ test('forwarding', async (t) => {
})

await t.test('should add proper trace info in transaction', (t, end) => {
const { agent, config, logger, stream } = t.nr
const { agent, config, logger } = t.nr
helper.runInTransaction(agent, 'pino-test', async (tx) => {
const level = 'info'
const message = 'My debug test'
logger[level](message)
const meta = agent.getLinkingMetadata()
const line = await once(stream, 'data')
const line = t.nr.logs.shift()
originalMsgAssertion({
hostname: agent.config.getHostnameSafe(),
logLine: line
Expand Down Expand Up @@ -238,13 +247,12 @@ test('forwarding', async (t) => {
await t.test(
'should assign hostname from NR linking metadata when not defined as a core chinding',
async (t) => {
const { agent, config, pino } = t.nr
const localStream = sink()
const localLogger = pino({ base: undefined }, localStream)
const { agent, config, pino, sink } = t.nr
const localLogger = pino({ base: undefined }, sink)
const message = 'pino unit test'
const level = 'info'
localLogger[level](message)
const line = await once(localStream, 'data')
const line = t.nr.logs.shift()
assert.equal(line.pid, undefined, 'should not have pid when overriding base chindings')
assert.equal(
line.hostname,
Expand All @@ -258,21 +266,21 @@ test('forwarding', async (t) => {
)

await t.test('should properly handle child loggers', (t, end) => {
const { agent, config, logger, stream } = t.nr
const { agent, config, logger } = t.nr
const childLogger = logger.child({ module: 'child' })
helper.runInTransaction(agent, 'pino-test', async (tx) => {
// these are defined in opposite order because the log aggregator is LIFO
const messages = ['this is a child message', 'my parent logger message']
const level = 'info'
logger[level](messages[1])
const meta = agent.getLinkingMetadata()
const line = await once(stream, 'data')
const line = t.nr.logs.shift()
originalMsgAssertion({
hostname: agent.config.getHostnameSafe(),
logLine: line
})
childLogger[level](messages[0])
const childLine = await once(stream, 'data')
const childLine = t.nr.logs.shift()
originalMsgAssertion({
hostname: agent.config.getHostnameSafe(),
logLine: childLine
Expand Down Expand Up @@ -330,15 +338,15 @@ test('metrics', async (t) => {
})

await t.test('should count logger metrics', (t, end) => {
const { agent, pino, stream } = t.nr
const { agent, pino, sink } = t.nr
const pinoLogger = pino(
{
level: 'debug',
customLevels: {
http: 35
}
},
stream
sink
)

helper.runInTransaction(agent, 'pino-test', async () => {
Expand All @@ -355,7 +363,6 @@ test('metrics', async (t) => {
pinoLogger[logLevel](msg)
}
}
await once(stream, 'data')

let grandTotal = 0
for (const [logLevel, maxCount] of Object.entries(logLevels)) {
Expand Down Expand Up @@ -405,10 +412,9 @@ test('metrics', async (t) => {
}
setup(t.nr, config)

const { agent, logger, stream } = t.nr
const { agent, logger } = t.nr
helper.runInTransaction(agent, 'pino-test', async () => {
logger.info('This is a log message test')
await once(stream, 'data')

const linesMetric = agent.metrics.getMetric(LOGGING.LINES)
assert.equal(linesMetric, undefined, `should not create ${LOGGING.LINES} metric`)
Expand All @@ -424,13 +430,11 @@ test('metrics', async (t) => {
test('should honor msg key in merging object (issue 2410)', async (t) => {
setup(t.nr, { application_logging: { enabled: true } })

const { agent, config, pino } = t.nr
const localStream = sink()
const localLogger = pino({ base: undefined }, localStream)
const { agent, config, pino, sink } = t.nr
const localLogger = pino({ base: undefined }, sink)
const message = 'pino unit test'
const level = 'info'
localLogger[level]({ msg: message })
await once(localStream, 'data')
assert.equal(agent.logs.getEvents().length, 1, 'should have 1 log in aggregator')
const formattedLine = agent.logs.getEvents()[0]()
validateLogLine({ line: formattedLine, message, level, config })
Expand Down
Loading