Criar configurações de diagnóstico no Azure Monitor

Crie e edite configurações de diagnóstico no Azure Monitor para enviar métricas e logs da plataforma Azure para diferentes destinos, como Logs do Azure Monitor, Armazenamento do Azure ou Hubs de Eventos do Azure. Você pode usar diferentes métodos para trabalhar com as configurações de diagnóstico, como o portal do Azure, a CLI do Azure, o PowerShell e o Azure Resource Manager.

Importante

A política de retenção, conforme definido nas configurações de diagnóstico, agora está preterida e não pode mais ser usada. Use a Política de Ciclo de Vida do Armazenamento do Azure para gerenciar o período de tempo em que seus logs são retidos. Para obter mais informações, confira Migrar a retenção de armazenamento de configurações de diagnóstico para o gerenciamento do ciclo de vida do Armazenamento do Azure

Azure portal

Você pode definir as configurações de diagnóstico no portal do Azure no menu do Azure Monitor ou no menu do recurso.

1. O ponto no qual você define as configurações de diagnóstico no portal do Azure depende do recurso:

   • Para um único recurso, selecione Configurações de diagnóstico em Monitoramento no menu do recurso.

     

   • Para um ou mais recursos, selecione Configurações de diagnóstico em Configurações no menu do Azure Monitor e selecione o recurso.

     

   • Para o log de atividades, selecione Log de atividades no menu do Azure Monitor e, depois, selecione Exportar Log de Atividades. Não esqueça de desabilitar toda configuração herdada para o log de atividades. Para obter instruções, consulte Desabilitar configurações existentes.

     

2. Se não existirem configurações no recurso selecionado, você será solicitado a criar uma configuração. Selecione Adicionar configuração de diagnóstico.

   

   Caso haja configurações existentes no recurso, você verá uma lista de configurações já definidas nesse recurso. Selecione Adicionar configuração de diagnóstico, para adicionar uma nova configuração. Ou selecione Editar configuração para editar uma existente. Cada configuração pode ter apenas um destino de cada tipo.

   

3. Dê um nome à configuração se ela ainda não tiver um.

   

4. Logs e métricas para rota: para logs, escolha um grupo de categorias ou marque as caixas de seleção individuais para cada categoria de dados que você deseja enviar para os destinos especificados mais tarde. A lista de categorias varia para cada serviço do Azure. Selecione AllMetrics se desejar armazenar métricas nos logs do Azure Monitor também.

5. Detalhes de destino: marque a caixa de seleção para cada destino. As opções aparecem para que você possa adicionar mais informações.

   

   1. Envie para o workspace do Log Analytics: selecione a Assinatura e o workspace do Log Analytics para onde deseja enviar os dados. Caso não tenha um workspace, você precisará criar um antes de continuar.

   2. Arquivar em uma conta de armazenamento: selecione sua Assinatura e a Conta de armazenamento onde deseja armazenar os dados.

      

      Dica

      Use a Política de Ciclo de Vida do Armazenamento do Azure para gerenciar o período de tempo em que seus logs são retidos. A Política de Retenção, conforme definida nas configurações de Configuração de Diagnóstico, foi preterida.

   3. Stream para hub de eventos: especifique os seguintes critérios:

      • Assinatura: a assinatura da qual o hub de eventos faz parte.
      • Namespace do hub de eventos: se não tiver um, você deverá criar um.
      • Nome de Hub de eventos (opcional): o nome para o qual enviar todos os dados. Se você não especificar um nome, um hub de eventos será criado para cada categoria de log. Se você estiver enviando para várias categorias, talvez você deva especificar um nome para limitar o número de hubs de eventos criados. Para obter mais informações, veja cotas e limites dos Hubs de Eventos do Azure.
      • Política de Hub de Eventos (opcional também): uma política define as permissões do mecanismo de transmissão. Para obter mais informações, confira Recursos dos Hubs de Eventos.

   4. Enviar para a solução de parceiro: primeiro, instale os Serviços ISV Nativos do Azure em sua assinatura. As opções de configuração variam de acordo com o parceiro. Para saber mais, confira Visão geral dos Serviços de ISV Nativo do Azure.

6. Se o serviço oferecer suporte aos modos específico do recurso e diagnóstico do Azure uma opção para selecionar a tabela de destino será exibida quando você selecionar Espaço de trabalho do Log Analytics como um destino. Normalmente, você deve selecionar Recurso específico, pois a estrutura da tabela permite mais flexibilidade e consultas mais eficientes.

   

