--- title: "Custom Telemetry Ingestion Solution Guide" slug: "telemetry-ingestion-solution-guide" updated: 2026-11-18T17:11:51Z published: 2026-11-18T17:11:51Z canonical: "docs.crossworkassurance.cisco.com/telemetry-ingestion-solution-guide" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.crossworkassurance.cisco.com/llms.txt > Use this file to discover all available pages before exploring further. # Custom Telemetry Ingestion Solution Guide If you require telemetry that is 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. #### Out-of-the-box vs. Custom Telemetry Crosswork Assurance provides default Telemetry Collector configurations for IOS-XE and IOS-XR routers via **MDT Dial Out**. This guide covers customizing the default Telegraf configuration to collect additional sensor paths and metrics. For gNMI Dial In connectivity, the same steps apply, however the Telegraf configuration requires additional modifications. For custom telemetry ingestion engagements, contact your Cisco CX or Partner representative. ## At a Glance 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 your specific needs. ## Prerequisites - The [Ingestion Staging feature](/latest/docs/telemetry-ingestion-staging-feature) must be turned on in Crosswork Assurance. This feature is used in the final step of the procedure. - Access to the Crosswork Assurance UI with permissions to create Telemetry Collector configurations. --- ## Step 1: Create the Default Out-of-the-Box Configuration Follow the configuration instructions in [Configure Telemetry Collector](/latest/docs/configure-telemetry-collector), and choose either **XR** or **XE** based on your router type. --- ## Step 2: Edit the Default Configuration to Collect Sensor Paths/Metrics of Interest ### Download the Default Telegraf Configuration 1. In the Crosswork Assurance UI, navigate to **Sensors > Collectors > Telemetry Collectors**. 2. From the list, select the XE or XR Telemetry Collector that you created in Step 1. A side panel appears. 3. Click the **download icon** to get a local copy of the Telegraf configuration file. ![Download the Telegraf configuration](https://cdn.document360.io/01d1de5e-a375-4fbc-aa82-666ac04c2113/Images/Documentation/image%20(4)(2).png?sv=2026-02-06&spr=https&st=2026-11-19T19%3A38%3A38Z&se=2026-11-19T20%3A38%3A38Z&sr=b&sp=r&sig=RjflClhZfDFLqVCLZ9Efu4vpl8hEVrL0K7VJICDGzmE%3D) ### Edit the Telegraf Configuration Using your preferred editor, edit the Telegraf configuration file to bring in the desired sensor path metrics. > **Note:** 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. This article does not provide instructions on how to write your Telegraf changes. Telegraf is an open source tool and there are ample resources online to assist with this configuration work. Once you have completed your edits, save the Telegraf configuration file. You will upload this file in the next step. --- ## Step 3: Update the Telemetry Collector with Your Custom Telegraf Configuration 1. Navigate to **Sensors > Collectors > Telemetry Collectors**. 2. Select the XE or XR Telemetry Collector that you created from the list. A side panel appears. 3. Select the **Configuration** tab. 4. Change the **Telegraf Configuration** value from the existing XE or XR value to **Custom**. 5. Use the file upload box to upload your new Telegraf configuration file. **Change the Telegraf Configuration to "Custom":** ![Set Telegraf Configuration to Custom](https://cdn.document360.io/01d1de5e-a375-4fbc-aa82-666ac04c2113/Images/Documentation/up.png?sv=2026-02-06&spr=https&st=2026-11-19T19%3A38%3A38Z&se=2026-11-19T20%3A38%3A38Z&sr=b&sp=r&sig=yUPwIX3TjYhqgDpmevahVtuYcJrheAdNjTAV%2BNJBcbw%3D) **Upload your custom TOML file:** ![Upload custom Telegraf configuration](https://cdn.document360.io/01d1de5e-a375-4fbc-aa82-666ac04c2113/Images/Documentation/Screenshot%202026-05-28%20at%203.15.50%E2%80%AFPM.png?sv=2026-02-06&spr=https&st=2026-11-19T19%3A38%3A38Z&se=2026-11-19T20%3A38%3A38Z&sr=b&sp=r&sig=u4BX6GQ93ItEdZ%2BSZxowdTT5it5qQLSEFMBT0K7Z2II%3D) After saving, the platform confirms the new configuration is applied. ![Configuration applied confirmation](https://cdn.document360.io/01d1de5e-a375-4fbc-aa82-666ac04c2113/Images/Documentation/Screenshot%202026-05-28%20at%203.45.58%E2%80%AFPM.png?sv=2026-02-06&spr=https&st=2026-11-19T19%3A38%3A38Z&se=2026-11-19T20%3A38%3A38Z&sr=b&sp=r&sig=VyxJb1y9n%2BUSUMzavmRZ9Hf2PJJrDGEJvymVJeheTyA%3D) --- ## Step 4: Deploy and Verify Deploy the Telemetry Collector and a Sensor Collector to start data flow to Crosswork Assurance. For deployment instructions, see: - **Docker:** [Deploy Telemetry Collector in Docker](/latest/docs/deploying-telemetry-collector-in-docker) - **Kubernetes:** [Deploy Telemetry Collector in Kubernetes](/latest/docs/deploying-telemetry-collector-in-kubernetes) ## Step 5: Curate Incoming Telemetry Use the [Ingestion Staging feature](/latest/docs/telemetry-ingestion-staging-feature) to edit and curate the incoming telemetry to meet your specific needs. See [Advanced Topic: Ingestion Specification Custom Metrics](/latest/docs/advanced-topic-ingestion-specification-custom-metrics) for details on configuring ingestion specifications. **© 2026 Cisco and/or its affiliates. All rights reserved.** For more information about trademarks, please visit: [Cisco trademarks](https://www.cisco.com/c/en/us/about/legal/trademarks.html)[](https://www.cisco.com/c/en/us/about/legal/trademarks.html) For more information about legal terms, please visit: [Cisco legal terms](https://www.cisco.com/c/en/us/about/legal/terms-conditions.html)