Generic troubleshooting information

[flaki]

Currently it's not very easy to figure out when something goes wrong in Atmo, and especially so when using subo (which is practically all the time), because e.g. subo dev runs stuff in docker, isolated, and is pretty opaque itself, not displaying the commands that are executed. Supplying non-default configuration (e.g. environment variables that configure Atmo).

We have seen an example of this in suborbital/e2core#90, and also we are seeing it increasingly on Discord.

We should provide information on how to debug runnables, Atmo and SCN better and how to enable some of the options that facilitate this debugging.

One such recent example is the question "How do I switch Atmo into debugging mode?".

• After some digging, I figured out that Atmo uses the info log level by default
• Diving deeper into Atmo's code I found the logger component and information on the log levels and a way to specify logger options
• Atmo overrides the log prefix, but with that I knew I need to set ATMO_LOG_LEVEL to debug to see the debug messages in the output
• It is not immediately clear how to set environment variables to Atmo when running with subo dev so I had to look up the command that gets executed
• With that I could manually launch Atmo in a docker container with debugging output enabled:

docker run -v=$PROJECTDIR:/home/atmo -e=ATMO_LOG_LEVEL=debug -e=ATMO_HTTP_PORT=8080 -p=8080:8080 suborbital/atmo:v0.4.2 atmo

Many of our users are willing (and have the technical expertise) to browse the sources for our tools and this can help them in figuring things out on their own but we should give our users tools and documentation that helps with this.

This is also just a lot of work to get debugging output out of subo dev so I am planning to propose some improvements in subo to make this easier.