Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

server_info/state: document new ports field #2130

Merged
merged 3 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions content/_api-examples/server_info/jsonrpc-response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
{
"result": {
"info": {
"build_version": "1.12.0",
"complete_ledgers": "32570-82521761",
"hostid": "LEST",
"initial_sync_duration_us": "190181187",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time_s": 3,
"proposers": 35
},
"load_factor": 1,
"network_id": 0,
"peer_disconnects": "5",
"peer_disconnects_resources": "0",
"peers": 22,
"ports": [
{
"port": "7777",
"protocol": [
"ws"
]
},
{
"port": "8080",
"protocol": [
"ws"
]
},
{
"port": "80",
"protocol": [
"http"
]
},
{
"port": "51235",
"protocol": [
"peer"
]
}
],
"pubkey_node": "n9KQK8yvTDcZdGyhu2EGdDnFPEBSsY5wEgpU5GgpygTgLFsjQyPt",
"server_state": "full",
"server_state_duration_us": "91758491912",
"state_accounting": {
"connected": {
"duration_us": "83091928",
"transitions": "2"
},
"disconnected": {
"duration_us": "104836801",
"transitions": "2"
},
"full": {
"duration_us": "91758491912",
"transitions": "1"
},
"syncing": {
"duration_us": "2252409",
"transitions": "1"
},
"tracking": {
"duration_us": "48",
"transitions": "1"
}
},
"time": "2023-Sep-13 22:12:31.377492 UTC",
"uptime": 91948,
"validated_ledger": {
"age": 1,
"base_fee_xrp": 0.00001,
"hash": "6872A6612DCEBCFC717FEBC66EB8CC2A4D5EEB2B0F15FC3DCD060049FCA47F31",
"reserve_base_xrp": 10,
"reserve_inc_xrp": 2,
"seq": 82521761
},
"validation_quorum": 28
},
"status": "success"
}
}
86 changes: 86 additions & 0 deletions content/_api-examples/server_info/ws-response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
{
"id": 1,
"result": {
"info": {
"build_version": "1.12.0",
"complete_ledgers": "32570-82521701",
"hostid": "LEST",
"initial_sync_duration_us": "190181187",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time_s": 3.001,
"proposers": 35
},
"load_factor": 1,
"network_id": 0,
"peer_disconnects": "5",
"peer_disconnects_resources": "0",
"peers": 22,
"ports": [
{
"port": "7777",
"protocol": [
"ws"
]
},
{
"port": "8080",
"protocol": [
"ws"
]
},
{
"port": "80",
"protocol": [
"http"
]
},
{
"port": "51235",
"protocol": [
"peer"
]
}
],
"pubkey_node": "n9KQK8yvTDcZdGyhu2EGdDnFPEBSsY5wEgpU5GgpygTgLFsjQyPt",
"server_state": "full",
"server_state_duration_us": "91535211664",
"state_accounting": {
"connected": {
"duration_us": "83091928",
"transitions": "2"
},
"disconnected": {
"duration_us": "104836801",
"transitions": "2"
},
"full": {
"duration_us": "91535211664",
"transitions": "1"
},
"syncing": {
"duration_us": "2252409",
"transitions": "1"
},
"tracking": {
"duration_us": "48",
"transitions": "1"
}
},
"time": "2023-Sep-13 22:08:48.097189 UTC",
"uptime": 91725,
"validated_ledger": {
"age": 4,
"base_fee_xrp": 0.00001,
"hash": "5825332DC66029ECCD896CACB3BBB79E4F5372A8DCA91AA2874A1A1A87B79F84",
"reserve_base_xrp": 10,
"reserve_inc_xrp": 2,
"seq": 82521701
},
"validation_quorum": 28
}
},
"status": "success",
"type": "response"
}
11 changes: 11 additions & 0 deletions content/_snippets/port-descriptor-object.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Port Descriptor Object
<!-- This nested object definition is identical across server_state and server_info -->

Each member of the `ports` array is an object with the following fields:

| Field | Value | Description |
|------------|-----------------|-------------|
| `port` | String - Number | A port number where the server is listening. |
| `protocol` | Array of String | A list of protocols being served on this port. Valid protocols include `http` or `https` for JSON-RPC, `ws`, `ws2`, `wss`, `wss2` for WebSocket, `grpc` for [gRPC](configure-grpc.html), and `peer` for the [XRP Ledger Peer Protocol](peer-protocol.html). |

**Note:** Depending on network infrastructure, the ports and protocols reported here may not match how the server can be reached from the outside network. For example, if TLS terminates at a load balancer or proxy, the server may report `http` on one port, but might only be reachable through `https` on port 443 from outside.
1 change: 1 addition & 0 deletions content/_snippets/rippled_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"1.8.1",
"1.10.0",
"1.11.0",
"1.12.0",
] %}

{% for v in rippled_versions %}
Expand Down
Loading
Loading