1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/website/docs/contributing/ADRs/overarching/logging.md

41 lines
854 B
Markdown
Raw Normal View History

---
title: "ADR: Logging errors"
---
## Background
After debugging multiple errors over the last few years, we've consistently found that when something goes wrong, we
would like as much context as possible to debug faster.
## Decision
When we log at the error level, we should give the person debugging as much information as possible.
As such, please include the error as a second argument to `logger.error`. This will include the stacktrace in the log
message and make it a lot easier to figure out where the error is coming from
### Change
#### Previously
```typescript
function errors() {
try {
} catch (e) {
this.logger.error(`Something went wrong {$e}`);
}
}
```
to
#### Now (Recommended)
```typescript
function errors() {
try {
} catch (e) {
this.logger.error('Something went wrong', e);
}
}
```