Use Application Insights Java In-Process Agent in Azure Spring Apps

Enable the Java In-Process Agent by using the following procedure.

1. Go to the service | Overview page of your service instance and then select Application Insights in the Monitoring section.

2. Select Enable Application Insights to enable Application Insights in Azure Spring Apps.

3. Select an existing instance of Application Insights or create a new one.

4. When Application Insights is enabled, you can configure one optional sampling rate (default 10.0%).

   

5. Select Save to save the change.

You can use the Portal to check or update the current settings in Application Insights.

Enable Application Insights using the Azure portal

1. Select Application Insights.

2. Enable Application Insights by selecting Edit binding, or the Unbound hyperlink.

   

3. Edit Application Insights or Sampling rate, then select Save.

Disable Application Insights

1. Select Application Insights.

2. Select Unbind binding to disable Application Insights.

   

Change Application Insights Settings

Select the name under the Application Insights column to open the Application Insights section.

Edit Application Insights buildpack bindings in Build Service

To check and update the current settings for the Application Insights buildpack bindings in Build Service, follow these steps:

1. Select Build Service.
2. Choose your builder.
3. Select Edit under the Bindings column.

Application Insights settings are found in the ApplicationInsights item listed under the Binding type column.

1. Select the Bound hyperlink, or select Edit Binding under the ellipse, to open and edit the Application Insights buildpack bindings.

   

2. Edit the binding settings, then select Save.

   

az spring create \
    --resource-group <resource-group-name> \
    --name "service-instance-name" \
    --app-insights <name-or-resource-ID> \
    --sampling-rate <sampling-rate>

az spring create \
    --resource-group <resource-group-name> \
    --name "service-instance-name" \
    --app-insights <name-or-resource-ID> \
    --sampling-rate <sampling-rate> \
    --sku Enterprise

az spring create \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --app-insights-key <connection-string-or-instrumentation-key> \
    --sampling-rate <sampling-rate>

az spring create \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --app-insights-key <connection-string-or-instrumentation-key> \
    --sampling-rate <sampling-rate> \
    --sku Enterprise

az spring create \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --disable-app-insights

az spring create \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --disable-app-insights \
    --sku Enterprise

Check Application Insights settings

To check the Application Insights settings of an existing Azure Spring Apps instance, use the following command:

az spring app-insights show \
    --resource-group <resource-group-name> \
    --name <service-instance-name>

Update Application Insights

To update Application Insights to use a connection string (preferred) or instrumentation key, use the following command:

az spring app-insights update \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --app-insights-key <connection-string-or-instrumentation-key> \
    --sampling-rate <sampling-rate>

To update Application Insights to use the resource name or ID, use the following command:

az spring app-insights update \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --app-insights <name-or-resource-ID> \
    --sampling-rate <sampling-rate>

Disable Application Insights with the update command

To disable Application Insights on an existing Azure Spring Apps instance, use the following command:

az spring app-insights update \
    --resource-group <resource-group-name> \
    --name <service-instance-name> \
    --disable

Manage Application Insights buildpack bindings

This section applies to the Enterprise plan only, and provides instructions that supplement the previous section.

The Azure Spring Apps Enterprise plan uses buildpack bindings to integrate Azure Application Insights with the type ApplicationInsights. For more information, see How to configure APM integration and CA certificates.

To create an Application Insights buildpack binding, use the following command:

az spring build-service builder buildpack-binding create \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-binding-name> \
    --builder-name <your-builder-name> \
    --type ApplicationInsights \
    --properties sampling-percentage=<your-sampling-percentage> \
                 connection-string=<your-connection-string>

To list all buildpack bindings, and find Application Insights bindings the type ApplicationInsights, use the following command:

az spring build-service builder buildpack-binding list \
    --resource-group <your-resource-group-name> \
    --service <your-service-resource-name> \
    --builder-name <your-builder-name>

To replace an Application Insights buildpack binding, use the following command:

