diff --git a/docs/cli-tools.md b/docs/cli-tools.md index f3fd272..9ca4650 100644 --- a/docs/cli-tools.md +++ b/docs/cli-tools.md @@ -93,3 +93,25 @@ The `get-node-status` command performs checks using: - `goal node status` to connect to the running daemon and retrieve basic node information - `/health`: This API endpoint checks the reported health of the node. [REST API /health documentation](https://developer.algorand.org/docs/rest-apis/algod/#get-health). - `/ready`: This API endpoint checks the reported readiness of the node and if fully caught up. [REST API /ready documentation](https://developer.algorand.org/docs/rest-apis/algod/#get-ready). + +### Set Telemetry Name and GUID + +To set telemetry name or to opt-out, execute the following command: + +```bash +~/voi/bin/set-telemetry-name +``` + +To set telemetry name and GUID, execute the following command: + +```bash +~/voi/bin/set-telemetry-name +``` + +### Get Telemetry Status + +To get status of your telemetry including enablement, name, and GUID, execute the following command: + +```bash +~/voi/bin/get-telemetry-status +``` diff --git a/docs/updating/telemetry.md b/docs/updating/telemetry.md index cee2450..d25d9c7 100644 --- a/docs/updating/telemetry.md +++ b/docs/updating/telemetry.md @@ -7,3 +7,11 @@ To update your telemetry name after installation, or to opt-out, you can run the ```bash ~/voi/bin/set-telemetry-name ``` + +## Getting Your Telemetry status + +To get your telemetry status, including enablement/name/GUID, you can run the following command: + +```bash +~/voi/bin/get-telemetry-status +```