Após registrar, publicar e ativar uma extensão na DataWorks Open Platform, o DataWorks envia uma mensagem de evento para a extensão quando uma ação no workspace aciona um evento de ponto de extensão. Em seguida, visualize os resultados retornados pela extensão. Este tópico descreve os eventos de ponto de extensão compatíveis com o Operation Center e demonstra como utilizá-los para acionar validações personalizadas.
Pré-requisitos
Ative a assinatura de mensagens. Para mais informações, consulte Ativar assinatura de mensagens.
Desenvolva e implante a extensão. Para mais informações, consulte Desenvolver e implantar uma extensão usando o Function Compute.
Contexto
O DataWorks pode enviar notificações sobre eventos de pontos de extensão. Use extensões para criar pontos de verificação de processo com base nos pontos de extensão compatíveis e execute lógicas personalizadas para operações específicas. Para utilizar esse recurso, registre primeiro a extensão no console do DataWorks e depois ative-a em Administration > Extensions. No painel de navegação do DataWorks Administration, clique em Extensions para abrir a página de gerenciamento de extensões. Na seção Extension Scope, selecione Workspace como tipo, escolha o workspace desejado e ative a chave Enable da sua extensão. Na caixa de diálogo Extension Data Authorization, confirme os detalhes da autorização, como a API para um evento de alteração de arquivo: UpdateIDEEventResult. Selecione I have read and agree to the risks associated with the preceding data authorization. e clique em Agree and Authorize.
Somente um administrador de workspace pode ativar uma extensão em Administration > Extensions.
Para mais informações sobre extensões, consulte Visão geral de extensões.
O procedimento anterior refere-se a uma extensão no nível de workspace. Para mais informações, consulte Eventos de ponto de extensão compatíveis.
Visão geral
O módulo Operation Center permite que seus serviços recebam mensagens dos seguintes eventos de ponto de extensão. Registre um programa local como uma extensão do DataWorks para receber essas mensagens, processá-las com lógica personalizada e devolver os resultados à plataforma chamando a API UpdateWorkbenchEventResult. Esse mecanismo viabiliza a implementação de controles de processo no DataWorks. O Operation Center é compatível com os seguintes pontos de extensão:
|
Evento |
Descrição |
|
node change event |
Nota
Neste contexto, um nó refere-se a uma tarefa na lista Scheduled Tasks do Operation Center de produção. |
|
backfill data event |
|
Neste contexto, um nó refere-se a uma tarefa na lista Scheduled Tasks do Operation Center de produção. Ao executar as operações anteriores em tarefas na página Scheduled Tasks do ambiente de produção, a validação da extensão é acionada. Executar essas operações em tarefas agendadas no ambiente de desenvolvimento não aciona a validação da extensão. Da mesma forma, congelar ou descongelar uma instância na página de instâncias não aciona a validação da extensão.
Pontos de extensão compatíveis
Operation Center: Congelar e descongelar um nó
Este exemplo demonstra como acionar uma extensão ao congelar um nó. No Operation Center, na página Scheduled Tasks, clique em com o botão direito em um nó de destino, como xc_demo_start, e selecione Suspend (Freeze) no menu de atalho. Essa ação constitui um ponto de extensão. Também é possível acioná-la clicando em no ícone de congelamento na barra de ferramentas. Após o acionamento, o painel Operation Check Details (a extensão) aparece à direita. Esse painel exibe o nome do nó, o tipo de operação (Suspend/Freeze) e o status do ponto de verificação de validação, como 'Operation check in progress'. Clique em View Details ou View Documentation para visualizar os resultados da validação, em Recheck para acionar a validação novamente ou em Close para fechar o painel.
Operation Center: Remover a implantação de um nó
Na lista Scheduled Tasks, clique em com o botão direito em uma tarefa de destino, como test_select, e selecione Undeploy node no menu de atalho. Após iniciar a remoção da implantação, uma mensagem Undeployment check in progress e um ícone de status aparecem na linha da tarefa, indicando que uma extensão está validando a operação. Clique em no ícone de status para abrir a caixa de diálogo Operation Check Details. Essa caixa exibe o nome da tarefa, o tipo de operação (Undeploy), os pontos de verificação e seus respectivos status. A coluna Operation fornece links para View Details e View Documentation. Os botões Recheck e Close encontram-se na parte inferior da caixa de diálogo.
Operation Center: Backfill de dados
No painel de navegação à esquerda do Operation Center, selecione Scheduled Tasks. No DAG à direita, clique em com o botão direito em um nó de tarefa de destino e escolha uma opção de backfill de dados, como para o nó atual, nó atual e downstream, no modo de nós em massa ou no modo avançado. Essa ação aciona um evento de ponto de extensão de verificação prévia. Após enviar a tarefa, visualize o status de verificação da tarefa de backfill selecionando Backfill Instances no painel de navegação à esquerda. Clique em no status de verificação para abrir a caixa de diálogo Operation Check Details, que exibe os resultados da validação da extensão, incluindo os nomes dos pontos de verificação e seus status.
Referências
Para ativar uma extensão, consulte Ativar uma extensão.
Para mais informações sobre eventos de ponto de extensão no Operation Center, consulte Eventos de ponto de extensão compatíveis.
Para o formato de mensagem de um evento de backfill de dados, consulte Evento de backfill de dados.
Para o formato de mensagem de um evento de alteração de nó, consulte Evento de alteração de nó (criar, modificar, excluir, congelar, descongelar e remover implantação).