mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-07-12 06:31:06 +03:00
Troubleshooting: Move Reporting A Bug, log and config files to top.
Athanasius
parent
22bb7eb84b
commit
47ac2de278
@ -25,10 +25,17 @@ let g:vmt_insert_anchors = 1
|
||||
let g:vmt_auto_update_on_save = 1
|
||||
----------------
|
||||
The above will mean the TOC is updated on each file save.
|
||||
To manually remove just use :RemoveToc
|
||||
|
||||
Then to add it back :GenTocRedCarpet
|
||||
-->
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
* [Reporting a problem](#reporting-a-problem)
|
||||
* [Debug Log Files](#debug-log-files)
|
||||
* [Plain Log File](#plain-log-file)
|
||||
* [Location of configuration files](#location-of-configuration-files)
|
||||
* [I ran the program with "run as Administrator" and ...](#i-ran-the-program-with-quot-run-as-administrator-quot-and)
|
||||
* [Program won't start](#program-won-39-t-start)
|
||||
* [Re-running application does nothing](#re-running-application-does-nothing)
|
||||
@ -66,17 +73,99 @@ The above will mean the TOC is updated on each file save.
|
||||
* [Multi-Accounting](#multi-accounting)
|
||||
* [I run two instances of E:D simultaneously, but I can't run two instances of EDMC](#i-run-two-instances-of-e-d-simultaneously-but-i-can-39-t-run-two-instances-of-edmc)
|
||||
* [Error: Wrong Cmdr](#error-wrong-cmdr)
|
||||
* [Location of configuration files](#location-of-configuration-files)
|
||||
* [Reporting a problem](#reporting-a-problem)
|
||||
* [Debug Log Files](#debug-log-files)
|
||||
* [Plain Log File](#plain-log-file)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
To manually remove just use :RemoveToc
|
||||
|
||||
Then to add it back :GenTocRedCarpet
|
||||
-->
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='reporting-a-problem'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
# Reporting a problem
|
||||
Please report a problem as a new GitHub [issue](https://github.com/EDCD/EDMarketConnector/issues/new?assignees=&labels=bug%2C+unconfirmed&template=bug_report.md&title=).
|
||||
**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](#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...
|
||||
1. The [plain log file](#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.
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='debug-log-files'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
## 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](#plain-log-file) in bug
|
||||
reports as well.
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='plain-log-file'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
## Plain Log File
|
||||
As well as the [Debug log file](#debug-log-files) 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](Running-from-source.md) 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.
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='location-of-configuration-files'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
# Location of configuration files
|
||||
If your configuration has been corrupted, or badly set, such that you can't run the program to fix it, or you otherwise need to directly access the configuration then these are the locations of the configuration:
|
||||
|
||||
* Mac: You can use the 'defaults' command to interact with the stored settings, i.e.
|
||||
|
||||
`defaults read uk.org.marginal.edmarketconnector`
|
||||
|
||||
to show the current settings and appropriate '[write](https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/defaults.1.html)' commands to change them.
|
||||
* Windows: Configuration is stored in the registry under `HKEY_CURRENT_USER\Software\Marginal\EDMarketConnector` . There are also some non-configuration files at `%LOCALAPPDATA%\EDMarketConnector\` in your user profile.
|
||||
* Linux: Configuration is stored in the file `${HOME}/.config/EDMarketConnector/EDMarketConnector.ini`
|
||||
|
||||
---
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
@ -639,97 +728,3 @@ The Frontier server that supplies data to this app is supplying data for a diffe
|
||||
If 1 check your username/password settings.
|
||||
|
||||
If 2 this problem may or may not resolve itself in time.
|
||||
|
||||
|
||||
---
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='location-of-configuration-files'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
# Location of configuration files
|
||||
If your configuration has been corrupted, or badly set, such that you can't run the program to fix it, or you otherwise need to directly access the configuration then these are the locations of the configuration:
|
||||
|
||||
* Mac: You can use the 'defaults' command to interact with the stored settings, i.e.
|
||||
|
||||
`defaults read uk.org.marginal.edmarketconnector`
|
||||
|
||||
to show the current settings and appropriate '[write](https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/defaults.1.html)' commands to change them.
|
||||
* Windows: Configuration is stored in the registry under `HKEY_CURRENT_USER\Software\Marginal\EDMarketConnector` . There are also some non-configuration files at `%LOCALAPPDATA%\EDMarketConnector\` in your user profile.
|
||||
* Linux: Configuration is stored in the file `${HOME}/.config/EDMarketConnector/EDMarketConnector.ini`
|
||||
|
||||
|
||||
--
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='reporting-a-problem'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
# Reporting a problem
|
||||
Please report a problem as a new GitHub [issue](https://github.com/EDCD/EDMarketConnector/issues/new?assignees=&labels=bug%2C+unconfirmed&template=bug_report.md&title=).
|
||||
**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](#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...
|
||||
1. The [plain log file](#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.
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='debug-log-files'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
## 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](#plain-log-file) in bug
|
||||
reports as well.
|
||||
|
||||
<!-- vim-markdown-toc Redcarpet -->
|
||||
|
||||
<a name='plain-log-file'></a>
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
## Plain Log File
|
||||
As well as the [Debug log file](#debug-log-files) 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](Running-from-source.md) 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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user