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.

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

Set log level after instantiation #278

Merged
merged 2 commits into from
Feb 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,28 @@ const kafka = new Kafka({
})
```

To override the log level after instantiation, call `setLogLevel` on the individual logger.

```javascript
const { Kafka, logLevel } = require('kafkajs')

const kafka = new Kafka({
clientId: 'my-app',
brokers: ['kafka1:9092', 'kafka2:9092'],
logLevel: logLevel.ERROR
})
kafka.logger().setLogLevel(logLevel.WARN)

const producer = kafka.producer(...)
producer.logger().setLogLevel(logLevel.INFO)

const consumer = kafka.consumer(...)
consumer.logger().setLogLevel(logLevel.DEBUG)

const amin = kafka.admin(...)
admin.logger().setLogLevel(logLevel.NOTHING)
```

The environment variable `KAFKAJS_LOG_LEVEL` can also be used and it has precedence over the configuration in code, example:

```sh
Expand Down
1 change: 1 addition & 0 deletions src/__snapshots__/index.spec.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Object {
"error": [Function],
"info": [Function],
"namespace": [Function],
"setLogLevel": [Function],
"warn": [Function],
}
`;
1 change: 1 addition & 0 deletions src/admin/__snapshots__/index.spec.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Object {
"error": [Function],
"info": [Function],
"namespace": [Function],
"setLogLevel": [Function],
"warn": [Function],
}
`;
1 change: 1 addition & 0 deletions src/consumer/__tests__/__snapshots__/logger.spec.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Object {
"error": [Function],
"info": [Function],
"namespace": [Function],
"setLogLevel": [Function],
"warn": [Function],
}
`;
13 changes: 9 additions & 4 deletions src/loggers/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const createLevel = (label, level, currentLevel, namespace, logFunction) => (
message,
extra = {}
) => {
if (level > currentLevel) return
if (level > currentLevel()) return
logFunction({
namespace,
level,
Expand All @@ -34,7 +34,7 @@ const evaluateLogLevel = logLevel => {
}

const createLogger = ({ level = LEVELS.INFO, logCreator = null } = {}) => {
const logLevel = evaluateLogLevel(level)
let logLevel = evaluateLogLevel(level)
const logFunction = logCreator(logLevel)

const createNamespace = (namespace, logLevel = null) => {
Expand All @@ -43,15 +43,20 @@ const createLogger = ({ level = LEVELS.INFO, logCreator = null } = {}) => {
}

const createLogFunctions = (namespace, namespaceLogLevel = null) => {
const currentLogLevel = namespaceLogLevel == null ? logLevel : namespaceLogLevel
const currentLogLevel = () => (namespaceLogLevel == null ? logLevel : namespaceLogLevel)
const logger = {
info: createLevel('INFO', LEVELS.INFO, currentLogLevel, namespace, logFunction),
error: createLevel('ERROR', LEVELS.ERROR, currentLogLevel, namespace, logFunction),
warn: createLevel('WARN', LEVELS.WARN, currentLogLevel, namespace, logFunction),
debug: createLevel('DEBUG', LEVELS.DEBUG, currentLogLevel, namespace, logFunction),
}

return assign(logger, { namespace: createNamespace })
return assign(logger, {
namespace: createNamespace,
setLogLevel: newLevel => {
logLevel = newLevel
},
})
}

return createLogFunctions()
Expand Down
20 changes: 20 additions & 0 deletions src/loggers/index.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,24 @@ describe('Loggers', () => {
newLogger.debug('<test custom logLevel for namespaced logger>')
expect(myLogger).not.toHaveBeenCalled()
})

it('allows overriding the logLevel after instantiation', () => {
logger.setLogLevel(LEVELS.INFO)

logger.debug('Debug message that never gets logged')
expect(myLogger).not.toHaveBeenCalled()

logger.info('Info message', { extra: true })
expect(myLogger).toHaveBeenCalledWith(LEVELS.DEBUG, {
namespace: 'MyNamespace',
level: LEVELS.INFO,
label: 'INFO',
log: {
timestamp: timeNow.toISOString(),
logger: 'kafkajs',
message: 'Info message',
extra: true,
},
})
})
})
1 change: 1 addition & 0 deletions src/producer/__snapshots__/index.spec.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Object {
"error": [Function],
"info": [Function],
"namespace": [Function],
"setLogLevel": [Function],
"warn": [Function],
}
`;