Génération de journaux de débogage

Utilisez les journaux de débogage pour résoudre les problèmes liés aux sessions de lecture MediaTailor et d'insertion de publicités. Pour générer des journaux de débogage, définissez le mode journal sur debug dans la demande du joueur sur. MediaTailor Pour les rapports côté serveur, définissez le mode journal dans la demande de lecture. Pour les rapports côté client, définissez le mode journal dans la demande d'initialisation de session.

Lorsque le mode journal est défini sur Debug, MediaTailor écrit les données du journal de débogage dans Logs. CloudWatch Les journaux de débogage fournissent des informations sur les événements suivants. Pour une liste complète des données produites dans les journaux de débogage, consultez la section Champs des journaux de débogage.

• Interaction avec l'origine : détails sur MediaTailor l'interaction avec le serveur d'origine. Par exemple, la réponse au manifeste d'origine, le type de manifeste et l'URL d'origine.

• Manifeste généré : détails sur la réponse de la session de lecture depuis MediaTailor. Par exemple, le manifeste qui MediaTailor génère.

• Session initialisée : détails de l'initialisation de la session, tels que l'ID de session.

Prérequis

Pour configurer le mode journal sur Debug, vous devez d'abord MediaTailor autoriser l'envoi de journaux CloudWatch, si ce n'est déjà fait. Une fois que vous avez accordé l'autorisation MediaTailor d'accès CloudWatch, vous êtes prêt à activer le mode journal de débogage. Pour plus d'informations sur la façon d'accorder MediaTailor l'autorisation d'accès, CloudWatch consultez Configuration des autorisations pour Amazon CloudWatch.

Comment configurer le mode journal pour le débogage

Cette section explique comment configurer le mode journal pour le débogage pour les rapports côté serveur et côté client.

Rapports côté serveur

Pour les rapports côté serveur, incluez le paramètre et la valeur de la ?aws.logMode=DEBUG requête dans la demande de GET HTTP lecture envoyée par votre joueur au point de terminaison HLS ou DASH. MediaTailor Pour des informations générales sur les rapports côté serveur, voir Rapports côté serveur.

Important

La valeur DEBUG est sensible à la casse.

Une demande de lecture qui inclut ?aws.logMode=DEBUG ressemble à ce qui suit :

Exemple Demande de lecture vers un point de terminaison HLS

GET <mediatailorURL>/v1/master/<hashed-account-id>/<origin-id>/<asset-id>?aws.logMode=DEBUG

Après avoir défini le mode journal sur le débogage, nous vous recommandons de vérifier que la session de journalisation du débogage est active. Pour vérifier que la session de débogage est active, vérifiez s'il existe des CloudWatch journaux pour l'ID de session. L'ID de session est inclus dans le point de terminaison de lecture qui MediaTailor fournit. Pour de plus amples informations, veuillez consulter Verify that the debug log mode is active for your playback session.

Rapports côté client

Pour les rapports côté client, incluez la logMode clé et la DEBUG valeur dans le corps de la demande d'initialisation de POST HTTP session de votre client au point de terminaison /v1/session. MediaTailor Pour des informations générales sur les rapports côté client, voir Rapports côté client.

Important

La valeur DEBUG est sensible à la casse.

Après avoir défini le mode journal sur Debug, nous vous recommandons de vérifier que la session de débogage est active. Pour vérifier que la session de débogage est active, vérifiez qu'un SESSION_INITIALIZED événement est associé à l'ID de session dans les CloudWatch journaux. L'ID de session est inclus dans le point de terminaison de lecture qui MediaTailor fournit. Pour de plus amples informations, veuillez consulter Verify that the debug log mode is active for your playback session.

Nombre maximum de sessions de débogage actives

Vous pouvez avoir un maximum de 10 sessions de journal de débogage actives. Lorsque votre lecteur envoie sa demande d'initialisation de session ou de lecture à MediaTailor, MediaTailor vérifie si la limite a été atteinte. Si c'est le cas, MediaTailor vérifie s'il existe des sessions périmées. Une session est périmée si elle n'a pas été consultée pendant un certain laps de temps. Pour les diffusions en direct, cette durée est de 10 minutes, pour les diffusions VOD, elle est de 30 minutes.