7. Selecione Salvar.

Após alguns instantes, a nova configuração aparece na lista de configurações para esse recurso. Os logs são transmitidos para os destinos especificados à medida que novos dados de evento são gerados. Podem se passar até 15 minutos entre o momento em que um evento é emitido e o momento em que ele aparece no workspace do Log Analytics.

PowerShell

Use o cmdlet New-AzDiagnosticSetting para criar uma configuração de diagnóstico com o Azure PowerShell. Confira a documentação deste cmdlet para obter descrições de seus parâmetros.

Importante

Você não pode usar esse método para um log de atividades. Em vez disso, use Criar uma configuração de diagnóstico no Azure Monitor usando um modelo do Azure Resource Manager para criar um modelo do Resource Manager e implantá-lo com o PowerShell.

O cmdlet do PowerShell de exemplo a seguir cria uma configuração de diagnóstico para todos os logs ou para logs de auditoria e métricas para um cofre de chaves usando o Workspace do Log Analytics.

$KV = Get-AzKeyVault -ResourceGroupName <resource group name> -VaultName <key vault name>
$Law = Get-AzOperationalInsightsWorkspace -ResourceGroupName <resource group name> -Name <workspace name>  # LAW name is case sensitive

$metric = New-AzDiagnosticSettingMetricSettingsObject -Enabled $true -Category AllMetrics
# For all available logs, use:
$log = New-AzDiagnosticSettingLogSettingsObject -Enabled $true -CategoryGroup allLogs  
# or, for audit logs, use:
$log = New-AzDiagnosticSettingLogSettingsObject -Enabled $true -CategoryGroup audit    
New-AzDiagnosticSetting -Name 'KeyVault-Diagnostics' -ResourceId $KV.ResourceId -WorkspaceId $Law.ResourceId -Log $log -Metric $metric -Verbose

CLI

Use o comando az monitor diagnostic-settings create para criar uma configuração de diagnóstico com a CLI do Azure. Confira a documentação desse comando para obter descrições de seus parâmetros.

Importante

Você não pode usar esse método para um log de atividades. Em vez disso, use Criar configuração de diagnóstico no Azure Monitor usando um modelo do Gerenciador de Recursos para criar um modelo do Gerenciador de Recursos e implantá-lo com a CLI do Azure.

O comando de exemplo a seguir cria uma configuração de diagnóstico usando todos os três destinos. A sintaxe fica ligeiramente diferente de acordo com o cliente.

