Criar e editar regras de coleta de dados (DCRs) no Azure Monitor

Artigo
04/04/2024

Há vários métodos para criar uma regra de coleta de dados (DCR) no Azure Monitor. Em alguns casos, o Azure Monitor criará e gerenciará o DCR de acordo com as configurações definidas no portal do Azure. Em outros casos, talvez seja necessário criar seus próprios DCRs para personalizar cenários específicos.

Este artigo descreve os diferentes métodos para criar e editar um DCR. Para obter o conteúdo do DCR em si, consulte Estrutura de uma regra de coleta de dados no Azure Monitor.

Permissões

Você precisa das seguintes permissões para criar DCRs e associações:

Função incorporada	Âmbitos	Razão
Contribuidor de Monitorização	Subscrição e/ou Grupo de recursos e/ou Um DCR existente	Crie ou edite DCRs, atribua regras à máquina, implante associações.
Contribuidor de Máquina Virtual Azure Connected Machine Resource Administrator	Máquinas virtuais, conjuntos de dimensionamento de máquinas virtuais Servidores compatíveis com o Azure Arc	Implante extensões de agente na VM.
Qualquer função que inclua a ação Microsoft.Resources/deployments/*	Subscrição e/ou Grupo de recursos e/ou Um DCR existente	Implante modelos do Azure Resource Manager.

Métodos automatizados para criar um DCR

A tabela a seguir lista métodos para criar cenários de coleta de dados usando o portal do Azure onde o DCR é criado para você. Nesses casos, você não precisa interagir diretamente com o DCR em si.

Cenário	Recursos	Description
Agente do Azure Monitor	Configurar a coleta de dados para o Azure Monitor Agent	Use o portal do Azure para criar um DCR que especifica eventos e contadores de desempenho a serem coletados de uma máquina com o Azure Monitor Agent. Em seguida, associe essa regra a uma ou mais máquinas virtuais. O Azure Monitor Agent será instalado em qualquer máquina que não o tenha no momento.
	Habilitar visão geral de insights de VM	Quando você habilita insights de VM em uma VM, o agente do Azure Monitor é instalado e um DCR é criado que coleta um conjunto predefinido de contadores de desempenho. Você não deve modificar este DCR.
Informações de contentores	Habilitar insights de contêiner	Quando você habilita Insights de contêiner em um cluster Kubernetes, uma versão conteinerizada do agente do Azure Monitor é instalada e um DCR é criado que coleta dados de acordo com a configuração selecionada. Talvez seja necessário modificar esse DCR para adicionar uma transformação.
Logs de texto ou JSON	Coletar logs de um arquivo de texto ou JSON com o Azure Monitor Agent	Use o portal do Azure para criar um DCR para coletar entradas de um log de texto em uma máquina com o Azure Monitor Agent.

Criar manualmente um DCR

Para criar manualmente um DCR, crie um arquivo JSON usando a configuração apropriada para a coleta de dados que você está configurando. Comece com um dos DCRs de exemplo e use as informações em Estrutura de uma regra de coleta de dados no Azure Monitor para modificar o arquivo JSON para seu ambiente e requisitos específicos.

Depois de criar o arquivo JSON, você pode usar qualquer um dos seguintes métodos para criar o DCR:

Use o comando az monitor data-collection rule create para criar um DCR a partir do seu arquivo JSON usando a CLI do Azure, conforme mostrado no exemplo a seguir.

az monitor data-collection rule create --location 'eastus' --resource-group 'my-resource-group' --name 'myDCRName' --rule-file 'C:\MyNewDCR.json' --description 'This is my new DCR'

Use o cmdlet New-AzDataCollectionRule para criar o DCR a partir do arquivo JSON usando o PowerShell, conforme mostrado no exemplo a seguir.

New-AzDataCollectionRule -Location 'east-us' -ResourceGroupName 'my-resource-group' -RuleName 'myDCRName' -RuleFile 'C:\MyNewDCR.json' -Description 'This is my new DCR'

Use a API de criação de DCR para criar o DCR a partir do seu arquivo JSON. Você pode usar qualquer método para chamar uma API REST, conforme mostrado nos exemplos a seguir.

$ResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/dataCollectionRules/my-dcr"
$FilePath = ".\my-dcr.json"
$DCRContent = Get-Content $FilePath -Raw 
Invoke-AzRestMethod -Path ("$ResourceId"+"?api-version=2022-06-01") -Method PUT -Payload $DCRContent

ResourceId="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/dataCollectionRules/my-dcr"
FilePath="my-dcr.json"
az rest --method put --url $ResourceId"?api-version=2022-06-01" --body @$FilePath

Consulte as referências a seguir para definir DCRs e associações em um modelo.

Use o modelo a seguir para criar um DCR usando informações de Estrutura de uma regra de coleta de dados no Monitor do Azure e Regras de coleta de dados de exemplo (DCRs) no Azure Monitor para definir o dcr-properties.

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "dataCollectionRuleName": {
            "type": "string",
            "metadata": {
                "description": "Specifies the name of the Data Collection Rule to create."
            }
        },
        "location": {
            "type": "string",
            "metadata": {
                "description": "Specifies the location in which to create the Data Collection Rule."
            }
        }
    },
    "resources": [
        {
            "type": "Microsoft.Insights/dataCollectionRules",
            "name": "[parameters('dataCollectionRuleName')]",
            "location": "[parameters('location')]",
            "apiVersion": "2021-09-01-preview",
            "properties": {
                "<dcr-properties>"
            }
        }
    ]
}

Associação DCR -Azure VM

O exemplo a seguir cria uma associação entre uma máquina virtual do Azure e uma regra de coleta de dados.

Arquivo de modelo do bíceps

@description('The name of the virtual machine.')
param vmName string

@description('The name of the association.')
param associationName string

@description('The resource ID of the data collection rule.')
param dataCollectionRuleId string

resource vm 'Microsoft.Compute/virtualMachines@2021-11-01' existing = {
  name: vmName
}

resource association 'Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview' = {
  name: associationName
  scope: vm
  properties: {
    description: 'Association of data collection rule. Deleting this association will break the data collection for this virtual machine.'
    dataCollectionRuleId: dataCollectionRuleId
  }
}

Arquivo de modelo ARM

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of the virtual machine."
      }
    },
    "associationName": {
      "type": "string",
      "metadata": {
        "description": "The name of the association."
      }
    },
    "dataCollectionRuleId": {
      "type": "string",
      "metadata": {
        "description": "The resource ID of the data collection rule."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Insights/dataCollectionRuleAssociations",
      "apiVersion": "2021-09-01-preview",
      "scope": "[format('Microsoft.Compute/virtualMachines/{0}', parameters('vmName'))]",
      "name": "[parameters('associationName')]",
      "properties": {
        "description": "Association of data collection rule. Deleting this association will break the data collection for this virtual machine.",
        "dataCollectionRuleId": "[parameters('dataCollectionRuleId')]"
      }
    }
  ]
}

Arquivo de parâmetros

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "value": "my-azure-vm"
    },
    "associationName": {
      "value": "my-windows-vm-my-dcr"
    },
    "dataCollectionRuleId": {
      "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/microsoft.insights/datacollectionrules/my-dcr"
    }
   }
}

DCR Association - Servidor habilitado para Arc

O exemplo a seguir cria uma associação entre um servidor habilitado para Azure Arc e uma regra de coleta de dados.

Arquivo de modelo do bíceps

@description('The name of the virtual machine.')
param vmName string

@description('The name of the association.')
param associationName string

@description('The resource ID of the data collection rule.')
param dataCollectionRuleId string

resource vm 'Microsoft.HybridCompute/machines@2021-11-01' existing = {
  name: vmName
}

resource association 'Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview' = {
  name: associationName
  scope: vm
  properties: {
    description: 'Association of data collection rule. Deleting this association will break the data collection for this Arc server.'
    dataCollectionRuleId: dataCollectionRuleId
  }
}

Arquivo de modelo ARM

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of the virtual machine."
      }
    },
    "associationName": {
      "type": "string",
      "metadata": {
        "description": "The name of the association."
      }
    },
    "dataCollectionRuleId": {
      "type": "string",
      "metadata": {
        "description": "The resource ID of the data collection rule."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Insights/dataCollectionRuleAssociations",
      "apiVersion": "2021-09-01-preview",
      "scope": "[format('Microsoft.HybridCompute/machines/{0}', parameters('vmName'))]",
      "name": "[parameters('associationName')]",
      "properties": {
        "description": "Association of data collection rule. Deleting this association will break the data collection for this Arc server.",
        "dataCollectionRuleId": "[parameters('dataCollectionRuleId')]"
      }
    }
  ]
}

Arquivo de parâmetros

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "value": "my-hybrid-vm"
    },
    "associationName": {
      "value": "my-windows-vm-my-dcr"
    },
    "dataCollectionRuleId": {
      "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/microsoft.insights/datacollectionrules/my-dcr"
    }
   }
}

Editar um DCR

Para editar um DCR, você pode usar qualquer um dos métodos descritos na seção anterior para criar um DCR usando uma versão modificada do JSON.

Se você precisar recuperar o JSON para um DCR existente, poderá copiá-lo do Modo de Exibição JSON para o DCR no portal do Azure. Você também pode recuperá-lo usando uma chamada de API, conforme mostrado no exemplo do PowerShell a seguir.

$ResourceId = "<ResourceId>" # Resource ID of the DCR to edit
$FilePath = "<FilePath>" # Store DCR content in this file
$DCR = Invoke-AzRestMethod -Path ("$ResourceId"+"?api-version=2022-06-01") -Method GET
$DCR.Content | ConvertFrom-Json | ConvertTo-Json -Depth 20 | Out-File -FilePath $FilePath

Para obter um tutorial que percorre o processo de recuperação e, em seguida, edição de um DCR existente, consulte Tutorial: Editar uma regra de coleta de dados (DCR).

Share via