Erweiterbares Protokollierung für Flutter – basierend auf Timber für Android, mit ähnlicher (soweit es die Dart-Sprache erlaubt) Methoden-API und denselben Konzepten für Baum und Pflanzung der Protokollbaumstruktur.
Aus öffentlichen Paketdaten erstellte Orientierung.
Fimber ist ein erweiterbares Logging-Paket für Flutter, inspiriert durch Androids Timber. Es bietet eine saubere, konsistente API zum Protokollieren mit Unterstützung für mehrere Log-Bäume, wodurch Entwickler Logs an verschiedene Ziele wie Konsole, Dateien oder Remote-Dienste weiterleiten können. Fimber legt Wert auf Einfachheit und Flexibilität und ermöglicht bedingtes Protokollieren sowie strukturierte Ausgaben. Sein Design folgt eng den Konzepten von Timber, passt sich aber den Beschränkungen der Dart-Sprache an. Ideal für Debugging und Überwachung in Entwicklung- und Produktionsumgebungen.
Anwendungsfälle
Debugging des App-Verhaltens
Überwachung von Laufzeitproblemen
Bedingte Protokollierung in der Produktion
Zentralisierte Protokollverwaltung
Integration mit Crash-Meldungstools
Testprotokoll-Ausgaben
Hauptmerkmale
Baum-basierte Protokollarchitektur
Erweiterbares Protokollbaum-System
Ähnliche API wie Android Timber
Unterstützung für mehrere Ausgabedestinationen
Bedingtes Protokollieren über Tags
Einfache Einrichtung mit minimalem Boilerplate
Geeignet für
Flutter-Entwickler, die strukturiertes Protokollieren suchen
Teams, die eine flexible Protokollweiterleitung benötigen
Apps, die eine Unterscheidung zwischen Debug- und Release-Modus erfordern
Projekte, die mit externen Überwachungsdiensten integriert sind
Entwickler, die mit Timber auf Android vertraut sind
Hinweise
Kann für fortgeschrittene Anwendungsfälle zusätzliche Konfiguration erfordern
Leistungseinbußen bei Szenarien mit hoher Frequenz der Protokollierung
Eingeschränkte integrierte Formatierung im Vergleich zu umfassenden Logging-Frameworks
Nicht für umfangreiche Protokollverarbeitung oder -analyse geeignet
Benötigt manuelle Einrichtung von Protokollbäumen für komplexe Workflows
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
fimber
Extensible logging for Dart and Flutter.
Package is based on famous Android logging library API - Timber, this is library for simplify logging for Flutter.
Using similar (as far as Dart lang allows) method API with same concepts for tree and planting logging tree.
Also check out flutter_fimber which extends fimber to platform specific output and logging style.
Getting Started
To start add using it:
Add fimber to pubspec.yaml
pre-nullsafety
dependencies:fimber:^0.6.6
remember about import in file you plan to use Fimber
import'package:fimber/fimber.dart';
Initialize logging tree on start of your application
voidmain() {
Fimber.plantTree(DebugTree());
// app code here ...// DebugTree options for time elapsed// by default DebugTree will output timestamp of the VM/Flutter app// to enable elapsed time since planting the tree logFimber.plantTree(DebugTree.elapsed());
}
Start using it with static methods:
import'fimber.dart';
voidmain() {
var parameter = 343.0;
// use directlyFimber.i("Test message $argument");
Fimber.i("Extra error message", ex: Exception("Test thorwable"));
// other log levelsFimber.d("DEBUG");
Fimber.v("VERBOSE");
Fimber.w("WARN");
try {
throwException("Exception thrown");
} catch (e, stacktrace) {
// providing `stacktrace` will better show where issue was thrown// if not provided will use log line location.Fimber.i("Error caught.", ex: e, stacktrace: stacktrace);
}
}
This will log the value and grab a TAG from stacktrace - that is little costly and if more logs will be done per second.
Colorize logs - ColorizeStyle
useColors property set to true will use default colors of the logos, you can change the mapping with in colorizeMap for DebugTree and CustomFormatTree
The useColors by default is disabled.
ColorizeStyle Aggregates list of AnsiStyle so you can combine styles together.
And use its instance inside class, you can create logger for a dart file or for a class.
var logger = FimberLog("MY_TAG");
voidmain() {
logger.d("Test message");
}
// or inside a classclassSomeBloc{
var logger = FimberLog("SomeBloc");
StringfetchMessage() {
logger.d("About to fetch some data.");
//...var data = "load something";
logger.d("Retrived data (len = ${data.length}");
return data;
}
}
Use block function and pass method that uses logger.
Use this function to log multiple messages with same tag, allows optional return value.
Due to nature of auto-tag generation from stacktrace this block only does it once and create local FimberLog instance to pass into the anonymous method.
var someMessage = "Test message from inside of block";
var output = Fimber.block((log) {
log.d("Started block");
var i = 0;
for (i = 0; i < 10; i++) {
log.d("$someMessage, value: $i");
}
log.i("End of block");
return i;
});
Custon line formatters
Use custom line formatters to define your logging format.
Use file log tree - the logs will go to a log file (Useful in DartVM apps).
There are log rolling with size and time/date interval, so it is possible to setup log output per hour/day or any other time.
see: SizeRollingFileTree or TimedRollingFileTree or use abstract class RollingFileTree to create your own version of rolling log file.
Add Crashlytics plugin (maybe other remote logger tools) with flutter_crashlytics
Licence
Copyright2018MateuszPerlakLicensed under the ApacheLicense, Version2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unlessrequired by applicable law or agreed to in writing, software
distributed under the Licenseis distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the Licensefor the specific language governing permissions and
limitations under the License.