Para especificar o modo específico do recurso se o serviço der suporte a ele, adicione o export-to-resource-specific parâmetro com um valor de true.`

az monitor diagnostic-settings create  \
--name KeyVault-Diagnostics \
--resource /subscriptions/<subscription ID>/resourceGroups/<resource group name>/providers/Microsoft.KeyVault/vaults/mykeyvault \
--logs    '[{"category": "AuditEvent","enabled": true}]' \
--metrics '[{"category": "AllMetrics","enabled": true}]' \
--storage-account /subscriptions/<subscription ID>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage account name> \
--workspace /subscriptions/<subscription ID>/resourcegroups/<resource group name>/providers/microsoft.operationalinsights/workspaces/<log analytics workspace name> \
--event-hub-rule /subscriptions/<subscription ID>/resourceGroups/<resource group name>/providers/Microsoft.EventHub/namespaces/<event hub namespace>/authorizationrules/RootManageSharedAccessKey \
--event-hub <event hub name> \
--export-to-resource-specific true

Resource Manager

O modelo JSON a seguir fornece um exemplo para criar uma configuração de diagnóstico para enviar todos os logs de auditoria para um espaço de trabalho de análise de log. Lembre-se de que o apiVersion pode mudar dependendo do recurso no escopo.

Arquivo de modelo

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "scope": {
        "type": "string"
    },
    "workspaceId": {
        "type": "string"
    },
    "settingName": {
        "type": "string"
    }
},
  "resources": [
    {
      "type": "Microsoft.Insights/diagnosticSettings",
      "apiVersion": "2021-05-01-preview",
      "scope": "[parameters('scope')]",
      "name": "[parameters('settingName')]",
      "properties": {
       "workspaceId": "[parameters('workspaceId')]",
      "logs": [
             {
            "category": null,
            "categoryGroup": "audit",
            "enabled": true
          }
        ]
      }
    }
  ]
  }

Arquivo de parâmetros

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "settingName": {
        "value": "audit3"
    },
    "workspaceId": {
      "value": "/subscriptions/<subscription id>/resourcegroups/<resourcegroup name>/providers/microsoft.operationalinsights/workspaces/<workspace name>"
    },
    "scope": {
      "value": "Microsoft.<resource type>/<resourceName>"
    }
  }
}

REST API

Para criar ou atualizar as configurações de diagnóstico usando a API REST do Azure Monitor, confira Configurações de diagnóstico.

Azure Policy

Para obter detalhes sobre como usar o Azure Policy para criar configurações de diagnóstico em escala, confira Criar configurações de diagnóstico em escala usando o Azure Policy.

Solução de problemas

Aqui estão algumas dicas para solucionar problemas.

Não há suporte para a categoria de métrica

Quando você implanta uma configuração de diagnóstico, você recebe uma mensagem de erro semelhante a "A categoria de métrica 'xxxx' não é suportada". Você pode receber esse erro mesmo que sua implantação anterior tenha sido bem-sucedida.

O problema ocorre quando você usa um modelo do Resource Manager, a API REST, a CLI do Azure ou o Azure PowerShell. As configurações de diagnóstico criadas por meio do portal do Azure não são afetadas, porque apenas os nomes de categoria com suporte são apresentados.

O problema ocorre devido a uma alteração recente na API subjacente. Não há e nunca houve suporte para categorias de métrica diferentes de AllMetrics, exceto para alguns serviços do Azure muito específicos. No passado, outros nomes de categoria foram ignorados ao se implantar uma configuração de diagnóstico. O back-end do Azure Monitor redirecionava essas categorias para AllMetrics. A partir de fevereiro de 2021, o back-end foi atualizado para confirmar especificamente que a categoria de métrica fornecida é precisa. Essa alteração pode causar a falha de algumas implantações.

Caso receba esse erro, atualize suas implantações para substituir quaisquer nomes de categoria de métricas por AllMetrics para corrigir o problema. Se a implantação tiver sido adicionada anteriormente a várias categorias, mantenha apenas uma com a referência AllMetrics. Caso continue tendo esse problema, entre em contato com o Suporte do Azure pelo portal do Azure.

A configuração desapareceu devido aos caracteres não ASCII no resourceID

As configurações de diagnóstico não dão suporte às IDs de recurso com caracteres não ASCII. Por exemplo, considere o termo "Preproducción". Por não poder renomear recursos no Azure, a sua única opção é criar um novo recurso sem os caracteres não ASCII. Se os caracteres estão em um grupo de recursos, você pode mover esses recursos para um novo. Caso contrário, você precisará recriar o recurso.

Possibilidade de dados duplicados ou removidos

Todos os esforços são feitos para garantir que todos os dados de log sejam enviados corretamente aos seus destinos, no entanto, não é possível garantir 100% de transferência de dados de logs entre pontos de extremidade. Novas tentativas e outros mecanismos estão em vigor para contornar esses problemas e tentar garantir que os dados de log cheguem ao ponto de extremidade.

Recursos inativos

Quando um recurso está inativo e exportando métricas de valor zero, o mecanismo de exportação das configurações de diagnóstico reduz gradualmente a frequência para evitar custos desnecessários de exportação e armazenamento de valores zero. A retirada pode levar a um atraso na exportação do próximo valor diferente de zero.

Quando um recurso fica inativo por uma hora, o mecanismo de exportação recua para 15 minutos. Isso significa que há uma possível latência de até 15 minutos para que o próximo valor diferente de zero seja exportado. O tempo máximo de retirada de duas horas é atingido após sete dias de inatividade. Quando o recurso começa a exportar valores diferentes de zero, o mecanismo de exportação retorna à latência de exportação original de três minutos.

Esse comportamento se aplica apenas às métricas exportadas e não afeta alertas baseados em métricas ou o dimensionamento automático.

Próximas etapas

• Revise como trabalhar com configurações de diagnóstico no Azure Monitor
• Migrar a retenção de armazenamento de configurações de diagnóstico para o gerenciamento do ciclo de vida do Armazenamento do Azure
• Leia mais sobre os logs da plataforma do Azure