diff --git a/src/support/collect-diagnostic.md b/src/support/collect-diagnostic.md index 97e61d2e..d871ed17 100644 --- a/src/support/collect-diagnostic.md +++ b/src/support/collect-diagnostic.md @@ -1,7 +1,38 @@ # Collect Diagnostic -The [zilla dump](/reference/config/zilla-cli.md#zilla-dump) command will capture all the internal events at the stream level for a detailed analysis of what zilla was doing. +Collect the following diagnostic information after reproducing the issue you are observing, and collect the artefacts once the behavior occurs so that runtime data is still available. -These logs are captured down to the nanosecond and are exported as a `.pcap` file to be used with [Wireshark](https://wiki.wireshark.org/SampleCaptures). +## Capture the Engine Runtime Directory -You can find instructions on how to view the capture in wireshark in the zilla dump [plugin install section](/reference/config/zilla-cli.md#i-install-plugin-directory). +Zilla stores engine runtime state under the engine directory. By default: `/var/run/zilla` + +:::info +However, this location may be different if the `zilla.engine.directory` parameter is set in `zilla.properties`. Please verify the correct directory before proceeding. +::: + +Create a tar archive of the engine directory shortly after reproducing the issue: + +```bash +tar cvf /tmp/zilla-archive.tar /var/run/zilla +``` + +If your engine directory is different, replace `/var/run/zilla` with the configured path. + +## Confirm Zilla Version + +Capture the exact Zilla version you are running: + +```bash +zilla version -v +``` + +## Share with Support + +Send the following items to `support@aklivity.io` + +* `zilla-archive.tar` +* Output of `zilla version -v` +* Zilla configuration file `zilla.yaml` +* A brief description of the issue and how to reproduce it. + +These artifacts provide the most relevant diagnostic information for stream-level and engine-level analysis and allow support to investigate efficiently.