Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bmw-tech/lumberdash
Do you need logs? Lumberdash is the answer!
https://github.com/bmw-tech/lumberdash
flutter flutter-package
Last synced: 7 days ago
JSON representation
Do you need logs? Lumberdash is the answer!
- Host: GitHub
- URL: https://github.com/bmw-tech/lumberdash
- Owner: bmw-tech
- Created: 2019-03-07T00:03:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-14T08:10:41.000Z (about 2 years ago)
- Last Synced: 2024-10-22T10:58:08.782Z (16 days ago)
- Topics: flutter, flutter-package
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/lumberdash
- Size: 221 KB
- Stars: 165
- Watchers: 11
- Forks: 25
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# lumberdash
[](https://github.com/bmw-tech/lumberdash/actions)
[](https://codecov.io/gh/bmw-tech/lumberdash)
[](https://pub.dartlang.org/packages/lumberdash)
Do you need logs? Lumberdash is the answer! With a simple but powerful logging API, Lumberdash is the easiest way to record logs.
And if that is not enough, you can extend its API and create your own custom plugins for your own logging needs.
## How it works
Simply `putLumberdashToWork` with your preferred `LumberdashClient`, and start logging!
You can get the best of **Lumberdash** by using plugins! For example, by using the `colorize_lumberdash`, you could print logs in stdout with colors:
```dart
import 'package:lumberdash/lumberdash.dart';
import 'package:colorize_lumberdash/colorize_lumberdash.dart';
void main() {
putLumberdashToWork(withClients: [ColorizeLumberdash()]);
logWarning('Hello Warning');
logFatal('Hello Fatal!');
logMessage('Hello Message!');
logError(Exception('Hello Error'));
}
```
You could also use multiple clients to log to different sources:
```dart
import 'package:lumberdash/lumberdash.dart';
import 'package:colorize_lumberdash/colorize_lumberdash.dart';
import 'package:firebase_lumberdash/firebase_lumberdash.dart';
void main() {
putLumberdashToWork(withClients: [
ColorizeLumberdash(),
FirebaseLumberdash(
firebaseAnalyticsClient: FirebaseAnalytics(),
environment: 'development',
releaseVersion: '1.0.0',
),
]);
logWarning('Hello Warning');
logFatal('Hello Fatal!');
logMessage('Hello Message!');
logError(Exception('Hello Error'));
}
```
## Plugins officially supported by BMW
- [colorize_lumberdash](https://pub.dartlang.org/packages/colorize_lumberdash)
- [firebase_lumberdash](https://pub.dartlang.org/packages/firebase_lumberdash)
- [print_lumberdash](https://pub.dartlang.org/packages/print_lumberdash)
- [sentry_lumberdash](https://pub.dartlang.org/packages/sentry_lumberdash)
### How to create a Lumberdash plugin
Add `lumberdash` to your dependencies, and extend the `LumberdashClient`. That easy!
You can see the `SimpleClient` in this package as inspiration.
## Maintainers
This project is maintained by BMW Group.
Thank you to the original authors
- Jorge Coca (@jorgecoca)
- Felix Angelov (@felangel)
- Tim Chabot(@tchabot22)
and all contributors.
## License
```
MIT License
Copyright (c) 2019 BMW Technology Corporation
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.
```