Skip to main content

Logging

misskey_client can log HTTP requests and responses. Logging is disabled by default.

Enabling logs​

Set enableLog: true in MisskeyClientConfig:

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

When enabled, the default StdoutLogger writes to stdout via the logger package.

Disabling logs​

Omit enableLog or set it to false (the default):

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

Custom logger with FunctionLogger​

FunctionLogger adapts a simple callback to the Logger interface:

final client = MisskeyClient(
  config: MisskeyClientConfig(
    baseUrl: Uri.parse('https://misskey.example.com'),
    enableLog: true,
  ),
  tokenProvider: () => 'token',
  logger: FunctionLogger((level, message) {
    // level is one of: 'debug', 'info', 'warn', 'error'
    myLogger.log(level, message);
  }),
);

FunctionLogger takes precedence over the enableLog flag. If you supply a custom logger, it receives all log calls regardless of enableLog.

Implementing a custom Logger​

For full control, implement the Logger interface:

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]) {
    // Handle error with optional stack trace
  }
}

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

Default behavior​

When enableLog: true is set and no custom logger is supplied, the StdoutLogger is used. It delegates to the logger package internally.

In debug builds, all log levels (debug and above) are emitted. In release builds, only warnings and errors are output.

Log format:

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