Adicionar e-mail e notificações do sistema para eventos Job

Você pode monitorar as execuções de um Job e a tarefa que faz parte desse Job configurando notificações quando uma execução começa, é concluída com êxito, falha ou sua duração excede um limite configurado. As notificações podem ser enviadas para um ou mais endereços email ou destinos de sistema, como Slack, Microsoft Teams, PagerDuty ou qualquer serviço baseado em webhook.

Configurar notificações do sistema

Observação

  • Para cada Job ou tarefa, o senhor pode configurar um máximo de três destinos do sistema para cada tipo de evento de notificação.

  • Um administrador deve configurar destinos do sistema. Os destinos do sistema são configurados selecionando Criar novo destino na caixa de diálogo Editar notificações do sistema ou na página de configurações do administrador.

  • As notificações definidas no nível Job não são enviadas quando uma tarefa com falha é repetida. Para receber uma notificação de falha após cada tarefa com falha (incluindo cada nova tentativa com falha), use notificações de tarefa. Para adicionar notificações do sistema para execução de tarefas, clique em + Adicionar ao lado de Notificações no painel de tarefas ao adicionar ou editar uma tarefa Job .

  • Um Job concluído no estado Succeeded with failures é considerado bem-sucedido. Para receber alertas para Job concluídas nesse estado, você deve selecionar Êxito ao configurar notificações.

As notificações do sistema integram-se a ferramentas de notificação populares, incluindo:

Para adicionar uma ou mais notificações do sistema quando a execução deste Job tiver um evento notificável, como início, conclusão ou falha Job :

  1. No painel de detalhesJob para o seu Job, clique em Editar notificações.

  2. Clique em Adicionar notificação e selecione um destino do sistema em Destino.

  3. Em Selecione um destino do sistema, selecione um destino e clique na caixa de seleção de cada tipo de notificação a ser enviada para esse destino.

  4. Para adicionar outro destino, clique em Adicionar notificação novamente.

  5. Clique em Confirmar.

Importante

O conteúdo das mensagens do Slack e do Microsoft Teams pode mudar em versões futuras. Você não deve implementar clientes ou processamentos que dependam do conteúdo específico ou da formatação dessas mensagens. Se necessitar de um esquema ou formatação específica para notificações, a Databricks recomenda configurar um webhook definido pelo utilizador.

Configurar notificações por e-mail

Observação

  • As notificações definidas no nível Job não são enviadas quando uma tarefa com falha é repetida. Para receber uma notificação de falha após cada tarefa com falha (incluindo cada nova tentativa com falha), use notificações de tarefa. Para adicionar notificações email para execução de tarefas, clique em + Adicionar ao lado de Notificações no painel de tarefas ao adicionar ou editar uma tarefa Job .

  • Um Job concluído no estado Succeeded with failures é considerado bem-sucedido. Para receber alertas para Job concluídas nesse estado, você deve selecionar Êxito ao configurar notificações.

Para adicionar um ou mais endereços email para notificar quando a execução deste Job começar, terminar ou falhar:

  1. No painel de detalhesJob para o seu Job, clique em Editar notificações.

  2. Clique em Adicionar notificação e selecione o endereçoemail em Destino.

  3. Insira um endereço email e clique na caixa de seleção de cada tipo de notificação para enviar para esse endereço.

  4. Para inserir outro endereço email para notificação, clique em Adicionar notificação novamente.

  5. Clique em Confirmar.

Você pode usar notificações por e-mail para integração com ferramentas como Amazon SES e SNS.

Configurar notificações para Joblento ou atrasado

Se você configurou uma duração esperada para um Job, poderá adicionar um email ou uma notificação do sistema se o Job exceder a duração configurada. Para receber uma notificação de Job que exceda o limite de duração, clique na caixa de seleção Aviso de duração ao adicionar ou editar uma notificação.

Filtrar notificações para execução ignorada ou cancelada

Você pode reduzir o número de notificações enviadas filtrando as notificações quando uma execução é ignorada ou cancelada. Para filtrar notificações, marque Silenciar notificações para execução ignorada ou Silenciar notificações para execução cancelada ao adicionar ou modificar notificações por e-mail ou notificações do sistema.

Observação

Selecionar Silenciar notificações para execução ignorada ou Silenciar notificações para execução cancelada de um Job não filtra notificações configuradas para tarefas Job . Para filtrar todas as notificações para execução ignorada ou cancelada, você também deve filtrar todas as notificações de nível de tarefa que você configurou.

Cargas úteis de webhook HTTP

Se você estiver usando um webhook HTTP para enviar notificações, a seguir estão exemplos de cargas enviadas pelo Databricks para seu endpoint configurado.

Notificação para um evento de início de execução Job :

{
  "event_type": "jobs.on_start",
  "workspace_id": "your_workspace_id",
  "run": {
    "run_id": "run_id"
  },
  "job": {
    "job_id": "job_id",
    "name": "job_name"
  }
}

Notificação para um evento de início de execução de tarefa:

{
  "event_type": "jobs.on_start",
  "workspace_id": "your_workspace_id",
  "task": {
    "task_key": "task_name"
  },
  "run": {
    "run_id": "run_id_of_task"
    "parent_run_id": "run_id_of_parent_job_run"
  },
  "job": {
    "job_id": "job_id",
    "name": "job_name"
  }
}

Ao configurar destinos, os webhooks podem ser configurados para os seguintes tipos de eventos:

Código do evento

Quando é enviado?

jobs.on_start

A execução começa.

jobs.on_success

Uma execução é interrompida e concluída em um estado bem-sucedido ou bem-sucedido com falhas.

jobs.on_failure

Uma execução é interrompida em um estado malsucedido.

jobs.on_duration_warning_threshold_exceeded

Uma execução está em execução há mais tempo do que a duração esperada configurada.