Utiliser les journaux de plate-forme

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Cette page explique comment utiliser les journaux de plate-forme générés par l'API Live Stream dans le cadre de Cloud Logging. L'API Live Stream utilise le nom de service de l'API Logging livestream.googleapis.com pour consigner l'activité liée aux canaux.

Avant de commencer

Activer la journalisation de la plate-forme

Par défaut, les journaux de plate-forme livestream.googleapis.com/channel_activities de l'API Live Stream sont désactivés. Pour activer les journaux, vous devez spécifier un niveau de gravité lors de la création ou de la mise à jour de la ressource de canal.

Pour activer les journaux, ajoutez le champ suivant au corps JSON de la requête de la méthode projects.locations.channels.create ou projects.locations.channels.patch:

   "logConfig": {
     "logSeverity": "SEVERITY_LEVEL"
   },
  

SEVERITY_LEVEL est l'un des éléments suivants :

  • OFF
  • DEBUG
  • INFO
  • WARNING
  • ERROR

Une fois que vous avez choisi un niveau de gravité du journal pour un canal, seuls les journaux de plate-forme dont le niveau de gravité est supérieur ou égal au niveau de gravité choisi sont consignés. Par exemple, si le niveau de gravité est WARNING, seuls les journaux avec le niveau de gravité WARNING et ERROR sont consignés. Si le niveau de gravité est INFO, tous les journaux, à l'exception de DEBUG, sont consignés.

Pour en savoir plus sur les niveaux de gravité des journaux, consultez la page LogSeverity.

Afficher les journaux de plate-forme

Pour afficher les journaux de la plate-forme, procédez comme suit:

Console

Pour afficher les journaux de la plate-forme dans Google Cloud Console:

  1. Accédez à l'explorateur de journaux :

    Accéder à l'explorateur de journaux

  2. Sélectionnez le projet Cloud approprié.

  3. Dans le champ Query (Requête), saisissez la commande de requête suivante:

    resource.labels.channel_id=CHANNEL_ID
    resource.labels.location=LOCATION
    logName="projects/PROJECT_ID/logs/livestream.googleapis.com%2Fchannel_activities"
    

    où :

    • CHANNEL_ID est l'ID de la chaîne que vous souhaitez déboguer ou surveiller. Exemple : my-channel.

    • LOCATION est l'emplacement de la chaîne que vous souhaitez déboguer ou surveiller. Exemple : us-central1.

    • PROJECT_ID est l'ID du projet contenant la version que vous souhaitez déboguer ou surveiller. Exemple : my-project.

  4. Cliquez sur Exécuter la requête.

Pour en savoir plus sur l'explorateur de journaux, consultez les pages Présentation de l'explorateur de journaux et Utiliser l'explorateur de journaux.

gcloud

L'outil de ligne de commande gcloud fournit une interface de ligne de commande à Cloud Logging.

Pour afficher les journaux channel_activities de votre projet, exécutez la commande suivante:

gcloud logging read "logName:projects/PROJECT_ID/logs/livestream.googleapis.com%2Fchannel_activities" --project=PROJECT_ID

PROJECT_ID est l'ID de votre projet Google Cloud.

Pour en savoir plus sur l'utilisation de l'outil gcloud avec Cloud Logging, consultez la section gcloud logging.

Utiliser les journaux de plate-forme

Cette section explique comment utiliser et interpréter des journaux de plate-forme spécifiques pour l'API Live Stream.

Modification du flux

Les journaux StreamingStateChange sont générés lorsque l'état de streaming d'un canal change. Le niveau de gravité d'un journal StreamingStateChange est défini sur ERROR lorsque le nouvel état du canal est STREAMING_ERROR. Sinon, le niveau de gravité d'un journal StreamingStateChange est INFO.

Voici un exemple de journal StreamingStateChange où l'état précédent est STREAMING_ERROR et le nouvel état est STREAMING :

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    message: "streaming state of channel "CHANNEL_ID" changes from "STREAMING_ERROR" to "STREAMING""
    streamingStateChange: {
      newState: "STREAMING"
      previousState: "STREAMING_ERROR"
      ...
    type: "livestream.googleapis.com/Channel"
  }
  severity: "INFO"
  ...
}

Vous pouvez ajouter des commandes dans le champ Query (Requête) de l'explorateur de journaux pour affiner les journaux affichés.

Ajoutez la commande suivante pour afficher tous les journaux StreamingStateChange dont le nouvel état est STREAMING:

jsonPayload.streamingStateChange.newState="STREAMING"

Ajoutez la commande suivante pour n'afficher que les journaux StreamingStateChange:

jsonPayload.streamingStateChange.newState:*

Erreur de streaming

Les journaux StreamingError sont générés lorsqu'un canal rencontre une erreur liée au streaming. Le niveau de gravité d'un journal StreamingError est ERROR.

Voici un exemple de journal StreamingError pour lequel l'API Live Stream a refusé l'autorisation d'importer des fichiers de sortie dans le bucket Cloud Storage spécifié:

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    message: "A live streaming encounters an error."
    streamingError: {
      error: {
        ...
        message: "Permission denied to access the GCS bucket "STORAGE_BUCKET_NAME""
  ...
  severity: "ERROR"
  ...
}

Cette erreur peut également se produire si le bucket Cloud Storage spécifié n'existe pas.

Si streamingError.message affiche le message This is due to an internal error. If the error persists, please contact support team, copiez le contenu du journal et envoyez-le à l'équipe d'assistance pour qu'elle la résolve.

Accepter

Les journaux InputAccept sont générés lorsqu'un flux d'entrée est correctement connecté au point de terminaison de l'API Live Stream. Le niveau de gravité des journaux InputAccept est INFO.

Le champ InputStreamProperty d'un journal InputAccept inclut les informations suivantes sur les sous-flux vidéo et audio du flux d'entrée:

Flux vidéo
  • index
  • codec
  • fréquence d'images
  • resolution
Flux audio
  • index
  • nombre de chaînes
  • mise en page de la chaîne
  • informations sur le codec

Vous pouvez utiliser les journaux InputAccept pour vérifier le format et l'état d'acceptation du flux d'entrée:

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    inputAccept: {
      inputAttachment: "input-primary"
      inputStreamProperty: {
        audioStreams: [
          0: {
            audioFormat: {
              channelCount: 2
              channelLayout: [
                0: "fl"
                1: "fr"
              ]
              codec: "aac"
            }
            index: 1
          }
        ]
        videoStreams: [
          0: {
            videoFormat: {
              codec: "h264"
              frameRate: 60
              heightPixels: 720
              widthPixels: 1280
      ...
      streamId: "STREAM_ID"
    }
    message: "Input stream "STREAM_ID" is accepted by channel "CHANNEL_ID" for input attachment "input-primary""
  }
  ...
  severity: "INFO"
  ...
}

Ajoutez la commande suivante dans le champ Requête de l'explorateur de journaux pour n'afficher que les journaux InputAccept pour un flux spécifique:

jsonPayload.inputAccept.streamId="STREAM_ID"

STREAM_ID est l'identifiant unique d'un flux inclus dans l'URI du point de terminaison d'entrée.

Erreur d'entrée

Les journaux InputError sont générés lorsqu'un flux d'entrée est refusé par l'API Live Stream. Le niveau de gravité d'un journal InputError est ERROR.

Voici un exemple de journal InputError où un flux d'entrée a été envoyé à un canal qui n'a pas encore commencé:

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    inputError: {
      error: {
        ...
        message: "The channel has not been started yet"
      }
      streamId: "STREAM_ID"
  ...
  severity: "ERROR"
  ...
}

Voici un exemple de journal InputError dans lequel un flux d'entrée en double a été envoyé à un canal en cours de diffusion:

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    inputError: {
      error: {
        code: 9
        message: "input stream "STREAM_ID" has been accepted. Please verify if another input stream has been streaming to the same endpoint."
      }
      streamId: "STREAM_ID"
  ...
  severity: "ERROR"
  ...
}

Ajoutez la commande suivante dans le champ Requête de l'explorateur de journaux pour n'afficher que les journaux InputError pour un flux spécifique:

jsonPayload.inputError.streamId="STREAM_ID"

STREAM_ID est l'identifiant unique d'un flux inclus dans l'URI du point de terminaison d'entrée.

Déconnecter

Les journaux InputDisconnect sont générés lorsque les flux d'entrée sont déconnectés de l'API Live Stream. Vous pouvez utiliser les journaux InputDisconnect pour rechercher les déconnexions de flux en direct inattendues. Le niveau de gravité d'un journal InputDisconnect est INFO.

Voici un exemple de journal InputDisconnect:

{
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.video.livestream.logging.v1.ChannelActivity"
    inputDisconnect: {
      inputAttachment: "input-primary"
      streamId: "STREAM_ID"
    }
    message: "Input stream "STREAM_ID" is disconnected by channel "CHANNEL_ID" for input attachment "input-primary""
  ...
  severity: "INFO"
  ...
}