Log Analytics virtual machine extension for Linux (Extensão de máquina virtual do Log Analytics para Linux)

  • Artigo

Descrição geral

O Azure Monitor Logs fornece recursos de monitoramento, alerta e correção de alertas em ativos locais e na nuvem. A extensão de máquina virtual do Log Analytics para Linux é publicada e suportada pela Microsoft. 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 existente do Log Analytics. Este documento detalha as plataformas, configurações e opções de implantação suportadas para a extensão de máquina virtual do Log Analytics para Linux.

Nota

Os servidores habilitados para Arco do Azure permitem implantar, remover e atualizar a extensão de VM do agente do Log Analytics para máquinas Windows e Linux que não sejam do Azure, simplificando o gerenciamento de sua máquina híbrida durante seu ciclo de vida. Para obter mais informações, consulte Gerenciamento de extensão de VM com servidores habilitados para Azure Arc.

Pré-requisitos

Sistema operativo

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

Versão do agente e da extensão da VM

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

Versão da extensão do Log Analytics Linux VM Versão do pacote do Log Analytics Agent
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 a Cloud

O Microsoft Defender for Cloud provisiona automaticamente o agente do Log Analytics e o conecta a um espaço de trabalho padrão do Log Analytics criado pelo Defender for Cloud em sua assinatura do Azure. Se você estiver usando o Microsoft Defender for Cloud, não execute as etapas neste documento. Isso substitui o espaço de trabalho configurado e interrompe a conexão com o Microsoft Defender for Cloud.

Ligação à Internet

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

Esquema de extensão

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

Nota

Como a solução de monitoramento de contêiner está sendo desativada, a documentação a seguir usa 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"
    }
  }
}

Nota

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

Valores de propriedade

Nome Valor / Exemplo
apiVersion 2018-06-01
editora Microsoft.EnterpriseCloud.Monitoring
tipo OmsAgentForLinux
typeHandlerVersion 1.16
workspaceId (por exemplo) 6F680A37-00C6-41C7-A93F-1437E3462574
workspaceKey (por exemplo) z4bU3p1/GrnWpQkky4gdabWXAhbWSTz70hm4m2Xt92XI+rSRgE8qVvRhsGo9TXffbrTahyrwv35W0pOqQAU7uQ==

Implementação de modelos

Nota

Determinados componentes da extensão de VM do Log Analytics também são fornecidos na extensão de VM de diagnóstico. Devido a essa arquitetura, conflitos podem surgir se ambas as extensões forem instanciadas no mesmo modelo 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.

As extensões de VM do Azure podem ser implantadas com modelos do Azure Resource Manager. Os modelos são ideais ao implantar uma ou mais máquinas virtuais que exigem configuração pós-implantação, como integração aos Logs do Azure Monitor. Um modelo de exemplo 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 JSON para uma extensão de máquina virtual pode ser aninhada dentro do recurso de máquina virtual ou colocada no nível raiz ou superior de um modelo JSON do Gerenciador de Recursos. O posicionamento da configuração JSON afeta o valor do nome e do tipo de recurso. Para obter mais informações, consulte Definir nome e tipo para recursos filho.

O exemplo a seguir pressupõe que a extensão VM esteja aninhada dentro do recurso de máquina virtual. Ao aninhar o recurso de extensão, o JSON é colocado no "resources": [] objeto 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 colocar a extensão JSON na raiz do modelo, o nome do recurso inclui uma referência à 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"
    }
  }
}

Implementação da CLI do Azure

A CLI do Azure pode ser usada para implantar a extensão de VM do agente do Log Analytics em uma máquina virtual existente. Substitua o valor myWorkspaceKey abaixo pela chave do espaço de trabalho e o valor myWorkspaceId pelo ID do espaço de trabalho. Esses valores podem ser encontrados em seu espaço de trabalho do Log Analytics no portal do Azure 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 podem ser usados para implantar a extensão de VM do agente do Log Analytics em uma máquina virtual existente. Substitua o valor myWorkspaceKey abaixo pela chave do espaço de trabalho e o valor myWorkspaceId pelo ID do espaço de trabalho. Esses valores podem ser encontrados em seu espaço de trabalho do Log Analytics no portal do Azure 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

Resolver problemas

Os dados sobre o estado das implantações de extensão podem ser recuperados do portal do Azure e usando a CLI do Azure ou o Azure Powershell. Para ver o estado de implantação das extensões de uma determinada VM, execute o seguinte comando se estiver 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 está registada no seguinte ficheiro:

/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 seguinte comando se estiver 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 seguinte comando se estiver 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 de Erro Significado Ação possível
9 Ativar 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 espaço de trabalho especificado no esquema de extensão, defina stopOnMultipleConnections como false em configurações públicas ou remova essa propriedade. Essa VM é cobrada uma vez para cada espaço de trabalho 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 na instalação do pacote OMI
20 Falha na instalação do pacote SCX
33 Erro ao gerar metaconfiguração para omsconfig. Arquive um problema do GitHub com detalhes da saída.
51 Esta extensão não é suportada no sistema operacional da VM
52 Esta extensão falhou devido a uma dependência ou 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 correção do ID do espaço de trabalho e verifique se a máquina está conectada à Internet.
55 Não é possível conectar-se ao serviço Azure Monitor ou pacotes necessários 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 correção do ID do espaço de trabalho e verifique se os utilitários curl e tar estão instalados.

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

Suporte

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