본문으로 건너뛰기

로깅

misskey_client는 HTTP 요청과 응답을 로깅할 수 있습니다. 로깅은 기본적으로 비활성화되어 있습니다.

로그 활성화​

MisskeyClientConfig에서 enableLog: true를 설정합니다:

final client = MisskeyClient(
  config: MisskeyClientConfig(
    baseUrl: Uri.parse('https://misskey.example.com'),
    enableLog: true,
  ),
  tokenProvider: () => 'token',
);

활성화하면 기본 StdoutLogger가 logger 패키지를 통해 stdout에 출력합니다.

로그 비활성화​

enableLog를 생략하거나 false로 설정합니다 (기본값):

final client = MisskeyClient(
  config: MisskeyClientConfig(
    baseUrl: Uri.parse('https://misskey.example.com'),
    enableLog: false, // 기본값
  ),
);

FunctionLogger를 사용한 커스텀 로거​

FunctionLogger는 간단한 콜백을 Logger 인터페이스에 맞게 조정합니다:

final client = MisskeyClient(
  config: MisskeyClientConfig(
    baseUrl: Uri.parse('https://misskey.example.com'),
    enableLog: true,
  ),
  tokenProvider: () => 'token',
  logger: FunctionLogger((level, message) {
    // level은 'debug', 'info', 'warn', 'error' 중 하나입니다
    myLogger.log(level, message);
  }),
);

FunctionLogger는 enableLog 플래그보다 우선합니다. 커스텀 로거를 제공하면 enableLog 설정에 관계없이 모든 로그 호출을 받습니다.

커스텀 Logger 구현​

완전한 제어를 위해 Logger 인터페이스를 직접 구현할 수 있습니다:

class MyLogger implements Logger {
  @override
  void debug(String message) { /* ... */ }

  @override
  void info(String message) { /* ... */ }

  @override
  void warn(String message) { /* ... */ }

  @override
  void error(String message, [Object? error, StackTrace? stackTrace]) {
    // 선택적 스택 트레이스와 함께 오류 처리
  }
}

final client = MisskeyClient(
  config: MisskeyClientConfig(
    baseUrl: Uri.parse('https://misskey.example.com'),
  ),
  tokenProvider: () => 'token',
  logger: MyLogger(),
);

기본 동작​

enableLog: true로 설정하고 커스텀 logger를 제공하지 않으면 StdoutLogger가 사용됩니다. 내부적으로 logger 패키지에 위임합니다.

디버그 빌드에서는 모든 로그 레벨 (debug 이상)이 출력됩니다. 릴리스 빌드에서는 경고와 오류만 출력됩니다.

로그 형식:

[misskey_client] [LEVEL] 2025-01-01 12:00:00.000000 message