Alertas de SQL do Databricks

Esta página fornece diretrizes passo a passo para habilitar e usar alertas sql do Databricks para automatizar a execução da consulta, avaliar condições personalizadas e fornecer notificações quando essas condições forem atendidas. Com alertas, você pode monitorar proativamente seus dados de negócios e receber notificações oportunas sempre que os valores relatados estiverem fora dos limites esperados. Quando você agenda um alerta, a consulta associada é executada e os critérios de alerta são verificados, independentemente de quaisquer agendas existentes na consulta subjacente. Além disso, você pode acessar um histórico de alertas para examinar os resultados de avaliações de alertas anteriores.

Para saber como trabalhar com alertas herdados, confira o que são alertas herdados?.

Ativar alertas na sua área de trabalho

Os administradores do espaço de trabalho podem controlar o acesso a essa pré-visualização na página de Pré-visualizações. Ativar essa visualização não afeta seus alertas existentes; você pode continuar usando tanto esses alertas existentes quanto os alertas herdados em paralelo.

Exibir e organizar os alertas

Clique no Alertas na barra lateral para abrir a página de listagem de alertas.

• A guia Alertas é aberta por padrão e mostra todos os alertas no workspace. Você pode digitar para filtrar por nome. Clique apenas em meus alertas para mostrar apenas os alertas em que você é o proprietário.

• A aba Alertas herdados mostra alertas que foram criados usando o sistema de alertas anterior.

• Nome mostra o nome da cadeia de caracteres de cada alerta.

• O status mostra se o status do alerta é TRIGGERED, OKou ERROR.

• A agenda mostra a hora ou a data da última atualização.

• O proprietário mostra o nome de usuário da pessoa que possui o alerta.

• Criado em mostra a data e a hora em que o alerta foi criado.

  • TRIGGERED significa que, na execução mais recente, a coluna Valor em sua consulta de destino atingiu a Condição e o Limite configurados. Se o seu alerta verificar se "gatos" estão acima de 1500, seu alerta será disparado enquanto "gatos" estejam acima de 1500.
  • OK significa que, na execução da consulta mais recente, a coluna Valor não cumpriu a Condição e o Limite configurados. Isso não significa que o alerta não foi disparado anteriormente. Se o valor de "gatos" agora for 1470, seu alerta será mostrado como OK.
  • ERROR indica que ocorreu um erro durante a avaliação do alerta.

Criar um alerta

As etapas nesta seção explicam como criar o alerta mostrado na imagem a seguir. Use os rótulos e explicações para entender cada componente.

1. Editor de consultas: Escreva e teste a consulta na qual você deseja alertar.

2. Horário: Defina uma agenda periódica para a execução do alerta.

3. Condição: Selecione o limite de valor que deve disparar uma notificação de alerta. Você pode executar a consulta para testar a condição desta seção.

4. Notificações: Indique quais usuários ou destinos de notificação devem ser alertados quando o valor do limite estiver fora do intervalo esperado.

5. Avançado: Use configurações avançadas para alertar sobre valores e condições especiais.

Use as seguintes etapas para criar um alerta:

1. Clique em Alertas na barra lateral e clique em Criar Alerta.

2. Copie e cole a consulta a seguir no editor de consultas. Clique em Executar tudo (1000). Para saber mais sobre como trabalhar com o editor do SQL, consulte Escrever consultas e explorar dados no novo editor do SQL.

   SELECT
     to_date(tpep_pickup_datetime) as date,
     SUM(fare_amount) as amount
   FROM
     `samples`.`nyctaxi`.`trips`
   GROUP BY
     ALL
   ORDER BY
     1 DESC
   
   

3. No campo Condição , defina as condições que devem disparar o alerta.

   

   Aplique as seguintes configurações, conforme mostrado:

   • Selecione Soma como o valor de dados a ser verificado. As condições de alerta podem ser definidas no primeiro valor de uma coluna no resultado da consulta ou você pode optar por definir uma agregação em todas as linhas de uma única coluna, como SOMA ou MÉDIA.
   • Selecione o valor como a coluna a ser verificada.
   • Selecione > (maior que) como o operador lógico a ser aplicado.
   • Defina o valor limite como Static value 4000. O valor estático é selecionado por padrão. Insira 4000 no campo de valor.

4. Clique na condição de teste para visualizar o alerta e testar se o alerta seria disparado com os dados atuais. As configurações fornecidas devem disparar o alerta. Você pode alterar o valor do limite para testar ainda mais.

5. Na seção Notificações , pesquise seu nome de usuário e clique nele quando ele aparecer.

6. Clique no O ícone do calendário para abrir a caixa de diálogo Editar agendamento . Use os menus suspensos para definir o alerta para que ele seja executado a cada 5minutos a partir de 0 minutos após a hora. Clique em Salvar. Opcionalmente, marque a caixa de seleção Mostrar sintaxe cron para editar o agendamento na Sintaxe Quartz Cron.

7. Clique em Exibir alerta.

Seu alerta foi salvo e será executado conforme o cronograma fornecido. Os dados usados neste exemplo são estáticos, portanto, se sua condição de teste retornou como Disparada, isso acontecerá novamente na próxima vez que for executada. Você recebe uma notificação por email como um alerta. Se a condição de teste retornar OK, nenhuma notificação será enviada.

Examinar os detalhes do alerta

Uma página é aberta para mostrar os detalhes do alerta. Além disso, um histórico de alertas é mostrado com detalhes do histórico de avaliação. Clique no botão Executar agora para executar a consulta de alerta imediatamente e retornar o resultado nesta tela.

Clique em Editar no canto superior direito da página para continuar editando o alerta.

Configurações avançadas

Clique em Configurações avançadas para aplicar as seguintes configurações:

• Notificar ao ok: Enviar uma notificação quando o alerta retornar como OK.

• Frequência de notificação: Enviar periodicamente notificações sobre um alerta até que o status retorne a OK.

• Estado de resultado vazio: Defina um status especial a ser retornado quando a consulta não retornar resultados.

• Modelo: Você pode optar por enviar notificações usando o modelo padrão ou um modelo personalizado. A lista a seguir explica cada tipo de modelo:

  • Usar modelo padrão: a notificação de alerta é uma mensagem com links para a tela Configuração de alertas e a tela Consulta.

  • Usar modelo personalizado: a notificação de alertas inclui informações mais específicas sobre o alerta.

    1. Uma caixa composta de campos de entrada para o assunto e o corpo é exibida. Qualquer conteúdo estático é válido e você pode incorporar variáveis de modelo internas:

       • ALERT_STATUS: o status do alerta avaliado (cadeia de caracteres).
       • ALERT_CONDITION: o operador de condição de alerta (cadeia de caracteres).
       • ALERT_THRESHOLD: o limite de alertas (cadeia de caracteres ou número).
       • ALERT_COLUMN: o nome da coluna de alerta (cadeia de caracteres).
       • ALERT_NAME: o nome do alerta (cadeia de caracteres).
       • ALERT_URL: a URL da página de alerta (cadeia de caracteres).
       • QUERY_RESULT_TABLE: a tabela HTML do resultado da consulta (cadeia de caracteres). Os resultados são limitados às primeiras 100 linhas. Somente destinos de notificação por email podem renderizar HTML.
       • QUERY_RESULT_VALUE: o valor do resultado da consulta (cadeia de caracteres ou número).
       • QUERY_RESULT_ROWS: as linhas de resultado da consulta (matriz de valores).
       • QUERY_RESULT_COLS: as colunas de resultado da consulta (matriz de cadeia de caracteres).

       Um assunto de exemplo, por exemplo, poderia ser: Alert "{{ALERT_NAME}}" changed status to {{ALERT_STATUS}}.

    2. Você pode usar HTML para formatar mensagens em um modelo personalizado. Somente destinos de notificação por email podem renderizar HTML. As seguintes marcas e atributos são permitidos em modelos:

       • Marcas permitidas: <a>, <b>, <blockquote>, <br>, <code>, <del>, <div>, <em>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <hr>, <i>, <img>, <li>, <ol>, <p>, <pre>, <span>, <table>, <thread>, <tbody>, <td>, <th>, <tr>, <u>, <ul>

       • Atributos permitidos:

         Atributo	Marcas com suporte
         href	<a>
         title	<img>
         target	<a>
         alt	<img>
         src	<img>
         start	<b>, <blockquote>, <code>, <del>, , <em>, <hr>, <i>, , <pre><u>

    3. Selecione o botão de alternância Visualização para ver o resultado renderizado.

       Importante

       A visualização é útil para verificar se as variáveis de modelo foram renderizadas corretamente. Não é uma representação precisa do conteúdo de notificação eventual, pois cada destino de notificação pode exibir notificações de maneira diferente.

Os administradores do workspace podem configurar novos destinos de notificação. Confira Gerenciar destinos de notificação.

Agregações de alerta

Uma agregação em um alerta funciona modificando o SQL original da consulta SQL do Databricks anexada ao alerta. O alerta encapsula o texto da consulta original em uma expressão de tabela comum (CTE) e executa uma consulta de agregação envolvente nela para agregar o resultado da consulta.

