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

Update server_info/state w/ reporting mode details

Browse Source 
- Add reporting mode specific fields
- Mark peers field as omitted from reporting mode
- Fix "external" gRPC link in server modes page
- Update "Configure gRPC" tutorial to better reflect current status of
  gRPC in rippled

This commit fixes #1446.
This commit is contained in:
mDuo13
2022-11-16 15:38:42 -08:00
parent 0ab974f0e9
commit 3ed5d90519
6 changed files with 133 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

187
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md
View File

@@ -61,56 +61,57 @@ An example of a successful response:
"id": 1,
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64572720-65887227",
"hostid": "LARD",
"build_version": "1.9.4",
"complete_ledgers": "32570-75801736",
"hostid": "ARMY",
"initial_sync_duration_us": "273518294",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"jq_trans_overflow": "2282",
"last_close": {
"converge_time_s": 3.004,
"proposers": 41
"converge_time_s": 3.002,
"proposers": 35
},
"load_factor": 512.578125,
"load_factor_server": 1,
"peer_disconnects": "365016",
"peer_disconnects_resources": "336",
"peers": 211,
"pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
"load_factor": 1,
"network_id": 0,
"peer_disconnects": "3194",
"peer_disconnects_resources": "3",
"peers": 20,
"pubkey_node": "n9KKBZvwPZ95rQi4BP3an1MRctTyavYkZiLpQwasmFYTE6RYdeX3",
"server_state": "full",
"server_state_duration_us": "3589068181859",
"server_state_duration_us": "69205850392",
"state_accounting": {
"connected": {
"duration_us": "301410595",
"transitions": 2
"duration_us": "141058919",
"transitions": "7"
},
"disconnected": {
"duration_us": "1207534",
"transitions": 2
"duration_us": "514136273",
"transitions": "3"
},
"full": {
"duration_us": "3589270527034",
"transitions": 2
"duration_us": "4360230140761",
"transitions": "32"
},
"syncing": {
"duration_us": "6182323",
"transitions": 2
"duration_us": "50606510",
"transitions": "30"
},
"tracking": {
"duration_us": "43",
"transitions": 2
"duration_us": "40245486",
"transitions": "34"
}
},
"time": "2021-Aug-24 20:46:22.194299 UTC",
"uptime": 3589579,
"time": "2022-Nov-16 21:50:22.711679 UTC",
"uptime": 4360976,
"validated_ledger": {
"age": 3,
"age": 1,
"base_fee_xrp": 0.00001,
"hash": "F00F0E590242702B895BE378B6A6D365C094A047CFC8B11DD323D16F81CC67A5",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65887227
"hash": "3147A41F5F013209581FCDCBBB7A87A4F01EF6842963E13B2B14C8565E00A22B",
"reserve_base_xrp": 10,
"reserve_inc_xrp": 2,
"seq": 75801736
},
"validation_quorum": 33
"validation_quorum": 28
}
},
"status": "success",
@@ -126,55 +127,57 @@ An example of a successful response:
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"build_version": "1.9.4",
"complete_ledgers": "32570-75801747",
"hostid": "ABET",
"initial_sync_duration_us": "566800928",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"jq_trans_overflow": "47035",
"last_close": {
"converge_time_s": 3,
"proposers": 41
"proposers": 35
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"network_id": 0,
"peer_disconnects": "542",
"peer_disconnects_resources": "1",
"peers": 24,
"pubkey_node": "n9LvjJyaYHBWUvQUat632RrnpS7UHVLW2tLUGXSZ2yXouh4goDHX",
"server_state": "full",
"server_state_duration_us": "627203282776",
"server_state_duration_us": "3612238603",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
"duration_us": "125498126",
"transitions": "67"
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
"duration_us": "473415516",
"transitions": "2"
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
"duration_us": "4365855930299",
"transitions": "337"
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
"duration_us": "1383837914",
"transitions": "311"
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
"duration_us": "518995710",
"transitions": "374"
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"time": "2022-Nov-16 21:51:03.737667 UTC",
"uptime": 4368357,
"validated_ledger": {
"age": 2,
"age": 1,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
"hash": "D54A94D5EF620DC212EAB5958D592EC641FC94ED92146477A04DCE5B006DFF05",
"reserve_base_xrp": 10,
"reserve_inc_xrp": 2,
"seq": 75801747
},
"validation_quorum": 33
"validation_quorum": 28
},
"status": "success"
}
@@ -190,55 +193,57 @@ Loading: "/etc/opt/ripple/rippled.cfg"
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"build_version": "1.9.4",
"complete_ledgers": "32570-75801747",
"hostid": "ABET",
"initial_sync_duration_us": "566800928",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"jq_trans_overflow": "47035",
"last_close": {
"converge_time_s": 3,
"proposers": 41
"proposers": 35
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"network_id": 0,
"peer_disconnects": "542",
"peer_disconnects_resources": "1",
"peers": 24,
"pubkey_node": "n9LvjJyaYHBWUvQUat632RrnpS7UHVLW2tLUGXSZ2yXouh4goDHX",
"server_state": "full",
"server_state_duration_us": "627203282776",
"server_state_duration_us": "3612238603",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
"duration_us": "125498126",
"transitions": "67"
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
"duration_us": "473415516",
"transitions": "2"
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
"duration_us": "4365855930299",
"transitions": "337"
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
"duration_us": "1383837914",
"transitions": "311"
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
"duration_us": "518995710",
"transitions": "374"
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"time": "2022-Nov-16 21:51:03.737667 UTC",
"uptime": 4368357,
"validated_ledger": {
"age": 2,
"age": 1,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
"hash": "D54A94D5EF620DC212EAB5958D592EC641FC94ED92146477A04DCE5B006DFF05",
"reserve_base_xrp": 10,
"reserve_inc_xrp": 2,
"seq": 75801747
},
"validation_quorum": 33
"validation_quorum": 28
},
"status": "success"
}
@@ -276,11 +281,15 @@ The `info` object may have some arrangement of the following fields:
| `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. |
| `reporting` | Object | _([Reporting mode](rippled-server-modes.html) servers only)_ Information about this server's reporting-mode specific configurations. |
| `reporting.etl_sources` | Array | _([Reporting mode](rippled-server-modes.html) 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](#etl-source-object). |
| `reporting.is_writer` | Boolean | _([Reporting mode](rippled-server-modes.html) servers only)_ If `true`, this server is configured to write to the relational database with ledger data. If `false`, it is configured read-only and relies on other reporting mode servers to populate the database. |
| `reporting.last_publish_time` | String | _([Reporting mode](rippled-server-modes.html) 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](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][] |
| `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. |
@@ -295,6 +304,8 @@ The `info` object may have some arrangement of the following fields:
**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.
{% include '_snippets/etl-source-object.md' %}
## Possible Errors
* Any of the [universal error types][].