Lendo logs verbosos

Esta página explica como interpretar a saída de logs verbosos do SDK Braze. Para cada canal de envio de mensagens, você encontrará as entradas de log-chave a serem observadas, o que elas significam e problemas comuns a serem observados.

Antes de começar, certifique-se de que você ativou o registro verboso e sabe como coletar logs na sua plataforma.

Sessões

As sessões são a base da análise de dados e entrega de mensagens do Braze. Muitos recursos de envio de mensagens—incluindo mensagens no app e Cartões de Conteúdo—dependem de uma sessão válida iniciando antes que possam funcionar. Se as sessões não estiverem registrando corretamente, investigue isso primeiro. Para saber mais sobre como ativar o rastreamento de sessões, veja Etapa 5: Ativar o rastreamento de sessões do usuário.

Entradas de log-chave

• swift
• android

1
Started user session (id: <SESSION_ID>)

1
2
3
4
5
Ended user session (id: <SESSION_ID>, duration: <DURATION>s)
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: sessionEnd(duration: <DURATION>)

1
2
3
4
New session created with ID: <SESSION_ID>
Session start event for new session received
Completed the openSession call
Opened session with activity: <ACTIVITY_NAME>

1
2
3
Closed session with activity: <ACTIVITY_NAME>
Closed session with session ID: <SESSION_ID>
Requesting data flush on internal session close flush timer.

O que verificar

• Verifique se um log de início de sessão aparece quando o app é iniciado.
• Se você não ver um início de sessão, verifique se o SDK está devidamente inicializado e se openSession (Android) está sendo chamado.
• No Android, confirme se uma solicitação de rede está sendo feita para o endpoint Braze. Se você não vê isso, verifique sua chave de API e a configuração do endpoint.

Notificações por push

Os registros de notificação por push ajudam a verificar se os tokens dos dispositivos estão registrados, se as notificações são entregues e se os eventos de clique são rastreados.

Registro de token

Quando uma sessão começa, o SDK registra o token por push do dispositivo com a Braze.

• swift
• android

1
2
3
4
Updated push notification authorization:
- authorization: authorized

Received remote notifications device token: <PUSH_TOKEN>

1
2
3
4
5
6
"attributes": [
  {
    "push_token": "<PUSH_TOKEN>",
    "user_id": "<USER_ID>"
  }
]

1
2
3
4
"device": {
  "ios_push_auth": "authorized",
  "remote_notification_enabled": 1
}

1
Registering for Firebase Cloud Messaging token using sender id: <SENDER_ID>

O que verificar

• Se push_token estiver faltando no corpo da solicitação, o token não foi capturado. Verifique a configuração do push no seu app.
• Se ios_push_auth mostrar denied ou provisional, o usuário não concedeu permissão total para push.
• No Android, se você ver SENDER_ID_MISMATCH, atualize seu ID do remetente FCM para corresponder ao seu projeto Firebase.

Entrega e clique do push

Quando uma notificação por push é tocada, o SDK registra o processamento e os eventos de clique.

• swift
• android

1
2
3
4
5
6
7
8
9
10
11
12
13
Processing push notification:
- date: <TIMESTAMP>
- silent: false
- userInfo: {
  "ab": { ... },
  "ab_uri": "<DEEP_LINK_OR_URL>",
  "aps": {
    "alert": {
      "body": "<MESSAGE_BODY>",
      "title": "<MESSAGE_TITLE>"
    }
  }
}

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: pushClick(campaignId: ...)

1
2
3
4
Opening '<URL>':
- channel: notification
- useWebView: false
- isUniversalLink: false

1
BrazeFirebaseMessagingService: Got Remote Message from FCM

O que verificar

• Verifique se a carga útil do push contém os title, body esperados e quaisquer links profundos (ab_uri).
• Confirme que um evento pushClick é registrado após o toque.
• Se o evento de clique estiver ausente, verifique se seu delegado de app ou manipulador de notificações está encaminhando corretamente os eventos de push para o SDK Braze.

Mensagem no app

Os registros de mensagens no app mostram todo o ciclo de vida: entrega do servidor, acionamento com base em eventos, exibição, registro de impressão e rastreamento de cliques.

Entrega da mensagem

Quando um usuário inicia uma sessão e é elegível para uma mensagem no app, o SDK recebe a carga útil da mensagem do servidor.

• swift
• android

1
2
3
4
5
6
7
8
9
"templated_message": {
  "data": {
    "message": "...",
    "type": "HTML",
    "message_close": "SWIPE",
    "trigger_id": "<TRIGGER_ID>"
  },
  "type": "inapp"
}

1
Triggering action: <CAMPAIGN_BSON_ID>

Exibição da mensagem e impressão

• swift
• android

1
2
3
In-app message ready for display:
- triggerId: (campaignId: <CAMPAIGN_ID>, ...)
- extras: { ... }

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: inAppMessageImpression(triggerIds: [...])

1
handleExistingInAppMessagesInStackWithDelegate:: Displaying in-app message

Eventos de clique e botão

Quando um usuário toca em um botão ou fecha a mensagem:

• swift
• android

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: inAppMessageButtonClick(triggerIds: [...], buttonId: "<BUTTON_ID>")

1
No matching trigger for event.

O que verificar

