O módulo OpenEvent do DataWorks usa o EventBridge para assinar e enviar mensagens de eventos. Após criar um barramento de eventos personalizado no EventBridge, configure um canal de distribuição de eventos no DataWorks para publicar os eventos. Em seguida, crie regras no EventBridge para gerenciar esses eventos. Este tópico explica como ativar a assinatura de mensagens de eventos e configurar um barramento de eventos personalizado.
Observações de uso
Edição: Disponível apenas na DataWorks Enterprise Edition.
Regiões: Suportado nas regiões China (Pequim), China (Hangzhou), China (Shenzhen), China (Xangai), China (Zhangjiakou), China (Chengdu), EUA (Vale do Silício), EUA (Virgínia), Alemanha (Frankfurt), Japão (Tóquio), China (Hong Kong) e Cingapura.
Controle de acesso: Apenas o Open Platform Administrator, o Tenant Administrator, contas Alibaba Cloud ou usuários RAM com a permissão Aliyundataworksfullaccess têm permissões de leitura e gravação no console de desenvolvedor. Consulte Administrador da Open Platform e Conceder a permissão AliyunDataWorksFullAccess a um usuário RAM.
Dependência: O OpenEvent usa o EventBridge para assinar e consumir mensagens. Ative o EventBridge antes de começar.
Precauções
Se a assinatura do DataWorks Enterprise Edition expirar, todas as extensões ficarão inválidas e não poderão mais acionar verificações de eventos. O sistema aprova automaticamente quaisquer verificações acionadas que ainda não tenham atingido um estado terminal.
Funcionamento
O DataWorks expõe mensagens de alteração de status dos processos principais. No módulo OpenEvent da DataWorks Open Platform, mapeie um workspace do DataWorks para um barramento de eventos do EventBridge. Essa configuração envia todas as mensagens publicadas do workspace para o barramento de eventos especificado. Depois, gerencie essas mensagens no EventBridge. Por exemplo, filtre as mensagens enviadas pelo DataWorks para identificar aquelas exigidas por um sistema downstream e defina como e onde entregá-las.
As mensagens geradas por operações em módulos de nível de tenant são enviadas automaticamente para o barramento de eventos padrão, chamado Default, no EventBridge. Para obter uma lista de eventos de nível de tenant suportados, consulte Eventos de nível de tenant.
Configuração do DataWorks
Configure um canal de distribuição de eventos no DataWorks para enviar mensagens de eventos a um barramento de eventos do EventBridge. Siga estas etapas para autorizar o DataWorks a acessar o EventBridge e especificar o barramento de eventos onde o DataWorks publicará as mensagens.
Etapa 1: Conceder autorização de serviço
Se estiver usando o serviço OpenEvent pela primeira vez, use sua conta Alibaba Cloud ou um usuário RAM com a permissão AliyunDataWorksFullAccess para autorizar o DataWorks a acessar o EventBridge.
-
Faça login no console do DataWorks. Na região desejada, clique em no painel de navegação à esquerda. Clique em Go to Open Platform para abrir a página Developer Backend.
Na página Developer Backend, clique em OpenEvent no painel de navegação à esquerda para acessar a página OpenEvent.
-
Autorize o DataWorks a acessar os recursos do EventBridge.
Se esta for a primeira vez que você usa o serviço, um botão Authorize será exibido. Siga as instruções na tela para conceder ao DataWorks permissão de acesso aos recursos do EventBridge. Essa ação cria automaticamente uma função vinculada ao serviço chamada AliyunServiceRoleForDataWorksOpenPlatform no console RAM, em .
Etapa 2: Configurar o canal de distribuição de eventos
Um canal de distribuição de eventos mapeia um workspace do DataWorks para um barramento de eventos do EventBridge. Isso garante que todas as mensagens publicadas no workspace sejam enviadas para esse barramento específico.
Clique em Add Event Distribution Channel. Na caixa de diálogo exibida, configure os parâmetros Workspace for Event Distribution e Distribute to Custom Event Bus in EventBridge.
-
Se não houver nenhum barramento de eventos disponível no EventBridge, clique em Create Custom Event Bus para acessar o console do EventBridge e criar um. Alternativamente, clique em Quickly Create Custom Event Bus with Same Name as Your Workspace para gerar imediatamente um barramento de eventos.
Na caixa de diálogo Add Event Distribution Channel, selecione um workspace para o parâmetro Workspace for Event Distribution e um barramento de eventos personalizado para o parâmetro Distribute to Custom Event Bus in EventBridge e, em seguida, clique em OK.
Etapa 3: Ativar o canal de distribuição de eventos
Após configurar o canal de distribuição de eventos, visualize-o na página OpenEvent. Na coluna Actions, você pode Delete, Enable ou Disable o canal.
-
Enable: Ao ativar o canal, as mensagens de eventos do workspace são enviadas para o barramento de eventos correspondente.
Em seguida, acesse o console do EventBridge para visualizar todas as mensagens de eventos enviadas pelo DataWorks, filtrar as mensagens necessárias para um consumidor downstream e definir como e para quais serviços entregá-las.
Disable/Delete: Se você desativar ou excluir o canal, o DataWorks interromperá o envio de mensagens de eventos do workspace para o barramento de eventos correspondente. Não será mais possível receber essas mensagens de eventos por meio do EventBridge.
Configuração do EventBridge
Depois de ativar o canal de distribuição de eventos no DataWorks, as mensagens publicadas são enviadas automaticamente para o barramento de eventos do EventBridge especificado. Configure a filtragem no EventBridge para selecionar mensagens específicas para consumo e definir seus destinos de entrega.
Etapa 1: Criar um barramento de eventos personalizado
Se você criou um barramento de eventos personalizado com o mesmo nome do seu workspace do DataWorks na Etapa 2: Configurar o canal de distribuição de eventos, use diretamente esse barramento. Caso tenha clicado em Create Custom Event Bus, siga estas etapas para criar um. Para mais informações, consulte Visão geral do barramento de eventos.
Faça login no console do EventBridge e clique em Event Bus no painel de navegação à esquerda.
Na página Event Buses, acesse a aba Custom Event Buses e clique em Quickly Create. O exemplo a seguir cria um barramento de eventos personalizado chamado
DataWorks2023. Para criar rapidamente o barramento, basta configurar o Name e a Description. Você pode pular as etapas Event Source, Rule e Target.
Etapa 2: Configurar a regra de evento
Após criar o barramento de eventos, configure manualmente uma regra de evento para rotear as mensagens de eventos do DataWorks para seus serviços de destino.
Na barra de navegação à esquerda, clique em Event Bus. Localize o barramento de eventos do EventBridge desejado e clique em para acessar a página de configuração de regras de eventos.
Na página Event Rules, clique em Create Rule no canto superior esquerdo.
Configure basic information: Insira um nome e uma descrição para a regra de evento. Na etapa Configure basic information, o Event bus é definido como
DataWorks2023por padrão e não pode ser editado. Em Name, insirainstanceStatusChanges(2 a 127 caracteres, podendo conter letras, dígitos ou hifens). Em Description, insira uma descrição como "Esta regra filtra mensagens de 'alteração de status de instância' dentre todas as mensagens de eventos do workspace.".-
Configure event pattern : Um padrão de evento filtra mensagens com base em seu conteúdo. Configure os parâmetros da seguinte forma:
Event Source Type: Selecione Custom Event Source.
Event Source: Mantenha o valor padrão.
-
Pattern Content: Use o formato JSON para especificar o tipo de mensagem de evento. Cada mensagem de evento do DataWorks possui um tipo fixo. Encontre o tipo de mensagem para cada operação em Referência: Lista de eventos e formato de mensagem e use-o como valor para a chave
typeno conteúdo do padrão.{ "source": [ "acs.dataworks" ], "type": [ "dataworks:InstanceStatusChanges:InstanceStatusChanges" ] }
-
Debug event pattern : Após configurar o padrão de evento, depure-o para verificar se funciona conforme o esperado.
Se você concluiu a Etapa 3: Ativar o canal de distribuição de eventos no DataWorks, as mensagens de eventos estão sendo enviadas para o EventBridge. Para testar seu padrão, acesse a página Event Tracking, localize um evento do DataWorks para o seu barramento e copie seus detalhes. Cole os detalhes na seção Event Pattern Debugging e clique em Test para verificar o filtro.
-
Se os tipos de evento não corresponderem, a mensagem "Match failed" será exibida.
-
Se os tipos de evento corresponderem, a mensagem "Match succeeded. The event can be triggered as expected." será exibida.
-
-
Configure event target: Além de serviços personalizados, envie eventos para vários outros destinos para consumo. Para mais informações, consulte Visão geral de destinos de eventos.
Ao configurar o destino do evento, defina Service Type como HTTPS. Em URL, insira o endereço do serviço HTTPS, como
https://example.com/eventBridge/dataworksEvent. Para Body, selecione Complete Event. Em Network Type, selecione Public Network.NotaA configuração na figura mostra mensagens sendo enviadas para um serviço HTTPS especificado. Para que uma extensão receba essa mensagem, selecione HTTPS como tipo de serviço e insira o endereço de implantação da extensão no campo URL.
Após configurar e salvar a regra de evento, o EventBridge poderá rotear as mensagens de eventos do DataWorks com base nas suas definições. Esta configuração também oferece suporte a extensões.
Visualizar mensagens de eventos enviadas
Quando o canal de distribuição de eventos do DataWorks está ativado e um evento é acionado, visualize as mensagens de eventos enviadas na página Event Tracking do barramento de eventos associado. Localize diferentes mensagens de eventos com base em seu tipo. Para obter uma lista de tipos de eventos, consulte Referência: Lista de eventos e formato de mensagem.
Na página Event Tracking, selecione Query by Time Range. Defina um intervalo de tempo e clique em Query para visualizar registros de eventos acionados pelo DataWorks, como eventos do tipo dataworks:FileChange:DeployFile (implantação de arquivo) ou dataworks:FileChange:CommitFile (commit de arquivo). Para ver mais informações sobre um registro, verifique sua event trajectory e event details.
Melhores práticas
Assinatura de mensagens com um serviço local: Melhores Práticas: Bloqueio de Implantação de Tarefas Personalizadas.