Partilhar via

Esquema do log de operações do cliente de chamada

  • Artigo

O registro de operações do cliente de chamada fornece informações do lado do cliente sobre os pontos de extremidade de chamada e os participantes envolvidos em uma chamada. Esses logs estão atualmente em visualização e mostram os eventos do cliente que ocorreram em uma chamada e quais ações um cliente realiza durante uma chamada.

Esse log fornece informações detalhadas sobre as ações tomadas durante uma chamada e pode ser usado para visualizar e investigar problemas de chamada usando o Diagnóstico de Chamada para seu Recurso de Serviços de Comunicação do Azure. Saiba mais sobre o diagnóstico de chamadas

Como usar os registros de chamadas

Recomendamos que você colete todos os logs de chamadas disponíveis em um recurso de análise de log para que possa monitorar o uso de chamadas e melhorar a qualidade da chamada e receber novos logs dos Serviços de Comunicação do Azure à medida que os lançamos.

Existem duas ferramentas principais que pode utilizar para monitorizar as suas chamadas e melhorar a qualidade das chamadas.

Recomendamos usar os painéis do painel de insights de voz e vídeo para iniciar investigações de qualidade e usar diagnósticos de chamadas, conforme necessário, para explorar chamadas individuais quando precisar de detalhes granulares.

Conceitos de dados

Importante

Você deve coletar logs se quiser analisá-los. Para saber mais, consulte: Como faço para armazenar logs?

O Azure não armazena seus dados de log de chamadas, a menos que você habilite essas Configurações de Diagnóstico específicas. Os dados da sua chamada não estão disponíveis retroativamente. Você acumula dados depois de criar as Configurações de diagnóstico.

Definições de dados

Esquema do log de operações do cliente de chamada

Esta tabela descreve cada propriedade.

Property Description
CallClientTimeStamp O carimbo de data/hora para quando em operação ocorreu no SDK em UTC.
OperationName O nome da operação acionada no SDK de chamada.
CallId O ID exclusivo de uma chamada. Ele identifica eventos correlacionados de todos os participantes e pontos de extremidade que se conectam durante uma única chamada, e você pode usá-lo para unir dados de logs diferentes. É semelhante ao correlationId no log de resumo de chamadas e no log de diagnóstico de chamadas.
ParticipantId O identificador exclusivo para cada trecho de chamada (em chamadas em grupo) ou participante de chamada (em chamadas ponto a ponto). Essa ID é o principal ponto de correlação entre os logs CallSummary, CallDiagnostic, CallClientOperations e CallClientMediaStats.
OperationType Chame a Operação do Cliente.
OperationId Um GGUID exclusivo que identifica uma operação SDK.
DurationMs O tempo necessário para uma operação do SDK de chamada falhar ou ter êxito.
ResultType Campo que descreve o sucesso ou fracasso de uma operação.
ResultSignature Código de falha ou sucesso semelhante ao HTTP (200, 500).
SdkVersion A versão do SDK de chamada que está sendo usada.
UserAgent A cadeia de caracteres padrão do agente do usuário baseada no navegador ou na plataforma Calling SDK é usada.
ClientInstanceId Um GGUID exclusivo que identifica o objeto CallClient.
EndpointId A ID exclusiva que representa cada ponto de extremidade conectado à chamada, onde endpointType define o tipo de ponto de extremidade. Quando o valor é null, a entidade conectada é o servidor dos Serviços de Comunicação (endpointType = "Server").

Às vezes, o valor endpointId pode persistir para o mesmo usuário em várias chamadas (correlationId) para clientes nativos. O número de valores endpointId determina o número de logs de resumo de chamadas. Um log de resumo distinto é criado para cada valor endpointId.
OperationPayload Uma carga útil dinâmica que varia de acordo com a operação, fornecendo mais detalhes específicos da operação.

Dados de exemplo para vários tipos de chamada

Registro de operações do cliente de chamadas

Aqui está um log de operações do cliente de chamada para a operação "CreateView":

"properties": {
    "TenantId":               "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "TimeGenerated":          "2024-01-09T17:06:50.3Z",
    "CallClientTimeStamp":    "2024-01-09T15:07:56.066Z",
    "OperationName":          "CreateView" ,   
    "CallId":                 "92d800c4-abde-40be-91e9-3814ee786b19",
    "ParticipantId":          "2656fd6c-6d4a-451d-a1a5-ce1baefc4d5c",
    "OperationType":          "client-api-request",
    "OperationId":            "0d987336-37e0-4acc-aba3-e48741d88103",
    "DurationMs":             "577",
    "ResultType":             "Succeeded",
    "ResultSignature":        "200",
    "SdkVersion":             "1.19.2.2_beta",
    "UserAgent":              "azure-communication-services/1.3.1-beta.1 azsdk-js-communication-calling/1.19.2-beta.2 (javascript_calling_sdk;#clientTag:904f667c-5f25-4729-9ee8-6968b0eaa40b). Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
    "ClientInstanceId":       "d08a3d05-db90-415f-88a7-87ae74edc1dd",
    "OperationPayload":       "{"StreamType":"Video","StreamId":"2.0","Source":"remote","RemoteParticipantId":"remote"}",
    "Type":                   "ACSCallClientOperations"
}

Cada participante pode ter muitas métricas diferentes para uma chamada. Você pode executar a seguinte consulta no Log Analytics no portal do Azure para listar todas as operações possíveis no log de operações do cliente de chamada:

ACSCallClientOperations | distinct OperationName

Perguntas mais frequentes

Como faço para armazenar logs?

A secção seguinte explica este requisito.

Os logs dos Serviços de Comunicação do Azure não são armazenados em sua conta do Azure por padrão, portanto, você precisa começar a armazená-los para que ferramentas como informações de voz e vídeo, painel e diagnóstico de chamadas funcionem. Para coletar esses logs de chamadas, você precisa habilitar uma configuração de diagnóstico que direcione os dados da chamada para um espaço de trabalho do Log Analytics.

Os dados não são armazenados retroativamente, portanto, você começa a capturar registros de chamadas somente depois de definir a configuração de diagnóstico.

Siga as instruções para adicionar configurações de diagnóstico para seu recurso em Habilitar logs por meio de Configurações de Diagnóstico no Azure Monitor. Recomendamos que você colete inicialmente todos os logs. Depois de entender os recursos do Azure Monitor, determine quais logs você deseja reter e por quanto tempo. Ao adicionar sua configuração de diagnóstico, você será solicitado a selecionar logs. Para coletar todos os logs, selecione allLogs.

O volume, a retenção e o uso de dados no Log Analytics no Azure Monitor são cobrados por meio de medidores de dados existentes do Azure. Recomendamos que você monitore suas políticas de retenção e uso de dados para considerações de custo, conforme necessário. Para obter mais informações, consulte Controlando custos.

Se você tiver várias IDs de recurso dos Serviços de Comunicação do Azure, deverá habilitar essas configurações para cada ID de recurso.

Próximos passos