Guia descritivo para migração do Beagle Analytics 1.0 para o Beagle Analytics 2.0

O que é o Beagle Analytics

O Analytics é uma funcionalidade do Beagle que faz o tagueamento de alguns eventos como o clique em um componente ou o carregamento de uma tela.

Sobre o Analytics 1.0

Em sua primeira versão era necessário implementar um ClickEvent ou um ScreenEvent no Backend, como no exemplo abaixo:

ClickEvent(
   category = "category-button",
   label = "Label-button",
   value = "value-button"
)

ScreenEvent(
   screenName = "FALLBACK"
)

Esses eventos eram declarados em seus respectivos componentes no backend. Por exemplo:

Abaixo temos um exemplo do componente Botão declarado no backend:

Button(
   text = "Analytics 1",
   onPress = listOf(
       Alert("Analytics 1", "Tentando novamente!")
   ),
   clickAnalyticsEvent = ClickEvent(
       category = "category-button",
       label = "Label-button",
       value = "value-button"
   )
)

Uma vez declarados no Backend, os eventos (com as informações listadas neles) podem ser recuperados no Frontend a partir de uma classe customizada para manuseá-las.

• Essa classe estendia funcionalidades de uma classe interna do Beagle chamada Analytics que reunia as informações dos eventos em um objeto chamado event. Abaixo listamos a assinatura no Android para referência

@BeagleComponent
class SampleAnalytics: Analytics {
   override fun trackEventOnClick(event: ClickEvent) {
       //This code block will run when a ClickEvent is received
  Log.i("analytics1", "$event")
   }
   override fun trackEventOnScreenAppeared(event: ScreenEvent) {
       //This code block will run when a Screen is rendered
  Log.i("analytics1", "screenUp -> "+ event.screenName)
   }
   override fun trackEventOnScreenDisappeared(event: ScreenEvent) {
       //This code block will run when a Screen disappears
   }
}

Sobre o Analytics 2.0

O Analytics 2.0 melhorou a maneira como os eventos podem ser declarados no backend e recuperados no frontend, e mais, agora é possível habilitar o tracking para ações e propriedades sem ser necessário implementar o mapeamento de eventos no backend.

Abaixo, temos um exemplo da implementação no frontend Android

@BeagleComponent
class SampleAnalytics2:AnalyticsProvider {
   override fun getConfig(): AnalyticsConfig = object: AnalyticsConfig{
       override var actions: Map<String, List<String>>? = hashMapOf(
           "beagle:alert" to listOf("message")
       )
       override var enableScreenAnalytics: Boolean? = true
   }
   override fun createRecord(record: AnalyticsRecord) {
       Log.i("analytics2", record.toString())
   }
}

A configuração geral sobre o que deve ou não gerar eventos de analytics fica no frontend, mas ainda é possível controlar os eventos a partir do backend.

Agora, a propriedade que recebe os eventos de analytics faz parte da ação, e não mais do botão ou da tela como no Analytics 1. Essa propriedade se chama analytics

Aqui temos um exemplo de ação que recebe configurações de analytics no backend

Alert(
   title = "Analytics 2",
   message = "Tentando novamente!",
   analytics = ActionAnalyticsConfig.Enabled(
       ActionAnalyticsProperties(
           attributes = listOf("message", "title")
       )
   )
)

Perceba que o ActionAnalyticsConfig está definido como .Enabled, ou seja, isso faz com que o frontend capture o evento que dispara informações e demonstre-o

O ActionAnalyticsConfig trás algumas propriedades consigo, e aqui listamos somente os atributos da ação da qual queremos informações, mas existe uma outra propriedade chamada AdditionalEntries que recebe informações extras, que podemos enviar com as demais informações no ActionAnalyticsConfig.

Migrando do Analytics 1 para o Analytics 2

Vamos começar pelo backend. Embora não seja mais necessário criar eventos no backend, a funcionalidade está disponível para o Analytics 2 e o controle dos eventos pode ser realizado a partir do backend também.

Todas as informações, antes implementandas em atributos específicos na classe clickEvent, agora são enviadas automaticamente para o frontend, quando implementamos o ActionAnalyticsConfig.

1. Apague a implementação do ClickEvent ou ScreenEvent
2. Adicione o código ActionAnalyticsConfig.Enabled na propriedade analytics da ação que quer mapear.
3. Abaixo listamos o antes e depois de um botão com exemplos das funcionalidades de analytics no backend e as informações que serão recuperadas no frontend (no exemplo abaixo listamos as informações em cada objeto no formato de string):

Button(
  text = "Analytics 1",
  onPress = listOf(
    Alert("Analytics 1", "Tentando novamente!")
  ),
  clickAnalyticsEvent = ClickEvent(
    category = "category-button",
    label = "Label-button",
    value = "value-button"
  )
)

Button(
text = "Analytics 2",
onPress = listOf(
  Alert(
    title = "Analytics 2",
    message = "Tentando novamente!",
    analytics = ActionAnalyticsConfig.Enabled(
      ActionAnalyticsProperties(
        attributes = listOf("message", "title")
      )
 ...
)

4. Agora no frontend, basta apagar a classe customizada para o analytics 1 e implementar uma nova classe para o analytics 2.
5. Siga o exemplo de classe do analytics 2 listado nesse guia para Android e teste com a ação Alert.
6. Para outras plataformas (WEB, iOS), acesse os exemplos listados em nossa documentação para implementar o AnalysticsConfig.
7. Lembre-se de registrar as ações que quer acessar mesmo quando o backend não especificar nada na função getConfig() do AnalyticsProvider
8. Agora que o AnalyticsProvider foi implementado basta rodar sua aplicação e os eventos serão recebidos no frontend.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.