Create Application Insights

This step allows you to create an Azure Application Insights service. It allows you to monitor any running APIs or streaming Spark jobs running on Databricks.

Deployment

Add the following task to deployment.yaml

field	description	values
`task`	`"create_application_insights"`
`credentials` [optional]	The source of the credentials to use.	Defaults to `azure_keyvault`. One of: `azure_keyvault`
`credentials_type` [optional]	The type of the credentials to use.	Defaults to `active_directory_user`. One of: `service_principal`, `active_directory_user`
`kind` [optional]	Used to customize the UI	One of `web`, `ios`, `other`, `store`, `java`, `phone`
`application_type` [optional]	Type of application being monitored	One of `web`, `other`
`create_databricks_secret` [optional]	Postfix for the image name, will be added before the tag	One of `true`, `false`

Takeoff config

Takeoff supports 2 authentication types. You can choose either:

Service Principal
Active Directory User These credentials must be available in your Azure Keyvault, and the correct mapping with the secret names should be available in your config.yaml. If create_databricks_secret := true credentials for Databricks (host, token) must also be available in your cloud vault.

Currently Takeoff only supports Azure Keyvault as the source for credentials for use with `create_application_insights`

The default is to use a Active Directory User. For a service principal, ensure the following keyvault_keys are defined in your config.yaml:

azure:
  keyvault_keys:
    service_principal:
      client_id: "sp-client-id"
      secret: "sp-secret"
      tenant: "azure-tenant"

To use a service principal, you can add the following into your deployment.yaml:

- task: create_application_insights
  credentials: azure_keyvault
  credentials_type: service_principal

If you prefer to use an Active Directory User, please ensure the following keyvault_keys are defined:

azure:
  keyvault_keys:
    active_directory_user:
      username: "aad-username"
      password: "aad-password"

To use a service principal, you can add the following into your deployment.yaml:

- task: create_application_insights
  credentials: azure_keyvault
  credentials_type: active_directory_user

Examples

Assume an application name myapp and version 1.2.0. The resouce_group_naming parameter is rg{env}, where releases go to env =: prd

Minimum configuration example. This constructs an Application Insights service in the rgprd resource group with the name myapp.

steps:
  - task: create_application_insights

Full configuration example. This constructs an Application Insights service in the rgprd resource group with the name myapp with the UI tailored to Java applications, it also creates a Databricks secret under the scope myapp with name instrumentation-key.

steps:
  - task: create_application_insights
    kind: java
    application_type: other
    create_databricks_secret: true 