Skip to content

Commit

Permalink
Logging.md: Refer to se-edu/guides for logging level definitions
Browse files Browse the repository at this point in the history
As logging level definition is already present in se-edu/guides,
let's remove it from Logging.md and refer to se-edu/guides version
instead.
  • Loading branch information
damithc committed Jun 7, 2020
1 parent ed764e8 commit 53a4c2d
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions docs/Logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,9 @@ layout: page
title: Logging guide
---

We are using `java.util.logging` package for logging. The `LogsCenter`
class is used to manage the logging levels and logging destinations.

* The logging level can be controlled using the `logLevel` setting in the configuration file (See the [Configuration](#configuration) section).
* We are using `java.util.logging` package for logging.
* The `LogsCenter` class is used to manage the logging levels and logging destinations.
* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level.
* Log messages are output through: `Console` and to a `.log` file.

**Logging Levels**

* `SEVERE`: A critical problem detected which may cause the termination of the application.
* `WARNING`: Can continue, but with caution.
* `INFO`: Information showing the noteworthy actions by the App.
* `FINE`: Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size.

* Log messages are output through the console and to a `.log` file.
* The output logging level can be controlled using the `logLevel` setting in the configuration file (See the [Configuration guide](Configuration.md) section).
* **When choosing a level for a log message**, follow the conventions given in [_[se-edu/guides] Java: Logging conventions_](https://se-education.org/guides/conventions/java/logging.html).

0 comments on commit 53a4c2d

Please sign in to comment.