Registro extensível para Flutter - baseado no Timber do Android, usando uma API de método semelhante (na medida do permitido pela linguagem Dart), com os mesmos conceitos de árvore e plantio da árvore de registro.
Orientação gerada a partir de informações públicas. Apenas para referência.
Fimber é um pacote de registro extensível para Flutter, inspirado no Timber do Android. Ele oferece uma API limpa e consistente para log, com suporte a múltiplas árvores de log, permitindo que os desenvolvedores direcionem logs para diferentes destinos, como console, arquivos ou serviços remotos. O Fimber enfatiza simplicidade e flexibilidade, permitindo o registro condicional e saída estruturada. Seu design está alinhado com os conceitos do Timber, adaptando-se às limitações da linguagem Dart. Ideal para depuração e monitoramento em ambientes de desenvolvimento e produção.
Casos de uso
Depuração do comportamento do aplicativo
Monitoramento de problemas em tempo de execução
Registro condicional em produção
Gerenciamento centralizado de logs
Integração com ferramentas de relatório de falhas
Saídas de log de teste
Principais recursos
Arquitetura de registro baseada em árvore
Sistema de árvore de log extensível
API semelhante ao Android Timber
Suporte para múltiplos destinos de saída
Registro condicional por meio de tags
Configuração simples com pouco código boilerplate
Indicado para
Desenvolvedores Flutter procurando registro estruturado
Equipes que precisam de roteamento flexível de logs
Aplicativos que exigem diferenciação entre modo de depuração e lançamento
Projetos integrados com serviços externos de monitoramento
Desenvolvedores familiarizados com o Timber no Android
Considerações
Pode exigir configuração adicional para casos de uso avançados
Impacto no desempenho em cenários de logagem de alta frequência
Formatação interna limitada em comparação com frameworks de registro completos
Não projetado para processamento ou análise pesados de logs
Requer configuração manual de árvores de log para fluxos de trabalho complexos
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
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.