패키지, 저장소 및 앱 카테고리 검색

패키지 상세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
  • 다중 출력 대상 지원
  • 태그를 통한 조건부 로깅
  • 최소한의 보일러플레이트로 간단한 설정

적합한 대상

  • 구조화된 로깅을 원하는 플러터 개발자
  • 유연한 로그 라우팅이 필요한 팀
  • 디버그 및 릴리스 모드 구분이 필요한 앱
  • 외부 모니터링 서비스와 통합되는 프로젝트
  • 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.

카테고리

소스 저장소

이 패키지를 사용하는 프로젝트