ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-03 10:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Peer protocol: some updates for v1.2.1 changes

Browse Source
This commit is contained in:
mDuo13
2019-02-27 18:37:18 -08:00
parent 3ce789e1da
commit 76bc050fc8
3 changed files with 19 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
content/references/rippled-api/peer-crawler.md
View File

@@ -27,19 +27,21 @@ The JSON object has the following fields:
| `Field` | Value | Description |
|:-----------------|:-------|:-------------------------------------------------|
| `counts` | Object | _(May be omitted)_ Stats about this server's health, similar to the output of the [get_counts][] method. The default configuration does not report this field. |
| `overlay.active` | Array | Array of Peer Objects, where each member is a peer that is connected to this server. |
| `server` | Object | _(May be omitted)_ Information about this server. Contains the public fields from the [server_state method][]. |
| `unl` | Object | _(May be omitted)_ Information about the validators and validator list sites this server is configured to trust, similar to the output of the [validators method][] and [validator_list_sites][] method. |
| `version` | Number | Indicates the version of this peer crawler response format. As of rippled v1.2.1, the current peer crawler version number is `2`. |
| `counts` | Object | _(May be omitted)_ Stats about this server's health, similar to the output of the [get_counts][] method. The default configuration does not report this field. Information reported includes: how large the ledger and transaction databases are, the cache hit rate for the in-application caches, and how many objects of various types are cached in memory. Types of objects that may be stored in memory include ledgers (`Ledger`), transactions (`STTx`), validation messages (`STValidation`), and more. |
| `overlay` | Object | Information about the peer servers currently connected to this one. Contains one field, `active`, which is an array of objects (see below). |
| `server` | Object | _(May be omitted)_ Information about this server. Contains public fields from the [server_state method][], including what `rippled` version you are running (`build_version`), which [ledger versions](ledger-history.html) your server has available (`complete_ledgers`), and the amount of load your server is experiencing. [Updated in: rippled v1.2.1][New in: rippled v1.2.1] |
| `unl` | Object | _(May be omitted)_ Information about the validators and validator list sites this server is configured to trust, similar to the output of the [validators method][] and [validator_list_sites][] method. [Updated in: rippled v1.2.1][New in: rippled v1.2.1] |
| `version` | Number | Indicates the version of this peer crawler response format. The current peer crawler version number is `2`. [Updated in: rippled v1.2.1][New in: rippled v1.2.1] |
Each member of the `active` array is a Peer Object with the following fields:
Each member of the `overlay.active` array is an object with the following fields:
| `Field` | Value | Description |
|:-------------|:-------------------------|:-----------------------------------|
| `ip` | String (IPv4 Address) | _(May be omitted)_ The IP address of this connected peer. |
| `port` | String (Number) | _(May be omitted)_ The port number on the peer server that serves RTXP. Typically 51235. |
| `public_key` | String (Base-64 Encoded) | The public key of the ECDSA key pair used by this peer to sign RTXP messages. (This is the same data as the `pubkey_node` reported in the peer server's [`server_info` command](server_info.html).) |
| `complete_ledgers` | String | The range of [ledger versions](ledger-history.html) this peer has available. |
| `complete_shards` | String | _(May be omitted)_ The range of [ledger history shards](history-sharding.html) this peer has available. |
| `ip` | String (IPv4 Address) | _(May be omitted)_ The IP address of this connected peer. Omitted if the peer is configured as a validator or a [private peer](peer-protocol.html#private-peers). [Updated in: rippled v1.2.1][New in: rippled v1.2.1] |
| `port` | String (Number) | _(May be omitted)_ The port number on the peer server that serves RTXP. Typically `51235`. Omitted if the peer is configured as a validator or a [private peer](peer-protocol.html#private-peers). [Updated in: rippled v1.2.1][New in: rippled v1.2.1] |
| `public_key` | String (Base-64 Encoded) | The public key of the ECDSA key pair used by this peer to sign RTXP messages. (This is the same data as the `pubkey_node` reported by the peer server's [server_info method][].) |
| `type` | String | The value `in` or `out`, indicating whether the TCP connection to the peer is incoming or outgoing. |
| `uptime` | Number | The number of seconds the server has been connected to this peer. |
| `version` | String | The `rippled` version number the peer reports to be using. |
@@ -72,10 +74,15 @@ Response:
{% include '_code-samples/peer-crawler/crawl.json' %}
```
***TODO: Update the example for v1.2.1***
## See Also
- [Peer Protocol](peer-protocol.html)
- [Configure the Peer Crawler](configure-the-peer-crawler.html)
- The [XRPL Network Crawler](https://github.com/ripple/rippled-network-crawler) is an example of a tool that uses the peer crawler data to collect and store information about the XRP Ledger network.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

23
content/tutorials/manage-the-rippled-server/configuration/configure-the-peer-crawler.md
View File

@@ -9,8 +9,6 @@ This document contains steps for two options:
## Change the Information Reported by the Peer Crawler
***TODO: figure out how the config relates to validators opting out in v1.2.1***
To configure how much information your server provides in response to peer crawler requests, complete the following steps:
1. Edit your `rippled`'s config file.
@@ -27,26 +25,7 @@ To configure how much information your server provides in response to peer crawl
counts = 0
unl = 1
The settings in this example represent the default values. A setting with a value of `1` means to share that type of information. A value of `0` means not to share that information. The information shared by each option is as follows (the types of data described for each option are a sample, not an exhaustive list):
- **`overlay`** - Information about the peer servers your server is connected to, including:
- Their IP addresses, if they're not [private peers](peer-protocol.html#private-peers).
- The public keys they use for peer-to-peer communications.
- How long your server has been connected to them.
- The [ledger versions](ledger-history.html) they have available.
- **`server`** - Information about your server, including:
- What `rippled` version you are running.
- The [ledger versions](ledger-history.html) your server has available.
- The amount of load your server is experiencing.
- **`counts`** - Information about your server's memory usage, including:
- How large the ledger and transaction databases are
- How many objects of various types are cached in memory. Types of objects include ledgers (`Ledger`), transactions (`STTx`), validation messages (`STValidation`), and more.
- The cache hit rate for the in-application caches.
- **`unl`** - Information about your server's trusted validators, including:
- The URL of the [validator list site(s)](consensus-protections.html#validator-overlap-requirements) your server uses to find validators to trust
- When the validator list your server is using is scheduled to expire.
The names of the config fields match the names of the fields they control in the [peer crawler response](peer-crawler.html#response-format).
The settings in this example represent the default values. A setting with a value of `1` means to share that type of information. A value of `0` means not to share that information. The names of the config fields match the names of the fields they control in the [peer crawler response](peer-crawler.html#response-format).
3. After saving the changes to the config file, restart your `rippled` server to apply the updated configuration:

1
content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.md
View File

@@ -29,6 +29,7 @@ To enable public signing, perform the following steps:
systemctl restart rippled
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}