From c2cc532242cd57b8b376b83b55959a2b10aa3f20 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 23 Nov 2022 12:40:16 -0800 Subject: [PATCH] server_info/state updates: edits per reviews --- content/_snippets/etl-source-object.md | 12 ++++++------ .../server-info-methods/server_info.md | 6 +++--- .../server-info-methods/server_state.md | 7 ++++--- .../configuration/configure-grpc.md | 4 ++-- 4 files changed, 15 insertions(+), 14 deletions(-) diff --git a/content/_snippets/etl-source-object.md b/content/_snippets/etl-source-object.md index 229d3451a8..cd2230cb2c 100644 --- a/content/_snippets/etl-source-object.md +++ b/content/_snippets/etl-source-object.md @@ -5,9 +5,9 @@ On a reporting mode server, each member of the `etl_sources` field is an object | Field | Type | Description | |-----------------------------|---------|-------------| -| `connected` | Boolean | If `true`, the reporting mode server is connected to this p2p mode server. If `false`, that may indicate a network outage or that the p2p mode server is down. | -| `grpc_port` | String | The port number on the p2p mode server where this reporting mode server is configured to connect and retrieve ledger data via gRPC. | -| `ip` | String | The IP address (IPv4 or IPv6) of the p2p mode server. | -| `last_message_arrival_time` | String | An ISO 8601 timestamp indicating the most recent time the reporting mode server received a message from this p2p server. | -| `validated_ledgers_range` | String | The range of validated ledger versions this p2p mode server reports that it has available, in the same format as `complete_ledgers`. | -| `websocket_port` | String | The port number on the p2p server where this reporting mode server is configured to forward WebSocket requests that cannot be served directly from reporting mode. | \ No newline at end of file +| `connected` | Boolean | If `true`, the reporting mode server is connected to this P2P mode server. If `false`, the server is not connected. This could be due to misconfiguration, a network outage, or it could mean that the P2P mode server is down. | +| `grpc_port` | String | The port number on the P2P mode server where this reporting mode server is configured to connect and retrieve ledger data via gRPC. | +| `ip` | String | The IP address (IPv4 or IPv6) of the P2P mode server. | +| `last_message_arrival_time` | String | An ISO 8601 timestamp indicating the most recent time the reporting mode server received a message from this P2P server. | +| `validated_ledgers_range` | String | The range of validated ledger versions this P2P mode server reports that it has available, in the same format as `complete_ledgers`. | +| `websocket_port` | String | The port number on the P2P server where this reporting mode server is configured to forward WebSocket requests that cannot be served directly from reporting mode. | \ No newline at end of file diff --git a/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md b/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md index e3278d40b0..6e72c66566 100644 --- a/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md +++ b/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md @@ -282,9 +282,9 @@ The `info` object may have some arrangement of the following fields: | `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. | +| `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 writing to the relational database with ledger data. If `false`, it is not currenty writing, possibly because another reporting mode server is currently populating a shared database. | +| `reporting.last_publish_time` | String | _([Reporting mode](rippled-server-modes.html) servers only)_ An ISO 8601 timestamp indicating when this server last published a validated ledger to its [subscription streams](subscribe.html). | | `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][] | diff --git a/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md b/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md index ab2d6e83e8..c3962a82fd 100644 --- a/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md +++ b/content/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md @@ -290,9 +290,10 @@ The `state` object may have some arrangement of the following fields: | `pubkey_node` | String | Public key used to verify this server for peer-to-peer communications. This _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][] servers only)_ Information about this server's reporting-mode specific configurations. | -| `reporting.etl_sources` | Array | _([Reporting mode][] 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][] 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][] servers only)_ An ISO 8601 timestamp indicating when this server last saw a new validated ledger from any of its p2p mode sources. | +| `reporting.etl_sources` | Array | _([Reporting mode][] servers only)_ A l +ist 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][] servers only)_ If `true`, this server is writing to the relational database with ledger data. If `false`, it is not currenty writing, possibly because another reporting mode server is currently populating a shared database. | +| `reporting.last_publish_time` | String | _([Reporting mode][] 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][] | diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md b/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md index 36159884ad..52d0bf4bea 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md @@ -7,9 +7,9 @@ labels: --- # Configure gRPC -The `rippled` server has a limited [gRPC API](https://grpc.io/) which [p2p mode servers](rippled-server-modes.html) can provide. Reporting mode servers use this API to retrieve data about the latest validated ledgers and transactions. You can enable the gRPC API on your server with a new configuration stanza. [New in: rippled 1.5.0][] +The `rippled` server has a limited [gRPC API](https://grpc.io/) which [P2P mode servers](rippled-server-modes.html) can provide. Reporting mode servers use this API to retrieve data about the latest validated ledgers and transactions. You can enable the gRPC API on your server with a new configuration stanza. [New in: rippled 1.5.0][] -**Caution:** gRPC support is intended specifically for providing data to reporting mode servers from p2p mode servers. Breaking changes to the gRPC API may occur without warning or it may be removed entirely in future versions of the server. +**Caution:** gRPC support is intended specifically for providing data to reporting mode servers from P2P mode servers. Breaking changes to the gRPC API may occur without warning or it may be removed entirely in future versions of the server. ## Prerequisites