Is it bad practice to add CR/LF's to logging messages to improve readability

ponder275 :

We have a method which we use to log java exceptions in a log file. The method allows the caller to pass variables they wish to be shown in the log message for debugging purposes and uses inserts blank lines and tabs to make the message stand out and be more readable.

However, all of the recommendations I see to prevent Log Forging attacks recommend stripping all of the CRLF's out of the logging message.

Is it considered bad practice to have CRLF's in a logging message? This method is only used internally and any user supplied information can be sanitized before being passed to the method.

radai :

generally - yes.

while this seems a nice feature at first glance, you should consider the following potential complications:

• depending on exactly how this is implemented, if you hand the underlying logging framework multiple lines as multiple logging invocations your statement could get interleaved with other concurrent logging statements, making the resulting log less readable
• various log-parsing tools tend to assume one line == one statement. most know how to account for exception stack traces (that are multi line) but not much beyond, so you may find yourself having to delve into things like ELK stack / loggly configs to teach it about your fancy multiline statements.
• complications around terminals with different widths (if youre printing to console)

Guess you like

Origin http://43.154.161.224:23101/article/api/json?id=310489&siteId=1

Is it bad practice to add CR/LF's to logging messages to improve readability

Is it bad practice to catch RuntimeException for logging purposes?

Improve the readability of Python tuple

Python Specification: improve readability

Tips to improve readability

Improve the readability of visiting tuples

Improve code readability comments practical skills

How can we improve the readability of the program

Write an if without else to improve code readability

5 Essential Tips to Improve the Readability of Python Code

Start with the details: Improve the readability of your code

How can I improve readability and length of a method with many if statements?

How to name each element in a tuple to improve program readability

SpeedBI data visualization tool: enrich charts and improve the readability of reports

Use Lambda expressions to improve the readability and maintainability of Java code

springboot section add logging

Add database logging in Django

tensorflow log messages ---- tf.logging

Java exceptions wrapping: bad practice?

The highlight of the show is to use the Optional class to optimize the code, improve readability and simplify null value handling

Is it possible to add logging to removeIf in java 8?

Catching generic Exception in a toString implementation - bad practice?

Is it a bad practice to append operations to a Stream in different methods?

Q: Is embedding Java bad practice in BPEL?

Inner class for listener in Java, is this bad practice?

Is it a bad practice to change the value of an object, bypassing the setter?

Java bad practice doing: new... ().doSomething()?

Python logging.FileHandler prints messages into standard output

PX4 1.13.0 - Add Mavlink messages

Code bad taste - reconstruction to improve the design of existing code