Skip to content

Add string-based level keys to Bunyan logger#3136

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

Merged
joaquincasares merged 7 commits into from
May 24, 2022
Merged

Add string-based level keys to Bunyan logger #3136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
524c249
add string levels to bunyan
joaquincasares May 23, 2022
7f73fa0
lint
joaquincasares May 23, 2022
8add7ad
add try/except block with comments
joaquincasares May 23, 2022
0b4779f
add raw-based stream
joaquincasares May 23, 2022
9191cb3
working with raw
joaquincasares May 23, 2022
972a877
skip SequelizeLogs for prod
joaquincasares May 24, 2022
0c9a1ad
leave level, add logLevel
joaquincasares May 24, 2022
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
1 change: 1 addition & 0 deletions creator-node/compose/env/commonEnv.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export delegatePrivateKey=DELEGATE_PRIVATE_KEY
export creatorNodeEndpoint=CREATOR_NODE_ENDPOINT
export spOwnerWallet=SP_OWNER_WALLET
export COMPOSE_HTTP_TIMEOUT=200
export printSequelizeLogs=true

@SidSethiSidSethiMay 24, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whats intent behind the change here and in config.js? seems like it will do the same thing right, i may be misunderstanding tho

2 changes: 1 addition & 1 deletion creator-node/src/config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -262,7 +262,7 @@ const config = convict({
doc: 'If we should print logs from sequelize',
format: Boolean,
env: 'printSequelizeLogs',
default: true
default: false

@vicky-gvicky-gMay 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we be defaulting to true? seems like we'll be missing some logs if this is set to false

@dmanjunathdmanjunathMay 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SidSethi@vicky-g this and the commonEnv.sh change is necessary so this doesn't send sequelize debug sql queries to loggly. with kube and fluentd this was never sent over. it was primarily a debugging tool and commonEnv.sh now enables it for local development but turns it off for live stage/prod environments

@SidSethiSidSethiMay 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gotcha, thanks for clarifying

},

// Transcoding settings
Expand Down
21 changes: 20 additions & 1 deletion creator-node/src/logging.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,13 +3,32 @@ const shortid = require('shortid')

const config = require('./config')

// taken from: https://github.com/trentm/node-bunyan/issues/194#issuecomment-347801909
// since there is no official support for string-based "level" values
// response from author: https://github.com/trentm/node-bunyan/issues/194#issuecomment-70397668
function RawStdOutWithLevelName() {
return {
write: (log) => {
// duplicate log object before sending to stdout
const clonedLog = Object.assign({}, log)
Comment thread
SidSethi marked this conversation as resolved.

// add new level (string) to level key
clonedLog.logLevel = bunyan.nameFromLevel[clonedLog.level]

const logLine = JSON.stringify(clonedLog, bunyan.safeCycles()) + '\n'

@SidSethiSidSethiMay 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

once again, i see this safeCycles call in the linked examples, but no idea what it does
can you explain + add code comment?
not every linked example does this

@vicky-gvicky-gMay 24, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking at the documentation, looks like this is to show the keyword [Circular] for printing out circular logs. +1 to sid, can we add a comment here describing that?

https://npmdoc.github.io/node-npmdoc-bunyan/build/apidoc.html#apidoc.element.bunyan.safeCycles

process.stdout.write(logLine)
}
}
}

const logLevel = config.get('logLevel') || 'info'
const logger = bunyan.createLogger({
name: 'audius_creator_node',
streams: [
{
level: logLevel,
stream: process.stdout
stream: new RawStdOutWithLevelName(),
Comment thread
SidSethi marked this conversation as resolved.
type: 'raw'
}
]
})
Expand Down