Configuração de registro e rastreamento de evento para um aplicativo¶
Este tópico descreve como os provedores podem configurar um Snowflake Native App para registrar mensagens de log e rastrear eventos.
Sobre mensagens de log e eventos de rastreamento em um aplicativo¶
O Snowflake Native App Framework é compatível com o uso da funcionalidade de registro em log e rastreamento Snowflake para coletar informações sobre um aplicativo. Os provedores podem configurar um aplicativo para registrar e analisar o seguinte:
Mensagens de log – Mensagens independentes e detalhadas com informações sobre o estado de um código de um aplicativo específico.
Eventos de rastreamento – Dados estruturados que os provedores podem usar para obter informações abrangendo e agrupando diversas partes de seu código. Os eventos de rastreamento permitem que um aplicativo emita informações relacionadas ao seu desempenho e comportamento.
Para configurar um aplicativo para emitir mensagens de log e rastrear eventos, os provedores definem os níveis de log e rastreamento no arquivo de manifesto. Consulte Definição dos níveis de log e rastreamento para um aplicativo.
Os provedores também podem configurar um aplicativo para usar o compartilhamento de evento para permitir que o consumidor compartilhe as mensagens de log e rastreie eventos com o provedor. Consulte Sobre compartilhamento de evento para obter mais informações.
Sobre o compartilhamento de evento¶
O compartilhamento de evento permite que o provedor colete informações sobre o desempenho e o comportamento de um aplicativo. Um provedor pode configurar um aplicativo para solicitar que os consumidores compartilhem as mensagens de log e rastreiem eventos com o provedor. O compartilhamento de evento exige que o provedor e o consumidor configurem uma tabela de evento em sua conta para armazenar as mensagens de log e rastrear eventos emitidos pelo aplicativo.
Quando o compartilhamento de evento está habilitado, as mensagens de log e os eventos de rastreamento inseridos na tabela de evento na conta do consumidor também são inseridos na tabela de evento na conta do provedor.
Considerações ao usar o compartilhamento de evento¶
Antes de configurar o registro e o compartilhamento de evento para um aplicativo, os provedores devem considerar o seguinte:
Os provedores são responsáveis por todos os custos associados ao compartilhamento de eventos no lado do provedor, incluindo ingestão e armazenamento de dados.
Os provedores devem ter uma conta para armazenar eventos compartilhados em cada região onde você deseja oferecer suporte ao compartilhamento de eventos.
Os provedores devem definir o nível de log e o nível de rastreamento padrão para um aplicativo no arquivo de manifesto.
Nota
O compartilhamento de eventos não pode ser habilitado para um aplicativo instalado na mesma conta que o pacote de aplicativos no qual ele se baseia. Para testar o compartilhamento de evento para um aplicativo, os provedores devem usar várias contas.
Considerações ao migrar da funcionalidade anterior de compartilhamento de evento¶
Ao migrar da funcionalidade de compartilhamento de evento existente para o uso de definições de evento, os provedores devem considerar o seguinte.
A funcionalidade anterior de compartilhamento de evento é equivalente à definição de evento OPTIONAL ALL.
Versões publicadas e patches de um aplicativo que usava a funcionalidade anterior terão a definição de evento OPTIONAL ALL por padrão. Os provedores não precisam adicionar esta definição de evento ao arquivo de manifesto.
Para começar a usar definições de evento, os provedores podem adicionar definições de evento compatíveis com o arquivo de manifesto. Isso se aplica a novos aplicativos, bem como a novas versões e patches de aplicativos existentes.
Nota
Para começar a solicitar compartilhamento de log e evento mais granulares, os provedores só precisam adicionar definições de evento ao arquivo de manifesto. Nenhuma outra ação é necessária para os provedores.
Fluxo de trabalho – Configuração do compartilhamento de evento para um aplicativo¶
O compartilhamento de evento permite que os consumidores compartilhem mensagens de log e rastreiem eventos com o provedor.
O fluxo de trabalho a seguir mostra como definir e habilitar o compartilhamento de evento para um aplicativo:
O provedor define os níveis de log e rastreamento para o aplicativo.
O provedor adiciona definições de evento ao arquivo de manifesto.
As definições de evento atuam como filtros nas mensagens de log e rastreiam eventos emitidos pelo aplicativo. Os provedores podem configurar definições de evento como obrigatórias ou opcionais.
O provedor define uma tabela de evento em sua organização.
O provedor publica o aplicativo.
Quando um consumidor instala um aplicativo, ele pode definir uma tabela de evento e habilitar o compartilhamento de evento. Consulte Habilitação de registro em log e compartilhamento de evento para um aplicativo para obter mais informações sobre os requisitos de consumidor para compartilhamento de evento.