feat(core): Allow logging JSON to stdout #15766
Conversation
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
n8n-assistant
bot
added
core
despairblue
force-pushed
the
pay-2779-allow-logging-json-to-stdout
branch
from
1723aa5 to
c21e7cd
Compare
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
cubic found 1 issue across 4 files. Review it in cubic.dev
React with 👍 or 👎 to teach cubic. Tag @cubic-dev-ai to give specific feedback.
| for (const key of Object.keys(metadata)) { | ||
| const value = metadata[key]; | ||
| if (value instanceof Error) { | ||
| metadata[key] = this.detailedErrorStringify(value); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Would it be reasonable to expect the key to be called error so we don't have to check every key in every metadata object in every log?
There was a problem hiding this comment.
I'd rather be safe than sorry. But we should probably adhere to that pattern. I think we could write an eslint rule for that, but that's out of scope for this PR.
…etween info, error and debug logs
despairblue
force-pushed
the
pay-2779-allow-logging-json-to-stdout
branch
from
3cd87ce to
9b920d4
Compare
Workflow Test Results 📊 🔴 1 Failed,
|
| Workflow ID | Workflow Name | Reason |
|---|---|---|
| 237 | BasicLLMChain:AzureChat | Workflow contains 1 deleted data. |
⚠️ Warnings (3)
| Workflow ID | Workflow Name | Reason |
|---|---|---|
| 35 | Slack:User:getPresence info:UserProfile:get update... | Workflow contains new data that previously did not exist. |
| 257 | Agent:auto-fix:anthropic | Workflow contains new data that previously did not exist. |
| 53 | ConvertKit:CustomField:create getAll update delete... | Workflow contains new data that previously did not exist. |
|
✅ All Cypress E2E specs passed |
|
Got released with |
Summary
Before this we would always log text to stdout, which is sub-optimal for production use cases because we loose all of the metadata that log ingestion systems could use:
This PR adds a new environment variable to change the log's output format
N8N_LOG_FORMAT. It can be set todefaultandjsonand defaults todefault, which is the current text based output.Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/PAY-2779/allow-logging-json-to-stdout
Review / Merge checklist
PR Labeled withrelease/backport(if the PR is an urgent fix that needs to be backported)