Skip to content

Commit 9eb2328

Browse files
authored
Merge pull request #10661 from nextcloud/backport/10598/stable-34.0
[stable-34.0] fix(agents): Document how to properly acquire desktop client logs
2 parents f63d926 + db1e379 commit 9eb2328

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,29 @@ All contributions generated or assisted by this agent must fully comply with:
6464

6565
## General Guidance
6666

67+
### Collecting desktop-client application logs
68+
69+
For client behaviour bugs, collect the desktop client's own application log rather than relying only on the operating system log or Qt plugin tracing. The client logger supports these command-line options:
70+
71+
- `--logdebug` enables debug-level messages, including the detailed GUI and sync categories.
72+
- `--logflush` flushes each message promptly so the log is useful while reproducing a failure.
73+
- `--logfile <path>` writes to the specified file. `--logfile -` writes to standard output.
74+
- `--logdir <path>` writes rotating timestamped logs to a directory.
75+
76+
On macOS, the application sandbox can prevent the client from opening an arbitrary path such as the Desktop. Capturing standard output and letting the shell write the copy avoids that problem:
77+
78+
```sh
79+
logfile="$HOME/Desktop/nextcloud-client-$(date +%Y%m%d-%H%M%S).log"
80+
81+
"/path/to/Nextcloud.app/Contents/MacOS/Nextcloud" \
82+
--logfile - \
83+
--logdebug \
84+
--logflush \
85+
2>&1 | tee "$logfile"
86+
```
87+
88+
Quit all existing client instances before starting this command, and reproduce the problem in the instance launched by the command. The client is single-instance: launching another copy can forward the action to an already-running process, leaving the captured process without the relevant application log entries. Stop the capture with `Ctrl-C` after reproducing the issue and attach the resulting file. For a sharing or file-details issue, retain entries from the relevant `nextcloud.gui.*` categories and any warnings or errors around the reproduction.
89+
6790
### License headers
6891

6992
Every new file must include the correct SPDX license header. For GPL-2.0-or-later (the default for this repository):

0 commit comments

Comments
 (0)