framework-azure_application_insights_agent.md

Azure Application Insights Agent Framework

The Azure Application Insights Agent Framework causes an application to be automatically configured to work with a bound Azure Application Insights Service. Note: This framework is disabled by default.

Detection Criterion	Existence of a single bound Azure Application Insights service. Existence of a Azure Application Insights service is defined as the VCAP_SERVICES payload containing a service who's name, label or tag has azure-application-insights as a substring with at least `connection_string` or `instrumentation_key` set as credentials.
Tags	azure-application-insights=<version>

Tags are printed to standard output by the buildpack detect script

User-Provided Service

Users must provide their own Azure Application Insights service. A user-provided Azure Application Insights service must have a name or tag with azure-application-insights in it so that the Azure Application Insights Agent Framework Framework will automatically configure the application to work with the service.

The credential payload of the service has to contain one of the following entries:

Name	Description
connection_string	With agent version 3.x the connection string is required. You can find your connection string in your Application Insights resource.
instrumentation_key	With agent version 2.x the instrumentation key is required. With version 3.x this configuration is deprecated an it is recommended to switch to a connection string. You can find your instrumentation key in your Application Insights resource.

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.