Add Telemetry and Name to xx chain

If you have downloaded the Node and/or Gateway tarballs before 8/12/2021 or your xx chain service files lack a --telemetry-url flag, then a modification needs to be made to the xx chain service file on both machines to include the name and URL for telemetry.

Add Telemetry Flags to the Node

Follow the instructions below on the Node machine.

1. Open up the xx chain service file.

   $ sudo nano /opt/xxnetwork/xxnetwork-chain.service
   

2. Next, the name used for telemetry of your Node needs to be configured. Use the down key ↓ to navigate to the line that starts with ExecStart and, after the --validator flag, add the flag --name followed by your desired name for the Node. While not required, you may want to make the name unique so you can differentiate your Node from other Nodes and Gateways. If you do not set a name, then a random name will automatically be assigned to your Node.

     GNU nano 4.8
   
   xxnetwork-chain.service
   Modified  
   
   
   ExecStart=/bin/bash -c '/opt/xxnetwork/bin/xxnetwork-chain --validator --name [Node's name]
   Put your selected name for your Node. --base-path /opt/xxnetwork/db --port 15974 --ws-port 63007  >> /opt/xxnetwork/log/chain.log 2>&1'
   
   ^G Get Help
   ^X Exit
   ^O Write Out
   ^R Read File
   ^W Where Is
   ^\ Replace
   ^K Cut Text
   ^U Uncut Text
   ^J Justify
   ^T To Spell
   ^C Cur Pos
   ^_ Go To Line
   

3. After the --name flag, add the flag --telemetry-url "wss://telemetry.polkadot.io/submit/ 0".

     GNU nano 4.8
   
   xxnetwork-chain.service
   Modified  
   
   
   ExecStart=/bin/bash -c '/opt/xxnetwork/bin/xxnetwork-chain --validator --name [Node's name] --telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --base-path /opt/xxnetwork/db --port 15974 --ws-port 63007  >> /opt/xxnetwork/log/chain.log 2>&1'
   
   ^G Get Help
   ^X Exit
   ^O Write Out
   ^R Read File
   ^W Where Is
   ^\ Replace
   ^K Cut Text
   ^U Uncut Text
   ^J Justify
   ^T To Spell
   ^C Cur Pos
   ^_ Go To Line
   

   Note that if your entire line (from /opt/xxnetwork/bin/xxnetwork-chain to 2>&1) starts with double quotes (" ") instead of single quotes (' '), then the telemetry URL should be enclosed with single quotes (--telemetry-url 'wss://telemetry.polkadot.io/submit/ 0').

4. Once the change is made, save the file by pressing Ctrl+X, and when prompted to save the buffer, press Y. Finally, when prompted with the file name, press ↵ Enter.

5. Reload the systemd service files.

   $ sudo systemctl daemon-reexec
   

6. To activate the change, restart the xx chain service.

   $ sudo systemctl restart xxnetwork-chain.service
   

7. Finally, check that xx chain is running properly by tailing the log file.

   $ tail -f /opt/xxnetwork/log/chain.log
   

   It should print an output that looks similar to the followign example.

   2021-08-13 16:16:35 💤 Idle (50 peers), best: #54280 (0x722d…d8d5), finalized #54278 (0xfeba…2796), ⬇ 45.2kiB/s ⬆ 1.8kiB/s
   2021-08-13 16:16:36 ✨ Imported #54281 (0x3ca3…0936)
   2021-08-13 16:16:36 ✨ Imported #54281 (0x75fb…b2bb)
   2021-08-13 16:16:40 💤 Idle (50 peers), best: #54281 (0x3ca3…0936), finalized #54279 (0x9f29…ca70), ⬇ 175.2kiB/s ⬆ 7.5kiB/s
   

Add Telemetry Flags to the Gateway

Follow the instructions below on the Gateway machine.

1. First, stop the xx chain service.

   $ sudo systemctl stop xxnetwork-chain.service
   

2. Open up the xx chain service file.

   $ sudo nano /opt/xxnetwork/xxnetwork-chain.service
   

3. Next, the name used for telemetry of your Gateway needs to be configured. After the flag --light, add the flag --name followed by your desired name for the Gateway. While not required, you may want to make the name unique so you can differentiate your Gateway from other Nodes and Gateways. If you do not set a name, then a random name will automatically be assigned to your Gateway.

     GNU nano 4.8
   
   xxnetwork-chain.service
   Modified  
   
   
   ExecStart=/bin/bash -c '/opt/xxnetwork/bin/xxnetwork-chain --light --name [Gateway's name]
   Put your selected name for your Gateway. --base-path /opt/xxnetwork/db --port 15974 --ws-port 63007  >> /opt/xxnetwork/log/chain.log 2>&1'
   
   
   ^G Get Help
   ^X Exit
   ^O Write Out
   ^R Read File
   ^W Where Is
   ^\ Replace
   ^K Cut Text
   ^U Uncut Text
   ^J Justify
   ^T To Spell
   ^C Cur Pos
   ^_ Go To Line
   

4. After the --name flag, add the flag --telemetry-url "wss://telemetry.polkadot.io/submit/ 0".

     GNU nano 4.8
   
   xxnetwork-chain.service
   Modified  
   
   
   ExecStart=/bin/bash -c '/opt/xxnetwork/bin/xxnetwork-chain --light --name [Gateway's name] --telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --base-path /opt/xxnetwork/db --port 15974 --ws-port 63007  >> /opt/xxnetwork/log/chain.log 2>&1'
   
   ^G Get Help
   ^X Exit
   ^O Write Out
   ^R Read File
   ^W Where Is
   ^\ Replace
   ^K Cut Text
   ^U Uncut Text
   ^J Justify
   ^T To Spell
   ^C Cur Pos
   ^_ Go To Line
   

   Note that if your entire line (from /opt/xxnetwork/bin/xxnetwork-chain to 2>&1) starts with double quotes (" ") instead of single quotes (' '), then the telemetry URL should be enclosed with single quotes (--telemetry-url 'wss://telemetry.polkadot.io/submit/ 0').

5. Once the change is made, save the file by pressing Ctrl+X, and when prompted to save the buffer, press Y. Finally, when prompted with the file name, press ↵ Enter.

6. Reload the systemd service files.

   $ sudo systemctl daemon-reexec
   

7. To activate the change, start the xx chain service.

   $ sudo systemctl start xxnetwork-chain.service
   

8. Finally, check that xx chain is running properly by tailing the log file.

   $ tail -f /opt/xxnetwork/log/chain.log
   

   It should print an output that looks similar to the followign example.

   2021-08-13 16:16:35 💤 Idle (50 peers), best: #54280 (0x722d…d8d5), finalized #54278 (0xfeba…2796), ⬇ 45.2kiB/s ⬆ 1.8kiB/s
   2021-08-13 16:16:36 ✨ Imported #54281 (0x3ca3…0936)
   2021-08-13 16:16:36 ✨ Imported #54281 (0x75fb…b2bb)
   2021-08-13 16:16:40 💤 Idle (50 peers), best: #54281 (0x3ca3…0936), finalized #54279 (0x9f29…ca70), ⬇ 175.2kiB/s ⬆ 7.5kiB/s