server_state

[Source]

The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)

Request Format

An example of the request format:

{
  "id": 2,
  "command": "server_state"
}

{
    "method": "server_state",
    "params": [
        {}
    ]
}

#Syntax: server_state
rippled server_state

Try it!

The request does not takes any parameters.

Response Format

An example of a successful response:

{
  "id": 1,
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "64572720-65887201",
      "io_latency_ms": 1,
      "jq_trans_overflow": "0",
      "last_close": {
        "converge_time": 3005,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 256,
      "load_factor_fee_escalation": 256,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "365006",
      "peer_disconnects_resources": "336",
      "peers": 216,
      "pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
      "server_state": "full",
      "server_state_duration_us": "3588969453592",
      "state_accounting": {
        "connected": {
          "duration_us": "301410595",
          "transitions": 2
        },
        "disconnected": {
          "duration_us": "1207534",
          "transitions": 2
        },
        "full": {
          "duration_us": "3589171798767",
          "transitions": 2
        },
        "syncing": {
          "duration_us": "6182323",
          "transitions": 2
        },
        "tracking": {
          "duration_us": "43",
          "transitions": 2
        }
      },
      "time": "2021-Aug-24 20:44:43.466048 UTC",
      "uptime": 3589480,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153081,
        "hash": "B52AC3876412A152FE9C0442801E685D148D05448D0238587DBA256330A98FD3",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887201
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response"
}

200 OK

Headers

{
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "65844785-65887184",
      "io_latency_ms": 3,
      "jq_trans_overflow": "580",
      "last_close": {
        "converge_time": 3012,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 134022,
      "load_factor_fee_escalation": 134022,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "792367",
      "peer_disconnects_resources": "7273",
      "peers": 72,
      "pubkey_node": "n9LNvsFiYfFf8va6pma2PHGJKVLSyZweN1iBAkJQSeHw4GjM8gvN",
      "server_state": "full",
      "server_state_duration_us": "422128665555",
      "state_accounting": {
        "connected": {
          "duration_us": "172799714",
          "transitions": 1
        },
        "disconnected": {
          "duration_us": "309059",
          "transitions": 1
        },
        "full": {
          "duration_us": "6020429212246",
          "transitions": 143
        },
        "syncing": {
          "duration_us": "413813232",
          "transitions": 152
        },
        "tracking": {
          "duration_us": "266553605",
          "transitions": 152
        }
      },
      "time": "2021-Aug-24 20:43:43.043406 UTC",
      "uptime": 6021282,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153020,
        "hash": "ABEF3D24015E8B6B7184B4ABCEDC0E0E3AA4F0677FAB91C40B1E500707C1F3E5",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887184
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

Loading: "/etc/opt/ripple/rippled.cfg"
2020-Mar-24 01:30:08.646201720 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005

Headers

{
  "result": {
    "state": {
      "build_version": "1.7.2",
      "complete_ledgers": "65844785-65887184",
      "io_latency_ms": 3,
      "jq_trans_overflow": "580",
      "last_close": {
        "converge_time": 3012,
        "proposers": 41
      },
      "load_base": 256,
      "load_factor": 134022,
      "load_factor_fee_escalation": 134022,
      "load_factor_fee_queue": 256,
      "load_factor_fee_reference": 256,
      "load_factor_server": 256,
      "peer_disconnects": "792367",
      "peer_disconnects_resources": "7273",
      "peers": 72,
      "pubkey_node": "n9LNvsFiYfFf8va6pma2PHGJKVLSyZweN1iBAkJQSeHw4GjM8gvN",
      "server_state": "full",
      "server_state_duration_us": "422128665555",
      "state_accounting": {
        "connected": {
          "duration_us": "172799714",
          "transitions": 1
        },
        "disconnected": {
          "duration_us": "309059",
          "transitions": 1
        },
        "full": {
          "duration_us": "6020429212246",
          "transitions": 143
        },
        "syncing": {
          "duration_us": "413813232",
          "transitions": 152
        },
        "tracking": {
          "duration_us": "266553605",
          "transitions": 152
        }
      },
      "time": "2021-Aug-24 20:43:43.043406 UTC",
      "uptime": 6021282,
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 683153020,
        "hash": "ABEF3D24015E8B6B7184B4ABCEDC0E0E3AA4F0677FAB91C40B1E500707C1F3E5",
        "reserve_base": 20000000,
        "reserve_inc": 5000000,
        "seq": 65887184
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

The response follows the standard format, with a successful result containing a state object as its only field.

The state object may have some arrangement of the following fields:

Field Type Description
amendment_blocked Boolean (May be omitted) If true, this server is amendment blocked. If the server is not amendment blocked, the response omits this field. New in: rippled 0.80.0
build_version String The version number of the running rippled version.
complete_ledgers String Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. It is possible to be a disjoint sequence, e.g. "2500-5000,32570-7695432". If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string empty.
closed_ledger Object (May be omitted) Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes validated_ledger instead. The member fields are the same as the validated_ledger field.
io_latency_ms Number Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the rippled server is probably having serious load issues.
jq_trans_overflow String - Number The number of times this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see Capacity Planning. New in: rippled 0.90.0
last_close Object Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating.
last_close.converge_time Number The amount of time it took to reach a consensus on the most recently validated ledger version, in milliseconds.
last_close.proposers Number How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version.
load Object (Admin only) Detailed information about the current load state of the server.
load.job_types Array (Admin only) Information about the rate of different types of jobs the server is doing and how much time it spends on each.
load.threads Number (Admin only) The number of threads in the server's main job pool.
load_base Integer This is the baseline amount of server load used in transaction cost calculations. If the load_factor is equal to the load_base then only the base transaction cost is enforced. If the load_factor is higher than the load_base, then transaction costs are multiplied by the ratio between them. For example, if the load_factor is double the load_base, then transaction costs are doubled.
load_factor Number The load factor the server is currently enforcing. The ratio between this value and the load_base determines the multiplier for transaction costs. The load factor is determined by the highest of the individual server's load factor, cluster's load factor, the open ledger cost, and the overall network's load factor. Updated in: rippled 0.33.0
load_factor_fee_escalation Number (May be omitted) The current multiplier to the transaction cost to get into the open ledger, in fee levels. New in: rippled 0.32.0
load_factor_fee_queue Number (May be omitted) The current multiplier to the transaction cost to get into the queue, if the queue is full, in fee levels. New in: rippled 0.32.0
load_factor_fee_reference Number (May be omitted) The transaction cost with no load scaling, in fee levels. New in: rippled 0.32.0
load_factor_server Number (May be omitted) The load factor the server is enforcing, not including the open ledger cost. New in: rippled 0.33.0
peers Number (Omitted by reporting mode servers) How many other rippled servers this one is currently connected to.
pubkey_node String Public key used to verify this server for peer-to-peer communications. This node key pair is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the [node_seed] config option, which is useful for clustering.
pubkey_validator String (Admin only) Public key used by this node to sign ledger validations. This validation key pair is derived from the [validator_token] or [validation_seed] config field.
reporting Object (Reporting mode servers only) Information about this server's reporting-mode specific configurations.
reporting.etl_sources Array (Reporting mode servers only) A list of P2P-mode servers this reporting mode is retrieving data from. Each entry in this array is an ETL Source object.
reporting.is_writer Boolean (Reporting mode servers only) If true, this server is writing to the external database with ledger data. If false, it is not currently writing, possibly because another reporting mode server is currently populating a shared database, or because it's configured as read-only.
reporting.last_publish_time String (Reporting mode servers only) An ISO 8601 timestamp indicating when this server last saw a new validated ledger from any of its P2P mode sources.
server_state String A string indicating to what extent the server is participating in the network. See Possible Server States for more details.
server_state_duration_us Number The number of consecutive microseconds the server has been in the current state. New in: rippled 1.2.0
state_accounting Object A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. New in: rippled 0.30.1
state_accounting.*.duration_us String The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) New in: rippled 0.30.1
state_accounting.*.transitions String The number of times the server has changed into this state. New in: rippled 0.30.1
time String The current time in UTC, according to the server's clock. Updated in: rippled 1.5.0
uptime Number Number of consecutive seconds that the server has been operational. New in: rippled 0.30.1
validated_ledger Object (May be omitted) Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes closed_ledger instead.
validated_ledger.base_fee Number Base fee, in drops of XRP, for propagating a transaction to the network.
validated_ledger.close_time Number Time this ledger was closed, in seconds since the Ripple Epoch.
validated_ledger.hash String Unique hash of this ledger version, as hexadecimal.
validated_ledger.reserve_base Number The minimum account reserve, as of the most recent validated ledger version.
validated_ledger.reserve_inc Number The owner reserve for each item an account owns, as of the most recent validated ledger version.
validated_ledger.seq Number The ledger index of the most recently validated ledger version.
validation_quorum Number Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations.
validator_list_expires Number (Admin only) When the current validator list expires, in seconds since the Ripple Epoch, or 0 if the server has yet to load a published validator list. New in: rippled 0.80.1

ETL Source Object

On a reporting mode server, each member of the etl_sources field is an object with the following fields:

Field Type Description
connected Boolean If true, the reporting mode server is connected to this P2P mode server. If false, the server is not connected. This could be due to misconfiguration, a network outage, or it could mean that the P2P mode server is down.
grpc_port String The port number on the P2P mode server where this reporting mode server is configured to connect and retrieve ledger data via gRPC.
ip String The IP address (IPv4 or IPv6) of the P2P mode server.
last_message_arrival_time String An ISO 8601 timestamp indicating the most recent time the reporting mode server received a message from this P2P server.
validated_ledgers_range String The range of validated ledger versions this P2P mode server reports that it has available, in the same format as complete_ledgers.
websocket_port String The port number on the P2P server where this reporting mode server is configured to forward WebSocket requests that cannot be served directly from reporting mode.

Possible Errors