Extensão da máquina virtual do Log Analytics para Linux

Visão geral

Os Logs do Azure Monitor fornecem recursos de monitoramento, alertas e correção de alertas em ativos locais e de nuvem. A Microsoft publica e oferece suporte à extensão da máquina virtual do Log Analytics para Linux. A extensão instala o agente do Log Analytics em máquinas virtuais do Azure e registra máquinas virtuais em um espaço de trabalho do Log Analytics existente. Este documento detalha as plataformas com opções de plataformas, configurações e implantação com suporte para a extensão da máquina virtual do Log Analytics para Linux.

Observação

Com os servidores habilitados para Azure Arc, você pode implantar, remover e atualizar extensão de VM do agente Log Analytics em VMs Windows e Linux que não são do Azure, simplificando o gerenciamento do computador híbrido por meio do ciclo de vida. Para obter mais informações, confira Gerenciamento de extensão de VM com servidores habilitados para o Azure Arc.

Pré-requisitos

Sistema operacional

Para obter detalhes sobre as distribuições do Linux com suporte, consulte o artigo Visão geral dos agentes do Azure Monitor.

Versão do Agente e da Extensão de VM

A tabela a seguir fornece um mapeamento da versão da extensão de VM do Log Analytics e o pacote do agente do Log Analytics para cada versão. Há um link para as notas de versão da versão do pacote do agente do Log Analytics. As notas de versão incluem detalhes sobre correções de bug e novos recursos disponíveis para uma determinada liberação de agente.

Versão da extensão de VM do Linux do Log Analytics Versão do pacote do agente do Log Analytics
1.19.0 1.19.0
1.18.1 1.18.1
1.17.2 1.17.2
1.17.1 1.17.1
1.16.0 1.16.0
1.14.23 1.14.23
1.14.20 1.14.20
1.14.19 1.14.19
1.14.16 1.14.16
1.14.13 1.14.13
1.14.11 1.14.11
1.14.9 1.14.9
1.13.40 1.13.40
1.13.35 1.13.35
1.13.33 1.13.33
1.13.27 1.13.27
1.13.15 1.13.9-0
1.12.25 1.12.15-0
1.11.15 1.11.0-9
1.10.0 1.10.0-1
1.9.1 1.9.0-0
1.8.11 1.8.1-256
1.8.0 1.8.0-256
1.7.9 1.6.1-3
1.6.42.0 1.6.0-42
1.4.60.2 1.4.4-210
1.4.59.1 1.4.3-174
1.4.58.7 14.2-125
1.4.56.5 1.4.2-124
1.4.55.4 1.4.1-123
1.4.45.3 1.4.1-45
1.4.45.2 1.4.0-45
1.3.127.5 1.3.5-127
1.3.127.7 1.3.5-127
1.3.18.7 1.3.4-15

Microsoft Defender para Nuvem

O Microsoft Defender para Nuvem provisiona automaticamente o agente do Log Analytics e o conecta a um workspace do Log Analytics padrão criado pela Defender para Nuvem na sua assinatura do Azure. Se você estiver usando o Microsoft Defender para Nuvem, não passe correndo pelas etapas deste documento. Isso substitui o workspace configurado e interrompe a conexão com o Microsoft Defender para Nuvem.

Conectividade com a Internet

A extensão do agente do Log Analytics para Linux exige que a máquina virtual de destino esteja conectada à Internet.

Esquema de extensão

O seguinte JSON mostra o esquema para a extensão do agente do Log Analytics. A extensão requer a ID do espaço de trabalho e a chave do espaço de trabalho no espaço de trabalho do Log Analytics de destino. Esses valores podem ser encontrados no seu espaço de trabalho do Log Analytics no portal do Azure. Como a chave do workspace deve ser tratada como um dado confidencial, ela é armazenada em uma configuração protegida. Os dados de configuração protegidos pela extensão da VM do Azure são criptografados, sendo descriptografados apenas na máquina virtual de destino. Observe que workspaceId e workspaceKey diferenciam maiúsculas de minúsculas.

Observação

Como a solução de Monitoramento de Contêiner está sendo desativada, a documentação a seguir usará a configuração opcional "skipDockerProviderInstall": true.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "autoUpgradeMinorVersion": true,
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

Observação

O esquema acima assume que ele será colocado no nível raiz do modelo. Se você colocá-lo dentro do recurso de máquina virtual no modelo, as propriedades type e name deverão ser alteradas, conforme descrito abaixo.

Valores de propriedade

Nome Valor/Exemplo
apiVersion 2018-06-01
publicador Microsoft.EnterpriseCloud.Monitoring
type OmsAgentForLinux
typeHandlerVersion 1.16
workspaceId (por exemplo) 6f680a37-00c6-41c7-a93f-1437e3462574
workspaceKey (por exemplo) z4bU3p1/GrnWpQkky4gdabWXAhbWSTz70hm4m2Xt92XI+rSRgE8qVvRhsGo9TXffbrTahyrwv35W0pOqQAU7uQ==

Implantação de modelo

Observação

Determinados componentes da extensão de VM de análise de logs também são fornecidos na extensão de VM de diagnóstico. Devido a essa arquitetura, poderão surgir conflitos se as duas extensões forem instanciadas no mesmo modelo do ARM. Para evitar esses conflitos de tempo de instalação, use a dependsOn diretiva para garantir que as extensões sejam instaladas sequencialmente. As extensões podem ser instaladas em qualquer ordem.

Extensões de VM do Azure podem ser implantadas com modelos do Azure Resource Manager. Esses modelos são ideais para implantação de uma ou mais máquinas virtuais que exigem configuração pós-implantação, tal como integração aos Logs do Azure Monitor. Um exemplo de modelo do Resource Manager que inclui a extensão de VM do agente do Log Analytics pode ser encontrado na Galeria de Início Rápido do Azure.

A configuração do JSON para uma extensão da máquina virtual pode ser aninhado dentro do recurso de máquina virtual ou localizado no nível de raiz ou superior de um modelo JSON do Resource Manager. O posicionamento da configuração do JSON afeta o valor do tipo e nome do recurso. Para obter mais informações, consulte Definir o nome e o tipo de recursos filho.

O exemplo a seguir pressupõe que a extensão de VM está aninhada dentro do recurso de máquina virtual. Ao aninhar o recurso de extensão, o JSON é colocado no objeto "resources": [] da máquina virtual.

{
  "type": "extensions",
  "name": "OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

Ao inserir o JSON da extensão na raiz do modelo, o nome do recurso inclui uma referência na máquina virtual pai e o tipo reflete a configuração aninhada.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "<parentVmResource>/OMSExtension",
  "apiVersion": "2018-06-01",
  "location": "<location>",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/', <vm-name>)]"
  ],
  "properties": {
    "publisher": "Microsoft.EnterpriseCloud.Monitoring",
    "type": "OmsAgentForLinux",
    "typeHandlerVersion": "1.16",
    "settings": {
      "workspaceId": "myWorkspaceId",
      "skipDockerProviderInstall": true
    },
    "protectedSettings": {
      "workspaceKey": "myWorkSpaceKey"
    }
  }
}

Implantação da CLI do Azure

A CLI do Azure pode ser usada para implantar a extensão da VM do Agente do Log Analytics para uma máquina virtual existente. Substitua o valor myWorkspaceKey abaixo por sua chave do workspace e o valor myWorkspaceId pela ID do workspace. Esses valores podem ser encontrados no portal do Azure, no workspace do Log Analytics, em Configurações avançadas. Substitua o valor latestVersion por uma versão da versão da extensão da VM Linux do Log Analytics.

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name OmsAgentForLinux \
  --publisher Microsoft.EnterpriseCloud.Monitoring \
  --protected-settings '{"workspaceKey":"myWorkspaceKey"}' \
  --settings '{"workspaceId":"myWorkspaceId","skipDockerProviderInstall": true}' \
  --version latestVersion

Implantação do Azure PowerShell

Os cmdlets do Azure PowerShell pode ser usada para implantar a extensão da VM do Agente do Log Analytics para uma máquina virtual existente. Substitua o valor myWorkspaceKey abaixo por sua chave do workspace e o valor myWorkspaceId pela ID do workspace. Esses valores podem ser encontrados no portal do Azure, no workspace do Log Analytics, em Configurações avançadas. Substitua o valor latestVersion por uma versão da versão da extensão da VM Linux do Log Analytics.

Set-AzVMExtension \
  -ResourceGroupName myResourceGroup \
  -VMName myVM \
  -ExtensionName OmsAgentForLinux \
  -ExtensionType OmsAgentForLinux \
  -Publisher Microsoft.EnterpriseCloud.Monitoring \
  -TypeHandlerVersion latestVersion \
  -ProtectedSettingString '{"workspaceKey":"myWorkspaceKey"}' \
  -SettingString '{"workspaceId":"myWorkspaceId","skipDockerProviderInstall": true}'

Solução de problemas e suporte

Solucionar problemas

Os dados sobre o estado das implantações de extensão podem ser recuperados no portal do Microsoft Azure usando a CLI do Azure ou o Azure PowerShell. Para ver o estado da implantação das extensões de uma determinada VM, execute o comando a seguir usando a CLI do Azure.

az vm extension list --resource-group myResourceGroup --vm-name myVM -o table

A saída de execução da extensão é registrada no seguinte arquivo:

/var/log/azure/Microsoft.EnterpriseCloud.Monitoring.OmsAgentForLinux/extension.log

Para recuperar a versão da extensão do OMS instalada em uma VM, execute o comando a seguir se você está usando a CLI do Azure.

az vm extension show --resource-group myResourceGroup --vm-name myVM --instance-view

Para recuperar a versão da extensão do OMS instalada em uma VM, execute o comando a seguir se você está usando o Azure PowerShell.

Get-AzVMExtension -ResourceGroupName my_resource_group  -VMName my_vm_name -Name OmsAgentForLinux -Status

Códigos de erro e seus significados

Código do Erro Significado Ação possível
9 Habilitar chamado prematuramente Atualize o Agente Linux do Azure para a versão mais recente disponível.
10 A VM já está conectada a um espaço de trabalho do Log Analytics Para conectar a VM ao workspace especificado no esquema de extensão, defina stopOnMultipleConnections como falso nas configurações públicas ou remova esta propriedade. Essa VM é cobrada uma vez para cada workspace ao qual está conectada.
11 Configuração inválida fornecida para a extensão Siga os exemplos anteriores para definir todos os valores de propriedade necessários para a implantação.
17 Falha na instalação do pacote do Log Analytics
18 Falha na instalação do pacote OMSConfig. Examine a saída do comando para a falha raiz.
19 Falha da instalação do pacote OMI
20 Falha da instalação do pacote SCX
33 Erro ao gerar meta-configuração para o omsconfig. Relate um problema do GitHub com os detalhes do resultado.
51 Não há suporte para essa extensão no sistema operacional da VM
52 Essa extensão falhou devido a uma dependência ou uma permissão ausente Verifique a saída e os logs para obter mais informações sobre qual dependência ou permissão está faltando.
53 Esta extensão falhou devido a parâmetros de configuração ausentes ou errados Verifique a saída e os logs para obter mais informações sobre o que deu errado. Além disso, verifique a exatidão da ID do espaço de trabalho e verifique se o computador está conectado à Internet.
55 Não é possível se conectar ao serviço Azure Monitor. Os pacotes necessários estão ausentes ou o gerenciador de pacotes dpkg está bloqueado Verifique se o sistema tem acesso à Internet ou se um proxy HTTP válido foi fornecido. Além disso, verifique a exatidão da ID do workspace e verifique se os utilitários curl e tar estão instalados.

Informações adicionais podem ser encontradas no Guia de solução de problemas do Log Analytics-Agent-for-Linux.

Suporte

Caso precise de mais ajuda em qualquer ponto deste artigo, entre em contato com os especialistas do Azure nos fóruns do Azure e do Stack Overflow no MSDN. Como alternativa, você pode registrar um incidente de suporte do Azure. Vá para o site de suporte do Azure e selecione Obter suporte. Para saber mais sobre como usar o suporte do Azure, leia as Perguntas frequentes sobre o suporte do Microsoft Azure.