Skip to content

Commit

Permalink
Add telemetry status to telemetry docs + CLI tools
Browse files Browse the repository at this point in the history
  • Loading branch information
hsoerensen committed Feb 3, 2024
1 parent c0fc3a5 commit 8b053fd
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/cli-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <telemetry_name> <telemetry_guid>
```

### Get Telemetry Status

To get status of your telemetry including enablement, name, and GUID, execute the following command:

```bash
~/voi/bin/get-telemetry-status
```
8 changes: 8 additions & 0 deletions docs/updating/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 8b053fd

Please sign in to comment.