ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-04 11:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update server_state/info examples, add details on last_close

Browse Source
This commit is contained in:
mDuo13
2021-08-24 13:49:10 -07:00
parent 26eae89829
commit 43f7f52452
2 changed files with 266 additions and 768 deletions
Download Patch File Download Diff File Expand all files Collapse all files

538
content/references/rippled-api/public-rippled-methods/server-info-methods/server_info.md
View File

@@ -61,135 +61,56 @@ An example of a successful response:
"id": 1,
"result": {
"info": {
"build_version": "1.5.0-rc1",
"complete_ledgers": "54300020-54300717",
"hostid": "trace",
"build_version": "1.7.2",
"complete_ledgers": "64572720-65887227",
"hostid": "LARD",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time_s": 2.001,
"proposers": 34
"converge_time_s": 3.004,
"proposers": 41
},
"load": {
"job_types": [
{
"job_type": "untrustedProposal",
"peak_time": 9,
"per_second": 46
},
{
"avg_time": 14,
"job_type": "ledgerData",
"peak_time": 273,
"per_second": 1
},
{
"in_progress": 1,
"job_type": "clientCommand",
"per_second": 8
},
{
"job_type": "transaction",
"per_second": 8
},
{
"job_type": "batch",
"peak_time": 2,
"per_second": 7
},
{
"avg_time": 9,
"job_type": "advanceLedger",
"peak_time": 134,
"per_second": 2
},
{
"job_type": "fetchTxnData",
"per_second": 3
},
{
"avg_time": 9,
"job_type": "trustedValidation",
"peak_time": 95,
"per_second": 4
},
{
"job_type": "trustedProposal",
"peak_time": 8,
"per_second": 15
},
{
"job_type": "peerCommand",
"per_second": 1490
},
{
"job_type": "processTransaction",
"per_second": 8
},
{
"job_type": "SyncReadNode",
"peak_time": 8,
"per_second": 11
},
{
"job_type": "AsyncReadNode",
"peak_time": 18,
"per_second": 478
},
{
"job_type": "WriteNode",
"peak_time": 16,
"per_second": 416
}
],
"threads": 6
},
"load_factor": 1,
"peer_disconnects": "57",
"peer_disconnects_resources": "1",
"peers": 20,
"pubkey_node": "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state": "proposing",
"server_state_duration_us": "1807072679",
"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": "128124609",
"transitions": 1
"duration_us": "301410595",
"transitions": 2
},
"disconnected": {
"duration_us": "2290325",
"transitions": 1
"duration_us": "1207534",
"transitions": 2
},
"full": {
"duration_us": "1807072679",
"transitions": 1
"duration_us": "3589270527034",
"transitions": 2
},
"syncing": {
"duration_us": "3083023",
"transitions": 1
"duration_us": "6182323",
"transitions": 2
},
"tracking": {
"duration_us": "0",
"transitions": 1
"duration_us": "43",
"transitions": 2
}
},
"time": "2020-Mar-24 01:26:58.250104 UTC",
"uptime": 1940,
"time": "2021-Aug-24 20:46:22.194299 UTC",
"uptime": 3589579,
"validated_ledger": {
"age": 7,
"age": 3,
"base_fee_xrp": 0.00001,
"hash": "2BA01CA6291E30CE9610EEE2E0A6E9CF12B8914B389509940E9D3B48E0DF008C",
"hash": "F00F0E590242702B895BE378B6A6D365C094A047CFC8B11DD323D16F81CC67A5",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 54300717
"seq": 65887227
},
"validation_quorum": 29,
"validator_list": {
"count": 1,
"expiration": "2020-Apr-10 00:00:00.000000000 UTC",
"status": "active"
}
"validation_quorum": 33
}
},
"status": "success",
@@ -205,142 +126,55 @@ An example of a successful response:
{
"result": {
"info": {
"build_version": "1.5.0-rc1",
"complete_ledgers": "54300020-54300729",
"hostid": "trace",
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"jq_trans_overflow": "3",
"last_close": {
"converge_time_s": 2,
"proposers": 34
},
"load": {
"job_types": [
{
"job_type": "ledgerRequest",
"peak_time": 4,
"per_second": 4
},
{
"job_type": "untrustedProposal",
"peak_time": 5,
"per_second": 43
},
{
"avg_time": 14,
"job_type": "ledgerData",
"peak_time": 337
},
{
"in_progress": 1,
"job_type": "clientCommand",
"per_second": 9
},
{
"job_type": "transaction",
"peak_time": 8,
"per_second": 8
},
{
"job_type": "batch",
"peak_time": 5,
"per_second": 6
},
{
"avg_time": 6,
"job_type": "advanceLedger",
"peak_time": 96
},
{
"job_type": "fetchTxnData",
"per_second": 14
},
{
"job_type": "trustedValidation",
"peak_time": 5,
"per_second": 8
},
{
"job_type": "trustedProposal",
"per_second": 13
},
{
"avg_time": 2,
"job_type": "heartbeat",
"peak_time": 9
},
{
"job_type": "peerCommand",
"per_second": 1522
},
{
"job_type": "processTransaction",
"per_second": 8
},
{
"job_type": "SyncReadNode",
"peak_time": 9,
"per_second": 9
},
{
"job_type": "AsyncReadNode",
"peak_time": 24,
"per_second": 106
},
{
"job_type": "WriteNode",
"peak_time": 8,
"per_second": 282
}
],
"threads": 6
"converge_time_s": 3,
"proposers": 41
},
"load_factor": 1,
"peer_disconnects": "58",
"peer_disconnects_resources": "1",
"peers": 21,
"pubkey_node": "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state": "proposing",
"server_state_duration_us": "1850969666",
"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": "128124609",
"transitions": 1
"duration_us": "600242389",
"transitions": 40
},
"disconnected": {
"duration_us": "2290325",
"duration_us": "112927",
"transitions": 1
},
"full": {
"duration_us": "1850969666",
"transitions": 1
"duration_us": "3591757226163",
"transitions": 46
},
"syncing": {
"duration_us": "3083023",
"transitions": 1
"duration_us": "5304456",
"transitions": 7
},
"tracking": {
"duration_us": "0",
"transitions": 1
"duration_us": "13989631",
"transitions": 46
}
},
"time": "2020-Mar-24 01:27:42.147330 UTC",
"uptime": 1984,
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"validated_ledger": {
"age": 2,
"base_fee_xrp": 0.00001,
"hash": "0D2D30837E05995AAAAA117294BB45AB0699AB1219605FFD23318E050C7166E9",
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 54300729
"seq": 65886965
},
"validation_quorum": 29,
"validator_list": {
"count": 1,
"expiration": "2020-Apr-10 00:00:00.000000000 UTC",
"status": "active"
}
"validation_quorum": 33
},
"status": "success"
}
@@ -354,136 +188,60 @@ 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.5.0-rc1",
"complete_ledgers" : "54300020-54300739",
"hostid" : "trace",
"io_latency_ms" : 1,
"jq_trans_overflow" : "0",
"last_close" : {
"converge_time_s" : 3,
"proposers" : 34
},
"load" : {
"job_types" : [
{
"job_type" : "untrustedProposal",
"per_second" : 36
},
{
"avg_time" : 2,
"job_type" : "ledgerData",
"peak_time" : 50
},
{
"in_progress" : 1,
"job_type" : "clientCommand",
"per_second" : 8
},
{
"job_type" : "transaction",
"peak_time" : 1,
"per_second" : 8
},
{
"job_type" : "batch",
"peak_time" : 14,
"per_second" : 6
},
{
"avg_time" : 3,
"job_type" : "advanceLedger",
"peak_time" : 48,
"per_second" : 1
},
{
"job_type" : "fetchTxnData",
"per_second" : 4
},
{
"job_type" : "trustedValidation",
"peak_time" : 3,
"per_second" : 5
},
{
"job_type" : "trustedProposal",
"per_second" : 12
},
{
"job_type" : "peerCommand",
"per_second" : 1312
},
{
"job_type" : "processTransaction",
"per_second" : 8
},
{
"job_type" : "SyncReadNode",
"per_second" : 5
},
{
"job_type" : "AsyncReadNode",
"peak_time" : 20,
"per_second" : 56
},
{
"job_type" : "WriteNode",
"peak_time" : 3,
"per_second" : 183
}
],
"threads" : 6
},
"load_factor" : 1,
"peer_disconnects" : "60",
"peer_disconnects_resources" : "1",
"peers" : 21,
"pubkey_node" : "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator" : "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state" : "proposing",
"server_state_duration_us" : "1891111442",
"state_accounting" : {
"connected" : {
"duration_us" : "128124609",
"transitions" : 1
},
"disconnected" : {
"duration_us" : "2290325",
"transitions" : 1
},
"full" : {
"duration_us" : "1891111442",
"transitions" : 1
},
"syncing" : {
"duration_us" : "3083023",
"transitions" : 1
},
"tracking" : {
"duration_us" : "0",
"transitions" : 1
}
},
"time" : "2020-Mar-24 01:28:22.289087 UTC",
"uptime" : 2024,
"validated_ledger" : {
"age" : 2,
"base_fee_xrp" : 1e-05,
"hash" : "8BE6E2792A1D27437ABAF25B42CD367474F1EC74F6E2F576A318270A825298E4",
"reserve_base_xrp" : 20,
"reserve_inc_xrp" : 5,
"seq" : 54300739
},
"validation_quorum" : 29,
"validator_list" : {
"count" : 1,
"expiration" : "2020-Apr-10 00:00:00.000000000 UTC",
"status" : "active"
}
"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
},
"status" : "success"
}
"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"
}
}
```
@@ -493,45 +251,47 @@ The response follows the [standard format][], with a successful result containin
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](amendments.html#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](capacity-planning.html). [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. |
| `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](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#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](clustering.html). |
| `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](transaction-cost.html#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](clustering.html). |
| `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](rippled-server-states.html) 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](rippled-server-states.html) 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` | Unsigned Integer | Minimum amount of XRP (not drops) necessary for every account to keep in reserve |
| `validated_ledger.reserve_inc_xrp` | Unsigned Integer | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. |
| `validated_ledger.seq` | Number - [Ledger Index][] | 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][] |
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#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](peer-protocol.html#node-key-pair). |
| `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](capacity-planning.html). [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](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#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](clustering.html). |
| `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](transaction-cost.html#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_](peer-protocol.html#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](clustering.html). |
| `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](rippled-server-states.html) 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](rippled-server-states.html) 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.

496
content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md
View File

@@ -61,108 +61,13 @@ An example of a successful response:
"id": 1,
"result": {
"state": {
"build_version": "1.5.0-rc1",
"complete_ledgers": "54300020-54300697",
"build_version": "1.7.2",
"complete_ledgers": "64572720-65887201",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time": 3001,
"proposers": 34
},
"load": {
"job_types": [
{
"avg_time": 5,
"job_type": "untrustedValidation",
"peak_time": 21
},
{
"job_type": "ledgerRequest",
"peak_time": 9,
"per_second": 3
},
{
"job_type": "untrustedProposal",
"peak_time": 26,
"per_second": 45
},
{
"avg_time": 15,
"job_type": "ledgerData",
"peak_time": 105,
"per_second": 1
},
{
"in_progress": 1,
"job_type": "clientCommand",
"peak_time": 50,
"per_second": 8
},
{
"avg_time": 1,
"job_type": "transaction",
"peak_time": 35,
"per_second": 8
},
{
"job_type": "batch",
"peak_time": 5,
"per_second": 6
},
{
"avg_time": 4,
"job_type": "advanceLedger",
"peak_time": 65,
"per_second": 2
},
{
"job_type": "fetchTxnData",
"per_second": 3
},
{
"avg_time": 7,
"job_type": "trustedValidation",
"peak_time": 49,
"per_second": 6
},
{
"job_type": "trustedProposal",
"peak_time": 20,
"per_second": 14
},
{
"job_type": "clusterReport",
"peak_time": 2
},
{
"job_type": "heartbeat",
"peak_time": 1
},
{
"job_type": "peerCommand",
"per_second": 1334
},
{
"job_type": "processTransaction",
"per_second": 8
},
{
"job_type": "SyncReadNode",
"peak_time": 6,
"per_second": 35
},
{
"job_type": "AsyncReadNode",
"peak_time": 13,
"per_second": 1104
},
{
"job_type": "WriteNode",
"peak_time": 12,
"per_second": 976
}
],
"threads": 6
"converge_time": 3005,
"proposers": 41
},
"load_base": 256,
"load_factor": 256,
@@ -170,47 +75,45 @@ An example of a successful response:
"load_factor_fee_queue": 256,
"load_factor_fee_reference": 256,
"load_factor_server": 256,
"peer_disconnects": "55",
"peer_disconnects_resources": "1",
"peers": 21,
"pubkey_node": "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state": "proposing",
"server_state_duration_us": "1727270915",
"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": "128124609",
"transitions": 1
"duration_us": "301410595",
"transitions": 2
},
"disconnected": {
"duration_us": "2290325",
"transitions": 1
"duration_us": "1207534",
"transitions": 2
},
"full": {
"duration_us": "1727270915",
"transitions": 1
"duration_us": "3589171798767",
"transitions": 2
},
"syncing": {
"duration_us": "3083023",
"transitions": 1
"duration_us": "6182323",
"transitions": 2
},
"tracking": {
"duration_us": "0",
"transitions": 1
"duration_us": "43",
"transitions": 2
}
},
"time": "2020-Mar-24 01:25:38.448364 UTC",
"uptime": 1860,
"time": "2021-Aug-24 20:44:43.466048 UTC",
"uptime": 3589480,
"validated_ledger": {
"base_fee": 10,
"close_time": 638328331,
"hash": "A63E850343B9F06CFE637648FF3D46DBAB7B1E41BA6B9A26FA72AA706D82233D",
"close_time": 683153081,
"hash": "B52AC3876412A152FE9C0442801E685D148D05448D0238587DBA256330A98FD3",
"reserve_base": 20000000,
"reserve_inc": 5000000,
"seq": 54300697
"seq": 65887201
},
"validation_quorum": 29,
"validator_list_expires": 639792000
"validation_quorum": 33
}
},
"status": "success",
@@ -223,138 +126,64 @@ An example of a successful response:
```json
200 OK
Headers
{
"result": {
"state": {
"build_version": "1.5.0-rc1",
"complete_ledgers": "54300020-54300761",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"build_version": "1.7.2",
"complete_ledgers": "65844785-65887184",
"io_latency_ms": 3,
"jq_trans_overflow": "580",
"last_close": {
"converge_time": 3000,
"proposers": 34
},
"load": {
"job_types": [
{
"job_type": "ledgerRequest",
"per_second": 2
},
{
"job_type": "untrustedProposal",
"peak_time": 1,
"per_second": 41
},
{
"avg_time": 5,
"job_type": "ledgerData",
"peak_time": 42,
"per_second": 1
},
{
"in_progress": 1,
"job_type": "clientCommand",
"per_second": 7
},
{
"job_type": "transaction",
"per_second": 9
},
{
"job_type": "batch",
"peak_time": 8,
"per_second": 7
},
{
"job_type": "advanceLedger",
"peak_time": 12,
"per_second": 1
},
{
"job_type": "fetchTxnData",
"per_second": 5
},
{
"job_type": "trustedValidation",
"peak_time": 7,
"per_second": 7
},
{
"job_type": "trustedProposal",
"per_second": 14
},
{
"job_type": "peerCommand",
"per_second": 1461
},
{
"job_type": "processTransaction",
"per_second": 9
},
{
"job_type": "SyncReadNode",
"per_second": 4
},
{
"job_type": "AsyncReadNode",
"peak_time": 21,
"per_second": 124
},
{
"job_type": "WriteNode",
"peak_time": 7,
"per_second": 278
}
],
"threads": 6
"converge_time": 3012,
"proposers": 41
},
"load_base": 256,
"load_factor": 256,
"load_factor_fee_escalation": 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": "61",
"peer_disconnects_resources": "1",
"peers": 20,
"pubkey_node": "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator": "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state": "proposing",
"server_state_duration_us": "1974824750",
"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": "128124609",
"duration_us": "172799714",
"transitions": 1
},
"disconnected": {
"duration_us": "2290325",
"duration_us": "309059",
"transitions": 1
},
"full": {
"duration_us": "1974824750",
"transitions": 1
"duration_us": "6020429212246",
"transitions": 143
},
"syncing": {
"duration_us": "3083023",
"transitions": 1
"duration_us": "413813232",
"transitions": 152
},
"tracking": {
"duration_us": "0",
"transitions": 1
"duration_us": "266553605",
"transitions": 152
}
},
"time": "2020-Mar-24 01:29:46.002417 UTC",
"uptime": 2108,
"time": "2021-Aug-24 20:43:43.043406 UTC",
"uptime": 6021282,
"validated_ledger": {
"base_fee": 10,
"close_time": 638328581,
"hash": "E262523CB2579D3E1F66DEBBDCC3D7E9E7E3D88B0B45F9D5640C92766934C855",
"close_time": 683153020,
"hash": "ABEF3D24015E8B6B7184B4ABCEDC0E0E3AA4F0677FAB91C40B1E500707C1F3E5",
"reserve_base": 20000000,
"reserve_inc": 5000000,
"seq": 54300761
"seq": 65887184
},
"validation_quorum": 29,
"validator_list_expires": 639792000
"validation_quorum": 33
},
"status": "success"
}
@@ -367,160 +196,67 @@ An example of a successful response:
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.5.0-rc1",
"complete_ledgers" : "54300020-54300767",
"io_latency_ms" : 1,
"jq_trans_overflow" : "0",
"last_close" : {
"converge_time" : 3143,
"proposers" : 34
},
"load" : {
"job_types" : [
{
"job_type" : "untrustedProposal",
"peak_time" : 14,
"per_second" : 44
},
{
"avg_time" : 6,
"job_type" : "ledgerData",
"peak_time" : 252,
"per_second" : 3
},
{
"in_progress" : 1,
"job_type" : "clientCommand",
"peak_time" : 3,
"per_second" : 10
},
{
"avg_time" : 2,
"job_type" : "transaction",
"peak_time" : 61,
"per_second" : 10
},
{
"job_type" : "batch",
"peak_time" : 11,
"per_second" : 7
},
{
"avg_time" : 4,
"job_type" : "advanceLedger",
"peak_time" : 128,
"per_second" : 10
},
{
"job_type" : "fetchTxnData",
"per_second" : 4
},
{
"avg_time" : 11,
"job_type" : "writeAhead",
"peak_time" : 43
},
{
"avg_time" : 2,
"job_type" : "trustedValidation",
"peak_time" : 107,
"per_second" : 11
},
{
"avg_time" : 41,
"job_type" : "acceptLedger",
"peak_time" : 112
},
{
"job_type" : "trustedProposal",
"per_second" : 14
},
{
"avg_time" : 131,
"job_type" : "sweep",
"peak_time" : 523
},
{
"avg_time" : 36,
"job_type" : "heartbeat",
"peak_time" : 144
},
{
"job_type" : "peerCommand",
"per_second" : 1594
},
{
"job_type" : "processTransaction",
"per_second" : 10
},
{
"job_type" : "SyncReadNode",
"per_second" : 128
},
{
"job_type" : "AsyncReadNode",
"per_second" : 3346
},
{
"job_type" : "WriteNode",
"per_second" : 2275
}
],
"threads" : 6
},
"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" : "61",
"peer_disconnects_resources" : "1",
"peers" : 21,
"pubkey_node" : "n9KUjqxCr5FKThSNXdzb7oqN8rYwScB2dUnNqxQxbEA17JkaWy5x",
"pubkey_validator" : "nHBk5DPexBjinXV8qHn7SEKzoxh2W92FxSbNTPgGtQYBzEF4msn9",
"server_state" : "proposing",
"server_state_duration_us" : "1997468900",
"state_accounting" : {
"connected" : {
"duration_us" : "128124609",
"transitions" : 1
},
"disconnected" : {
"duration_us" : "2290325",
"transitions" : 1
},
"full" : {
"duration_us" : "1997468900",
"transitions" : 1
},
"syncing" : {
"duration_us" : "3083023",
"transitions" : 1
},
"tracking" : {
"duration_us" : "0",
"transitions" : 1
}
},
"time" : "2020-Mar-24 01:30:08.646564 UTC",
"uptime" : 2130,
"validated_ledger" : {
"base_fee" : 10,
"close_time" : 638328602,
"hash" : "835B1EDFA0D4B7BDE1F5030D1B5FBE98C122ABB9C34FE8889B77CD635766C1B5",
"reserve_base" : 20000000,
"reserve_inc" : 5000000,
"seq" : 54300767
},
"validation_quorum" : 29,
"validator_list_expires" : 639792000
"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
},
"status" : "success"
}
"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"
}
}
```
@@ -539,6 +275,8 @@ The `state` object may have some arrangement of the following fields:
| `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](capacity-planning.html). [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. |