Si la limite maximale de sessions de journal de débogage actives est atteinte, les journaux de débogage ne sont pas écrits dans CloudWatch les journaux de votre session. Si les journaux de débogage ne figurent pas dans CloudWatch les journaux de votre session, vous avez peut-être atteint cette limite. Pour vérifier si la limite a été atteinte, consultezVerify that the debug log mode is active for your playback session.

Champs du journal de débogage

Le tableau suivant répertorie les champs du journal de débogage qui MediaTailor écrivent dans. CloudWatch

Champ	Description
awsAccountId	Votre Compte AWS carte d'identité.
customerId	Votre numéro de MediaTailor client.
eventTimestamp	L'horodatage ISO 8601 associé à l'événement du journal de débogage.
eventType	Type d'événement du journal de débogage. Valeurs : ORIGIN_INTERACTION— Détails de MediaTailor l'interaction avec le serveur d'origine. Par exemple, la réponse au manifeste d'origine, le type de manifeste et l'URL d'origine. GENERATED_MANIFEST— Détails sur la réponse de la session de lecture de MediaTailor. Par exemple, le manifeste qui MediaTailor génère. SESSION_INITIALIZED— Détails de l'initialisation de la session, tels que l'ID de session.
originRequestUrl	URL de votre serveur d'origine qui est récupérée pour cette demande.
mediaTailorPath	Le MediaTailor point de terminaison qui a été appelé, y compris les paramètres transmis MediaTailor dans la demande de manifeste initiale.
requestId	L'ID d'une requête HTTP spécifique adressée à MediaTailor.
responseBody	Le manifeste contenu dans le corps de la réponse à partir de MediaTailor. Il s'agit soit du manifeste d'origine brut, soit du manifeste généré par MediaTailor.
sessionId	ID de session de lecture.
sessionType	Type de session de lecture. Valeurs: HLS, DASH

Lire les journaux de débogage

MediaTailor écrit les journaux de débogage dans Amazon CloudWatch Logs. Les frais de CloudWatch journalisation habituels s'appliquent. Utilisez CloudWatch Insights pour lire les journaux de débogage. Pour plus d'informations sur l'utilisation de CloudWatch Logs Insights, consultez la section Analyser les données des CloudWatch journaux avec Logs Insights dans le guide de l'utilisateur d'AWS CloudWatch Logs.

Note

L'affichage des journaux de débogage peut prendre quelques minutes. CloudWatch Si les journaux ne s'affichent pas, attendez quelques minutes et réessayez. Si les journaux ne s'affichent toujours pas, cela signifie peut-être que vous avez atteint le nombre maximal de sessions de journal de débogage actives. Pour vérifier si tel est le cas, exécutez une CloudWatch requête pour savoir si une session de débogage a été initialisée pour votre session de lecture. Pour de plus amples informations, veuillez consulter Verify that the debug log mode is active for your playback session.

Exemples

Cette section contient des exemples de requêtes que vous pouvez utiliser pour lire les données du journal de MediaTailor débogage.

Exemple 1 : Vérifiez que le mode journal de débogage est actif pour votre session de lecture

fields @timestamp, @message
 | filter sessionId = "32002de2-837c-4e3e-9660-f3075e8dfd90"
 | filter eventType = "SESSION_INITIALIZED" # client-side reporting
 or mediaTailorPath like “/v1/master" # server-side reporting HLS
 or mediaTailorPath like “/v1/dash" # server-side reporting DASH

Exemple 2 : Afficher les réponses de votre origine

fields @timestamp, responseBody, @message, mediaTailorPath
 | filter eventType = "ORIGIN_MANIFEST" and sessionId = "32002de2-837c-4e3e-9660-f3075e8dfd90"

Exemple 3 : Afficher le manifeste généré par MediaTailor pour une session donnée

fields @timestamp, responseBody, @message
 | filter mediaTailorPath like "/v1/master/" and eventType = "GENERATED_MANIFEST" and sessionId = "32002de2-837c-4e3e-9660-f3075e8dfd90"

Exemple 4 : Afficher tous les événements pour une donnée requestId

Utilisez cette requête pour afficher le manifeste d'origine et le manifeste généré par MediaTailor.

fields @timestamp, responseBody, @message, mediaTailorPath
 | filter requestId = "e5ba82a5-f8ac-4efb-88a0-55bed21c45b4"