From 615fab53fe0885dc307f2669fbf4533131c9edae Mon Sep 17 00:00:00 2001 From: rashmichandrashekar Date: Thu, 30 Aug 2018 13:47:27 -0700 Subject: [PATCH] Documentation for Container monitoring addon (#3735) --- docs/containermonitoringaddon.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/containermonitoringaddon.md diff --git a/docs/containermonitoringaddon.md b/docs/containermonitoringaddon.md new file mode 100644 index 000000000..aa262c4c5 --- /dev/null +++ b/docs/containermonitoringaddon.md @@ -0,0 +1,40 @@ +# ContainerMonitoring-Addon (Container Health) + +Container health gives you performance monitoring ability by collecting memory and processor metrics from controllers, nodes, and containers that are available in Kubernetes through the Metrics API. After you enable container health, these metrics are automatically collected for you through a containerized version of the Log Analytics agent for Linux and stored in your [Log Analytics] workspace. The included pre-defined views display the residing container workloads and what affects the performance health of the Kubernetes cluster so that you can: + + - Identify containers that are running on the node and their average processor and memory utilization. This knowledge can help you identify resource bottlenecks. + - Identify where the container resides in a controller or a pod. This knowledge can help you view the controller's or pod's overall performance. + - Review the resource utilization of workloads running on the host that are unrelated to the standard processes that support the pod. + - Understand the behavior of the cluster under average and heaviest loads. This knowledge can help you identify capacity needs and determine the maximum load that the cluster can sustain. + +# Prerequisites! + + - A Log Analytics workspace. You can create it when you enable monitoring of your new AKS cluster or let the onboarding experience create a default workspace in the default resource group of the AKS cluster subscription. If you chose to create it yourself, you can create it through [Azure Resource Manager], through [PowerShell], or in the [Azure portal]. + - The Log Analytics contributor role, to enable container monitoring. For more information about how to control access to a Log Analytics workspace, see [Manage workspaces]. + +# Components +- Your ability to monitor performance relies on a containerized Log Analytics agent for Linux, which collects performance and event data from all nodes in the cluster. The agent is automatically deployed and registered with the specified Log Analytics workspace after you enable container monitoring addon and specify the right encoded workspaceid and workspace key in the addon config. + + "name": "container-monitoring", + "enabled": true, + "config": { + "workspaceGuid": "Base-64 encoded workspace guid", + "workspaceKey": "Base 64 encoded workspace key" + } + ### Obtain workspace ID and key + - In the Azure portal, click All services. In the list of resources, type Log Analytics. As you begin typing, the list filters based on your input. Select Log Analytics. + - In your list of Log Analytics workspaces, select the workspace you intend on configuring the agent to report to. + - Select Advanced settings. + - Select Connected Sources, and then select Linux Servers. + - Copy and paste into your favorite editor, the Workspace ID and Primary Key. + +##### After the deployment is complete, you should be able to see all the cluster data here: [Link to Container Health] +##### Pick your workspace from the dropdown to get all the useful data about your cluster. +##### Any feedback: askcoin@microsoft.com + + [Log Analytics]: + [Azure Resource Manager]: + [PowerShell]: + [Azure portal]: + [Manage workspaces]: + [Link to Container Health]: