Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(576)

Unified Diff: pkg/logging/README.md

Issue 413193002: pkg/logging: use UnmodifiableMapView from dart:collection (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: removed initial line Created 6 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | pkg/logging/lib/logging.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/logging/README.md
diff --git a/pkg/logging/README.md b/pkg/logging/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..9d6c97815a78f835054978ad179d77b0052caff9
--- /dev/null
+++ b/pkg/logging/README.md
@@ -0,0 +1,42 @@
+## 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.
« no previous file with comments | « no previous file | pkg/logging/lib/logging.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698