From d4fb95e2b7f1229975669367dd418580144e411e Mon Sep 17 00:00:00 2001 From: Alex Kremer Date: Thu, 21 Sep 2023 00:45:12 +0100 Subject: [PATCH] Fix review issues --- .../networks-and-servers/amendments.md | 2 +- .../clio-methods/server_info-clio.md | 21 ++++++++++--------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/content/concepts/networks-and-servers/amendments.md b/content/concepts/networks-and-servers/amendments.md index dbd0ede363..868dee7459 100644 --- a/content/concepts/networks-and-servers/amendments.md +++ b/content/concepts/networks-and-servers/amendments.md @@ -4,6 +4,7 @@ parent: networks-and-servers.html blurb: Amendments represent new features or other changes to transaction processing. Validators coordinate through consensus to apply these upgrades to the XRP Ledger in an orderly fashion. labels: - Blockchain +outdated_translation: true --- # Amendments @@ -63,7 +64,6 @@ The voting configuration of a `rippled` server has no impact on it becoming amen You can unblock amendment blocked servers by upgrading to the newest version of `rippled`. ### Amendment Blocked Clio Servers - The Clio server can become amendment blocked if it encounters an unknown field type while loading ledger data. This occurs if the field is newer than the `libxrpl` dependency that was used when building Clio. To unblock your Clio server, upgrade to a newer Clio release that was built with a compatible `libxrpl`. diff --git a/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md b/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md index ed31efc438..ed47d86c4d 100644 --- a/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md +++ b/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md @@ -4,6 +4,7 @@ parent: clio-methods.html blurb: Retrieve status of the Clio server in human-readable format. labels: - Core Server +outdated_translation: true --- # server_info [[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "Source") @@ -44,7 +45,7 @@ The request does not take any parameters. ## Response Format -When a client connects to the `Clio` server over `localhost`, the response includes the `counters` and `etl` objects. These objects are omitted from the response when the client is not located on the same server, and hence does not connect over `localhost`. +When a client connects to the Clio server over `localhost`, the response includes the `counters` and `etl` objects. These objects are omitted from the response when the client is not located on the same server, and hence does not connect over `localhost`. An example of a successful response when client connects over `localhost`: @@ -567,14 +568,14 @@ The `info` object may have some arrangement of the following fields: | `Field` | Type | Description | |:------------------------------------|:----------------|:---------------------| | `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`. | -| `counters` | Object | _(May be omitted)_ Stats on API calls handled since server startup. This is present only if the client connects to the `Clio` server over `localhost`. -| `rpc` | Object | _(May be omitted)_ Stats on each API call handled by the Clio server since startup. Since this is nested within the `counters` object, this is also present only if the client connects to the `Clio` server over `localhost`. | +| `counters` | Object | _(May be omitted)_ Stats on API calls handled since server startup. This is present only if the client connects to the Clio server over `localhost`. +| `rpc` | Object | _(May be omitted)_ Stats on each API call handled by the Clio server since startup. Since this is nested within the `counters` object, this is also present only if the client connects to the Clio server over `localhost`. | | `rpc.*.started` | Number | Number of API calls of this type that the Clio server has started processing since startup. | | `rpc.*.finished` | Number | Number of API calls of this type that the Clio server has finished processing since startup. | | `rpc.*.errored` | Number | Number of API calls of this type that have resulted in some sort of error since startup. | | `rpc.*.forwarded` | Number | Number of API calls of this type that the Clio server has forwarded to a `rippled` P2P server since startup. | | `rpc.*.duration_us` | Number | The total number of microseconds spent processing API calls of this type since startup. | -| `subscriptions` | Object | _(May be omitted)_ Number of current subscribers for each stream type. Since this is nested within the `counters` object, this is also present only if the client connects to the `Clio` server over `localhost`. | +| `subscriptions` | Object | _(May be omitted)_ Number of current subscribers for each stream type. Since this is nested within the `counters` object, this is also present only if the client connects to the Clio server over `localhost`. | | `subscriptions.ledger` | | | | `subscriptions.transactions` | | | | `subscriptions.transactions_proposed` | | | @@ -585,12 +586,12 @@ The `info` object may have some arrangement of the following fields: | `subscriptions.books` | | | | `time` | String | The current time in UTC, according to the server's clock. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | | `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | -| `amendment_blocked` | Boolean | Whether the Clio server is [Amendment Blocked](amendments.html#amendment-blocked-in-clio-servers) [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | +| `amendment_blocked` | Boolean | _(May be omitted)_ Whether the Clio server is [Amendment Blocked](amendments.html#amendment-blocked-in-clio-servers) [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | | `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. | -| `clio_version` | String | The version number of the running `Clio` server. | -| `libxrpl_version` | String | The version number of the `libxrpl` library this `Clio` server was built against. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | -| `validation_quorum` | Number | _(May be omitted)_ Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. This value is obtained from `rippled`. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. | -| `rippled_version` | String | _(May be omitted)_ The version number of the running `rippled` server that the `Clio` server is connected to. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. | +| `clio_version` | String | The version number of the running Clio server. | +| `libxrpl_version` | String | The version number of the `libxrpl` library this Clio server was built against. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | +| `validation_quorum` | Number | _(May be omitted)_ Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. This value is obtained from `rippled`. This field may be omitted from the response if the Clio server is unable to connect to `rippled` for some reason. | +| `rippled_version` | String | _(May be omitted)_ The version number of the running `rippled` server that the Clio server is connected to. This field may be omitted from the response if the Clio server is unable to connect to `rippled` for some reason. | | `network_id` | String | _(May be omitted)_ The network ID of the network that the `rippled` this Clio server is connected to is operating on. This field may be omitted from the response if the Clio server is unable to connect to `rippled` for some reason. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | | `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. | @@ -604,7 +605,7 @@ The `info` object may have some arrangement of the following fields: | `cache.size` | Number | Number of state data objects currently in the cache. | | `cache.is_full` | Boolean | True if cache contains all state data for a specific ledger, false otherwise. Some API calls, such as the [book_offers method][], process much faster when the cache is full. | | `cache.latest_ledger_seq` | Number | The [ledger index][] of the latest validated ledger stored in the cache. | -| `etl` | Object | The `rippled` sources (ETL sources) that the Clio server is connected to. This is present only if the client connects to the `Clio` server over `localhost`. | +| `etl` | Object | The `rippled` sources (ETL sources) that the Clio server is connected to. This is present only if the client connects to the Clio server over `localhost`. | | `etl.etl_sources` | Object Array | List the `rippled` sources (ETL sources) that the Clio server is connected to and extracts data from. | | `etl.etl_sources.validated_range` | String | The validated ledger range retrieved by the P2P `rippled` server. | | `etl.etl_sources.is_connected` | Boolean | True if Clio is connected to this source via websocket, false otherwise. A value of false here could indicate a networking issue, or that `rippled` is not running, amongst other things. |