Advanced Topic: Adding Sensor Paths to the Default Offering

If you require additional sensor paths/metrics from IOS XE and IOS XR routers that are not included in the default out-of-the-box Crosswork Assurance offering, this article outlines the steps to build a custom Telemetry Collector for your use case.

At a glance, the procedure is as follows:

1. Create a default Telemetry Collector for your router (to use as a starting point).
2. Edit the default configuration to collect the sensor paths/metrics of interest.
3. Update the Telemetry Collector with your updated Telegraf configuration.
4. Deploy the Telemetry Collector and a Sensor Collector to start data flow to Crosswork Assurance.
5. Leverage the Ingestion Staging feature to edit and curate the incoming telemetry to meet the customer's specific needs.

Below are the step-by-step instructions for routers that are configured for MDT Dial out. For gNMI Dial In connectivity, the instructions still apply, however, the Telegraf configuration will require additional modifications.

Pre-requisite

Make sure that the Ingestion Staging feature is turned on in Crosswork Assurance before proceeding. This feature is used in the final step of the procedure.

Step 1: Create the Default Out-of-the-Box Configuration

Follow the configuration instructions in this article, and choose either XR or XE based on your router type.

Step 2: Edit the Default Out-of-the-Box Configuration to Collect Sensor Paths/Metrics of Interest

Download the Default Telegraf Configuration

Navigate to Sensors -> Collectors -> Telemetry Collectors. From the list, select the XE or XR Telemetry Collector that you just created in the previous step. A side panel appears. Click on the download icon to get a local copy of the Telegraf configuration file, as shown below:

Edit the Telegraf Configuration

Using your preferred editor, edit the Telegraf configuration file to bring in the desired sensor path metrics. Note that the default Telegraf configuration works for MDT Dial Out. If you require gNMI Dial In, the Telegraf configuration must be updated to establish that connectivity.

Once you have completed your edits, save the Telegraf configuration file. You will upload this configuration file in the next step to configure a custom telemetry collector.

Step 3: Update the Telemetry Collector with Your Custom Telegraf Configuration

Navigate to Sensors -> Collectors -> Telemetry Collectors, select the XE or XR Telemetry Collector that you just created from the list. A side panel appears. Select the Configuration tab. Change the value of the Telegraf Configuration from the existing XE or XR value to "custom", and use the file upload box to upload your new Telegraf configuration file.

Change the Telegraf Configuration to "Custom":

File upload:

After saving, the platform confirms the new configuration is applied.

Step 4: Configure and Deploy Telemetry Collector and Sensor Collector

Telemetry Collector

Deploy the Telemetry Collector that you just created. Deployment instructions are found in these articles:

• Deploying Telemetry Collector in Kubernetes
• Deploying Telemetry Collector in Docker

Sensor Collector

You will also require a Sensor Collector, configuration instructions are found in this article.

Deployment instructions are found in these articles:

• Deploying Telemetry Collector in Kubernetes
• Deploying Telemetry Collector in Docker

Step 5: Edit the Object type in the Ingestion Staging Feature

Now that new metrics are flowing from the router to Crosswork Assurance, the final step is to associate the new incoming metrics with the existing object type.

• Navigate to Ingestion -> Object Types.
• Select the IOS XE or IOS XR object type against which you have added new metrics.
• The new incoming metrics will appear as "unmapped" (shown below).
• Click on the unmapped metric and drag up to the top of the column Metrics section to automatically map it to the existing object type.
• Change any metrics attributes (naming/units/direction) in the middle Normalized Data column and click Publish.
  

Enable Data Flow

• Navigate to Ingestion -> Metrics, scroll to the Cisco category and choose your object type (For example, "IOS XR Environment").
• The new metrics appear in the list, but data will not flow in to Crosswork Assurance until you toggle on the metric in this screen:
  

That completes the process. Additional Sensor Path metrics are now flowing in to Crosswork Assurance.

Related Articles: Configure the Router to Stream to the Telemetry Collector

Refer to IOS XR - Stream Telemetry via gNMI Dial Out to set up an XR router to stream telemetry to the Telemetry Collector (and ultimately through to Crosswork Assurance).

Refer to IOS XE - Stream Telemetry via MDT Dial Out to set up an XE router to stream telemetry to the Telemetry Collector (and ultimately through to Crosswork Assurance).