Logs de chats - Amazon IVS

Logs de chats

O recurso de registro de logs de chat permite a você gravar todas as mensagens de chat em uma sala em qualquer um dos três locais padrão: um bucket do Amazon S3, no Amazon CloudWatch Logs ou no Amazon Kinesis Data Firehose. Posteriormente, os logs podem ser usados para análise ou criação de uma repetição de chat vinculada a uma sessão de vídeo ao vivo.

Ativar o log de chat para uma sala

O log de chat é uma opção avançada que pode ser ativada pela associação de uma configuração de log a uma sala. Uma configuração de log é um recurso que permite especificar um tipo de local (bucket do Amazon S3, Amazon CloudWatch Logs ou Amazon Kinesis Data Firehose) em que as mensagens de uma sala serão registradas em log. Para obter detalhes sobre como criar e gerenciar configurações de log, consulte Conceitos básicos do Amazon IVS Chat e Referência de API do Amazon IVS Chat.

É possível associar até três configurações de log a cada sala, seja ao criar uma nova sala (CreateRoom) ou ao atualizar uma sala existente (UpdateRoom). É possível associar várias salas à mesma configuração de log.

Quando pelo menos uma configuração ativa de log é associada a uma sala, todas as solicitações de mensagens enviadas para essa sala por meio da API Amazon IVS Chat Messaging são automaticamente registradas nos locais especificados. Estes são os atrasos médios de propagação (desde quando uma solicitação de mensagem é enviada até o momento em que ela se torna disponível em seus locais especificados):

  • Bucket do Amazon S3: 5 minutos

  • Amazon CloudWatch Logs ou Amazon Kinesis Data Firehose: 10 segundos

Conteúdo da mensagem

Formato

{ "event_timestamp": "string", "type": "string", "version": "string", "payload": { "string": "string" } }

Campos

Campo Descrição

event_timestamp

Carimbo de data/hora em UTC de quando a mensagem foi recebida pelo Amazon IVS Chat.

payload

A carga JSON de Mensagem (inscrever) ou Evento (inscrever) que os clientes receberão do serviço Amazon IVS Chat.

type

Tipo da mensagem de chat.

  • Valores válidos: MESSAGE | EVENT

version

Versão do formato do conteúdo da mensagem.

Bucket do Amazon S3

Formato

Os logs de mensagens são organizados e armazenados com o seguinte prefixo S3 e formato de arquivo:

AWSLogs/<account_id>/IVSChatLogs/<version>/<region>/room_<resource_id>/<year>/<month>/<day>/<hours>/<account_id>_IVSChatLogs_<version>_<region>_room_<resource_id>_<year><month><day><hours><minutes>_<hash>.log.gz

Campos

Campo Descrição

<account_id>

ID da conta da AWS a partir da qual a sala é criada.

<hash>

Um valor de hash gerado pelo sistema para garantir exclusividade.

<region>

A região de serviço da AWS em que a sala foi criada.

<resource_id>

Parte de ID de recurso do ARN da sala.

<version>

Versão do formato do conteúdo da mensagem.

<year> / <month> / <day> / <hours> / <minute>

Carimbo de data/hora em UTC de quando a mensagem foi recebida pelo Amazon IVS Chat.

Exemplo

AWSLogs/123456789012/IVSChatLogs/1.0/us-west-2/room_abc123DEF456/2022/10/14/17/123456789012_IVSChatLogs_1.0_us-west-2_room_abc123DEF456_20221014T1740Z_1766dcbc.log.gz

Amazon CloudWatch Logs

Formato

Os logs de mensagens são organizados e armazenados com o seguinte formato de nome de fluxo de logs:

aws/IVSChatLogs/<version>/room_<resource_id>

Campos

Campo Descrição

<resource_id>

Parte de ID de recurso do ARN da sala.

<version>

Versão do formato do conteúdo da mensagem.

Exemplo

aws/IVSChatLogs/1.0/room_abc123DEF456

Amazon Kinesis Data Firehose

Os logs de mensagem são enviados ao stream de entrega como dados de streaming em tempo real para destinos como o Amazon Redshift, Amazon OpenSearch Service, Splunk e quaisquer endpoints de HTTP personalizados de propriedade de provedores de serviços de terceiros compatíveis. Para obter mais informações, consulte O que é o Amazon Kinesis Data Firehose.

Restrições

  • Você deve ser o proprietário do local de log em que as mensagens serão armazenadas.

  • A sala, a configuração de log e o local do log devem estar na mesma região da AWS.

  • Somente as configurações ativas de log estão disponíveis para o log de chat.

  • Somente é possível excluir uma configuração de log que não esteja mais associada a nenhuma sala.

Para registrar em log mensagens em um local de sua propriedade, é necessária autorização com suas credenciais da AWS. Para dar ao IVS Chat o acesso necessário, uma política de recursos (para um bucket do Amazon S3 ou o CloudWatch Logs) ou uma função vinculada ao serviço (SLR) do AWS IAM (para o Amazon Kinesis Data Firehose) é gerada automaticamente quando a configuração de log é criada. Tenha cuidado com qualquer modificação na função ou nas políticas, pois isso pode afetar a permissão para o log de chat.

Monitoramento de erros com o Amazon CloudWatch

É possível monitorar erros que ocorrem no log de chat com o Amazon CloudWatch e criar alarmes ou painéis para indicar ou responder às alterações de erros específicos.

Há vários tipos de erros. Para obter mais informações, consulte Monitorar o Chat do Amazon IVS.