Memospot Help

Debugging

There's a built-in logger that can help diagnose some issues.

yq

Yq is a portable YAML, JSON, XML, CSV, TOML and properties processor. It's a convenient way to edit configuration files from the command line.

Enabling logging

Using yq

  • Linux/macOS:

    yq -i '.memospot.log.enabled = true' "~/.memospot/memospot.yaml"

  • Windows:

    yq -i '.memospot.log.enabled = true' "$Env:LocalAppData\memospot\memospot.yaml"

Manually editing memospot.yaml

memospot: log: enabled: true

Increasing log level

Using yq

  • Linux/macOS:

    yq -i '.root.level = "debug"' "~/.memospot/logging_config.yaml"

  • Windows:

    yq -i '.root.level = "debug"' "$Env:LocalAppData\memospot\logging_config.yaml"

Manually editing logging_config.yaml

root: level: debug

Disabling logging

  • Linux/macOS:

    yq -i '.memospot.log.enabled = false' "~/.memospot/memospot.yaml" rm ~/.memospot/logging_config.yaml

  • Windows:

    yq -i '.memospot.log.enabled = false' "$Env:LocalAppData\memospot\memospot.yaml" Remove-Item "$Env:LocalAppData\memospot\logging_config.yaml"

Manually editing memospot.yaml

memospot: log: enabled: false

Default logging_config.yaml

appenders: file: encoder: pattern: "{d(%Y-%m-%d %H:%M:%S)} - {h({l})}: {m}{n}" path: $ENV{MEMOSPOT_DATA}/memospot.log kind: rolling_file policy: trigger: kind: size limit: 10 mb roller: kind: fixed_window pattern: $ENV{MEMOSPOT_DATA}/memospot.log.{}.gz count: 5 base: 1 root: # debug | info | warn | error | off level: info appenders: - file

Extra configurations options can be found in the log4rs documentation

Last modified: 18 May 2024
Contributing