Skip to content

Commit ffbcde0

Browse files
committed
Review debug log output sections and formatting.
1 parent 971fbc9 commit ffbcde0

File tree

2 files changed

+15
-55
lines changed

2 files changed

+15
-55
lines changed

cyberduck/support.md

Lines changed: 11 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For issues with your remote storage user account credentials, please instead wri
1616
[Open a new ticket](https://github.com/iterate-ch/cyberduck/issues/new/choose) with a description of what you have done and what went wrong. Make sure to look or search for existing issues first. If you have trouble connecting to a server or your login credentials are not valid, try to resolve the issue with the assistance of your hosting service provider.
1717

1818
```{note}
19-
Discuss features and issues you are having in the [Cyberduck Google Group](https://github.com/iterate-ch/cyberduck/discussions). For issues with the registration key, please send an mail to [support@cyberduck.io](mailto:support@cyberduck.io).
19+
Discuss features and issues you are having in [GitHub Discussions](https://github.com/iterate-ch/cyberduck/discussions). For issues with the registration key, please send an email to [support@cyberduck.io](mailto:support@cyberduck.io).
2020
```
2121

2222
```{warning}
@@ -28,75 +28,35 @@ Please be aware that you are possibly using our software at no charge if you hav
2828
`````{tabs}
2929
````{group-tab} macOS
3030
31-
Log output can be found in the `cyberduck.log` file in`~/Library/Logs/Cyberduck`. You can also reveal the file by clicking on the _Show_ button within the Cyberduck preferences _Connection_ tab.
32-
33-
Alternatively, you can find `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`.
31+
Log output can be found in the `cyberduck.log` file in`~/Library/Logs/Cyberduck`. Select _Show_ in _Cyberduck → Preferences → Connection_ to reveal the log file. Alternatively, you can find `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`.
3432
3533
```{image} _images/Console.app.png
3634
:alt: Console.app
3735
:width: 600px
3836
```
3937
40-
````
41-
````{group-tab} Windows
42-
43-
Log output can be found in the `cyberduck.log` file in `%AppData%\cyberduck`. You can also reveal the file by clicking on the *Show* button within the Mountain Duck *Preferences Connection* tab. The file is named *cyberduck.log*.
44-
45-
````
46-
`````
47-
48-
### Debug Log
49-
50-
To enable debug logging tick the corresponding checkmark in the Cyberduck *Preferences Connection* tab. You can reach the logging output by clicking on the *Show* button within the same Cyberduck *Preferences* section. The file is called *cyberduck.log*.
51-
52-
Alternatively this can be configured using the following command line options.
53-
54-
````{tabs}
55-
```{group-tab} macOS
56-
57-
To enable debug logging open a *Terminal.app* window and enter
58-
59-
defaults write ~/Library/Preferences/ch.sudo.cyberduck.plist logging debug
60-
61-
Reset the logging configuration with
62-
63-
`defaults delete ~/Library/Preferences/ch.sudo.cyberduck.plist logging`
64-
65-
Restart Cyberduck for any logging configuration change to take effect.
66-
67-
```
68-
```{group-tab} Windows
69-
70-
Debug logging can be enabled with a [hidden setting](preferences.md#hidden-configuration-options). As there is no user interface for this yet you need to add the setting manually. If not existing yet you have to create the file [`%AppData%\Cyberduck\default.properties`](faq.md#preferences-and-application-support-files-location) and then add the property as follows:
38+
### Transcript
7139
72-
`logging=debug`
73-
74-
```
75-
````
76-
77-
### Additional Log Outputs
78-
79-
`````{tabs}
80-
````{tab} Transcript
81-
82-
You can only access the transcript which will log protocol request and responses. It's particular useful for protocols using HTTP. Open a *Terminal.app* window and enter
40+
You can access the transcript which will log protocol request and responses from the command line particularly useful for protocols using HTTP. Open a *Terminal.app* window and enter
8341
8442
`log stream --predicate '(process == "Cyberduck") && (category == "transcript")' --level info`
8543
8644
```{note}
8745
The transcript will be written in the *Terminal.app* window. Make sure to keep the window open after executing the command.
8846
```
89-
````
9047
91-
````{tab} Heap Dump
92-
93-
To create a heap dump of the Cyberduck process on macOS (in case of excessive memory usage for example) you can use `jmap` from the {download}`OpenJDK 13<https://github.com/AdoptOpenJDK/openjdk13-binaries/releases/download/jdk-13.0.2%2B8/OpenJDK13U-jdk_x64_mac_hotspot_13.0.2_8.pkg>`.
48+
````
49+
````{group-tab} Windows
9450
95-
`jmap -dump:file=cyberduck-dump.hprof [PID of Cyberduck process]`
51+
Log output can be found in the `cyberduck.log` file in `%AppData%\cyberduck`. Select _Show_ in _Cyberduck → Preferences → Connection_ to reveal the log file named *cyberduck.log*.
9652
9753
````
9854
`````
9955

56+
### Debug Log
57+
58+
To enable verbose log output select _Enable debug log_ in _Cyberduck → Preferences → Connection_.
59+
10060
## Application Support Folder
10161

10262
Inside the application support folder, the application saves files needed for their operations e.g. settings, log data, history files, etc.

mountainduck/support.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@ You can reach the application support folder by navigating to `%AppData%\Cyberdu
2929
`````{tabs}
3030
````{group-tab} macOS
3131
32-
Log output can be found in the `mountainduck.log` file in`~/Library/Logs/Mountain Duck`. You can easily reach this file in _Console.app_ (Open from `/Applications/Utilities`) under `Reports → Log Reports → mountainduck.log`. You can also reveal the file by clicking on the _Show_ button within the Mountain Duck preferences _Connection_ tab.
32+
Log output can be found in the `mountainduck.log` file in`~/Library/Logs/Mountain Duck`. You can easily reach this file in _Console.app_ (Open from `/Applications/Utilities`) under `Reports → Log Reports → mountainduck.log`. Select _Show_ in _Mountain Duck → Preferences → Connection_ to reveal the log file.
3333
3434
````
3535
````{group-tab} Windows
3636
37-
Log output can be found in the `mountainduck.log` file in `%AppData%\cyberduck`. You can also reveal the file by clicking on the *Show* button within the Mountain Duck *Preferences Connection* tab. The file is named *mountainduck.log*.
37+
Log output can be found in the `mountainduck.log` file in `%AppData%\cyberduck`. Select _Show_ in _Mountain Duck → Preferences → Connection_ to reveal the log file named *mountainduck.log*.
3838
3939
````
4040
`````
4141

4242
#### Debug Log
4343

44-
To enable debug logging tick the corresponding checkmark in the Mountain Duck *Preferences Connection* tab. You can reach the logging output by clicking on the *Show* button within the same Mountain Duck *Preferences* section. The file is called *mountainduck.log*.
44+
To enable verbose log output select _Enable debug log_ in _Mountain Duck Preferences → Connection_.
4545

4646
#### Error Log
4747

4848
An error log is a record of critical errors that occur during the operation of the application or server. It can be a useful tool for troubleshooting.
4949

50-
It can be reached by clicking on the Show button within the Mountain Duck *Preferences Connection* tab. The file is named *mountainduck.error*.
50+
It can be reached by clicking on the Show button within _Mountain Duck Preferences → Connection_. The file is named *mountainduck.error*.
5151

5252
### Feature Request
5353

0 commit comments

Comments
 (0)