{"id":2250,"date":"2019-02-20T04:18:18","date_gmt":"2019-02-19T20:18:18","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/iotdev\/?p=2250"},"modified":"2019-02-23T01:58:40","modified_gmt":"2019-02-22T17:58:40","slug":"diagnose-issues-with-distributed-tracing-for-azure-iot-hub-preview-in-visual-studio-code","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/iotdev\/diagnose-issues-with-distributed-tracing-for-azure-iot-hub-preview-in-visual-studio-code\/","title":{"rendered":"Diagnose issues with Distributed Tracing for Azure IoT Hub (preview) in Visual Studio Code\u00a0"},"content":{"rendered":"

Effective monitoring is instrumental in understanding and troubleshooting your modern cloud solution leveraging multiple services. Distributed tracing<\/a> helps you diagnose issues in your cloud solution by providing the capability to track the flow of a call and the associated latency across these different services.<\/p>\n

Today, we announced the public preview of\u00a0distributed tracing<\/a>\u00a0support in Azure IoT Hub<\/a>. You can leverage the IoT Hub logs with\u00a0distributed tracing<\/a> information to monitor the flow of messages through the IoT Hub and troubleshoot problems related to message loss or performance. You can further aggregate these logs to archive them in Blob storage, query the logs through Log Analytics and visualize the data flow in AppInsights as shown below.<\/p>\n

\"\"\"\"<\/p>\n

You can now use VS code to enable diagnostics on a subset of your devices and choose the frequency of logging by setting a sampling rate of diagnostic logs per device\u00a0depending on your business needs. This post provides an outline to configure distributed tracing settings using VS Code. Try it today and let us know what you think.<\/p>\n

Before you begin<\/b><\/p>\n

Please take the following steps to ensure that you are ready to leverage distributed tracing.<\/p>\n

    \n
  1. Ensure that you have the\u00a0Azure IoT\u00a0Hub\u00a0Toolkit\u00a0v2.x.x extension in VSCode. You can install the\u00a0Azure IoT Tools<\/a>\u00a0to get this extension.<\/li>\n
  2. Ensure that your devices have the latest device C SDK<\/a> and have the code updated to understand the distributed tracing settings. You can leverage the sample client application<\/a> code to make changes to your device SDK.<\/li>\n<\/ol>\n

     <\/p>\n

    Configure device to send diagnostic information<\/b><\/p>\n

    After\u00a0setting up your devices with updated C SDK, now you can control distributed tracing from Visual Studio Code with the Azure IoT Tools<\/a> extension in VS Code.<\/p>\n

      \n
    1. Expand \u201cAZURE IOT HUB DEVICES\u201d section inside Explorer, and follow the instructions to connect to your Azure IoT Hub.\n\"\"\"\"<\/li>\n
    2. Create a device or expand an existing device, you can see there is a child node named \u201cDistributed Tracing Setting (Preview)\u201d\n<\/span>\"\"<\/span><\/li>\n
    3. Right click it and select \u201cUpdate Distributed Tracing Setting (Preview)\u201d\n\"\"<\/li>\n
    4. Now you can enable\/disable distributed tracing and set the sampling rate<\/li>\n
    5. After setting, you can expand \u201cDistributed Tracing Setting (Preview)\u201d node to see if desired property is set successfully:\n\"\"<\/li>\n
    6. If your device is connected to IoT Hub, you can monitor reported properties. Once this section is updated, it means your device gets and respects the distributed tracing setting you just set.\u00a0You can also right click\u00a0\u201cEnable Distributed Tracing\u201d and \u201cSampling Rate\u201d nodes under \u201cDesired\u201d to set them separately.\n\"\"<\/li>\n<\/ol>\n

       <\/p>\n

      Accessing the logs<\/b><\/p>\n

      Once you have enabled distributed tracing on your devices, you can use the Azure portal to archive your logs to Azure storage, query in Log Analytics or visualize in\u00a0AppMap. More information about distributed tracing and ways to capture and analyze the logs can be found in our documentation<\/a>.<\/p>\n

      You can use\u00a0this sample<\/a>\u00a0to get started on\u00a0how you can configure and access the logs (and visualize the data) using AppInsights.<\/span><\/p>\n

      More useful resources on Azure IoT Hub<\/strong><\/p>\n