Defina monitoramento personalizado com ganchos de eventos

Visualização

O suporte para ganchos de eventos está em Public Preview.

Você pode usar ganchos de eventos para adicionar funções de retorno de chamada Python personalizadas que são executadas quando os eventos são persistidos nos logsde eventos de um pipeline do Delta Live Tables. Você pode usar ganchos de eventos para implementar soluções personalizadas de monitoramento e alertas. Por exemplo, você pode usar ganchos de eventos para enviar email ou gravar em logs quando ocorrem eventos específicos ou para integrar soluções de terceiros para monitorar eventos de pipeline.

Você define um gancho de evento com uma função Python que aceita um único argumento, onde o argumento é um dicionário que representa um evento. Em seguida, você inclui os ganchos de eventos como parte do código-fonte de um pipeline. Quaisquer ganchos de eventos definidos em um pipeline tentarão processar todos os eventos gerados durante cada atualização do pipeline. Se o seu pipeline for composto por vários artefatos de código-fonte, por exemplo, vários Notebook, quaisquer ganchos de eventos definidos serão aplicados a todo o pipeline. Embora os ganchos de eventos estejam incluídos no código-fonte do seu pipeline, eles não estão incluídos no gráfico do pipeline.

Você pode usar ganchos de eventos com pipeline que publicam no Hive metastore ou Unity Catalog.

Observação

  • Python é a única linguagem suportada para definir ganchos de eventos.

  • Os ganchos de eventos são acionados apenas para eventos em que o nível de maturidade é STABLE.

  • Os ganchos de eventos são executados de forma assíncrona a partir de atualizações de pipeline, mas de forma síncrona com outros ganchos de eventos. Isso significa que apenas um único gancho de evento é executado por vez, e outros ganchos de eventos aguardam para serem executados até que o gancho de evento em execução no momento seja concluído. Se um gancho de evento for executado indefinidamente, ele bloqueará todos os outros ganchos de evento.

  • Delta Live Tables tenta executar cada gancho de evento em cada evento emitido durante uma atualização de pipeline. Para ajudar a garantir que os ganchos de eventos atrasados tenham tempo para processar todos os eventos enfileirados, o Delta Live Tables aguarda um período fixo não configurável antes de encerrar a compute que executa o pipeline. No entanto, não é garantido que todos os ganchos sejam acionados em todos os eventos antes do término da compute .

Monitore o processamento do gancho de eventos

Use o tipo de evento hook_progress nos logs de eventos Delta Live Tables para monitorar o estado dos ganchos de eventos de uma atualização. Para evitar dependências circulares, os ganchos de eventos não são acionados para eventos hook_progress .

Defina um gancho de evento

Para definir um gancho de evento, use o decorador on_event_hook :

@dlt.on_event_hook(max_allowable_consecutive_failures=None)
def user_event_hook(event):
  # Python code defining the event hook

O max_allowable_consecutive_failures descreve o número máximo de vezes consecutivas que um gancho de evento pode falhar antes de ser desativado. Uma falha no gancho de evento é definida sempre que o gancho de evento lança uma exceção. Se um gancho de evento estiver desabilitado, ele não processará novos eventos até que o pipeline seja reiniciado.

max_allowable_consecutive_failures deve ser um número inteiro maior ou igual a 0 ou None. Um valor None (atribuído por default) significa que não há limite para o número de falhas consecutivas permitidas para o gancho de evento e que o gancho de evento nunca é desabilitado.

Falhas de ganchos de eventos e desativação de ganchos de eventos podem ser monitoradas nos logs de eventos como eventos hook_progress.

A função de gancho de evento deve ser uma função Python que aceita exatamente um parâmetro, uma representação de dicionário do evento que acionou esse gancho de evento. Qualquer valor de retorno da função de gancho de evento é ignorado.

Exemplo: Selecione eventos específicos para processamento

O exemplo a seguir demonstra um gancho de evento que seleciona eventos específicos para processamento. Especificamente, este exemplo espera até que os eventos do pipeline STOPPING sejam recebidos e, em seguida, envia uma mensagem para os logs do driver stdout.

@on_event_hook
def my_event_hook(event):
  if (
    event['event_type'] == 'update_progress' and
    event['details']['update_progress']['state'] == 'STOPPING'
  ):
    print('Received notification that update is stopping: ', event)

Exemplo: Envie todos os eventos para um canal do Slack

O exemplo a seguir implementa um gancho de evento que envia todos os eventos recebidos para um canal do Slack usando a API do Slack.

Este exemplo usa um segredo do Databricks para armazenar com segurança os tokens necessários para autenticação na API do Slack.

from dlt import on_event_hook
import requests

# Get a Slack API token from a Databricks secret scope.
API_TOKEN = dbutils.secrets.get(scope="<secret-scope>", key="<token-key>")

@on_event_hook
def write_events_to_slack(event):
  res = requests.post(
    url='https://slack.com/api/chat.postMessage',
    headers={
      'Content-Type': 'application/json',
      'Authorization': 'Bearer ' + API_TOKEN,
    },
    json={
      'channel': '<channel-id>',
      'text': 'Received event:\n' + event,
    }
  )

Exemplo: Configurar um gancho de evento para desabilitar após quatro falhas consecutivas

O exemplo a seguir demonstra como configurar um gancho de evento que será desabilitado se falhar consecutivamente quatro vezes.

from dlt import on_event_hook
import random

def run_failing_operation():
   raise Exception('Operation has failed')


# Allow up to 3 consecutive failures. After a 4th consecutive
# failure, this hook is disabled.
@on_event_hook(max_allowable_consecutive_failures=3)
def non_reliable_event_hook(event):
  run_failing_operation()

Exemplo: um pipeline Delta Live Tables com um gancho de evento

O exemplo a seguir demonstra a adição de um gancho de evento ao código-fonte de um pipeline. Este é um exemplo simples, mas completo, de uso de ganchos de eventos com um pipeline.

from dlt import table, on_event_hook, read
import requests
import json
import time

API_TOKEN = dbutils.secrets.get(scope="<secret-scope>", key="<token-key>")
SLACK_POST_MESSAGE_URL = 'https://slack.com/api/chat.postMessage'
DEV_CHANNEL = 'CHANNEL'
SLACK_HTTPS_HEADER_COMMON = {
 'Content-Type': 'application/json',
 'Authorization': 'Bearer ' + API_TOKEN
}

# Create a single dataset.
@table
def test_dataset():
 return spark.range(5)


# Definition of event hook to send events to a Slack channel.
@on_event_hook
def write_events_to_slack(event):
  res = requests.post(url=SLACK_POST_MESSAGE_URL, headers=SLACK_HTTPS_HEADER_COMMON, json = {
    'channel': DEV_CHANNEL,
    'text': 'Event hook triggered by event: ' + event['event_type'] + ' event.'
  })