From 971fbc91c33289b37ce5d88b1b280daab7db2145 Mon Sep 17 00:00:00 2001 From: Cassie205 Date: Tue, 7 Nov 2023 17:31:11 +0100 Subject: [PATCH 1/2] Layout improvement: Cyberduck support page --- cyberduck/support.md | 71 ++++++++++++++++++++------------------------ 1 file changed, 33 insertions(+), 38 deletions(-) diff --git a/cyberduck/support.md b/cyberduck/support.md index 5dbff963..e119b203 100644 --- a/cyberduck/support.md +++ b/cyberduck/support.md @@ -25,21 +25,12 @@ Please be aware that you are possibly using our software at no charge if you hav ## Logging Output - -```````{tabs} -``````{group-tab} macOS - `````{tabs} -````{tab} Log - -Reveal the log output named `cyberduck.log` by choosing _Preferences → Connection → Log → Show_. - -Alternatively, the `cyberduck.log` file can be found in `~/Library/Logs/Cyberduck`. +````{group-tab} macOS -```` -````{tab} Console.app +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. -You can easily `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`. +Alternatively, you can find `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`. ```{image} _images/Console.app.png :alt: Console.app @@ -47,37 +38,18 @@ You can easily `cyberduck.log` in *Console.app* (Open from `/Applications/Utilit ``` ```` -````` - -**Transcript** - -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 - -`log stream --predicate '(process == "Cyberduck") && (category == "transcript")' --level info` - -```{note} -The transcript will be written in the *Terminal.app* window. Make sure to keep the window open after executing the command. -``` - - -**Heap Dump** - -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`. - -`jmap -dump:file=cyberduck-dump.hprof [PID of Cyberduck process]` +````{group-tab} Windows -`````` -``````{group-tab} Windows +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*. -Reveal the log output named `cyberduck.log` by choosing _Preferences → Connection → Log → Show_. +```` +````` -Alternatively, the `cyberduck.log` file can be found in `%AppData%\cyberduck`. +### Debug Log -`````` -``````` +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*. -### Debug Logging Level -Enable debug logging by choosing _Preferences → Connection → Log → Enable debug log_. Alternatively this can be configured using the following command line options. +Alternatively this can be configured using the following command line options. ````{tabs} ```{group-tab} macOS @@ -102,6 +74,29 @@ Debug logging can be enabled with a [hidden setting](preferences.md#hidden-confi ``` ```` +### Additional Log Outputs + +`````{tabs} +````{tab} Transcript + +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 + +`log stream --predicate '(process == "Cyberduck") && (category == "transcript")' --level info` + +```{note} +The transcript will be written in the *Terminal.app* window. Make sure to keep the window open after executing the command. +``` +```` + +````{tab} Heap Dump + +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`. + +`jmap -dump:file=cyberduck-dump.hprof [PID of Cyberduck process]` + +```` +````` + ## Application Support Folder Inside the application support folder, the application saves files needed for their operations e.g. settings, log data, history files, etc. From ffbcde0127229b6efe1ea5de663cfb100e81d6ca Mon Sep 17 00:00:00 2001 From: David Kocher Date: Tue, 21 Nov 2023 13:12:18 +0100 Subject: [PATCH 2/2] Review debug log output sections and formatting. --- cyberduck/support.md | 62 ++++++++--------------------------------- mountainduck/support.md | 8 +++--- 2 files changed, 15 insertions(+), 55 deletions(-) diff --git a/cyberduck/support.md b/cyberduck/support.md index e119b203..4c8855ce 100644 --- a/cyberduck/support.md +++ b/cyberduck/support.md @@ -16,7 +16,7 @@ For issues with your remote storage user account credentials, please instead wri [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. ```{note} -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). +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). ``` ```{warning} @@ -28,75 +28,35 @@ Please be aware that you are possibly using our software at no charge if you hav `````{tabs} ````{group-tab} macOS -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. - -Alternatively, you can find `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`. +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`. ```{image} _images/Console.app.png :alt: Console.app :width: 600px ``` -```` -````{group-tab} Windows - -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*. - -```` -````` - -### Debug Log - -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*. - -Alternatively this can be configured using the following command line options. - -````{tabs} -```{group-tab} macOS - -To enable debug logging open a *Terminal.app* window and enter - - defaults write ~/Library/Preferences/ch.sudo.cyberduck.plist logging debug - -Reset the logging configuration with - -`defaults delete ~/Library/Preferences/ch.sudo.cyberduck.plist logging` - -Restart Cyberduck for any logging configuration change to take effect. - -``` -```{group-tab} Windows - -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: +### Transcript -`logging=debug` - -``` -```` - -### Additional Log Outputs - -`````{tabs} -````{tab} Transcript - -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 +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 `log stream --predicate '(process == "Cyberduck") && (category == "transcript")' --level info` ```{note} The transcript will be written in the *Terminal.app* window. Make sure to keep the window open after executing the command. ``` -```` -````{tab} Heap Dump - -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`. +```` +````{group-tab} Windows -`jmap -dump:file=cyberduck-dump.hprof [PID of Cyberduck process]` +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*. ```` ````` +### Debug Log + +To enable verbose log output select _Enable debug log_ in _Cyberduck → Preferences → Connection_. + ## Application Support Folder Inside the application support folder, the application saves files needed for their operations e.g. settings, log data, history files, etc. diff --git a/mountainduck/support.md b/mountainduck/support.md index 143649a0..c94c6601 100644 --- a/mountainduck/support.md +++ b/mountainduck/support.md @@ -29,25 +29,25 @@ You can reach the application support folder by navigating to `%AppData%\Cyberdu `````{tabs} ````{group-tab} macOS -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. +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. ```` ````{group-tab} Windows -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*. +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*. ```` ````` #### Debug Log -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*. +To enable verbose log output select _Enable debug log_ in _Mountain Duck → Preferences → Connection_. #### Error Log 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. -It can be reached by clicking on the Show button within the Mountain Duck *Preferences Connection* tab. The file is named *mountainduck.error*. +It can be reached by clicking on the Show button within _Mountain Duck → Preferences → Connection_. The file is named *mountainduck.error*. ### Feature Request