Criar um monitor usando a API
Importante
Esse recurso está em uma versão prévia.
Esta página descreve como criar um monitor no Databricks usando a API do Python e descreve todos os parâmetros usados na chamada à API. Você também pode criar e gerenciar monitores usando a API REST. Para obter informações de referência, consulte a referência da API do Python de monitoramento do Lakehouse e a referência da API REST.
Você pode criar um monitor em qualquer tabela Delta gerenciada ou externa registrada no Catálogo do Unity. Somente um único monitor pode ser criado em um metastore do Catálogo do Unity para qualquer tabela.
Requisitos
A API de Monitoramento do Lakehouse é integrada ao Databricks Runtime 14.3 LTS e superior. Para usar a versão mais recente da API ou usá-la com versões anteriores do Databricks Runtime, use o seguinte comando no início do notebook para instalar o cliente Python:
%pip install "https://ml-team-public-read.s3.amazonaws.com/wheels/data-monitoring/a4050ef7-b183-47a1-a145-e614628e3146/databricks_lakehouse_monitoring-0.4.14-py3-none-any.whl"
Parâmetro de tipo de perfil
O parâmetro profile_type
determina a classe de métricas que monitora os cálculos da tabela. Há três tipos: TimeSeries, InferenceLog e Snapshot. Esta seção descreve brevemente os parâmetros. Para obter detalhes, confira a referência da API ou a referência da API REST.
Observação
- Quando você cria pela primeira vez um perfil de série temporal ou inferência, o monitor analisa apenas os dados dos 30 dias anteriores à sua criação. Depois que o monitor é criado, todos os novos dados são processados.
- Monitores definidos em exibições materializadas e tabelas de streaming não dão suporte ao processamento incremental.
Perfil de TimeSeries
Um perfil de TimeSeries
compara distribuições de dados entre janelas de tempo. Para um perfil de TimeSeries
, você deve fornecer o seguinte:
- A coluna de carimbo de data/hora (
timestamp_col
). O tipo de dados de coluna de carimbo de data/hora deve serTIMESTAMP
ou um tipo que possa ser convertido em carimbos de data/hora usando ato_timestamp
função PySpark. - O conjunto de
granularities
sobre o qual calcular métricas. As granularidades disponíveis são "5 minutos", "30 minutos", "1 hora", "1 dia", "n semana(s)", "1 mês", "1 ano".
from databricks import lakehouse_monitoring as lm
lm.create_monitor(
table_name=f"{catalog}.{schema}.{table_name}",
profile_type=lm.TimeSeries(
timestamp_col="ts",
granularities=["30 minutes"]
),
output_schema_name=f"{catalog}.{schema}"
)
Perfil de InferenceLog
Um perfil de InferenceLog
é semelhante a um perfil de TimeSeries
, mas também inclui métricas de qualidade do modelo. Para um perfil de InferenceLog
, s seguintes parâmetros são necessários:
Parâmetro | Descrição |
---|---|
problem_type |
“classificação” ou “regressão”. |
prediction_col |
Coluna que contém os valores previstos do modelo. |
timestamp_col |
Coluna que contém o carimbo de data/hora da solicitação de inferência. |
model_id_col |
Coluna que contém a ID do modelo usado para previsão. |
granularities |
Determina como particionar os dados em janelas ao longo do tempo. Valores possíveis: "5 minutos", "30 minutos", "1 hora", "1 dia", "n semana(s)", "1 mês", "1 ano". |
Também há um parâmetro opcional:
Parâmetro opcional | Descrição |
---|---|
label_col |
Coluna que contém a verdade básica para previsões de modelo. |
from databricks import lakehouse_monitoring as lm
lm.create_monitor(
table_name=f"{catalog}.{schema}.{table_name}",
profile_type=lm.InferenceLog(
problem_type="classification",
prediction_col="preds",
timestamp_col="ts",
granularities=["30 minutes", "1 day"],
model_id_col="model_ver",
label_col="label", # optional
),
output_schema_name=f"{catalog}.{schema}"
)
Para perfis InferenceLog, as fatias são criadas automaticamente com base nos valores distintos de model_id_col
.
Perfil de Snapshot
Em contraste com o de TimeSeries
, um perfil de Snapshot
monitora como o conteúdo completo da tabela é alterado ao longo do tempo. As métricas são calculadas sobre todos os dados na tabela e monitoram o estado da tabela sempre que o monitoramento é atualizado.
from databricks import lakehouse_monitoring as lm
lm.create_monitor(
table_name=f"{catalog}.{schema}.{table_name}",
profile_type=lm.Snapshot(),
output_schema_name=f"{catalog}.{schema}"
)
Atualizar e exibir os resultados do monitor
Para atualizar tabelas de métricas, use run_refresh
. Por exemplo:
from databricks import lakehouse_monitoring as lm
lm.run_refresh(
table_name=f"{catalog}.{schema}.{table_name}"
)
Quando você chama run_refresh
de um notebook, as tabelas de métricas do monitor são criadas ou atualizadas. Esse cálculo é executado na computação sem servidor, não no cluster ao qual o notebook está anexado. Você pode continuar a executar comandos no notebook enquanto as estatísticas do monitor são atualizadas.
Para obter informações sobre as estatísticas armazenadas em tabelas de métricas, consulte Monitorar tabelas de métricas Tabelas de métricas são tabelas do Catálogo do Unity. Você pode consultá-las em notebooks ou no gerenciador de consultas SQL e exibi-las no Catalog Explorer.
Para exibir o histórico de todas as atualizações associadas a um monitor, use list_refreshes
.
from databricks import lakehouse_monitoring as lm
lm.list_refreshes(
table_name=f"{catalog}.{schema}.{table_name}"
)
Para obter o status de uma execução específica que foi enfileirada, em execução ou concluída, use get_refresh
.
from databricks import lakehouse_monitoring as lm
run_info = lm.run_refresh(table_name=f"{catalog}.{schema}.{table_name}")
lm.get_refresh(
table_name=f"{catalog}.{schema}.{table_name}",
refresh_id = run_info.refresh_id
)
Para cancelar uma atualização enfileirada ou em execução, use cancel_refresh
.
from databricks import lakehouse_monitoring as lm
run_info = lm.run_refresh(table_name=f"{catalog}.{schema}.{table_name}")
lm.cancel_refresh(
table_name=f"{catalog}.{schema}.{table_name}",
refresh_id=run_info.refresh_id
)
Exibir configurações do monitor
Você pode examinar as configurações do monitor usando a API get_monitor
.
from databricks import lakehouse_monitoring as lm
lm.get_monitor(table_name=TABLE_NAME)
Agenda
Para configurar um monitor para ser executado de acordo com um agendamento, use o schedule
parâmetro de create_monitor
:
lm.create_monitor(
table_name=f"{catalog}.{schema}.{table_name}",
profile_type=lm.TimeSeries(
timestamp_col="ts",
granularities=["30 minutes"]
),
schedule=lm.MonitorCronSchedule(
quartz_cron_expression="0 0 12 * * ?", # schedules a refresh every day at 12 noon
timezone_id="PST",
),
output_schema_name=f"{catalog}.{schema}"
)
Consulte expressões cron para obter mais informações.
Notificações
Para configurar notificações para um monitor, use o parâmetro notifications
de create_monitor
:
lm.create_monitor(
table_name=f"{catalog}.{schema}.{table_name}",
profile_type=lm.TimeSeries(
timestamp_col="ts",
granularities=["30 minutes"]
),
notifications=lm.Notifications(
# Notify the given email when a monitoring refresh fails or times out.
on_failure=lm.Destination(
email_addresses=["your_email@domain.com"]
)
)
output_schema_name=f"{catalog}.{schema}"
)
Há suporte para no máximo 5 endereços de email por tipo de evento (por exemplo, "on_failure").
Controlar o acesso às tabelas de métricas
As tabelas de métricas e o painel criados por um monitor pertencem ao usuário que criou o monitor. Você pode usar privilégios do Catálogo do Unity para controlar o acesso a tabelas de métricas. Para compartilhar painéis em um workspace, clique no botão Compartilhar no lado superior direito do painel.
Excluir um monitor
Para excluir um monitor:
lm.delete_monitor(table_name=TABLE_NAME)
Esse comando não exclui as tabelas de perfil e os painéis criados pelo monitor. Você deve excluir esses ativos em uma etapa separada ou salvá-los em um local diferente.
Blocos de anotações de exemplo
Os notebooks de exemplo a seguir ilustram como criar um monitor, atualizá-lo e examinar as tabelas de métricas que ele cria.
Exemplo de notebook: perfil de série temporal
Este notebook ilustra como criar um tipo TimeSeries
de monitor.
Notebook de exemplo do Monitor Lakehouse de Série Temporal
Exemplo de notebook: perfil de inferência (regressão)
Este notebook ilustra como criar um monitor do tipo InferenceLog
para um problema de regressão.
Notebook de exemplo de regressão do Monitor Lakehouse de Inferência
Exemplo de notebook: perfil de inferência (classificação)
Este notebook ilustra como criar um monitor do tipo InferenceLog
para um problema de regressão.
Notebook de exemplo de classificação do Monitor Lakehouse de inferência
Exemplo de notebook: perfil de instantâneo
Este notebook ilustra como criar um monitor do tipo Snapshot
.
Notebook de exemplo do Monitor Lakehouse de Instantâneo
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de