Azure Monitor Container Insights for Azure Arc-enabled Kubernetes clusters

Azure Monitor Container Insights provides rich monitoring experience for Azure Arc-enabled Kubernetes clusters.

Supported configurations

  • Azure Monitor Container Insights supports monitoring Azure Arc-enabled Kubernetes as described in the Overview article, except the live data feature. Also, users aren't required to have Owner permissions to enable metrics
  • Docker, Moby, and CRI compatible container runtimes such CRI-O and containerd.
  • Outbound proxy without authentication and outbound proxy with basic authentication are supported. Outbound proxy that expects trusted certificates is currently not supported.

Note

If you are migrating from Container Insights on Azure Red Hat OpenShift v4.x, please also ensure that you have disabled monitoring before proceeding with configuring Container Insights on Azure Arc enabled Kubernetes to prevent any installation issues.

Prerequisites

  • Pre-requisites listed under the generic cluster extensions documentation.

  • Log Analytics workspace. Azure Monitor Container Insights supports a Log Analytics workspace in the regions listed under Azure products by region page. You can create your own workspace using Azure Resource Manager, PowerShell, or Azure portal.

  • Contributor role assignment on the Azure subscription containing the Azure Arc-enabled Kubernetes resource. If the Log Analytics workspace is in a different subscription, then Log Analytics Contributor role assignment is needed on the Log Analytics workspace.

  • To view the monitoring data, you need to have Log Analytics Reader role assignment on the Log Analytics workspace.

  • The following endpoints need to be enabled for outbound access in addition to the ones mentioned under connecting a Kubernetes cluster to Azure Arc.

    Azure public cloud

    Endpoint Port
    *.ods.opinsights.azure.com 443
    *.oms.opinsights.azure.com 443
    dc.services.visualstudio.com 443
    *.monitoring.azure.com 443
    login.microsoftonline.com 443

    The following table lists the additional firewall configuration required for managed identity authentication.

    Agent resource Purpose Port
    global.handler.control.monitor.azure.com Access control service 443
    <cluster-region-name>.handler.control.monitor.azure.com Fetch data collection rules for specific AKS cluster 443

    Azure Government cloud

    If your Azure Arc-enabled Kubernetes resource is in Azure US Government environment, following endpoints need to be enabled for outbound access:

    Endpoint Port
    *.ods.opinsights.azure.us 443
    *.oms.opinsights.azure.us 443
    dc.services.visualstudio.com 443

    The following table lists the additional firewall configuration required for managed identity authentication.

    Agent resource Purpose Port
    global.handler.control.monitor.azure.cn Access control service 443
    <cluster-region-name>.handler.control.monitor.azure.cn Fetch data collection rules for specific AKS cluster 443
  • If you are using an Arc enabled cluster on AKS, and previously installed monitoring for AKS, please ensure that you have disabled monitoring before proceeding to avoid issues during the extension install

  • If you had previously deployed Azure Monitor Container Insights on this cluster using script without cluster extensions, follow the instructions listed here to delete this Helm chart. You can then continue to creating a cluster extension instance for Azure Monitor Container Insights.

Identify workspace resource ID

Run the following commands to locate the full Azure Resource Manager identifier of the Log Analytics workspace.

  1. List all the subscriptions that you have access to using the following command:

    az account list --all -o table
    
  2. Switch to the subscription hosting the Log Analytics workspace using the following command:

    az account set -s <subscriptionId of the workspace>
    
  3. The following example displays the list of workspaces in your subscriptions in the default JSON format.

    az resource list --resource-type Microsoft.OperationalInsights/workspaces -o json
    

    In the output, find the workspace name of interest. The id field of that represents the Azure Resource Manager identifier of that Log Analytics workspace.

    Tip

    This id can also be found in the Overview pane of the Log Analytics workspace through the Azure portal.

Create extension instance

Option 1 - With default values

This option uses the following defaults:

  • Creates or uses existing default log analytics workspace corresponding to the region of the cluster
  • Auto-upgrade is enabled for the Azure Monitor cluster extension
