Skip to content

Commit cca238e

Browse files
committed
Add more troubleshooting tips
1 parent a862f7a commit cca238e

File tree

1 file changed

+84
-1
lines changed

1 file changed

+84
-1
lines changed

docs/troubleshooting/README.md

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,61 @@ title: Troubleshooting
55

66
# Troubleshooting
77

8-
## Typical problems and solutions
8+
## Finding problems
9+
10+
### Compilation problems
11+
12+
```todo
13+
To be added
14+
```
15+
16+
### Runtime problems
17+
18+
If your O2 code is crashing and you have difficulties finding out the reason, try the following tips.
19+
20+
Redirect the terminal output to a text file (here called `stdout.log`):
21+
22+
```bash
23+
o2-analysis-... > stdout.log 2>&1
24+
```
25+
26+
Search for keywords related to problems in the log file using the `grep` command:
27+
28+
```bash
29+
grep -e "\\[ERROR\\]" -e "\\[FATAL\\]" -e "segmentation" -e "Segmentation" -e "SEGMENTATION" -e "command not found" -e "Error:" -e "Error in " -e "\\[WARN\\]" stdout.log
30+
```
31+
32+
Try to understand and resolve the first reported problem.
33+
34+
```note
35+
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.
36+
```
37+
38+
## Reporting problems
39+
40+
See the [Support](../gettingstarted/support.md) section for the list of Mattermost channels where you can ask for help.
41+
42+
When posting on Mattermost:
43+
44+
- 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.
45+
- Paste only lines relevant to your problem. (See [Finding problems](#finding-problems).)
46+
- Enclose code words and expressions in [backticks](https://www.markdownguide.org/basic-syntax/#code) (`).
47+
- When pasting blocks of code or log lines, use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks).
48+
- Use [syntax highlighting](https://www.markdownguide.org/extended-syntax/#syntax-highlighting) when pasting blocks of code.
49+
50+
## Typical compilation problems and solutions
51+
52+
### Compilation terminated because of exhausted memory
53+
54+
Error message:
55+
56+
```text
57+
c++: fatal error: Killed signal terminated program cc1plus
58+
```
59+
60+
The compilation exhausted all available RAM memory and was killed. Try to compile with less cores using the `-j N` option to use `N` cores.
61+
62+
## Typical runtime problems and solutions
963

1064
### Tree not found
1165

@@ -49,3 +103,32 @@ and the table should be found.
49103
- Missing `fv0c`: If you are running on Run 3 data or MC, please make sure that the process switches in the `bc-selection`, `event-selection` and `multiplicity-table` workflows are set to `"processRun2": "false", "processRun3": "true"` in your config JSON; see e.g. the `Configurables` section in the [event selection](../basics-usage/HelperTasks.md#event-selection) documentation.
50104
- Missing `tofsignal`: Please refer to the documentation on the [TOF PID](../basics-usage/HelperTasks.md#particle-identification) requirements.
51105
- Missing `collision_001`: Please add the `o2-analysis-collision-converter`.
106+
107+
### CCDB object not found
108+
109+
Error messages:
110+
111+
```text
112+
[ERROR] Requested resource does not exist: http://alice-ccdb.cern.ch/...
113+
[FATAL] Got nullptr from CCDB for path ...
114+
```
115+
116+
Verify whether:
117+
118+
- You use the right workflow configuration (e.g. Run 2 vs 3).
119+
- The timestamp is correct.
120+
- The path is correct (check at <http://alice-ccdb.cern.ch/browse/>).
121+
- The connection to CCDB is fine.
122+
123+
```todo
124+
How to check the timestamp?
125+
```
126+
127+
### Alien connection failed
128+
129+
```todo
130+
Error message:
131+
```
132+
133+
- Create an Alien token by executing the `alien-token-init` command inside the O2Physics environment.
134+
- Verify that the connection can be established by executing `alien.py`.

0 commit comments

Comments
 (0)