Após registrar, publicar e ativar uma extensão na DataWorks Open Platform, o DataWorks envia mensagens de evento para sua extensão quando ações do workspace acionam eventos de ponto de extensão. O Operation Center oferece suporte a eventos de alteração de nó e eventos de backfill de dados, que permitem executar validações personalizadas.
Pré-requisitos
Você ativou a assinatura de mensagens. Para mais informações, consulte Ative a assinatura de mensagens.
Você desenvolveu e implantou a extensão. Para mais informações, consulte Desenvolva e implante uma extensão usando Function Compute.
Contexto
O DataWorks envia notificações para eventos de ponto de extensão e permite criar pontos de verificação de processo que executam lógicas personalizadas para operações específicas. Para utilizar esse recurso, registre sua extensão no console do DataWorks e 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 exibida, 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 do workspace pode ativar uma extensão em Administration > Extensions.
Para mais informações sobre extensões, consulte Visão geral da extensão.
O procedimento anterior refere-se a uma extensão no nível do workspace. Para mais informações, consulte Eventos de ponto de extensão com suporte.
Visão geral
O Operation Center envia mensagens para os 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 retornar os resultados chamando a API UpdateWorkbenchEventResult para implementar controles de processo. Os seguintes pontos de extensão têm suporte:
|
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. A execução dessas 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 com suporte
Operation Center: Congelar e descongelar um nó
O exemplo a seguir demonstra como acionar uma extensão ao congelar um nó. No Operation Center, na página Scheduled Tasks, clique com o botão direito em um nó de destino, como xc_demo_start, e selecione Suspend (Freeze) no menu de atalho. Você também pode clicar em o ícone de congelamento na barra de ferramentas. Após o acionamento da ação, o painel Operation Check Details aparece à direita, exibindo o nome do nó, o tipo de operação (Suspend/Freeze) e o status do ponto de verificação. Clique em View Details ou View Documentation para visualizar os resultados da validação, em Recheck para executar a validação novamente ou em Close para sair do painel.
Operation Center: Remover a implantação de um nó
Na lista Scheduled Tasks, clique 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, um ícone de status e a mensagem Undeployment check in progress aparecem na linha da tarefa. Clique em o ícone de status para abrir a caixa de diálogo Operation Check Details, que exibe o nome da tarefa, o tipo de operação (Undeploy) e o status do ponto de verificação. A coluna Operation fornece links para View Details e View Documentation. Clique em Recheck para executar a validação novamente ou em Close para fechar a 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 com o botão direito em um nó de tarefa de destino e selecione 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, selecione Backfill Instances no painel de navegação à esquerda para visualizar o status da verificação. Clique em o status da verificação para abrir a caixa de diálogo Operation Check Details, que exibe os resultados da validação, incluindo os nomes dos pontos de verificação e seus respectivos status.
Referências
Para ativar uma extensão, consulte Ative uma extensão.
Para mais informações sobre eventos de ponto de extensão no Operation Center, consulte Eventos de ponto de extensão com suporte.
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ó (crie, modifique, exclua, congele, descongele e remova a implantação).