🗳️Destinations

Tudo que você precisa saber para preparar seu destination para recebe eventos em tempo real do Agnostic Data.

Elastic Cloud

Para configurar uma instanância do Elastic Cloud para receber eventos do Agnostic Data é simples. Siga os passos.

Configurar tipos dados

Configurar os tipos dados ajudará o Elastic a inferir corretamente nos tipos de dados dos eventos. São basicamente 4 tipos de dados que "treinamos" o Elastic para ele não se perder, são eles:

inserted_date, device_geohash, complete_data, items.item_id, items.id

Para informar ao Elastic que desejamos esses tipos de dados realize os seguintes passos:

  1. Navegue até a página "Dev Tools" em (https://INSTANCIA/app/dev_tools#/console)

  2. Cole o conteúdo abaixo (de "Template de tipos") na área apropriada e clique no play (>) para enviar um request que irá realizar um PUT em _index_template com o template de nome agnostic_template e os tipos e formatos, conforme definidos abaixo.

Template de tipos
```json

// PUT _index_template/agnostic_template
{
  "index_patterns": ["events_*"],
  "template": {
    "mappings": {
      "properties": {
          "inserted_date": {
                "type": "date",
                "format": "strict_date_optional_time||epoch_second"
          },
          "start_session": {
              "type": "date",
              "format": "strict_date_optional_time||epoch_second"
          },        
          "last_origin_ts": {
              "type": "date",
              "format": "strict_date_optional_time||epoch_second"
          },        
          "utm_case": {
              "properties": {
                  "attr_dts_ts": {
                    "type": "date",
                    "format": "strict_date_optional_time||epoch_second"
                  }
              }
          },
          "device_geohash": {
            "type": "geo_point"
          },
          "complete_data": {
            "properties": {
              "save": {
                "type": "boolean"
              }
            }
          },
          "items": {
              "properties": {
                "item_id": {
                  "type": "text"
                },
                "id": {
                  "type": "text"
                }
              }
          },  
          "relative_view": {
            "type": "text",
            "fields": {
              "keyword": {
                "type": "keyword"
              }
            }
          },
          "user_id": {
            "type": "text",
            "fields": {
              "keyword": {
                "type": "keyword",
                "ignore_above": 256
              }
            }
          }                   
      }
    }
  }
}


// PUT /CLIENTE_HOOK/_settings
{
  "index.default_pipeline": "json_parser"
}

```

Gerar chaves de acesso

Gere as chaves de acesso para cadastrá-las no AgnosticData, assim você poder tirar todo o proveito desta integração. Para gerar a chave de acesso siga os passos:

  1. Navegue até a página API em Stack Management -> Security -> Api Key. Exemplo: https://INSTANCIA/app/management/security/api_keys)

  2. Clique em "CREATE API KEY"

  3. Em name preencher com "agnostic-user-writer"

  4. Selecionar "Personal API KEY"

  5. Desabilitar "Restrict privileges", "Expire after time", "Include metadata"

  6. Confirmar criação em "CREATE API KEY"

  7. Na tela aparecerá uma chave copie-a e salve-a

  8. Navegue até o arquivo/tela de configuração do projeto do AgnosticData e preenche na lista de destinations do elastic em settings.destinations.elastic com os valores

    1. is_active: true,

    2. id: (você encontra no campo Cloud Id acessando as configurações da implantação em https://cloud.elastic.co/deployments/)

    3. index: events

    4. private_key_base64: (é chave copiada e salva e convertida em base64)

    5. url: copie em Elasticsearch clicando em "copy endpoint"

Exemplo de JSON de Configuração
{
   "is_active": true,
   "id": "copie o Cloud Id da implantação do seu Elastic Cloud",
   "index": "events",
   "private_key_base64": "CHAVE_BASE_64",
   "url": "copie clicando em Copy endpoint da implantação"
}

Configurando seu primeiro Data View Kibana

Para visualizar seus eventos de forma apropriada, crie seu primeiro Data View Kibana. Nesta etapa vamos informar ao Elastic/Kibana que o campo "timestamp" será o inserted_date.

Outro ponto importante nesta configuração de Data View é agregrar todos os índices em uma única visão.

Cada evento gera um índice específico, por exemplo, um evento de click irá gerar o índice event_PROJECT_ID_click, ou um evento checkout_doneirá gerar um índice com todos os eventos checkout_done emevent_PROJECT_ID_checkout_done.

Criando o data view

  1. Acesse app/kibana_overview#/ (https://INSTANCIA/app/kibana_overview#)

  2. Em name preencha com "events_all"

  3. Em pattern preencha com "events_PROJECT_ID_*" (isso irá agregar todos os índice em uma visão)

  4. Em Timestamp field escolha "inserted_date"

  5. Clique em "save data view to kibana"

Pronto! Agora você já explorar os dados de eventos, obter insights e gerar dashboards!

Firestore (Firebase)

Para receber os eventos analytics em real-time no Firestore do Fireabse é simples! São necessários apenas 3 informações para integrar o Firestore como destinationdo AgnosticData. São elas:

```json
            "firestore": {
              "id": "nome_do_projeto_do_firebase",
              "client_email": "firebase-adminsdk-XXXXXX@nome_do_projeto_do_firebase.iam.gserviceaccount.com",
              "private_key_base64": "private_key_as_base64"
            }
```

Vamos ao trabalho!

  1. Primeiro crie o seu projeto no Firebase

Acesse a console em https://firebase.google.com/?hl=pt-br e depois "Criar projeto"

  1. Ativação do Google Analytics (opcional)

Não é necessário ativar o Google Analytics ao criar o projeto no Firebase para ser utilizado como destination. Ative-o apenas se souber exatamente o que estiver fazendo.

Lembre-se: Utilizando o AgnosticData não é necessário colocar o pixel Meta ou Google Analytics em seu site ou aplicativo. O próprio AgnosticData irá automaticamente enviar os dados coletados para esses destinos quando configurados.

  1. Gerar a chave do projeto

Após o projeto criado, vamos gerar a chave do projeto Firebase.

Esta chave será futuramente inserida nas configurações do seu projeto no AgnosticData onde os eventos do seu escopo serão enviados em tempo-real (sem atrasos). A partir desta integração você terá seus dados, completamente do seu lado, para insights e modelagem de algoritmos inteligentes.

  1. Navegue até "Configurações do Projeto"

  2. Aba "Contas de Serviço"

  3. Clique em "Gerar nova chave privada"

  4. Um arquivo JSON será gerado, salve-o em local seguro.

  1. Recuperar atributos necessários.

Após download do JSON, recupere os atributos "client_email" e "project_id" que serão utilizados como client_email e id nas configurações do AgnosticData, respectivamente.

  1. Converta o private_key em base64

Por fim, converta o atributo private_key em base64 e adicione em private_key_base64. Se necessário utilize o script abaixo, passando o caminho do arquivo JSON como parâmetro, para gerar essa chave sem erros.

CUIDADO! Não utilize sites públicos (conversores online) para converter a chave privada em base 64. Faça você mesmo!

// recebe um caminho de entrada da chave de service account como uma chave JSON
// retira o campo "private_key" e converte para base64

const fs = require('fs');
const path = require('path');

const args = process.argv.slice(2);
const jsonPath = args[0];

const json = JSON.parse(fs.readFileSync(jsonPath, 'utf8'));
const privateKey = json.private_key;

const b64 = Buffer.from(privateKey).toString('base64');

console.log("\n", b64);

  1. Adicione ao AgnosticData

Acesse a console, navegue até " Meus Destinos" e clique em Firebase Firestore.

Em seguida, clique na aba "Configuração" e adicione os atributos recuperados nos passos 4 e 5.

🎉 Pronto! Agora você tem eventos anaytics em real-time completamente isolado 🔐 e em seu ambiente, sobre a gestão e a governança da sua empresa.

PreviousIntegraçõesNextEstratégias de Atribuição

Last updated