az spring build-service builder buildpack-binding set \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-binding-name> \
    --builder-name <your-builder-name> \
    --type ApplicationInsights \
    --properties sampling-percentage=<your-sampling-percentage> \
                 connection-string=<your-connection-string>

To get an Application Insights buildpack binding, use the following command:

az spring build-service builder buildpack-binding show \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-binding-name> \
    --builder-name <your-builder-name>

To delete an Application Insights buildpack binding, use the following command:

az spring build-service builder buildpack-binding delete \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-binding-name> \
    --builder-name <your-builder-name>

The following sections describe how to automate your deployment using Bicep, Azure Resource Manager templates (ARM templates) or Terraform.

Bicep

To deploy using a Bicep file, copy the following content into a main.bicep file. For more information, see Microsoft.AppPlatform Spring/monitoringSettings.

param springName string
param location string = resourceGroup().location

resource spring 'Microsoft.AppPlatform/Spring@2020-07-01' = {
  name: springName
  location: location
  properties: {}
}

resource monitorSetting 'Microsoft.AppPlatform/Spring/monitoringSettings@2020-11-01-preview' = {
  parent: spring
  name: 'default'
  properties: {
    appInsightsInstrumentationKey: '00000000-0000-0000-0000-000000000000'
    appInsightsSamplingRate: 88
  }
}

ARM templates

To deploy using an ARM template, copy the following content into an azuredeploy.json file. For more information, see Microsoft.AppPlatform Spring/monitoringSettings.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "springName": {
      "type": "string"
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": [
    {
      "type": "Microsoft.AppPlatform/Spring",
      "apiVersion": "2020-07-01",
      "name": "[parameters('springName')]",
      "location": "[parameters('location')]",
      "properties": {}
    },
    {
      "type": "Microsoft.AppPlatform/Spring/monitoringSettings",
      "apiVersion": "2020-11-01-preview",
      "name": "[format('{0}/{1}', parameters('springName'), 'default')]",
      "properties": {
        "appInsightsInstrumentationKey": "00000000-0000-0000-0000-000000000000",
        "appInsightsSamplingRate": 88
      },
      "dependsOn": [
        "[resourceId('Microsoft.AppPlatform/Spring', parameters('springName'))]"
      ]
    }
  ]
}

Terraform

For a Terraform deployment, use the following template. For more information, see azurerm_spring_cloud_service.

provider "azurerm" {
  features {}
}

resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West Europe"
}

resource "azurerm_application_insights" "example" {
  name                = "tf-test-appinsights"
  location            = azurerm_resource_group.example.location
  resource_group_name = azurerm_resource_group.example.name
  application_type    = "web"
}

resource "azurerm_spring_cloud_service" "example" {
  name                = "example-springcloud"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
  sku_name            = "S0"

  config_server_git_setting {
    uri          = "https://github.com/Azure-Samples/piggymetrics"
    label        = "config"
    search_paths = ["dir1", "dir2"]
  }

  trace {
    connection_string = azurerm_application_insights.example.connection_string
    sample_rate       = 10.0
  }

  tags = {
    Env = "staging"
  }
}

Automation in the Enterprise plan is pending support. Documentation is added as soon as it's available.

The Java agent is updated/upgraded regularly with the JDK, which may affect the following scenarios.

• Existing applications that use the Java agent before updating/upgrading aren't affected.
• Applications created after updating/upgrading use the new version of the Java agent.
• Existing applications that didn't previously use the Java agent require restart or redeployment to use the new version of the Java agent.

The Java agent is updated/upgraded when the buildpack is updated.

Java agent configuration hot-loading

Azure Spring Apps has a hot-loading mechanism to adjust the settings of agent configuration without restart of applications.

• If the Java agent is already enabled, changes to the Application Insights instance or SamplingRate value don't require application restart.

• If you enable the Java agent, then you must restart applications.

• When you disable the Java agent, applications stop sending all monitoring data after a delay in minutes. You can restart applications to remove the agent from the Java runtime environment.