General Guidelines
| # | 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 | Exception should be logged as close to the source as possible. |
| 6 | For business exceptions we will use error level but we will add configuration so that it is not written to the console by default. |
| 7 | Check logging level when constructing strings i.e. using more than one static string. |
Summary of each logging level
...
| # | 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". | Error | This will be logged in the place it is handled. |
| 2 | Where exactly to log error, at source or a common central place?
| Error | This will be logged in the place it is handled. |