パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.7.0

fimber

Flutter用の拡張可能なログ出力 - AndroidのTimberに基づき、Dart言語の制約内で可能な限り類似したメソッドAPIと、ツリーおよびログツリーの植え付けという同じコンセプトを使用しています。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
3.4万
いいね数
78
Pub ポイント
140

パッケージをインストール

flutter pub add fimber

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Fimber は、Android の Timber をインスパイアした拡張可能な Flutter 向けログパッケージです。複数のログツリーをサポートし、コンソール、ファイル、リモートサービスなど、さまざまな宛先にログをルーティングできる、洗練された一貫した API を提供します。Fimber はシンプルさと柔軟性を重視しており、条件付きログ記録や構造化出力を可能にしています。Dart の言語制約に合わせて、Timber の概念に近い設計を採用しています。開発および本番環境でのデバッグや監視に最適です。

用途

  • アプリケーション動作のデバッグ
  • 実行時問題のモニタリング
  • プロダクションでの条件付きログ記録
  • 集中型ログ管理
  • クラッシュレポートツールとの統合
  • テストログ出力

主な機能

  • ツリー型ログアーキテクチャ
  • 拡張可能なログツリーシステム
  • Android Timber と似た API
  • 複数の出力先のサポート
  • タグによる条件付きログ記録
  • 最小限のボイラープレートによるシンプルなセットアップ

適している対象

  • 構造化ログを求めるFlutter開発者
  • 柔軟なログルーティングが必要なチーム
  • デバッグおよびリリースモードの区別が必要なアプリ
  • 外部モニタリングサービスと統合するプロジェクト
  • Android の Timber に精通した開発者

注意事項

  • 高度なユースケースでは追加の構成が必要になる場合があります
  • 高頻度ログ記録シナリオにおけるパフォーマンスへの影響
  • 機能豊富なログフレームワークと比較して、組み込みのフォーマット機能が限られている
  • 大量のログ処理や分析には設計されていません
  • 複雑なワークフローには、ログツリーの手動設定が必要です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Analyze Code Style

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

void main() {
  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 log
  Fimber.plantTree(DebugTree.elapsed());
  
}
 
Start using it with static methods:
import 'fimber.dart';


void main() {
  var parameter = 343.0;
  // use directly
  Fimber.i("Test message $argument");
  Fimber.i("Extra error message", ex: Exception("Test thorwable"));
  
  // other log levels
  Fimber.d("DEBUG");
  Fimber.v("VERBOSE");
  Fimber.w("WARN");
  
  try {
    throw Exception("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.

AnsiStyle is combination of AnsiColor and AnsiSelection values

Here is output of test output.

Colorize Test Output

Create tagged version of Fimber

And use its instance inside class, you can create logger for a dart file or for a class.

var logger = FimberLog("MY_TAG");

void main() {
  
  logger.d("Test message");
}

// or inside a class
class SomeBloc {
  var logger = FimberLog("SomeBloc");
  String fetchMessage() {
    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.


    Fimber.plantTree(CustomFormatTree(
        logFormat: "${CustomFormatTree.TIME_ELAPSED_TOKEN} ${CustomFormatTree
            .MESSAGE_TOKEN} ${CustomFormatTree.TIME_STAMP_TOKEN}"
    ));

Deprecated moved to fimber_io package

import 'package:fimber_io/fimber_io.dart';

    Fimber.plantTree(FimberFileTree("my-Log-File.txt",
        logFormat: "${CustomFormatTree.TIME_ELAPSED_TOKEN} ${CustomFormatTree
            .MESSAGE_TOKEN} ${CustomFormatTree.TIME_STAMP_TOKEN}"
    ));

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.

TODO - road map

Licence


   Copyright 2018 Mateusz Perlak

   Licensed under the Apache License, Version 2.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.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト