Skip to content

Commit 746a7fb

Browse files
authored
Merge pull request #214485 from damendo/agent-rename
Agent rename changes 1
2 parents f824e71 + 6b63a8c commit 746a7fb

8 files changed

+276
-217
lines changed

articles/azure-monitor/containers/container-insights-agent-config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Configure Container insights agent data collection | Microsoft Docs
33
description: This article describes how you can configure the Container insights agent to control stdout/stderr and environment variables log collection.
44
ms.topic: conceptual
55
ms.date: 08/25/2022
6-
ms.reviewer: viviandiec
6+
ms.reviewer: aul
77
---
88

99
# Configure agent data collection for Container insights
@@ -31,7 +31,7 @@ The following table describes the settings you can configure to control data col
3131
| `[log_collection_settings.stdout] exclude_namespaces =` | String | Comma-separated array | Array of Kubernetes namespaces for which stdout logs will not be collected. This setting is effective only if<br> `log_collection_settings.stdout.enabled`<br> is set to `true`.<br> If not specified in ConfigMap, the default value is<br> `exclude_namespaces = ["kube-system"]`. |
3232
| `[log_collection_settings.stderr] enabled =` | Boolean | true or false | This controls if stderr container log collection is enabled.<br> When set to `true` and no namespaces are excluded for stdout log collection<br> (`log_collection_settings.stderr.exclude_namespaces` setting), stderr logs will be collected from all containers across all pods/nodes in the cluster.<br> If not specified in ConfigMaps, the default value is<br> `enabled = true`. |
3333
| `[log_collection_settings.stderr] exclude_namespaces =` | String | Comma-separated array | Array of Kubernetes namespaces for which stderr logs will not be collected.<br> This setting is effective only if<br> `log_collection_settings.stdout.enabled` is set to `true`.<br> If not specified in ConfigMap, the default value is<br> `exclude_namespaces = ["kube-system"]`. |
34-
| `[log_collection_settings.env_var] enabled =` | Boolean | true or false | This setting controls environment variable collection<br> across all pods/nodes in the cluster<br> and defaults to `enabled = true` when not specified<br> in ConfigMaps.<br> If collection of environment variables is globally enabled, you can disable it for a specific container<br> by setting the environment variable<br> `AZMON_COLLECT_ENV` to **False** either with a Dockerfile setting or in the [configuration file for the Pod](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) under the **env:** section.<br> If collection of environment variables is globally disabled, then you cannot enable collection for a specific container (that is, the only override that can be applied at the container level is to disable collection when it's already enabled globally.). It’s strongly recommended to secure log analytics workspace access with the default [log_collection_settings.env_var] enabled = true. If sensitive data is stored in environment variables, it is mandatory and very critical to secure log analytics workspace. |
34+
| `[log_collection_settings.env_var] enabled =` | Boolean | true or false | This setting controls environment variable collection<br> across all pods/nodes in the cluster<br> and defaults to `enabled = true` when not specified<br> in ConfigMaps.<br> If collection of environment variables is globally enabled, you can disable it for a specific container<br> by setting the environment variable<br> `AZMON_COLLECT_ENV` to **False** either with a Dockerfile setting or in the [configuration file for the Pod](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) under the **env:** section.<br> If collection of environment variables is globally disabled, then you cannot enable collection for a specific container (that is, the only override that can be applied at the container level is to disable collection when it's already enabled globally.). |
3535
| `[log_collection_settings.enrich_container_logs] enabled =` | Boolean | true or false | This setting controls container log enrichment to populate the Name and Image property values<br> for every log record written to the ContainerLog table for all container logs in the cluster.<br> It defaults to `enabled = false` when not specified in ConfigMap. |
3636
| `[log_collection_settings.collect_all_kube_events] enabled =` | Boolean | true or false | This setting allows the collection of Kube events of all types.<br> By default the Kube events with type *Normal* are not collected. When this setting is set to `true`, the *Normal* events are no longer filtered and all events are collected.<br> It defaults to `enabled = false` when not specified in the ConfigMap |
3737

@@ -65,11 +65,11 @@ Perform the following steps to configure and deploy your ConfigMap configuration
6565

6666
Example: `kubectl apply -f container-azm-ms-agentconfig.yaml`.
6767

68-
The configuration change can take a few minutes to finish before taking effect, and all omsagent pods in the cluster will restart. The restart is a rolling restart for all omsagent pods, not all restart at the same time. When the restarts are finished, a message is displayed that's similar to the following and includes the result: `configmap "container-azm-ms-agentconfig" created`.
68+
The configuration change can take a few minutes to finish before taking effect, and all Azure Monitor Agent pods in the cluster will restart. The restart is a rolling restart for all Azure Monitor Agent pods, not all restart at the same time. When the restarts are finished, a message is displayed that's similar to the following and includes the result: `configmap "container-azm-ms-agentconfig" created`.
6969

7070
## Verify configuration
7171

72-
To verify the configuration was successfully applied to a cluster, use the following command to review the logs from an agent pod: `kubectl logs omsagent-fdf58 -n kube-system`. If there are configuration errors from the omsagent pods, the output will show errors similar to the following:
72+
To verify the configuration was successfully applied to a cluster, use the following command to review the logs from an agent pod: `kubectl logs ama-logs-fdf58 -n kube-system`. If there are configuration errors from the Azure Monitor Agent pods, the output will show errors similar to the following:
7373

7474
```
7575
***************Start Config Processing********************
@@ -94,21 +94,21 @@ After you correct the error(s) in ConfigMap, save the yaml file and apply the up
9494
9595
If you have already deployed a ConfigMap on clusters and you want to update it with a newer configuration, you can edit the ConfigMap file you've previously used and then apply using the same command as before, `kubectl apply -f <configmap_yaml_file.yaml`.
9696
97-
The configuration change can take a few minutes to finish before taking effect, and all omsagent pods in the cluster will restart. The restart is a rolling restart for all omsagent pods, not all restart at the same time. When the restarts are finished, a message is displayed that's similar to the following and includes the result: `configmap "container-azm-ms-agentconfig" updated`.
97+
The configuration change can take a few minutes to finish before taking effect, and all Azure Monitor Agent pods in the cluster will restart. The restart is a rolling restart for all Azure Monitor Agent pods, not all restart at the same time. When the restarts are finished, a message is displayed that's similar to the following and includes the result: `configmap "container-azm-ms-agentconfig" updated`.
9898
9999
## Verifying schema version
100100
101-
Supported config schema versions are available as pod annotation (schema-versions) on the omsagent pod. You can see them with the following kubectl command: `kubectl describe pod omsagent-fdf58 -n=kube-system`
101+
Supported config schema versions are available as pod annotation (schema-versions) on the Azure Monitor Agent pod. You can see them with the following kubectl command: `kubectl describe pod ama-logs-fdf58 -n=kube-system`
102102
103103
The output will show similar to the following with the annotation schema-versions:
104104
105105
```
106-
Name: omsagent-fdf58
106+
Name: ama-logs-fdf58
107107
Namespace: kube-system
108108
Node: aks-agentpool-95673144-0/10.240.0.4
109109
Start Time: Mon, 10 Jun 2019 15:01:03 -0700
110110
Labels: controller-revision-hash=589cc7785d
111-
dsName=omsagent-ds
111+
dsName=ama-logs-ds
112112
pod-template-generation=1
113113
Annotations: agentVersion=1.10.0.1
114114
dockerProviderVersion=5.0.0-0

articles/azure-monitor/containers/container-insights-enable-aks.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -259,43 +259,43 @@ After you've enabled monitoring, it might take about 15 minutes before you can v
259259
Run the following command to verify that the agent is deployed successfully.
260260

261261
```
262-
kubectl get ds omsagent --namespace=kube-system
262+
kubectl get ds ama-logs --namespace=kube-system
263263
```
264264

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

267267
```output
268-
User@aksuser:~$ kubectl get ds omsagent --namespace=kube-system
268+
User@aksuser:~$ kubectl get ds ama-logs --namespace=kube-system
269269
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
270-
omsagent 2 2 2 2 2 beta.kubernetes.io/os=linux 1d
270+
ama-logs 2 2 2 2 2 beta.kubernetes.io/os=linux 1d
271271
```
272272

273273
If there are Windows Server nodes on the cluster then you can run the following command to verify that the agent is deployed successfully.
274274

275275
```
276-
kubectl get ds omsagent-win --namespace=kube-system
276+
kubectl get ds ama-logs-windows --namespace=kube-system
277277
```
278278

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

281281
```output
282-
User@aksuser:~$ kubectl get ds omsagent-win --namespace=kube-system
282+
User@aksuser:~$ kubectl get ds ama-logs-windows --namespace=kube-system
283283
NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE
284-
omsagent-win 2 2 2 2 2 beta.kubernetes.io/os=windows 1d
284+
ama-logs-windows 2 2 2 2 2 beta.kubernetes.io/os=windows 1d
285285
```
286286

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

289289
```
290-
kubectl get deployment omsagent-rs -n=kube-system
290+
kubectl get deployment ama-logs-rs -n=kube-system
291291
```
292292

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

295295
```output
296296
User@aksuser:~$ kubectl get deployment omsagent-rs -n=kube-system
297297
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
298-
omsagent 1 1 1 1 3h
298+
ama-logs-rs 1 1 1 1 3h
299299
```
300300

301301
## View configuration with CLI

articles/azure-monitor/containers/container-insights-enable-arc-enabled-clusters.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Monitor Azure Arc-enabled Kubernetes clusters
33
ms.date: 05/24/2022
44
ms.topic: article
5-
ms.custom: ignite-2022
65
author: shashankbarsin
76
ms.author: shasb
87
description: Collect metrics and logs of Azure Arc-enabled Kubernetes clusters using Azure Monitor.
@@ -118,7 +117,7 @@ az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-n
118117
To use [managed identity authentication (preview)](container-insights-onboard.md#authentication), add the `configuration-settings` parameter as in the following:
119118

120119
```azurecli
121-
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
120+
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 amalogsagent.useAADAuth=true
122121
```
123122

124123

@@ -135,17 +134,17 @@ az k8s-extension create --name azuremonitor-containers --cluster-name <cluster-n
135134
If you want to tweak the default resource requests and limits, you can use the advanced configurations settings:
136135

137136
```azurecli
138-
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
137+
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 amalogsagent.resources.daemonset.limits.cpu=150m amalogsagent.resources.daemonset.limits.memory=600Mi amalogsagent.resources.deployment.limits.cpu=1 amalogsagent.resources.deployment.limits.memory=750Mi
139138
```
140139

141-
Check out the [resource requests and limits section of Helm chart](https://github.com/helm/charts/blob/master/incubator/azuremonitor-containers/values.yaml) for the available configuration settings.
140+
Checkout the [resource requests and limits section of Helm chart](https://github.com/helm/charts/blob/master/incubator/azuremonitor-containers/values.yaml) for the available configuration settings.
142141

143142
### Option 4 - On Azure Stack Edge
144143

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

147146
```azurecli
148-
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
147+
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 amalogsagent.logsettings.custommountpath=/home/data/docker
149148
```
150149

151150

@@ -234,7 +233,7 @@ az k8s-extension show --name azuremonitor-containers --cluster-name \<cluster-na
234233
Enable Container insights extension with managed identity authentication option using the workspace returned in the first step.
235234

236235
```cli
237-
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\>
236+
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 amalogsagent.useAADAuth=true logAnalyticsWorkspaceResourceID=\<workspace-resource-id\>
238237
```
239238

240239
## [Resource Manager](#tab/migrate-arm)
@@ -279,4 +278,4 @@ For issues with enabling monitoring, we have provided a [troubleshooting script]
279278

280279
- 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](container-insights-agent-config.md) to configure desired data collection settings to your ConfigMap configurations file.
281280

282-
- To scrape and analyze Prometheus metrics from your cluster, review [Configure Prometheus metrics scraping](container-insights-prometheus.md)
281+
- To scrape and analyze Prometheus metrics from your cluster, review [Configure Prometheus metrics scraping](container-insights-prometheus-integration.md)

0 commit comments

Comments
 (0)