ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-19 11:15:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
43f7f524529939861d88b74cca19fe5bd862009d
xrpl-dev-portal/content/references/rippled-api/public-rippled-methods/server-info-methods/server_info.md

15 KiB
Raw Blame History

html, parent, blurb, labels
html parent blurb labels
server_info.html server-info-methods.html Retrieve status of the server in human-readable format.
Core Server

server_info

[Source]

The server_info command asks the server for a human-readable version of various information about the rippled server being queried.

Request Format

An example of the request format:

WebSocket

{
  "id": 1,
  "command": "server_info"
}

JSON-RPC

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

Commandline

#Syntax: server_info
rippled server_info

Try it! >

The request does not take any parameters.

Response Format

An example of a successful response:

WebSocket

{
  "id": 1,
  "result": {
    "info": {
      "build_version": "1.7.2",
      "complete_ledgers": "64572720-65887227",
      "hostid": "LARD",
      "io_latency_ms": 1,
      "jq_trans_overflow": "0",
      "last_close": {
        "converge_time_s": 3.004,
        "proposers": 41
      },
      "load_factor": 512.578125,
      "load_factor_server": 1,
      "peer_disconnects": "365016",
      "peer_disconnects_resources": "336",
      "peers": 211,
      "pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
      "server_state": "full",
      "server_state_duration_us": "3589068181859",
      "state_accounting": {
        "connected": {
          "duration_us": "301410595",
          "transitions": 2
        },
        "disconnected": {
          "duration_us": "1207534",
          "transitions": 2
        },
        "full": {
          "duration_us": "3589270527034",
          "transitions": 2
        },
        "syncing": {
          "duration_us": "6182323",
          "transitions": 2
        },
        "tracking": {
          "duration_us": "43",
          "transitions": 2
        }
      },
      "time": "2021-Aug-24 20:46:22.194299 UTC",
      "uptime": 3589579,
      "validated_ledger": {
        "age": 3,
        "base_fee_xrp": 0.00001,
        "hash": "F00F0E590242702B895BE378B6A6D365C094A047CFC8B11DD323D16F81CC67A5",
        "reserve_base_xrp": 20,
        "reserve_inc_xrp": 5,
        "seq": 65887227
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response"
}

JSON-RPC

200 OK

{
  "result": {
    "info": {
      "build_version": "1.7.2",
      "complete_ledgers": "64735538-65886965",
      "hostid": "TOLL",
      "io_latency_ms": 1,
      "jq_trans_overflow": "3",
      "last_close": {
        "converge_time_s": 3,
        "proposers": 41
      },
      "load_factor": 1,
      "peer_disconnects": "467400",
      "peer_disconnects_resources": "16316",
      "peers": 85,
      "pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
      "server_state": "full",
      "server_state_duration_us": "627203282776",
      "state_accounting": {
        "connected": {
          "duration_us": "600242389",
          "transitions": 40
        },
        "disconnected": {
          "duration_us": "112927",
          "transitions": 1
        },
        "full": {
          "duration_us": "3591757226163",
          "transitions": 46
        },
        "syncing": {
          "duration_us": "5304456",
          "transitions": 7
        },
        "tracking": {
          "duration_us": "13989631",
          "transitions": 46
        }
      },
      "time": "2021-Aug-24 20:29:53.291350 UTC",
      "uptime": 3592376,
      "validated_ledger": {
        "age": 2,
        "base_fee_xrp": 0.00001,
        "hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
        "reserve_base_xrp": 20,
        "reserve_inc_xrp": 5,
        "seq": 65886965
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

Commandline

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

{
  "result": {
    "info": {
      "build_version": "1.7.2",
      "complete_ledgers": "64735538-65886965",
      "hostid": "TOLL",
      "io_latency_ms": 1,
      "jq_trans_overflow": "3",
      "last_close": {
        "converge_time_s": 3,
        "proposers": 41
      },
      "load_factor": 1,
      "peer_disconnects": "467400",
      "peer_disconnects_resources": "16316",
      "peers": 85,
      "pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
      "server_state": "full",
      "server_state_duration_us": "627203282776",
      "state_accounting": {
        "connected": {
          "duration_us": "600242389",
          "transitions": 40
        },
        "disconnected": {
          "duration_us": "112927",
          "transitions": 1
        },
        "full": {
          "duration_us": "3591757226163",
          "transitions": 46
        },
        "syncing": {
          "duration_us": "5304456",
          "transitions": 7
        },
        "tracking": {
          "duration_us": "13989631",
          "transitions": 46
        }
      },
      "time": "2021-Aug-24 20:29:53.291350 UTC",
      "uptime": 3592376,
      "validated_ledger": {
        "age": 2,
        "base_fee_xrp": 0.00001,
        "hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
        "reserve_base_xrp": 20,
        "reserve_inc_xrp": 5,
        "seq": 65886965
      },
      "validation_quorum": 33
    },
    "status": "success"
  }
}

The response follows the [standard format][], with a successful result containing an info object as its only field.

The info 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.
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.
complete_ledgers String Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. This may be a disjoint sequence such as 24900901-24900984,24901116-24901158. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string empty.
hostid String On an admin request, returns the hostname of the server running the rippled instance; otherwise, returns a single [RFC-1751][] word based on the node public key.
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 (since starting up) that 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_s Number The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds.
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_factor Number The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at 1000 load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the individual server's load factor, the cluster's load factor, the open ledger cost and the overall network's load factor. [Updated in: rippled 0.33.0][]
load_factor_local Number (May be omitted) Current multiplier to the [transaction cost][] based on load to this server.
load_factor_net Number (May be omitted) Current multiplier to the [transaction cost][] being used by the rest of the network (estimated from other servers' reported load values).
load_factor_cluster Number (May be omitted) Current multiplier to the [transaction cost][] based on load to servers in this cluster.
load_factor_fee_escalation Number (May be omitted) The current multiplier to the [transaction cost][] that a transaction must pay to get into the open ledger. [New in: rippled 0.32.0][]
load_factor_fee_queue Number (May be omitted) The current multiplier to the [transaction cost][] that a transaction must pay to get into the queue, if the queue is full. [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 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.
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 Number 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.age Number The time since the ledger was closed, in seconds.
validated_ledger.base_fee_xrp Number Base fee, in XRP. This may be represented in scientific notation such as 1e-05 for 0.00005.
validated_ledger.hash String Unique hash for the ledger, as hexadecimal.
validated_ledger.reserve_base_xrp Number Minimum amount of XRP (not drops) necessary for every account to keep in reserve
validated_ledger.reserve_inc_xrp Number Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger.
validated_ledger.seq Number The [ledger index][] of the latest validated ledger.
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 String (Admin only) Either the human readable time, in UTC, when the current validator list will expire, the string unknown if the server has yet to load a published validator list or the string never if the server uses a static validator list. [Updated in: rippled 1.5.0][]

Note: If the closed_ledger field is present and has a small seq value (less than 8 digits), that indicates rippled does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs.

Possible Errors

  • Any of the [universal error types][].

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}