Why do I need both APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING in my Azure Function configuration?

Question

APPINSIGHTS_INSTRUMENTATIONKEY contains the instrumentation key for Application Insights.

APPLICATIONINSIGHTS_CONNECTION_STRING contains the instrumentation key for Application Insights prefixed with InstrumentationKey=.

That seems pointless unless each value enables certain features with Application Insights.

score 25 · Accepted Answer · answered Mar 15 '20 at 09:53

25

Looking at the release notes for SDK Version 2.0.12998:

App Insights configuration will use the APPLICATIONINSIGHTS_CONNECTION_STRING app setting if it is set (APPINSIGHTS_INSTRUMENTATIONKEY is the fallback and continues to work as-is).

Furthermore, if you read the documentation for App Insights Connection String, you will notice that when you use connection string, you can specify custom endpoints. This is not possible if you just specify the instrumentation key. In that case, SDK will connect to default endpoints.

answered Mar 15 '20 at 09:53

Gaurav Mantri

128,066
12
206
241

Thank you. That is great news. I was confused because when reading this article, it tells me to add both of them. So that is just wrong? https://learn.microsoft.com/en-us/azure/azure-monitor/app/azure-web-apps?tabs=net#troubleshooting – Niels Brinch Mar 15 '20 at 10:01
1

Honestly, I don't know. Out of curiosity I researched for this question and provided the answer :). Two things: 1) I noticed that the document you referenced is older than the release notes I linked in my answer. So it is quite possible that they forgot to update the document and 2) If you scroll all the way to the bottom of the documentation link you shared, you'll see that you can open up a Github issue for this documentation page. I would recommend doing that so that if the documentation is incorrect, Microsoft will get it corrected. – Gaurav Mantri Mar 15 '20 at 10:07
Thank you. It says in GitHub that they prefer feedback directly on the article so I have done that instead. Thanks a lot. – Niels Brinch Mar 15 '20 at 10:14
2

Note the connection strings docs page linked in the answer now says (at the top): "Important: We don't recommend setting both Connection String and Instrumentation key. In the event that a user does set both, whichever was set last will take precedence." – Matt Johnson-Pint May 13 '20 at 18:27

score 6 · Answer 2 · answered Jun 15 '20 at 13:48

6

One important thing to note is that if APPINSIGHTS_INSTRUMENTATIONKEY is removed from the Azure Function's configuration, the "Logs" entry in the "Monitoring" section in the Azure portal does not show logs anymore and instead asks you again to connect to an Application Insights resource. If you do so, the portal recreates the APPINSIGHTS_INSTRUMENTATIONKEY config setting.

This seems like a bug in the Azure portal since metrics and logs do continue to be collected. Also, funny enough "Log stream" continues to work as well.

answered Jun 15 '20 at 13:48

Björn Jarisch

311
4
8

AFAIK Log stream doesn't use AppInsights. – Monsignor Sep 24 '20 at 10:53
It is using both now. The source can be selected from the drop-down menu. – jikuja Dec 03 '20 at 17:08

score 2 · Answer 3 · answered Mar 06 '23 at 09:19

APPINSIGHTS_INSTRUMENTATIONKEY is deprecated:

On March 31, 2025, support for instrumentation key ingestion will end. Instrumentation key ingestion will continue to work, but we'll no longer provide updates or support for the feature. Transition to connection strings to take advantage of new capabilities.

And if you use APPINSIGHTS_INSTRUMENTATIONKEY you should migrate to APPLICATIONINSIGHTS_CONNECTION_STRING.

This means that we need just APPLICATIONINSIGHTS_CONNECTION_STRING.

Why do I need both APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING in my Azure Function configuration?

3 Answers3