Share via

Application Insights keys

  • Article

APPLIES TO: SDK v3

Azure Application Insights displays data about your application in a Microsoft Azure resource. To add telemetry to your bot you need an Azure subscription and an Application Insights resource created for your bot. From this resource, you can obtain the three keys to configure your bot:

  1. Instrumentation key
  2. Application ID
  3. API key

This topic will show you how to create these Application Insights keys.

Note

During the bot creation or registration process, you were given the option to turn Application Insights On or Off. If you had turned it On then your bot already has all the necessary Application Insights keys it needs. However, if you had turned it Off then you can follow the instructions in this topic to help you manually create these keys.

Instrumentation key

To get the Instrumentation key, do the following:

  1. From the Azure portal, under the Monitor section, create a new Application Insights resource (or use an existing one). Portal screen capture of Application Insights listing

  2. From the list of Application Insights resources, click the Application Insight resource you just created.

  3. Click Overview.

  4. Expand the Essentials block and find the Instrumentation Key. Portal screen capture of Overview Portal screen capture of the Instrumentation key

  5. Copy the Instrumentation Key and paste it to the Application Insights Instrumentation Key field of your bot's settings.

Application ID

To get the Application ID, do the following:

  1. From your Application Insights resource, click API Access.

  2. Copy the Application ID and paste it to the Application Insights Application ID field of your bot's settings. Portal screen capture of the Application ID

API key

To get the API key, do the following:

  1. From the Application Insights resource, click API Access.

  2. Click Create API Key.

  3. Enter a short description, check the Read telementry option, and click the Generate key button. Portal screen capture of the Application ID and API Key

    Warning

    Copy this API key and save it because this key will never be shown to you again. If you lose this key, you have to create a new one.

  4. Copy the API key to the Application Insights API key field of your bot's settings.

Additional resources

For more information on how to connect these fields into your bot's settings, see Enable analytics.