getlog

lightning-getlog -- Command to show logs.

SYNOPSIS

getlog [level]

DESCRIPTION

The getlog the RPC command to show logs, with optional log level.

  • level (string, optional) (one of "broken", "unusual", "info", "debug", "trace", "io"): A string that represents the log level. The default is info.

RETURN VALUE

On success, an object is returned, containing:

  • created_at (string): UNIX timestamp with 9 decimal places, when logging was initialized.

  • bytes_used (u32): The number of bytes used by logging records.

  • bytes_max (u32): The bytes_used values at which records will be trimmed .

  • log (array of objects):

    • type (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "TRACE", "IO_IN", "IO_OUT")

    If type is "SKIPPED":

    • num_skipped (u32): Number of unprinted log entries (deleted or below level parameter).

    If type is "BROKEN", "UNUSUAL", "INFO", "DEBUG" or "TRACE":

    • time (string): UNIX timestamp with 9 decimal places after created_at.
    • source (string): The particular logbook this was found in.
    • log (string): The actual log message.
    • node_id (pubkey, optional): The peer this is associated with.

    If type is "IO_IN" or "IO_OUT":

    • time (string): Seconds after created_at, with 9 decimal places.
    • source (string): The particular logbook this was found in.
    • log (string): The associated log message.
    • data (hex): The IO which occurred.
    • node_id (pubkey, optional): The peer this is associated with.

ERRORS

On failure, one of the following error codes may be returned:

  • -32602: Error in given parameters.

AUTHOR

Vincenzo Palazzo <vincenzo.palazzo@protonmail.com> wrote the initial version of this man page,
but many others did the hard work of actually implementing this rpc command.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning

EXAMPLES

Example 1:

Request:

lightning-cli getlog -k "level"="unusual"
{
  "id": "example:getlog#1",
  "method": "getlog",
  "params": {
    "level": "unusual"
  }
}

Response:

{
  "created_at": 1738000000,
  "bytes_used": 1630000,
  "bytes_max": 10485760,
  "log": [
    {
      "type": "SKIPPED",
      "num_skipped": 144
    },
    {
      "type": "UNUSUAL",
      "time": "71.800000000",
      "source": "plugin-bookkeeper",
      "log": "topic 'utxo_deposit' is not a known notification topic"
    },
    {
      "type": "UNUSUAL",
      "time": "72.800000000",
      "source": "plugin-bookkeeper",
      "log": "topic 'utxo_spend' is not a known notification topic"
    },
    {
      "type": "SKIPPED",
      "num_skipped": 147
    },
    {
      "type": "UNUSUAL",
      "time": "74.800000000",
      "node_id": "nodeid010101010101010101010101010101010101010101010101010101010101",
      "source": "chan#1",
      "log": "No peer channel with scid=228x1x1"
    }
  ]
}