az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-name> --resource-group <resource-group> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers

To use managed identity authentication (preview), add the configuration-settings parameter as in the following:

az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-name> --resource-group <resource-group> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers --configuration-settings omsagent.useAADAuth=true

Option 2 - With existing Azure Log Analytics workspace

You can use an existing Azure Log Analytics workspace in any subscription on which you have Contributor or a more permissive role assignment.

az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-name> --resource-group <resource-group> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers --configuration-settings logAnalyticsWorkspaceResourceID=<armResourceIdOfExistingWorkspace>

Option 3 - With advanced configuration

If you want to tweak the default resource requests and limits, you can use the advanced configurations settings:

az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-name> --resource-group <resource-group> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers --configuration-settings  omsagent.resources.daemonset.limits.cpu=150m omsagent.resources.daemonset.limits.memory=600Mi omsagent.resources.deployment.limits.cpu=1 omsagent.resources.deployment.limits.memory=750Mi

Checkout the resource requests and limits section of Helm chart for the available configuration settings.

Option 4 - On Azure Stack Edge

If the Azure Arc-enabled Kubernetes cluster is on Azure Stack Edge, then a custom mount path /home/data/docker needs to be used.

az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-name> --resource-group <resource-group> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers --configuration-settings omsagent.logsettings.custommountpath=/home/data/docker

Note

If you are explicitly specifying the version of the extension to be installed in the create command, then ensure that the version specified is >= 2.8.2.

Verify extension installation status

Once you have successfully created the Azure Monitor extension for your Azure Arc-enabled Kubernetes cluster, you can additionally check the status of installation using the Azure portal or CLI. Successful installations should show the status as 'Installed'. If your status is showing 'Failed' or remains in the 'Pending' state for long periods of time, proceed to the Troubleshooting section below.

  1. In the Azure portal, select the Azure Arc-enabled Kubernetes cluster with the extension installing
  2. From the resource pane on the left, select the 'Extensions' item under the 'Settings' section.
  3. You should see an extension with the name 'azuremonitor-containers' listed, with the listed status in the 'Install status' column

Migrate to managed identity authentication (preview)

Use the flowing guidance to migrate an existing extension instance to managed identity authentication (preview).

First retrieve the Log Analytics workspace configured for Container insights extension.

az k8s-extension show --name azuremonitor-containers --cluster-name \<cluster-name\> --resource-group \<resource-group\> --cluster-type connectedClusters -n azuremonitor-containers 

Enable Container insights extension with managed identity authentication option using the workspace returned in the first step.

az k8s-extension create --name azuremonitor-containers --cluster-name \<cluster-name\> --resource-group \<resource-group\> --cluster-type connectedClusters --extension-type Microsoft.AzureMonitor.Containers --configuration-settings omsagent.useAADAuth=true logAnalyticsWorkspaceResourceID=\<workspace-resource-id\> 

Delete extension instance

The following command only deletes the extension instance, but doesn't delete the Log Analytics workspace. The data within the Log Analytics resource is left intact.

az k8s-extension delete --name azuremonitor-containers --cluster-type connectedClusters --cluster-name <cluster-name> --resource-group <resource-group>

Disconnected cluster

If your cluster is disconnected from Azure for > 48 hours, then Azure Resource Graph won't have information about your cluster. As a result the Insights pane may display incorrect information about your cluster state.

Troubleshooting

For issues with enabling monitoring, we have provided a troubleshooting script to help diagnose any problems.

Next steps

  • With monitoring enabled to collect health and resource utilization of your Azure Arc-enabled Kubernetes cluster and workloads running on them, learn how to use Container insights.

  • By default, the containerized agent collects the stdout/ stderr container logs of all the containers running in all the namespaces except kube-system. To configure container log collection specific to particular namespace or namespaces, review Container Insights agent configuration to configure desired data collection settings to your ConfigMap configurations file.

  • To scrape and analyze Prometheus metrics from your cluster, review Configure Prometheus metrics scraping