Browse Source

logging: add examples for logging.

As suggested by @cdecker, but also did a bit of minor reformatting.

I don't like the excessive indenting in our man pages though,
but that's a separate problem.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
travis-debug
Rusty Russell 5 years ago
parent
commit
0aad532db1
  1. 26
      doc/lightningd-config.5
  2. 8
      doc/lightningd-config.5.md

26
doc/lightningd-config.5

@ -146,7 +146,7 @@ for any subsystem containing that string\. Subsystems include:
.RE .RE
The following subsystems exist for each channel, where N is an incrementing The following subsystems exist for each channel, where N is an incrementing
internal integer id assigned for the lifetime of the channel: internal integer id assigned for the lifetime of the channel:
.RS .RS
@ -159,29 +159,34 @@ internal integer id assigned for the lifetime of the channel:
.IP \[bu] .IP \[bu]
\fIonchaind-chan #N\fR: Each onchain close handling daemon \fIonchaind-chan #N\fR: Each onchain close handling daemon
.IP \[bu] .IP \[bu]
\fIjson #FD\fR: Each JSONRPC connection, FD = file descriptor number \fIjson #FD\fR: Each JSONRPC connection, FD = file descriptor number
.RE
So, \fBlog-level=debug:plugin\fR would set debug level logging on all
plugins and the plugin manager\. \fBlog-level=io:chan #55\fR would set
IO logging on channel number 55 (or 550, for that matter)\.
\fBlog-prefix\fR=\fIPREFIX\fR \fBlog-prefix\fR=\fIPREFIX\fR
Prefix for log lines: this can be customized if you want to merge logs Prefix for log lines: this can be customized if you want to merge logs
with multiple daemons\. with multiple daemons\.
\fBlog-file\fR=\fIPATH\fR \fBlog-file\fR=\fIPATH\fR
Log to this file instead of stdout\. Sending \fBlightningd\fR(8) SIGHUP will Log to this file instead of stdout\. Sending \fBlightningd\fR(8) SIGHUP will
cause it to reopen this file (useful for log rotation)\. cause it to reopen this file (useful for log rotation)\.
\fBrpc-file\fR=\fIPATH\fR \fBrpc-file\fR=\fIPATH\fR
Set JSON-RPC socket (or /dev/tty), such as for \fBlightning-cli\fR(1)\. Set JSON-RPC socket (or /dev/tty), such as for \fBlightning-cli\fR(1)\.
\fBdaemon\fR \fBdaemon\fR
Run in the background, suppress stdout and stderr\. Run in the background, suppress stdout and stderr\.
\fBconf\fR=\fIPATH\fR \fBconf\fR=\fIPATH\fR
Sets configuration file (default: \fBlightning-dir\fR/\fIconfig\fR )\. If this Sets configuration file (default: \fBlightning-dir\fR/\fIconfig\fR )\. If this
is a relative path, it is relative to the starting directory, not is a relative path, it is relative to the starting directory, not
\fBlightning-dir\fR (unlike other paths)\. \fIPATH\fR must exist and be \fBlightning-dir\fR (unlike other paths)\. \fIPATH\fR must exist and be
@ -189,20 +194,17 @@ readable (we allow missing files in the default case)\. Using this inside
a configuration file is meaningless\. a configuration file is meaningless\.
\fBwallet\fR=\fIDSN\fR \fBwallet\fR=\fIDSN\fR
Identify the location of the wallet\. This is a fully qualified data source Identify the location of the wallet\. This is a fully qualified data source
name, including a scheme such as \fBsqlite3\fR or \fBpostgres\fR followed by the name, including a scheme such as \fBsqlite3\fR or \fBpostgres\fR followed by the
connection parameters\. connection parameters\.
\fBencrypted-hsm\fR \fBencrypted-hsm\fR
If set, you will be prompted to enter a password used to encrypt the \fBhsm_secret\fR\. If set, you will be prompted to enter a password used to encrypt the \fBhsm_secret\fR\.
Note that once you encrypt the \fBhsm_secret\fR this option will be mandatory for Note that once you encrypt the \fBhsm_secret\fR this option will be mandatory for
\fBlightningd\fR to start\. \fBlightningd\fR to start\.
.RE
.SH Lightning node customization options .SH Lightning node customization options
\fBalias\fR=\fIRRGGBB\fR \fBalias\fR=\fIRRGGBB\fR

8
doc/lightningd-config.5.md

@ -118,7 +118,8 @@ for any subsystem containing that string. Subsystems include:
* *gossipd*: The gossip daemon * *gossipd*: The gossip daemon
* *connectd*: The network connection daemon * *connectd*: The network connection daemon
The following subsystems exist for each channel, where N is an incrementing
The following subsystems exist for each channel, where N is an incrementing
internal integer id assigned for the lifetime of the channel: internal integer id assigned for the lifetime of the channel:
* *openingd-chan #N*: Each opening / idling daemon * *openingd-chan #N*: Each opening / idling daemon
* *channeld-chan #N*: Each channel management daemon * *channeld-chan #N*: Each channel management daemon
@ -126,6 +127,11 @@ internal integer id assigned for the lifetime of the channel:
* *onchaind-chan #N*: Each onchain close handling daemon * *onchaind-chan #N*: Each onchain close handling daemon
* *json #FD*: Each JSONRPC connection, FD = file descriptor number * *json #FD*: Each JSONRPC connection, FD = file descriptor number
So, **log-level=debug:plugin** would set debug level logging on all
plugins and the plugin manager. **log-level=io:chan #55** would set
IO logging on channel number 55 (or 550, for that matter).
**log-prefix**=*PREFIX* **log-prefix**=*PREFIX*
Prefix for log lines: this can be customized if you want to merge logs Prefix for log lines: this can be customized if you want to merge logs
with multiple daemons. with multiple daemons.

Loading…
Cancel
Save