monero-health 0.1.6

Check health of monero daemons.

Monero health

This is work in progress.

Monero health is supposed to provide information about the Monero daemon health.

There are two health checks at the moment:

• Checking the Monero daemon status using the hard_fork_info RPC.
• Checking the age of the last block on the daemon using a pre-configured offset.

Note:

The Monero daemon information are retrieved using the Monero daemon JSON RPC. The RPC connection is established using python-monerorpc.

Configuration

Monero daemon connection

The connection to the Monero daemon can be configured using environment variables:

environment variable	default value
MONEROD_RPC_URL	"127.0.0.1"
MONEROD_RPC_PORT	18081
MONEROD_RPC_USER	""
MONEROD_RPC_PASSWORD	""

Note:

The RPC connection is established using python-monerorpc.

Last block age

The last block's timestamp is checked against a given pre-configured offset:

environment variable	default value
OFFSET	12
OFFSET_UNIT	"minutes"

I.e that the last block is considered out-of-date as soon as it becomes older than - in the default case - 12 [minutes].

The Monero RPC method used is:

• get_last_block_header

Daemon status

No configuration is needed.

The Monero RPC method used is:

• hard_fork_info

Results

JSON response

This module is not really supposed to be run as a script, rather as a module.

However, it is possible to directly run it as a script. it will then output the complete information:

    MONEROD_RPC_URL=node.xmr.to python monero_health.py
    # Last block age.
    INFO:DaemonHealth:Checking 'node.xmr.to:18081'.
    {'hash': 'b0f683278980ac65adfa6600c040d38f29f2299912c6c580d04f2f6704bf11d3', 'block_timestamp': '2019-12-19T15:02:16', 'check_timestamp': '2019-12-19T15:08:29', 'status': 'OK', 'block_recent': True, 'block_recent_offset': 12, 'block_recent_offset_unit': 'minutes'}
    # Monero daemon status.
    INFO:DaemonHealth:Checking 'node.xmr.to:18081'.
    {'status': 'OK', 'version': 12}

When imported as a module the functions can be imported/called separately, like this:

• Last block age:

    from monero_health import (
        daemon_last_block_check,
    )
    ...
    result = daemon_last_block_check()
    ...

• Monero daemaon status:

    from monero_health import (
        daemon_status_check,
    )
    ...
    result = daemon_status_check()
    ...

• Combined daemon status:

    from monero_health import (
        daemon_combined_status_check,
    )
    ...
    result = daemon_combined_status_check()
    ...

Possible status values

The status returned can have the following values:

• OK
  • For a last block that is not considered old: (daemon_last_block_check)
  • For a daemon with status OK: (daemon_status_check)
  • Every possible status is OK: (daemon_combined_status_check)
• ERROR
  • For a last block that is considered old: (daemon_last_block_check)
  • For a daemon with status ERROR: (daemon_status_check)
  • At least one possible status is ERROR: (daemon_combined_status_check)
• UNKNOWN
  • In case of a connection error (mostly related to HTTP requests): (daemon_last_block_check, daemon_status_check)
  • At least one possible status is UNKNOWN: (daemon_combined_status_check)

Errors

In case of an error an error key is added to the responses of:

• daemon_last_block_check
• daemon_status_check but not to daemon_combined_status_check.

This error key always contains the keys:

• error
• message

Example - No Monero daemon running at 127.0.0.1:18081:

{
    "block_recent": false,
    "block_recent_offset": "12",
    "block_recent_offset_unit": "minutes",
    "block_timestamp": "---",
    "check_timestamp": "2020-01-07T14:53:24",
    "error": {
        "error": "-341: could not establish a connection, original error: HTTPConnectionPool(host='127.0.0.1', port=18081): Max retries exceeded with url: /json_rpc (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7fe25e449cd0>: Failed to establish a new connection: [Errno 111] Connection refused'))",
        "message": "Cannot determine daemon status. Daemon: '127.0.0.1:18081'."
    },
    "hash": "---",
    "status": "UNKNOWN"
}