Skip to content

Troubleshooting

David Sangrey edited this page Dec 31, 2023 · 5 revisions

Reporting a Problem

Please report a problem as a new GitHub issue. Do not decide you do not need to use the Bug Report template. All of the information it asks for is vital in diagnosing any bugs.

Be sure to attach both:

  1. A relevant debug log file - these are always at DEBUG level, or even TRACE if you use the --trace command-line option, so might contain information not in...
  2. The plain log file immediately after the bug occurs. In addition to actually logged output this contains any other output which won't be in the debug log file.

Debug Log Files

If you are using 4.1.0, or later (including betas of 4.1.0) then there is a new set of rotated logfiles in the location:

  • Windows: %TEMP%\EDMarketConnector\EDMarketConnector-debug.log
  • Mac: $TMPDIR/EDMarketConnector/EDMarketConnector-debug.log
  • Linux: $TMPDIR/EDMarketConnector/EDMarketConnector-debug.log

These are not truncated on a new run, so there will be no need to re-create the bug. They are, however, rotated (to EDMarketConnector-debug.log.1 and onwards) if they reach 1 MiB in size. So check timestamps and contents to be sure you upload the correct file!

These files also always contain DEBUG output, whereas the file detailed below only contains raw print() output and anything logged at the level you have configured.

They do not contain plain print(..) and other non-logged output, so we still need you to also supply the plain log file in bug reports as well.

Plain Log File

As well as the Debug log file there is also the actual console output of the program. This can contain a little extra output not found in the Debug log file, such as exceptions and tracebacks. It is vital you attach this file/output to bug reports as well.

When running from the provided Windows installer this is redirected to:

%TEMP%\EDMarketConnector.log

With the old (up to 3.43) macOS installer this is found in:

${TMPDIR}/EDMarketConnector.log

In all cases of Running from source you will need to capture the output of EDMarketConnector.py, e.g. on Linux or macOS:

EDMarketConnector.py 2>&1 | tee "${TMPDIR}/EDMarketConnector.log"

You can make that ... | tee -a ... if you're OK with this log file growing until you delete or truncate it yourself.