Config: Add TELEMETRY_URL support for telemetry configuration (algora…

…nd#6237)
mikeyhodl · Feb 18, 2025 · 78b1200 · 78b1200
1 parent 548b26a
commit 78b1200
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/docker/README.md b/docker/README.md
@@ -34,21 +34,22 @@ The following config.json overrides are applied:
 
 The following environment variables can be supplied. Except when noted, it is possible to reconfigure deployments even after the data directory has been initialized.
 
-| Variable | Description |
-| -------- | ----------- |
+| Variable        | Description                                                                                                                                         |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
 | NETWORK         | Leave blank for a private network, otherwise specify one of mainnet, betanet, testnet, or devnet. Only used during a data directory initialization. |
-| PROFILE         | If set, initializes the config.json file according to the given profile. |
+| PROFILE         | If set, initializes the config.json file according to the given profile.                                                                            |
 | DEV_MODE        | If set to 1 on a private network, enable dev mode. Only used during data directory initialization.                                                  |
 | START_KMD       | When set to 1, start kmd service with no timeout. THIS SHOULD NOT BE USED IN PRODUCTION.                                                            |
 | FAST_CATCHUP    | If set to 1 on a public network, attempt to start fast-catchup during initial config.                                                               |
 | TOKEN           | If set, overrides the REST API token.                                                                                                               |
 | ADMIN_TOKEN     | If set, overrides the REST API admin token.                                                                                                         |
 | KMD_TOKEN       | If set along with `START_KMD`, override the KMD REST API token.                                                                                     |
 | TELEMETRY_NAME  | If set on a public network, telemetry is reported with this name.                                                                                   |
+| TELEMETRY_URL   | The URL to send telemetry to if enabled (TELEMETRY_NAME is also required).  Defaults to sending to Algorand.                                        |
 | NUM_ROUNDS      | If set on a private network, override default of 30000 participation keys.                                                                          |
-| GENESIS_ADDRESS | If set, use this API address to initialize the genesis file. |
+| GENESIS_ADDRESS | If set, use this API address to initialize the genesis file.                                                                                        |
 | PEER_ADDRESS    | If set, override phonebook with peer ip:port (or semicolon separated list: ip:port;ip:port;ip:port...)                                              |
-| GOSSIP_PORT     | If set, configure the node to listen for external connections on this address. For example "4161" |
+| GOSSIP_PORT     | If set, configure the node to listen for external connections on this address. For example "4161"                                                   |
 
 ### Special Files
 

diff --git a/docker/files/run/run.sh b/docker/files/run/run.sh
@@ -95,6 +95,9 @@ function configure_data_dir() {
   # configure telemetry
   if [ "$TELEMETRY_NAME" != "" ]; then
     diagcfg telemetry name -n "$TELEMETRY_NAME" -d "$ALGORAND_DATA"
+    if [ "$TELEMETRY_URL" != "" ]; then
+      diagcfg telemetry endpoint -e "$TELEMETRY_URL" -d "$ALGORAND_DATA"
+    fi
     diagcfg telemetry enable -d "$ALGORAND_DATA"
   elif ! [ -f "/etc/algorand/logging.config" ]; then
     diagcfg telemetry disable
@@ -213,6 +216,7 @@ echo "   TOKEN:           ${TOKEN:-"Not Set"}"
 echo "   ADMIN_TOKEN:     ${ADMIN_TOKEN:-"Not Set"}"
 echo "   KMD_TOKEN:       ${KMD_TOKEN:-"Not Set"}"
 echo "   TELEMETRY_NAME:  $TELEMETRY_NAME"
+echo "   TELEMETRY_URL:   $TELEMETRY_URL"
 echo "   NUM_ROUNDS:      $NUM_ROUNDS"
 echo "   GENESIS_ADDRESS: $GENESIS_ADDRESS"
 echo "   PEER_ADDRESS:    $PEER_ADDRESS"