Skip to content

Commit ed2a3c5

Browse files
Adjusting documentation
1 parent b7294cb commit ed2a3c5

File tree

3 files changed

+31
-30
lines changed

3 files changed

+31
-30
lines changed

docs/core/logger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,17 +321,17 @@ Logger can optionally log uncaught exceptions by setting `log_uncaught_exception
321321

322322
#### Stack trace logging
323323

324-
Logger can optionally log the full stack trace as JSON by setting `logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True)` at initialization.
324+
By default, the Logger will automatically log the full stack trace in JSON format when using `logger.exception`. If you want to disable this feature, set `serialize_stacktrace=False` during initialization."
325325

326326
=== "logging_stacktrace.py"
327327

328-
```python hl_lines="8"
328+
```python hl_lines="7 15"
329329
--8<-- "examples/logger/src/logging_stacktrace.py"
330330
```
331331

332332
=== "logging_stacktrace_output.json"
333333

334-
```json hl_lines="7-22"
334+
```json hl_lines="9-27"
335335
--8<-- "examples/logger/src/logging_stacktrace_output.json"
336336
```
337337

examples/logger/src/logging_stacktrace.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import requests
22

33
from aws_lambda_powertools import Logger
4-
from aws_lambda_powertools.logging.formatter import LambdaPowertoolsFormatter
54
from aws_lambda_powertools.utilities.typing import LambdaContext
65

76
ENDPOINT = "http://httpbin.org/status/500"
8-
logger = Logger(logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True))
7+
logger = Logger(serialize_stacktrace=True)
98

109

1110
def lambda_handler(event: dict, context: LambdaContext) -> str:
Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
11
{
2-
"level": "ERROR",
3-
"location": "lambda_handler:16",
4-
"message": "500 Server Error: INTERNAL SERVER ERROR for url: http://httpbin.org/status/500",
5-
"timestamp": "2023-09-28 19:25:09,781+0000",
6-
"service": "service_undefined",
7-
"stack_trace": [
8-
{
9-
"File": "/var/task/app.py",
10-
"Line": 14,
11-
"Column": 8,
12-
"Function": "lambda_handler",
13-
"Statement": "ret.raise_for_status()"
14-
},
15-
{
16-
"File": "/var/task/requests/models.py",
17-
"Line": 1021,
18-
"Column": 12,
19-
"Function": "raise_for_status",
20-
"Statement": "raise HTTPError(http_error_msg, response=self)"
21-
}
22-
],
23-
"exception": "Traceback (most recent call last):\n File \"/var/task/app.py\", line 14, in lambda_handler\n ret.raise_for_status()\n File \"/var/task/requests/models.py\", line 1021, in raise_for_status\n raise HTTPError(http_error_msg, response=self)\nrequests.exceptions.HTTPError: 500 Server Error: INTERNAL SERVER ERROR for url: http://httpbin.org/status/500",
24-
"exception_name": "HTTPError",
25-
"xray_trace_id": "1-6515d315-07fbcb5e693988c6480a98e2"
26-
}
2+
"level":"ERROR",
3+
"location":"lambda_handler:16",
4+
"message":"500 Server Error: INTERNAL SERVER ERROR for url: http://httpbin.org/status/500",
5+
"timestamp":"2023-10-09 17:47:50,191+0000",
6+
"service":"service_undefined",
7+
"exception":"Traceback (most recent call last):\n File \"/var/task/app.py\", line 14, in lambda_handler\n ret.raise_for_status()\n File \"/var/task/requests/models.py\", line 1021, in raise_for_status\n raise HTTPError(http_error_msg, response=self)\nrequests.exceptions.HTTPError: 500 Server Error: INTERNAL SERVER ERROR for url: http://httpbin.org/status/500",
8+
"exception_name":"HTTPError",
9+
"stack_trace":{
10+
"type":"HTTPError",
11+
"value":"500 Server Error: INTERNAL SERVER ERROR for url: http://httpbin.org/status/500",
12+
"module":"requests.exceptions",
13+
"frames":[
14+
{
15+
"file":"/var/task/app.py",
16+
"line":14,
17+
"function":"lambda_handler",
18+
"statement":"ret.raise_for_status()"
19+
},
20+
{
21+
"file":"/var/task/requests/models.py",
22+
"line":1021,
23+
"function":"raise_for_status",
24+
"statement":"raise HTTPError(http_error_msg, response=self)"
25+
}
26+
]
27+
}
28+
}

0 commit comments

Comments
 (0)