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

Merge pull request #2377 from XRPLF/migrate-open-prs-0205

Browse Source 
Port updates from open PRs to the redocly-migration branch
This commit is contained in:
Amarantha Kulkarni
2024-02-06 13:14:52 -08:00
committed by GitHub
parent 6d8591123f b57db39a59
commit 9faf1fb88f
2 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -20,7 +20,8 @@ An example of the request format:
```json ```json
{ {
"id": 1, "id": 1,
"command": "server_info" "command": "server_info",
"counters": false
} }
``` ```
{% /tab %} {% /tab %}
@@ -30,7 +31,7 @@ An example of the request format:
{ {
"method": "server_info", "method": "server_info",
"params": [ "params": [
{} {"counters" : false}
] ]
} }
``` ```
@@ -38,7 +39,8 @@ An example of the request format:
{% tab label="Commandline" %} {% tab label="Commandline" %}
```sh ```sh
#Syntax: server_info #Syntax: server_info [counters]
# counters is an optional boolean value, it is used to display performance metrics
rippled server_info rippled server_info
``` ```
{% /tab %} {% /tab %}
@@ -47,7 +49,11 @@ rippled server_info
[Try it! >](/resources/dev-tools/websocket-api-tool#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 ## 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. | | `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. | | `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. | | `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. **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.

2
docs/references/xrp-ledger-toml.md
View File

@@ -151,6 +151,7 @@ desc = "Test Net public server cluster"
[[PRINCIPALS]] [[PRINCIPALS]]
name = "Rome Reginelli" # Primary spec author name = "Rome Reginelli" # Primary spec author
email = "rome@example.com" # Not my real email address 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]] [[CURRENCIES]]
code = "LOL" code = "LOL"
@@ -214,6 +215,7 @@ The principals list provides information about the people (or business entities)
|:--------|:-------|:---------------------------------------------------------| |:--------|:-------|:---------------------------------------------------------|
| `name` | String | The name of this principal. | | `name` | String | The name of this principal. |
| `email` | String | The email address where this principal can be contacted. | | `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.) You may provide other contact information as desired. (See [Custom Fields](#custom-fields) for information about custom fields.)