Chromium Code Reviews| Index: pkg/logging/README.md |
| diff --git a/pkg/logging/README.md b/pkg/logging/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..25862062a440cd3d9be0ca4a89eab383e54e4c39 |
| --- /dev/null |
| +++ b/pkg/logging/README.md |
| @@ -0,0 +1,44 @@ |
| +Support for logging. |
|
sethladd
2014/07/24 16:48:13
Nit: start line with # ?
kevmoo
2014/07/24 17:44:18
Done.
|
| + |
|
sethladd
2014/07/24 16:48:13
READMEs often include notes about where to file bu
kevmoo
2014/07/24 17:44:18
There's already a license file in the package. We
|
| +## Initializing |
| + |
| +By default, the logging package does not do anything useful with the |
| +log messages. You must configure the logging level and add a handler |
| +for the log messages. |
| + |
| +Here is a simple logging configuration that logs all messages |
| +via `print`. |
| + |
| +```dart |
| +Logger.root.level = Level.ALL; |
| +Logger.root.onRecord.listen((LogRecord rec) { |
| + print('${rec.level.name}: ${rec.time}: ${rec.message}'); |
| +}); |
| +``` |
| + |
| +First, set the root [Level]. All messages at or above the level are |
| +sent to the [onRecord] stream. |
| + |
| +Then, listen on the [onRecord] stream for [LogRecord] events. The |
| +[LogRecord] class has various properties for the message, error, |
| +logger name, and more. |
| + |
| +## Logging messages |
| + |
| +Create a [Logger] with a unique name to easily identify the source |
| +of the log messages. |
| + |
| +```dart |
| +final Logger log = new Logger('MyClassName'); |
| +``` |
| + |
| +Here is an example of logging a debug message and an error: |
| + |
| +```dart |
| +var future = doSomethingAsync().then((result) { |
| + log.fine('Got the result: $result'); |
| + processResult(result); |
| +}).catchError((e, stackTrace) => log.severe('Oh noes!', e, stackTrace)); |
| +``` |
| + |
| +See the [Logger] class for the different logging methods. |