Reorganise monitoring docs (#1554)

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
Nicolas MASSART 5 years ago committed by GitHub
parent 6ae6963830
commit c3add3eef0
  1. 2
      docs/Configuring-Pantheon/Networking/Configuring-Ports.md
  2. 4
      docs/Monitoring/Alethio/Lite-Block-Explorer.md
  3. 2
      docs/Monitoring/Alethio/Lite-Network-Monitor.md
  4. 0
      docs/Monitoring/Alethio/Overview.md
  5. 0
      docs/Monitoring/Alethio/ethstats.png
  6. 0
      docs/Monitoring/Alethio/explorer.png
  7. 0
      docs/Monitoring/Monitoring-Performances.md
  8. 8
      docs/Reference/Pantheon-CLI-Syntax.md
  9. 12
      mkdocs.yml

@ -30,7 +30,7 @@ options specify the HTTP and WebSockets JSON-RPC ports. The defaults are `8545`
## Metrics ## Metrics
To enable [Prometheus to access Pantheon](../../Using-Pantheon/Monitoring.md#monitor-node-performance-using-prometheus), To enable [Prometheus to access Pantheon](../../Monitoring/Monitoring-Performances.md#monitor-node-performance-using-prometheus),
open the metrics port or metrics push port to Prometheus or the Prometheus push gateway on TCP. open the metrics port or metrics push port to Prometheus or the Prometheus push gateway on TCP.
The [`--metrics-port`](../../Reference/Pantheon-CLI-Syntax.md#metrics-port) and [`--metrics-push-port`](../../Reference/Pantheon-CLI-Syntax.md#metrics-push-port) The [`--metrics-port`](../../Reference/Pantheon-CLI-Syntax.md#metrics-port) and [`--metrics-push-port`](../../Reference/Pantheon-CLI-Syntax.md#metrics-push-port)

@ -25,7 +25,7 @@ data is required.
To run the Ethereum Lite Explorer using the Docker image: To run the Ethereum Lite Explorer using the Docker image:
1. Start Pantheon with the [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option. 1. Start Pantheon with the [`--rpc-http-enabled`](../../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option.
!!! example !!! example
@ -81,7 +81,7 @@ To run the Ethereum Lite Explorer using the Docker image:
* Remove other environment variables. * Remove other environment variables.
1. In another terminal, start Pantheon with the [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option. 1. In another terminal, start Pantheon with the [`--rpc-http-enabled`](../../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option.
!!! example !!! example

@ -81,7 +81,7 @@ Start the EthStats Lite server using in-memory persistence:
cd ethstats-network-server/docker/lite-mode/memory-persistence cd ethstats-network-server/docker/lite-mode/memory-persistence
``` ```
1. Update the `docker-compose.yml` file to your Pantheon [network ID](../Configuring-Pantheon/NetworkID-And-ChainID.md): 1. Update the `docker-compose.yml` file to your Pantheon [network ID](../../Configuring-Pantheon/NetworkID-And-ChainID.md):
```yaml ```yaml
- NETWORK_ID=2018 - NETWORK_ID=2018

Before

Width:  |  Height:  |  Size: 830 KiB

After

Width:  |  Height:  |  Size: 830 KiB

Before

Width:  |  Height:  |  Size: 559 KiB

After

Width:  |  Height:  |  Size: 559 KiB

@ -281,7 +281,7 @@ Comma separated list of categories for which to track metrics. The default is al
metrics-enabled=true metrics-enabled=true
``` ```
Set to `true` to enable the [metrics exporter](../Using-Pantheon/Monitoring.md#monitor-node-performance-using-prometheus). Set to `true` to enable the [metrics exporter](../Monitoring/Monitoring-Performances.md#monitor-node-performance-using-prometheus).
The default is `false`. The default is `false`.
`--metrics-enabled` cannot be specified with `--metrics-push-enabled`. That is, either Prometheus polling or Prometheus `--metrics-enabled` cannot be specified with `--metrics-push-enabled`. That is, either Prometheus polling or Prometheus
@ -301,7 +301,7 @@ push gateway support can be enabled but not both at once.
metrics-host="127.0.0.1" metrics-host="127.0.0.1"
``` ```
Specifies the host on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Using-Pantheon/Monitoring.md#monitor-node-performance-using-prometheus). Specifies the host on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Monitoring/Monitoring-Performances.md#monitor-node-performance-using-prometheus).
The metrics server respects the [`--host-whitelist` option](#host-whitelist). The metrics server respects the [`--host-whitelist` option](#host-whitelist).
The default is `127.0.0.1`. The default is `127.0.0.1`.
@ -320,7 +320,7 @@ The default is `127.0.0.1`.
metrics-port="6174" metrics-port="6174"
``` ```
Specifies the port (TCP) on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Using-Pantheon/Monitoring.md#monitor-node-performance-using-prometheus). Specifies the port (TCP) on which [Prometheus](https://prometheus.io/) accesses [Pantheon metrics](../Monitoring/Monitoring-Performances.md#monitor-node-performance-using-prometheus).
The default is `9545`. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking/Configuring-Ports.md). The default is `9545`. Ports must be [exposed appropriately](../Configuring-Pantheon/Networking/Configuring-Ports.md).
### metrics-push-enabled ### metrics-push-enabled
@ -337,7 +337,7 @@ The default is `9545`. Ports must be [exposed appropriately](../Configuring-Pant
metrics-push-enabled="true" metrics-push-enabled="true"
``` ```
Set to `true` to start the [push gateway integration](../Using-Pantheon/Monitoring.md#running-prometheus-with-pantheon-in-push-mode). Set to `true` to start the [push gateway integration](../Monitoring/Monitoring-Performances.md#running-prometheus-with-pantheon-in-push-mode).
`--metrics-push-enabled` cannot be specified with `--metrics-enabled`. That is, either Prometheus polling or Prometheus `--metrics-push-enabled` cannot be specified with `--metrics-enabled`. That is, either Prometheus polling or Prometheus
push gateway support can be enabled but not both at once. push gateway support can be enabled but not both at once.

@ -117,12 +117,12 @@ nav:
- Accessing Logs Using JSON-RPC API: Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md - Accessing Logs Using JSON-RPC API: Using-Pantheon/Accessing-Logs-Using-JSON-RPC.md
- Using Wallets for Account Management: Using-Pantheon/Account-Management.md - Using Wallets for Account Management: Using-Pantheon/Account-Management.md
- Mining: Using-Pantheon/Mining.md - Mining: Using-Pantheon/Mining.md
- Monitoring Pantheon: Using-Pantheon/Monitoring.md - Monitoring:
- Monitoring Pantheon: - Monitoring Performances: Monitoring/Monitoring-Performances.md
- Alethio: - Monitoring Network:
- Overview: Alethio/Overview.md - Alethio Overview: Monitoring/Alethio/Overview.md
- Ethereum Lite Explorer: Alethio/Lite-Block-Explorer.md - Alethio Ethereum Lite Explorer: Monitoring/Alethio/Lite-Block-Explorer.md
- EthStats Lite Network Monitor: Alethio/Lite-Network-Monitor.md - Alethio EthStats Lite Network Monitor: Monitoring/Alethio/Lite-Network-Monitor.md
- Troubleshooting: - Troubleshooting:
- Troubleshooting: Troubleshooting/Troubleshooting.md - Troubleshooting: Troubleshooting/Troubleshooting.md
- Reference: - Reference:

Loading…
Cancel
Save