Skip to content

Commit

Permalink
Review debug log output sections and formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
@dkocher
dkocher committed Nov 21, 2023
1 parent 971fbc9 commit ffbcde0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 55 deletions.
62 changes: 11 additions & 51 deletions cyberduck/support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).
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 [[email protected]](mailto:[email protected]).
```

```{warning}
Expand All @@ -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<https://github.com/AdoptOpenJDK/openjdk13-binaries/releases/download/jdk-13.0.2%2B8/OpenJDK13U-jdk_x64_mac_hotspot_13.0.2_8.pkg>`.
````
````{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.
Expand Down
8 changes: 4 additions & 4 deletions mountainduck/support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ffbcde0

Please sign in to comment.