flameshot-org/flameshot

Verbose logging

オープン

#3,172 opened on 2023/04/19

 (1 件のコメント) (3 件のリアクション) (1 人の担当者)C++ (1,916 件のフォーク)batch import
CLIEnhancementHacktoberfest

Repository metrics

Stars
 (29,897 個のスター)
PR merge metrics
 (平均マージ 2d 23h) (30d で 12 merged PRs)

説明

Feature Description

The issue

It has been brought up quite a few times that the user is willing to help us pin-point the issue (e.g https://github.com/flameshot-org/flameshot/issues/3126#issuecomment-1475760380) , but there is no easy way to give us some log on what is happening on their computer.

The suggestion

It would be good to have an opt-in verbose logging system that it can store a log file and the user can send it to us. It should be verbose enough especially about:

  • the information it detects from the host machine (OS, monitors, keyboard layout, flameshot version)
  • the build flags that the Flameshot binary was built with
  • the config and if there is any issues detected with it when reading it and if it falls back to any defaults
  • the CLI argument that was passed to the Flameshot binary
  • the dbus messages sent and received

Design suggestion

  • One simple CLI flags: --log which it send to stdout if no file is defined, or if path is defined writes it into files.
  • if writing to files, it would be better if it can write one file per any of the item in the previous list and also incorporates a uniform epoch in the file names in case user runs Flameshot multiple times.

コントリビューターガイド