Configuring and Deploying Sensor Collector for Telemetry

Create and deploy a Sensor Collector for incoming telemetry from IOS XR or IOS XE routers

1. Use the Provider Connectivity Assurance user interface to create a new Sensor Collector by selecting Sensors ▶ Collectors ▶ Sensor Collector.

Choose the + button on the right to create a new Sensor Collector.

2. Select Gateway in the Type field and then click the Configure Sensor Collector button to proceed.
   

3. Give the Sensor Collector a meaningful name. This must be a unique name compared to all other named Sensor Collectors on the tenant, and it must not contain spaces.

Tip: The best practice is to create a name that includes:

• An indication of the incoming data type
• Name of the server upon which it will be deployed
• Name of the Provider Connectivity Assurance tenant to which it is connected

Example: Using a name format like IOS_XR_<servername_tenantname> makes it easier to locate the Sensor Collector in the inventory later, especially when there are many Sensor Collectors listed.

4. In the Metric configuration field, select telemetry-collector as per the screenshot below.

5. Populate the zone value, using a unique value. The recommended best practice is to use the same value that was used as the Sensor Collector name. For example, in this screenshot, the zone and the name are both identically set to “my-new-sensor-collector”.
   

6. Click the check mark in the top right corner to save.

7. Select your Sensor Collector from the list and click the ellipsis (three dots) in the upper-right corner and choose Download (Docker). This triggers the download to your local machine. This triggers the download to your local machine.
   Note: The package is built dynamically so it requires a few minutes to complete.

The banner at the top shows "preparing file for download... (this may take a minute)" as a reminder that patience is required:

8. Transfer the .tar file to the target machine where the Sensor Collector will run.
9. On the target machine, after you have transferred the .tar file, execute these commands:

mkdir sensorCollectorDir
mv sensorCollectorArchive.tar.gz sensorCollectorDir
cd sensorCollectorDir/
gunzip sensorCollectorArchive.tar.gz 
tar xvf sensorCollectorArchive.tar 

10. If your environment requires a proxy to reach the internet follow those steps: Dealing with Proxies

11. To install and run the permanent Docker service simply run the run.sh script.

./run.sh

12. Once you have executed the run.sh shell script above, you should check that Sensor Collector is running correctly. The instructions for checking are here.

If you are having issues with running the Sensor Collector, information on troubleshooting Sensor Collector can be found here

At this point if things are running correctly, you can proceed to the next section on Telemetry Collector installation.