Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simc/logger
Small, easy to use and extensible logger which prints beautiful logs.
https://github.com/simc/logger
Last synced: 6 days ago
JSON representation
Small, easy to use and extensible logger which prints beautiful logs.
- Host: GitHub
- URL: https://github.com/simc/logger
- Owner: simc
- License: mit
- Created: 2019-06-04T20:17:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T14:40:26.000Z (about 1 year ago)
- Last Synced: 2025-01-19T19:12:10.711Z (6 days ago)
- Language: Dart
- Homepage: https://pub.dev/packages/logger
- Size: 555 KB
- Stars: 1,069
- Watchers: 14
- Forks: 128
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- project-awesome - simc/logger - Small, easy to use and extensible logger which prints beautiful logs. (Dart)
README
# Logger
[](https://pub.dartlang.org/packages/logger)
[](https://github.com/leisim/logger/actions)
[](https://github.com/leisim/logger/commits/master)
[](https://github.com/leisim/logger/pulls)
[](https://github.com/leisim/logger)
[](https://github.com/leisim/logger/blob/master/LICENSE)
> [!CAUTION]
> This repo is NOT LONGER leading! The new repo is here: [https://github.com/SourceHorizon/logger](https://github.com/SourceHorizon/logger)
Small, easy to use and extensible logger which prints beautiful logs.
Inspired by [logger](https://github.com/orhanobut/logger) for Android.
**Show some ❤️ and star the repo to support the project**
### Resources:
- [Documentation](https://pub.dev/documentation/logger/latest/logger/logger-library.html)
- [Pub Package](https://pub.dev/packages/logger)
- [GitHub Repository](https://github.com/leisim/logger)
## Getting Started
Just create an instance of `Logger` and start logging:
```dart
var logger = Logger();
logger.d("Logger is working!");
```
Instead of a string message, you can also pass other objects like `List`, `Map` or `Set`.
## Output
# Documentation
## Log level
You can log with different levels:
```dart
logger.v("Verbose log");
logger.d("Debug log");
logger.i("Info log");
logger.w("Warning log");
logger.e("Error log");
logger.wtf("What a terrible failure log");
```
To show only specific log levels, you can set:
```dart
Logger.level = Level.warning;
```
This hides all `verbose`, `debug` and `info` log events.
## Options
When creating a logger, you can pass some options:
```dart
var logger = Logger(
filter: null, // Use the default LogFilter (-> only log in debug mode)
printer: PrettyPrinter(), // Use the PrettyPrinter to format and print log
output: null, // Use the default LogOutput (-> send everything to console)
);
```
If you use the `PrettyPrinter`, there are more options:
```dart
var logger = Logger(
printer: PrettyPrinter(
methodCount: 2, // number of method calls to be displayed
errorMethodCount: 8, // number of method calls if stacktrace is provided
lineLength: 120, // width of the output
colors: true, // Colorful log messages
printEmojis: true, // Print an emoji for each log message
printTime: false // Should each log print contain a timestamp
),
);
```
### Auto detecting
With the `io` package you can auto detect the `lineLength` and `colors` arguments.
Assuming you have imported the `io` package with `import 'dart:io' as io;` you
can auto detect `colors` with `io.stdout.supportsAnsiEscapes` and `lineLength`
with `io.stdout.terminalColumns`.
You should probably do this unless there's a good reason you don't want to
import `io`, for example when using this library on the web.
## LogFilter
The `LogFilter` decides which log events should be shown and which don't.
The default implementation (`DevelopmentFilter`) shows all logs with `level >= Logger.level` while in debug mode. In release mode all logs are omitted.
You can create your own `LogFilter` like this:
```dart
class MyFilter extends LogFilter {
@override
bool shouldLog(LogEvent event) {
return true;
}
}
```
This will show all logs even in release mode. (**NOT** a good idea)
## LogPrinter
The `LogPrinter` creates and formats the output, which is then sent to the `LogOutput`.
You can implement your own `LogPrinter`. This gives you maximum flexibility.
A very basic printer could look like this:
```dart
class MyPrinter extends LogPrinter {
@override
List log(LogEvent event) {
return [event.message];
}
}
```
If you created a cool `LogPrinter` which might be helpful to others, feel free to open a pull request. :)
### Colors
Please note that all IDEs (VSCode, XCode, Android Studio, IntelliJ) do not
support ANSI escape sequences in their terminal outputs. These escape sequences
are used to color output. If using such an IDE do not configure colored output.
However, if you are using a JetBrains IDE (Android Studio, IntelliJ, etc.)
you can make use of the [Grep Console Plugin](https://plugins.jetbrains.com/plugin/7125-grep-console)
and the [`PrefixPrinter`](/lib/src/printers/prefix_printer.dart)
decorator to achieved colored logs for any logger:
```dart
var logger = Logger(
printer: PrefixPrinter(PrettyPrinter(colors: false))
);
```
## LogOutput
`LogOutput` sends the log lines to the desired destination.
The default implementation (`ConsoleOutput`) send every line to the system console.
```dart
class ConsoleOutput extends LogOutput {
@override
void output(OutputEvent event) {
for (var line in event.lines) {
print(line);
}
}
}
```
Possible future `LogOutput`s could send to a file, firebase or to Logcat. Feel free to open pull requests.
## logger_flutter extension
The [logger_flutter](https://pub.dev/packages/logger_flutter) package is an extension for logger. You can add it to any Flutter app. Just shake the phone to show the console.
## MIT License
```
Copyright (c) 2019 Simon Leier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```