Compartilhar via

Configurar logs de diagnóstico por meio da API REST do Azure Monitor

  • Artigo

Este artigo descreve como configurar logs de diagnóstico para o Azure Data Factory usando a API REST do Azure Monitor.

Configurações de Diagnóstico

Use as configurações de diagnóstico a fim de configurar logs de diagnóstico para recursos que não sejam de computação. As configurações de um controle de recurso têm os seguintes recursos:

  • Elas especificam para onde os logs de diagnóstico são enviados. Os exemplos incluem uma Conta de Armazenamento do Azure, um hub de eventos do Azure ou logs do Monitor.
  • Elas especificam quais categorias de log são enviadas.
  • Especificam por quanto tempo cada categoria de log deve ser mantida em uma conta de armazenamento.
  • Uma retenção de zero dias significa que os logs serão mantidos indefinidamente. Por outro lado, o valor pode ser qualquer número de dias, entre 1 e 2.147.483.647.
  • Se as políticas de retenção estiverem definidas, mas o armazenamento dos logs em uma conta de armazenamento estiver desabilitado, as políticas de retenção não terão nenhum efeito. Por exemplo, essa condição pode ocorrer quando apenas as opções de logs dos hubs de eventos ou do Monitor são selecionadas.
  • As políticas de retenção são aplicadas por dia. O limite entre os dias ocorre à meia-noite no UTC (Tempo Universal Coordenado). No final de um dia, os logs de dias que ultrapassarem a política de retenção são excluídos. Por exemplo, se houver uma política de retenção de um dia, no início do dia de hoje, os logs de anteontem serão excluídos.

Habilitar os logs de diagnóstico por meio da API REST do Monitor

Use a API REST do Monitor para habilitar os logs de diagnóstico.

Criar ou atualizar uma configuração de diagnóstico na API REST do Monitor

Solicitação

PUT
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Cabeçalhos

Corpo

{
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "metrics": [
        ],
        "logs": [
                {
                    "category": "PipelineRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "TriggerRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "ActivityRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                }
            ]
    },
    "location": ""
}
Propriedade Type Descrição
storageAccountId String A ID do recurso da conta de armazenamento a qual você deseja enviar os logs de diagnóstico.
serviceBusRuleId String A ID da regra de barramento de serviço do namespace do barramento de serviço no qual os hubs de eventos devem ser criados para transmitir logs de diagnóstico. A ID da regra tem o formato {service bus resource ID}/authorizationrules/{key name}.
workspaceId String A ID do workspace em que os logs serão salvos.
métricas Valores de parâmetro da execução do pipeline a serem passados para o pipeline invocado Um objeto JSON que mapeia os nomes de parâmetro para os valores de argumento.
logs Tipo complexo O nome de uma categoria de log de diagnóstico de um tipo de recurso. Para obter a lista de categorias de log de diagnóstico de um recurso, realize uma operação de configurações de diagnóstico GET.
category String Uma matriz de categorias de log e suas políticas de retenção.
timeGrain String A granularidade das métricas que são capturadas no formato de duração ISO 8601. O valor da propriedade deve ser PT1M, que especifica um minuto.
Habilitado Boolean Especifica se a coleção da métrica ou da categoria de log está habilitada para este recurso.
retentionPolicy Tipo complexo Descreve a política de retenção para uma categoria de métrica ou de log. Essa propriedade é usada somente para contas de armazenamento.
dias int O número de dias para manter as métricas ou os logs. Se o valor da propriedade for 0, os logs serão mantidos para sempre. Essa propriedade é usada somente para contas de armazenamento.

Resposta

200 OK.

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

Obtenha informações sobre as configurações de diagnóstico na API REST do Monitor

Solicitação

GET
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Cabeçalhos

Resposta

200 OK.

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.Storage/storageAccounts/azmonlogs",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.EventHub/namespaces/shloeventhub/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/ADF/providers/Microsoft.OperationalInsights/workspaces/mihaipie",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

Para obter mais informações, confira Configurações de diagnóstico.

Conteúdo relacionado

Monitorar as operações do SSIS com o Azure Monitor