docs(logging): update Logging section in README with modern Observer usage and Talker integration examples

This commit is contained in:
Sergey Penkovsky
2025-08-12 00:32:39 +03:00
parent ea2b6687f4
commit 358da8f96b

View File

@@ -422,30 +422,68 @@ final dialogManager = dialogScope.resolve<DialogManager>();
### Logging
CherryPick supports centralized logging of all dependency injection (DI) events and errors. You can globally enable logs for your application or test environment with:
CherryPick lets you log all dependency injection (DI) events and errors using a flexible observer mechanism.
#### Custom Observers
You can pass any implementation of `CherryPickObserver` to your root scope or any sub-scope.
This allows centralized and extensible logging, which you can direct to print, files, visualization frameworks, external loggers, or systems like [Talker](https://pub.dev/packages/talker).
##### Example: Printing All Events
```dart
import 'package:cherrypick/cherrypick.dart';
void main() {
// Set a global logger before any scopes are created
CherryPick.setGlobalLogger(PrintLogger()); // or your custom logger
final scope = CherryPick.openRootScope();
// All DI actions and errors will now be logged!
// Use the built-in PrintCherryPickObserver for console logs
final observer = PrintCherryPickObserver();
final scope = CherryPick.openRootScope(observer: observer);
// All DI actions and errors will now be printed!
}
```
- All dependency resolution, scope creation, module installation, and circular dependency errors will be sent to your logger (via info/error method).
- By default, logs are off (SilentLogger is used in production).
If you want fine-grained, test-local, or isolated logging, you can provide a logger directly to each scope:
##### Example: Advanced Logging with Talker
For richer logging, analytics, or UI overlays, use an advanced observer such as [talker_cherrypick_logger](../talker_cherrypick_logger):
```dart
final logger = MockLogger();
final scope = Scope(null, logger: logger); // works in tests for isolation
scope.installModules([...]);
import 'package:cherrypick/cherrypick.dart';
import 'package:talker/talker.dart';
import 'package:talker_cherrypick_logger/talker_cherrypick_logger.dart';
void main() {
final talker = Talker();
final observer = TalkerCherryPickObserver(talker);
CherryPick.openRootScope(observer: observer);
// All container events go to the Talker log system!
}
```
#### Default Behavior
- By default, logging is silent (`SilentCherryPickObserver`) for production, with no output unless you supply an observer.
- You can configure observers **per scope** for isolated, test-specific, or feature-specific logging.
#### Observer Capabilities
Events you can observe and log:
- Dependency registration
- Instance requests, creations, disposals
- Module installs/removals
- Scope opening/closing
- Cache hits/misses
- Cycle detection
- Diagnostics, warnings, errors
Just implement or extend `CherryPickObserver` and direct messages anywhere you want!
#### When to Use
- Enable verbose logging and debugging in development or test builds.
- Route logs to your main log system or analytics.
- Hook into DI lifecycle for profiling or monitoring.
---
### Circular Dependency Detection