[breaking] `daemon --debug-file` will overwrite the log file instead of appending to it #1773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Closed

cmaglie wants to merge 1 commit into arduino:master from cmaglie:overwrite_debug_logs

Closed

[breaking] `daemon --debug-file` will overwrite the log file instead of appending to it #1773

cmaglie wants to merge 1 commit into arduino:master from cmaglie:overwrite_debug_logs

Conversation

cmaglie

Copy link

Member

@cmaglie cmaglie commented Jun 17, 2022 •

edited

Loading

Please check if the PR fulfills these requirements

The PR has no duplicates (please search among the Pull Requests
before creating one)
The PR follows
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
UPGRADING.md has been updated with a migration guide (for breaking changes)

What kind of change does this PR introduce?
daemon --debug-file log.txt will overwrite log.txt instead of appending to it

What is the current behavior?
daemon --debug-file log.txt will append on log.txt

What is the new behavior?
daemon --debug-file log.txt will overwrite log.txt

Does this PR introduce a breaking change, and is titled accordingly?
Yes, UPGRADING.md has been updated

@cmaglie


 daemon --debug-file will overwrite instead of append

131533f

@cmaglie cmaglie requested a review from a team

June 17, 2022 09:53

@cmaglie cmaglie self-assigned this

Jun 17, 2022

@cmaglie cmaglie added type: imperfection topic: CLI criticality: high labels

Jun 17, 2022

@cmaglie cmaglie added this to the arduino-cli 0.24.0 milestone

Jun 17, 2022

@cmaglie cmaglie changed the title ~~(削除) [breaking] daemon --debug-file will overwrite instead of appending to it (削除ここまで)~~ (追記) [breaking] daemon --debug-file will overwrite the log file instead of appending to it (追記ここまで)

Jun 17, 2022

@kittaakos

Copy link

Contributor

kittaakos commented Jun 17, 2022

I'm not too fond of it, and IDE2 does not need it.

On the IDE2 side, the gRPC log files preference should be a path to a folder. IDE2 should create a new log file per app session.

I've never seen an app/tool updating log files by erasing the content from the previous session.

@AlbyIanna

Copy link

AlbyIanna commented Jun 17, 2022 •

edited

Loading

@kittaakos it depends on what we want to achieve on the IDE. I believe a single file being overwritten every time is enough because otherwise, the CLI would log tons of lines and as a user, I wouldn't want to find a folder with a 10GB log file.

But this is only my opinion. In any case, with the change made in this PR we can still achieve what you are saying (that is: having a log file per session), we'd just need to name every file differently.

Let's discuss this in a separate thread because whether or not we'll have multiple log files in the IDE, it's not a CLI matter.