Feature Request: Encode stack traces as an array

[1hakusai1]

Hi! I often use this library. It is very useful and I love it.

When the logger using JsonFormatter logs exceptions, the output is like this.

{
  "asctime": "2024-12-16 16:29:19,170",
  "levelname": "ERROR",
  "name": "my-logger",
  "message": "Unexpected Error",
  "exc_info": "Traceback (most recent call last):\n  File \"/Users/hakusai/src/hakusai/stacktrace-as-array/main.py\", line 20, in <module>\n    do_something()\n  File \"/Users/hakusai/src/hakusai/stacktrace-as-array/main.py\", line 14, in do_something\n    raise Exception(\"something wrong\")\nException: something wrong"
}

The stack trace is hard to read. It should be more readable like this.

{
  "asctime": "2024-12-16 16:48:29,666",
  "levelname": "ERROR",
  "name": "my-logger",
  "message": "Unexpected Error",
  "exc_info": [
    "Traceback (most recent call last):",
    "  File \"/Users/hakusai/src/hakusai/stacktrace-as-array/main.py\", line 20, in <module>",
    "    do_something()",
    "  File \"/Users/hakusai/src/hakusai/stacktrace-as-array/main.py\", line 14, in do_something",
    "    raise Exception(\"something wrong\")",
    "Exception: something wrong"
  ]
}

Proposal

• Add Option such like stack_trace_as_array to JsonFormatter.
  • default: False for backward compatibility.
  • if True, The formatter encodes stack traces as an array.

If you agree this feature, I will create PR.

[nhairs]

Interesting idea - definitely not opposed to it, but would like to hear what others have to say about it.

[edgarrmondragon]

FWIW, structlog does something similar

{
    "event": "Cannot compute!",
    "exception": [
        {
            "exc_type": "ZeroDivisionError",
            "exc_value": "division by zero",
            "syntax_error": null,
            "is_cause": false,
            "frames": [
                {
                    "filename": "<doctest default[3]>",
                    "lineno": 2,
                    "name": "<module>",
                    "locals": {...,
                        "var": "'spam'"
                    }
                }
            ]
        }
    ]
}

https://www.structlog.org/en/stable/api.html#structlog.processors.JSONRenderer

[nhairs]

That's good to know thanks @edgarrmondragon

[1hakusai1]

Thanks! I will implement it.