new: Nested objects flattening feature

[pamburus]

Added

• --flatten command line option.
• HL_FLATTEN environment variable
• formatting.flatten configuration file option.

--flatten <WHEN>        Whether to flatten objects [env: HL_FLATTEN=] [default: always] [possible values: never, always]

The default value is "always", which means that all nested objects are now flattened by default.

Before

After

Reasoning

It is very difficult to read logs with nested objects because you have to collect a lot of scattered keys to construct a path and understand what the fully qualified key really is.

Opt out

To preserve the old behavior, explicitly specify --flatten never or HL_FLATTEN=never, or set formatting.flatten to never in the configuration file.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.72%. Comparing base (377359b) to head (859f0f4).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #229      +/-   ##
==========================================
+ Coverage   33.65%   40.72%   +7.07%     
==========================================
  Files          36       36              
  Lines        5049     5078      +29     
==========================================
+ Hits         1699     2068     +369     
+ Misses       3350     3010     -340     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.