From 6465edf6bdfc5fd75823284cf6e1a861c6925ba9 Mon Sep 17 00:00:00 2001 From: Amarantha Kulkarni Date: Mon, 5 Feb 2024 10:40:29 -0800 Subject: [PATCH 1/2] Porting updates from PR #2271 to the Redocly migration branch --- docs/references/xrp-ledger-toml.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/references/xrp-ledger-toml.md b/docs/references/xrp-ledger-toml.md index 174a5ab1d8..b229259391 100644 --- a/docs/references/xrp-ledger-toml.md +++ b/docs/references/xrp-ledger-toml.md @@ -151,6 +151,7 @@ desc = "Test Net public server cluster" [[PRINCIPALS]] name = "Rome Reginelli" # Primary spec author email = "rome@example.com" # Not my real email address +social_1 = "https://website.tld/username" # Social media username/handle as an alternative way to connect [[CURRENCIES]] code = "LOL" @@ -214,6 +215,7 @@ The principals list provides information about the people (or business entities) |:--------|:-------|:---------------------------------------------------------| | `name` | String | The name of this principal. | | `email` | String | The email address where this principal can be contacted. | +| `social_1` | String | The social media username/handle where this principal can be contacted. For consistency, use site names, not domains, when specifying social media platforms. For example, `x = "@username"` or `linkedin = "username"` | You may provide other contact information as desired. (See [Custom Fields](#custom-fields) for information about custom fields.) From b57db39a59128e9b7d5ada1069e5d274dcc28354 Mon Sep 17 00:00:00 2001 From: Amarantha Kulkarni Date: Mon, 5 Feb 2024 10:54:03 -0800 Subject: [PATCH 2/2] Porting updates from PR #2193 to the redocly-migration branch --- .../server-info-methods/server_info.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md index d82697a300..4bf53438e4 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md @@ -20,7 +20,8 @@ An example of the request format: ```json { "id": 1, - "command": "server_info" + "command": "server_info", + "counters": false } ``` {% /tab %} @@ -30,7 +31,7 @@ An example of the request format: { "method": "server_info", "params": [ - {} + {"counters" : false} ] } ``` @@ -38,7 +39,8 @@ An example of the request format: {% tab label="Commandline" %} ```sh -#Syntax: server_info +#Syntax: server_info [counters] +# counters is an optional boolean value, it is used to display performance metrics rippled server_info ``` {% /tab %} @@ -47,7 +49,11 @@ rippled server_info [Try it! >](/resources/dev-tools/websocket-api-tool#server_info) -The request does not take any parameters. +The request includes the following parameters: + +| Field | Type | Required? | Description | +|:----------------------|:--------|:----------|-------------| +| `counters` | Boolean | No | If `true`, return metrics about the job queue, ledger store, and API method activity. The default is `false`. | ## Response Format @@ -119,6 +125,8 @@ The `info` object may have some arrangement of the following fields: | `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 expires, 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. | +| `counters` | Object | This object contains performance metrics pertaining to the RPC calls (currently executing calls and completed calls) and the JobQueue. It also contains details of the nodestore like `node_writes`, `node_reads_total`, `node_reads_hit`, etc| +| `current_activity` | Object | This field lists the items currently being run in the job queue and contains two arrays for `jobs` and `methods`. | **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.