Partager via

Schéma du journal des opérations du client d’appel

  • Article

Le journal des opérations du client d’appel fournit des informations côté client sur les points de terminaison d’appel et les participants impliqués dans un appel. Ces journaux sont actuellement en préversion et affichent les événements du client qui se sont produits dans un appel et quelles actions le client a effectuées pendant un appel.

Ce journal fournit des informations détaillées sur les actions effectuées pendant un appel et peut être utilisé pour visualiser les problèmes d’appel et investiguer à l’aide de Diagnostics d’appel pour votre ressource Azure Communication Services. En savoir plus sur les diagnostics d’appel

Comment utiliser les journaux d’appels

Nous vous recommandons de collecter tous les journaux d’appels disponibles dans une ressource Log Analytics afin de pouvoir surveiller votre utilisation des appels et d’améliorer la qualité des appels, et pour pouvoir recevoir de nouveaux journaux d’Azure Communication Services dès qu’ils sont publiés.

Vous pouvez utiliser deux outils principaux pour surveiller vos appels et améliorer leur qualité.

Nous vous recommandons d’utiliser les tableaux de bord Tableau de bord des insights vocaux et vidéo pour démarrer des investigations de qualité et d’utiliser les diagnostics d’appel si nécessaire pour explorer des appels individuels quand vous avez besoin de détails précis.

Concepts de données

Important

Vous devez collecter les journaux si vous souhaitez les analyser. Pour plus d’informations, consultez Comment stocker les journaux ?

Azure ne stocke pas les données de vos journaux d’appels, sauf si vous activez ces paramètres de diagnostic spécifiques. Vos données d’appel ne sont pas disponibles rétroactivement. Vous accumulez des données une fois les paramètres de diagnostic créés.

Définitions des données

Schéma du journal des opérations du client d’appel

Ce tableau décrit chaque propriété.

Propriété Description
CallClientTimeStamp Horodatage de l’opération sur le SDK en heure UTC.
OperationName Nom de l’opération déclenchée sur le SDK Calling.
CallId ID unique pour un appel. Il identifie les événements corrélés de tous les participants et points de terminaison qui se connectent pendant un appel, et vous pouvez l’utiliser pour joindre les données de différents journaux. Il est similaire au correlationId dans le journal de résumé des appels et le journal de diagnostic des appels.
ParticipantId Identificateur unique pour chaque signal d’appel (dans les appels de groupe) ou participant d’appel (dans les appels pair à pair). Cet ID est le point de corrélation principal entre les journaux CallSummary, CallDiagnostic, CallClientOperations et CallClientMediaStats.
OperationType Opération du client d’appel.
OperationId GGUID unique identifiant une opération du SDK.
DurationMs Durée que prend une opération du SDK appelant pour échouer ou réussir.
ResultType Champ décrivant la réussite ou l’échec d’une opération.
ResultSignature Échec de type HTTP ou code de réussite (200, 500).
SdkVersion Version du SDK Calling en cours d’utilisation.
UserAgent La chaîne de l’agent utilisateur standard basée sur le navigateur ou le SDK Calling de la plateforme est utilisée.
ClientInstanceId GGUID unique identifiant l’objet CallClient.
EndpointId ID unique qui représente chaque point de terminaison connecté à l’appel, où endpointType définit le type de point de terminaison. Lorsque la valeur est nulle, l’entité connectée est le serveur Communication Services (endpointType = "Server").

La valeur endpointId peut parfois être conservée pour le même utilisateur sur plusieurs appels (correlationId) pour les clients natifs. Le nombre de valeurs endpointId détermine le nombre de journaux de résumé des appels. Un journal de résumé distinct est créé pour chaque valeur endpointId.
OperationPayload Charge utile dynamique qui varie en fonction de l’opération et qui fournit davantage de détails spécifiques à l’opération.

Exemples de données pour différents types d’appel

Journal des opérations du client d’appel

Voici un journal des opérations du client d’appel pour l’opération « 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"
}

Chaque participant peut avoir de nombreuses métriques différentes pour un appel. Vous pouvez exécuter la requête suivante dans Log Analytics dans le Portail Azure pour lister toutes les opérations possibles dans le journal des opérations du client d’appel :

ACSCallClientOperations | distinct OperationName

Forum aux questions

Comment stocker les journaux ?

La section suivante décrit cette exigence.

Les journaux Azure Communication Services ne sont pas stockés dans votre compte Azure par défaut. Vous devez donc commencer à les stocker pour que les outils comme le Tableau de bord des insights vocaux et vidéo et les diagnostics d’appel fonctionnent. Pour collecter les journaux des appels, vous devez activer un paramètre de diagnostic qui dirige les données d’appel vers un espace de travail Log Analytics.

Les données ne sont pas stockées rétroactivement, par conséquent vous commencez à capturer les journaux des appels uniquement après avoir configuré le paramètre de diagnostic.

Pour ajouter des paramètres de diagnostic à votre ressource, suivez les instructions de Activer les journaux via des paramètres de diagnostic dans Azure Monitor. Nous vous recommandons de collecter tous les journaux initialement. Une fois que vous avez compris les fonctionnalités d’Azure Monitor, déterminez les journaux que vous voulez conserver et pendant combien de temps. Quand vous ajoutez votre paramètre de diagnostic, vous êtes invité à sélectionner des journaux. Pour collecter tous les journaux, sélectionnez allLogs.

Le volume de vos données, leur conservation et leur utilisation dans Log Analytics au sein d’Azure Monitor sont facturés via les compteurs de données Azure existants. Nous vous recommandons d’analyser vos stratégies d’utilisation et de conservation des données pour des considérations de coût si nécessaire. Pour plus d’informations, consultez Contrôler les coûts.

Si vous avez plusieurs ID de ressource Azure Communications Services, vous devez activer ces paramètres pour chaque ID de ressource.

Étapes suivantes