lightning-terminal/doc/troubleshooting.md
Oliver Gugger a0190334fd
doc: unify shell code block formatting
The code blocks aren't displayed correctly in GitBook when using the
"shell script" markup hint. We unify all code blocks to use the same
"shell" hint. While doing so, we also use an explicit unicode character
to represent the shell. This should make it more clear that the
character isn't part of the command itself.
2021-01-18 15:41:19 +01:00

1.8 KiB

Troubleshooting

If you have trouble running your node, please first check the logs for warnings or errors. If there are errors relating to one of the embedded servers, then you should open an issue in their respective GitHub repos (lnd, loop, pool, faraday. If the issue is related to the web app, then you should open an issue here in this repo.

Server

Server-side logs are stored in the directory specified by lnd.lnddir in your configuration. Inside, there is a logs dir containing the log files in subdirectories. Be sure to set lnd.debuglevel=debug in your configuration to see the most verbose logging information.

Browser

Client-side logs are disabled by default in production builds. Logging can be turned on by adding a couple keys to your browser's localStorage. Simply run these two JS statements in you browser's DevTools console then refresh the page:

localStorage.setItem('debug', '*'); localStorage.setItem('debug-level', 'debug');

The value for debug is a namespace filter which determines which portions of the app to display logs for. The namespaces currently used by the app are as follows:

  • main: logs general application messages
  • action: logs all actions that modify the internal application state
  • grpc: logs all GRPC API requests and responses

Example filters: main,action will only log main and action messages. *,-action will log everything except action messages.

The value for debug-level determines the verbosity of the logs. The value can be one of debug, info, warn, or error.