Skip to content

Troubleshooting: Add instructions on what info to provide #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsekihat merged 1 commit into from
Jun 4, 2026
Merged

Troubleshooting: Add instructions on what info to provide #357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/troubleshooting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ grep -e "\\[ERROR\\]" -e "\\[FATAL\\]" -e "\\[CRITICAL\\]" -e "segmentation" -e

See also [shell rc utilities](../tools/README.md#shell-rc-utilities).

Try to understand and resolve the first reported problem.
Try to understand and resolve the reported problems in order of appearance.

```note
You can inspect a failing [AliHyperloop test](../hyperloop/userdocumentation.md#-wagon-tests) in the same way. The log is saved in the `stdout.log` file in the test output directory.
Expand All @@ -54,6 +54,16 @@ See the [Support](../gettingstarted/support.md) section for the list of Mattermo
When asking for help with compilation or with running a local analysis, it may be useful to provide basic information about your O2Physics setup.
You can generate it using the [Setup diagnostic tool](../tools/README.md#setup-diagnostic-tool).

When asking for help with running an analysis:

- If the problem is on AliHyperloop, provide:
- the link to the read-only view of the [wagon test](../hyperloop/userdocumentation.md#-wagon-tests) or the [train run](../hyperloop/userdocumentation.md#train-runs).
- If the problem is local, provide:
- the name of the dataset of the input files,
- the command or script used to run the analysis,
- the log file,
- the dumped `dpl-config.json` file (and the input JSON file, if the dumped one is incomplete).

When posting on Mattermost:

- Do not paste the entire content of files or any long blocks of log lines or code directly in the message. If needed, attach the file.
Expand Down
Loading