Skip to content

docs: add FileOutput date-based example #56 #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AzazelSensei wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add FileOutput date-based example #56 #118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7300d5
docs: add FileOutput date-based example
AzazelSensei Sep 5, 2026
7e91438
docs: use DateTimeFormat.onlyDate in FileOutput example
AzazelSensei Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,26 @@ Other provided `LogOutput`s are:
* `FileOutput`/`AdvancedFileOutput`
* `StreamOutput`

### File output

`FileOutput` writes logs to a file. Include today's date in the file name
(`log-2024-02-01.log`, `log-2024-02-02.log`, ...):

```dart
import 'dart:io';

final logger = Logger(
printer: PrettyPrinter(colors: false),
output: FileOutput(
file: File('log-${DateTimeFormat.onlyDate(DateTime.now())}.log'),
),
);
```

The path is fixed when the `Logger` is created, so a process that stays up past
midnight keeps writing to the same file. For size-based rotation and buffered
writes, use `AdvancedFileOutput`. File output is not available on web.

Possible future `LogOutput`s could send to Firebase or to Logcat. Feel free to open pull
requests.

Expand Down
Loading