Add validator performance options. (Consensys#263)

* Add CLI option to disable built-in slashing protection for external signers. Signed-off-by: Byron Gravenorst <[email protected]> * Add instructions to connect to mainnet. Signed-off-by: Byron Gravenorst <[email protected]> * updating submodule to latest * Add instructions to connect to mainnet. Signed-off-by: Byron Gravenorst <[email protected]> * Fix markdown issue. Signed-off-by: Byron Gravenorst <[email protected]> * Add validator performance options. Signed-off-by: Byron Gravenorst <[email protected]> * Update docs/Reference/CLI/CLI-Syntax.md Co-authored-by: Adrian Sutton <[email protected]> * Update docs/Reference/CLI/Subcommands/Validator-Client.md Co-authored-by: Adrian Sutton <[email protected]> Co-authored-by: Adrian Sutton <[email protected]>
seroze · Apr 5, 2021 · d8fb38c · d8fb38c
1 parent 3f7aaaf
commit d8fb38c
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md
@@ -1765,6 +1765,39 @@ Locks the keystore files listed in [`--validator-keys`](#validator-keys). Defaul
 Attempts to lock all keystores in a directory if a directory is specified in
 [`--validator-keys`](#validator-keys).
 
+### validators-performance-tracking-mode
+
+=== "Syntax"
+
+    ```bash
+    --validators-performance-tracking-mode=<STRING>
+    ```
+
+=== "Command Line"
+
+    ```bash
+    --validators-performance-tracking-mode=LOGGING
+    ```
+
+=== "Environment Variable"
+
+    ```bash
+    TEKU_VALIDATORS_PERFORMANCE_TRACKING_MODE=LOGGING
+    ```
+
+=== "Configuration File"
+
+    ```bash
+    validators-performance-tracking-mode: LOGGING
+    ```
+
+Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and
+`NONE`. Defaults to `ALL`.
+
+When `LOGGING` is enabled, attestation and block performance is reported as log messages. When
+`METRICS` is enabled, attestation and block performance is reported using [metrics] in the
+[`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category.
+
 ### ws-checkpoint
 
 === "Syntax"
@@ -1815,3 +1848,4 @@ or clear your weak subjectivity settings.
 [load new validators without restarting Teku]: ../../HowTo/Load-Validators-No-Restart.md
 [recent finalized checkpoint state from which to sync]: ../../HowTo/Get-Started/Checkpoint-Start.md
 [Ethereum 2.0 specification]: https://github.com/ethereum/eth2.0-specs/tree/master/configs
+[metrics]: ../../HowTo/Monitor/Metrics.md
diff --git a/docs/Reference/CLI/Subcommands/Validator-Client.md b/docs/Reference/CLI/Subcommands/Validator-Client.md
@@ -785,8 +785,42 @@ Locks the keystore files listed in [`--validator-keys`](#validator-keys). Defaul
 Attempts to lock all keystores in a directory if a directory is specified in
 [`--validator-keys`](#validator-keys).
 
+### validators-performance-tracking-mode
+
+=== "Syntax"
+
+    ```bash
+    --validators-performance-tracking-mode=<STRING>
+    ```
+
+=== "Command Line"
+
+    ```bash
+    --validators-performance-tracking-mode=LOGGING
+    ```
+
+=== "Environment Variable"
+
+    ```bash
+    TEKU_VALIDATORS_PERFORMANCE_TRACKING_MODE=LOGGING
+    ```
+
+=== "Configuration File"
+
+    ```bash
+    validators-performance-tracking-mode: LOGGING
+    ```
+
+Set the validator performance tracking strategy. Valid options are `LOGGING`, `METRICS`, `ALL`, and
+`NONE`. Defaults to `ALL`.
+
+When `LOGGING` is enabled, attestation and block performance is reported as log messages. When
+`METRICS` is enabled, attestation and block performance is reported using [metrics] in the
+[`VALIDATOR_PERFORMANCE`](#metrics-categories) metrics category.
+
 <!-- links -->
 [environment variables or a configuration file]: ../CLI-Syntax.md#specifying-options
 [Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
 [slashing protection]: ../../../Concepts/Slashing-Protection.md
 [recent finalized checkpoint state from which to sync]: ../../../HowTo/Get-Started/Checkpoint-Start.md
+[metrics]: ../../../HowTo/Monitor/Metrics.md