Por exemplo, uma agregação SUM em um alerta anexado a uma consulta com texto SELECT 1 AS column_name significa que sempre que o alerta é atualizado, o SQL modificado executado seria: WITH q AS (SELECT 1 AS column_name) SELECT SUM(column_name) FROM q.

Isso significa que o resultado da consulta original (pré-agregado) não pode ser mostrado em um corpo personalizado de alerta (com parâmetros como QUERY_RESULT_ROWS e QUERY_RESULT_COLS) sempre que houver uma agregação em um alerta. Em vez disso, essas variáveis exibirão apenas o resultado final da consulta pós-agregação.

Alerta em várias colunas

Para definir um alerta com base em várias colunas de uma consulta, sua consulta pode implementar a lógica de alerta e retornar um valor booliano para o alerta a ser disparado. Por exemplo:

SELECT CASE WHEN drafts_count > 10000 AND archived_count > 5000 THEN 1 ELSE 0 END
FROM (
SELECT sum(CASE WHEN is_archived THEN 1 ELSE 0 END) AS archived_count,
sum(CASE WHEN is_draft THEN 1 ELSE 0 END) AS drafts_count
FROM queries) data

A consulta retorna 1 quando drafts_count > 10000 and archived_count > 5000. Em seguida, você pode configurar o alerta para disparar quando o valor for 1.

Alerta sobre visualizações de métricas

Como as exibições de métrica são projetadas para acompanhar e medir as principais métricas de negócios, elas combinam bem com alertas para que você possa ser notificado automaticamente quando uma métrica estiver fora de um intervalo esperado. Os alertas sobre exibições de métrica funcionam da mesma forma que um alerta em qualquer outro conjunto de dados. Ao escrever a consulta para configurar a consulta, use o nome totalmente qualificado da exibição de métrica que deseja monitorar.

Como a integração do Git funciona com alertas

Você pode usar pastas Git do Databricks para controlar e gerenciar alterações em alertas. Para acompanhar alertas com o Git, coloque-os em uma pasta do Git do Databricks. Os alertas clonados recentemente só aparecem na página de lista de alertas ou na API depois que um usuário interage com eles. Eles pausaram agendas e precisam ser explicitamente retomados pelos usuários.

As pastas Git do Databricks fornecem uma maneira centralizada de gerenciar operações comuns do Git para alertas e outros objetos de workspace. Para saber mais, confira as pastas git do Azure Databricks.

Diferenças em relação aos alertas herdados

A versão mais recente dos alertas do Databricks SQL se comporta de forma diferente dos alertas herdados de algumas maneiras principais:

• Integração de Jobs: A versão mais recente ainda não suporta diretamente a referência de um alerta no pipeline de Jobs. Esse recurso estará disponível em breve. Os alertas herdados dão suporte ao tipo de tarefa de Alertas em Jobs.
• Reutilização da consulta: Uma consulta SQL salva existente não pode ser reutilizada ao criar um alerta. Cada alerta possui sua definição de consulta, que pode ser criada diretamente no novo editor de alertas.
• Valores de status de alerta: Os estados de alerta são simplificados e os alertas não dão mais suporte ao UNKNOWN status de alertas herdados. As avaliações se resolvem em OK, TRIGGERED, ou ERROR.

Você pode continuar a usar os alertas mais recentes e alertas herdados lado a lado durante a transição.

Configurar permissões de acesso ao alerta e transferir a propriedade do alerta

Para obter níveis de permissão de alerta, consulte ACLs de alertas.

1. Na barra lateral, clique em Alertas.

2. Clique em um alerta.

3. Clique em Compartilhar no canto superior direito da página de detalhes do alerta para abrir a caixa de diálogo Compartilhamento .

   

4. Pesquise e selecione os grupos e usuários e atribua o nível de permissão.

5. Clique em Adicionar.

Transferir a propriedade de um alerta

Ao salvar um alerta, você se torna o proprietário do alerta. Se o proprietário de um alerta for removido de um workspace, o alerta não terá mais um proprietário. Um usuário administrador de workspace pode transferir a propriedade de um alerta para um usuário diferente. Você também pode transferir a propriedade usando a API de Permissões.

1. Como administrador do workspace, faça logon no workspace do Azure Databricks.

2. Na barra lateral, clique em Alertas.

3. Clique em um alerta.

4. Clique no botão Compartilhar no canto superior direito para abrir a caixa de diálogo Compartilhamento.

5. Clique no ícone de engrenagem no canto superior direito e clique em Atribuir novo proprietário.

   

6. Selecione o usuário ao qual a propriedade será atribuída.

7. Clique em Confirmar.