How do I migrate from using an Instrumentation Key to a Connection String in Application Insights for a Java Spring Boot application using an ARM template (template.json)?

Hi Devarakonda Amani (SEBT),

Hey there! It sounds like you're looking to migrate from using the Instrumentation Key to the Connection String for Application Insights in your Java Spring Boot application, and you want to do this using an ARM template. Here’s a step-by-step guide on how to do this:

Updating the ARM Template

1). Modify the Template: Update your template.json to include the connection string as follows:

{
  "properties": {
    "appInsightsConfiguration": {
      "connectionString": "<YOUR_APP_INSIGHTS_CONNECTION_STRING>"
    },
    ...
  }
}

Make sure to replace <YOUR_APP_INSIGHTS_CONNECTION_STRING> with the actual connection string from your Application Insights resource.

2). Deployment: Deploy your ARM template using Azure CLI or your preferred method. This will ensure that your Application Insights resource is configured to use the connection string.

Referencing the Connection String in Spring Boot

You can set the connection string in your Spring Boot application via properties or environment variables:

1). application.properties or application.yml: Add the following line to your application.properties or application.yml file:

applicationinsights.connection.string=<YOUR_APP_INSIGHTS_CONNECTION_STRING>

OR

applicationinsights:
  connection:
    string: <YOUR_APP_INSIGHTS_CONNECTION_STRING>

2). Environment Variable: Alternatively, set the following environment variable for your deployment:

export APPLICATIONINSIGHTS_CONNECTION_STRING="<YOUR_APP_INSIGHTS_CONNECTION_STRING>"

This takes precedence over the configuration file.

Code Changes

In many cases, you won't need to change your application code if you simply switch the way you provide the connection string. However, if you're setting up the connection string programmatically or wish to validate the configuration, ensure you reference the setting correctly.

Best Practices and Pitfalls

• Testing: After the migration, test your application to make sure telemetry is being sent correctly to the Application Insights resource.
• Monitor for Issues: Watch for any exceptions or issues in your logs related to telemetry sent to Application Insights.
• Environment-specific Configurations: If deploying to different environments (dev, test, production), ensure that each environment has the correct connection string set, either programmatically or through environment variables.

Please accept as "Yes" if the answer provided is useful, so that you can help others in the community looking for remediation for similar issues.

If you have any further questions or need clarification on any specific part, feel free to ask!