Tutorial: Enable telemetry and monitoring for your Azure Linux Container Host cluster

Article
09/19/2024

In this tutorial, part four of five, you'll set up Container Insights to monitor an Azure Linux Container Host cluster. You'll learn how to:

Enable monitoring for an existing cluster.
Verify that the agent is deployed successfully.
Verify that the solution is enabled.

In the next and last tutorial, you'll learn how to upgrade your Azure Linux nodes.

Prerequisites

In previous tutorials, you created and deployed an Azure Linux Container Host cluster. To complete this tutorial, you need an existing cluster. If you haven't done this step and would like to follow along, start with Tutorial 1: Create a cluster with the Azure Linux Container Host for AKS.
If you're connecting an existing AKS cluster to a Log Analytics workspace in another subscription, the Microsoft.ContainerService resource provider must be registered in the subscription with the Log Analytics workspace. For more information, see Register resource provider.
You need the latest version of Azure CLI. Run az --version to find the version. If you need to install or upgrade, see Install Azure CLI.

1 - Enable monitoring

Option 1: Use a default Log Analytics workspace

The following step enables monitoring for your Azure Linux Container Host cluster using Azure CLI. In this example, you aren't required to precreate or specify an existing workspace. This command simplifies the process for you by creating a default workspace in the default resource group of the AKS cluster subscription. If one doesn't already exist in the region, the default workspace created will resemble the format DefaultWorkspace-< GUID >-< Region >.

az aks enable-addons -a monitoring -n testAzureLinuxCluster -g testAzureLinuxResourceGroup

The first few lines of the output should contain the following in the addonProfiles configuration :

{
  "aadProfile": null,
  "addonProfiles": {
    "omsagent": {
      "config": {
        "logAnalyticsWorkspaceResourceID": "/subscriptions/<WorkspaceSubscription>/resourceGroups/DefaultResourceGroup-EUS2/providers/Microsoft.OperationalInsights/workspaces/DefaultWorkspace-<WorkspaceSubscription>-EUS2",
        "useAADAuth": "true"
      },
      "enabled": true,
      "identity": null
    }
  },
}

Option 2: Specify a Log Analytics workspace

In this example, you can specify a Log Analytics workspace to enable monitoring of your Azure Linux Container Host cluster. The resource ID of the workspace will be in the form "/subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<WorkspaceName>".

az aks enable-addons -a monitoring -n testAzureLinuxCluster -g testAzureLinuxResourceGroup --workspace-resource-id <workspace-resource-id>

The output will resemble the following example:

provisioningState       : Succeeded

2 - Verify agent and solution deployment

Run the following command to verify that the agent is deployed successfully.

kubectl get ds ama-logs --namespace=kube-system

The output should resemble the following example, which indicates that it was deployed properly:

User@aksuser:~$ kubectl get ds ama-logs --namespace=kube-system
NAME       DESIRED   CURRENT   READY   UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
ama-logs   3         3         3       3            3           <none>          3m22s

To verify deployment of the solution, run the following command:

kubectl get deployment ama-logs-rs -n=kube-system

The output should resemble the following example, which indicates that it was deployed properly:

User@aksuser:~$ kubectl get deployment ama-logs-rs -n=kube-system
NAME       DESIRED   CURRENT   UP-TO-DATE   AVAILABLE    AGE
ama-logs-rs   1         1         1            1            3h

3 - Verify solution configuration

Use the aks show command to find out whether the solution is enabled or not, what the Log Analytics workspace resource ID is, and summary information about the cluster.

az aks show -g testAzureLinuxResourceGroup -n testAzureLinuxCluster

After a few minutes, the command completes and returns JSON-formatted information about the solution. The results of the command should show the monitoring add-on profile and resemble the following example output:

"addonProfiles": {
    "omsagent": {
      "config": {
        "logAnalyticsWorkspaceResourceID": "/subscriptions/<WorkspaceSubscription>/resourceGroups/<DefaultWorkspaceRG>/providers/Microsoft.OperationalInsights/workspaces/<defaultWorkspaceName>"
      },
      "enabled": true
    }
  }

Next steps

In this tutorial, you enabled telemetry and monitoring for your Azure Linux Container Host cluster. You learned how to:

Enable monitoring for an existing cluster.
Verify that the agent is deployed successfully.
Verify that the solution is enabled.

In the next tutorial, you'll learn how to upgrade your Azure Linux nodes.

Upgrade Azure Linux nodes

Share via