• Se a mensagem no app não for exibida, verifique se o início da sessão foi registrado primeiro.
• Filtre as respostas do seu endpoint Braze configurado para confirmar que a carga útil da mensagem foi entregue.
• Se as impressões não estão sendo registradas, verifique se você não implementou um delegado inAppMessageDisplay personalizado que suprime o registro.
• Se “Nenhum gatilho correspondente para o evento” aparecer, isso é normal e indica que nenhuma mensagem adicional no aplicativo está configurada para esse evento.

Cartões de conteúdo

Os logs do Cartão de Conteúdo ajudam você a verificar se os cartões estão sincronizados com o dispositivo, exibidos para o usuário e que as interações (impressões, cliques, dispensas) estão sendo rastreadas.

Sincronização do cartão

Os Cartões de Conteúdo são sincronizados no início da sessão e quando uma atualização manual é solicitada. Se nenhuma sessão for registrada, nenhum Cartão de Conteúdo será exibido.

• swift
• android

1
2
3
4
5
6
7
8
9
10
11
"cards": [
  {
    "id": "<CARD_ID>",
    "tt": "<CARD_TITLE>",
    "ds": "<CARD_DESCRIPTION>",
    "tp": "short_news",
    "v": 0,
    "cl": 0,
    "p": 1
  }
]

1
Requesting content cards sync.

Impressões, cliques e dispensas

• swift
• android

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardImpression(cardIds: [...])

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardClick(cardIds: [...])

1
2
3
Opening '<URL>':
- channel: contentCard
- useWebView: true

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardDismissed(cardIds: [...])

O que verificar

• Nenhum cartão exibido: Verifique se o início da sessão está registrado. Os cartões de conteúdo requerem uma sessão ativa para sincronizar.
• Cartões ausentes para novos usuários: Novos usuários em sua primeira sessão podem não ver os cartões de conteúdo até a próxima sessão. Esse é um comportamento esperado.
• Cartão excede o limite de tamanho: Cartões de conteúdo acima de 2 KB não são exibidos e a mensagem é abortada.
• Cartão persiste após parar a campanha: Verifique se a sincronização foi concluída após a campanha ser parada. Os cartões de conteúdo são removidos do dispositivo após uma sincronização bem-sucedida. Ao parar uma campanha, certifique-se de que a opção de remover cartões ativos dos feeds dos usuários esteja selecionada.

Deep links

Os registros de deep link aparecem em notificações por push, mensagens no aplicativo e cartões de conteúdo. A estrutura do registro é consistente, independentemente do canal de origem.

• swift
• android

1
2
3
4
5
Opening '<DEEP_LINK_URL>':
- channel: <SOURCE_CHANNEL>
- useWebView: false
- isUniversalLink: false
- extras: { ... }

1
adb shell am start -W -a android.intent.action.VIEW -d "<YOUR_DEEP_LINK>" "<YOUR_PACKAGE_NAME>"

O que verificar

• Verifique se a URL do deep link corresponde ao que você configurou na campanha.
• Se o deep link funcionar de um canal (por exemplo, push) mas não de outro (por exemplo, Content Cards), verifique se a sua implementação de manuseio de deep link suporta todos os canais.
• No iOS, links universais requerem manuseio adicional. Se os links universais não estiverem funcionando a partir dos canais do Braze, verifique se seu app implementa o protocolo BrazeDelegate para manuseio de URL.
• No Android, verifique se o manuseio automático de deep link está desativado se você usar um manipulador personalizado. Caso contrário, o manipulador padrão pode entrar em conflito com sua implementação.

Identificação do usuário

Quando um usuário é identificado com um external_id, o SDK registra um evento de mudança de usuário.

• android
• swift

1
changeUser called with: <EXTERNAL_ID>

1
"user_id": "<EXTERNAL_ID>"

Solicitações de rede

Logs detalhados incluem todos os detalhes da solicitação e resposta HTTP para comunicação do SDK com os servidores do Braze. Esses são úteis para diagnosticar problemas de conectividade.

Estrutura da solicitação

Filtre por solicitações para seu endpoint Braze configurado (por exemplo, sdk.iad-01.braze.com). A estrutura da solicitação inclui:

• swift
• android

1
2
3
4
5
6
7
[http] request POST: <YOUR_BRAZE_ENDPOINT>
- Headers:
  - Content-Type: application/json
  - X-Braze-Api-Key: <REDACTED>
  - X-Braze-Req-Attempt: 1
  - X-Braze-Req-Tokens-Remaining: <COUNT>
- Body: { ... }

1
Making request(id = <REQUEST_ID>) to <YOUR_BRAZE_ENDPOINT>

O que verificar

• chave de API: Verifique se XBraze-ApiKey corresponde à chave de API do seu espaço de trabalho.
• Endpoint: Confirme se a URL da solicitação corresponde ao endpoint de SDK configurado.
• Tentativas de nova tentativa: XBraze-Req-Attempt maior que 1 indica que o SDK está tentando novamente uma solicitação falhada, o que pode sinalizar problemas de conectividade.
• Limitação de taxa: XBraze-Req-Tokens-Remaining mostra os tokens de solicitação restantes. Uma contagem baixa pode indicar que o SDK está se aproximando dos limites de taxa.
• Solicitações ausentes: No Android, se você não ver uma solicitação para o endpoint do Braze após o início da sessão, verifique sua chave de API e a configuração do endpoint.

Abreviações comuns de eventos

Em cargas úteis de log detalhadas, o Braze usa nomes de eventos abreviados. Aqui está uma referência: