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

Escape newlines in LogfmtRenderer #592

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Conversation

madjar
Copy link
Contributor

@madjar madjar commented Jan 29, 2024

Summary

Currently, the LogfmtRenderer doesn't escape newlines, so any newline in a field (most commonly exceptions, but also other fields) ends up breaking the log over multiple lines, which messes up with log processing downstream.

This PR makes it so that newlines get escaped. I've checked that the behaviour is identical to the implementations in https://github.com/jteppinette/python-logfmter/ and https://github.com/sirupsen/logrus (which are the other logfmt implementations I happen to be using).

Pull Request Check List

  • Do not open pull requests from your main branch – use a separate branch!
    • There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
    • This is not a pre-requisite for your your pull request to be accepted, but you have been warned.
  • Added tests for changed code.
    • The CI fails with less than 100% coverage.
  • New APIs are added to our typing tests in api.py.
  • Updated documentation for changed code.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      • The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 23.1.0, the next version is gonna be 23.2.0. If the next version is the first in the new year, it'll be 24.1.0.
  • Documentation in .rst and .md files is written using semantic newlines.
  • Changes (and possible deprecations) are documented in the changelog.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

@madjar madjar force-pushed the structlog-newlines branch from 02cdf04 to a0e3538 Compare January 29, 2024 10:35
tests/test_processors.py Outdated Show resolved Hide resolved
@hynek
Copy link
Owner

hynek commented Jan 29, 2024

Ah great, a logfmt expert! Any opinions about #511 / #513? 🥺

Copy link
Owner

@hynek hynek left a comment

Choose a reason for hiding this comment

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

Thanks!

@hynek hynek merged commit b93037f into hynek:main Jan 29, 2024
16 checks passed
@madjar madjar deleted the structlog-newlines branch January 30, 2024 09:17
@madjar
Copy link
Contributor Author

madjar commented Jan 30, 2024

I would not call myself an expert, but I'm happy to take a look at compare the behaviour of the various tools in my stack :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants