Logging Examples Specific to CPS
...
Where exactly to log error, at source or a common central place?
- Prevent same error being logged may times (some duplication might be unavoidable though)
- Consider that REST layer is optional (so that is why the current commit is not a good solution for centralized logging)
Logging Decisions
...
General Guideline
| 1 | It is up to the consumer of the java API if they want to log the exception or not. |
| 2 | In the REST API when we catch an exception we should log it as we lose a lot of information when we convert it into a HTTP response code. |
| 3 | For business exceptions we will use error level but we will add configuration so that it is not written to the console by default. |
| 4 | You should log the original exception if it provides more information. |
| 5 | For business exceptions we will use error level but we will add configuration so that it is not written to the console by default. |
Logging Examples Specific to CPS
| # | Scenario | Logging level | Decision on how/where to log |
|---|---|---|---|
| 1 | If the user tries to add an anchor with no dataspace we will log "Dataspace does not exist". | This will be logged in the place it is handled. | |
| 2 | Where exactly to log error, at source or a common central place?
|
Summary of each logging level
...