Créer des métriques de compteur

Cette page explique comment créer des métriques basées sur les journaux de type compteur à l'aide de Cloud Console, de l'API Logging et de l'outil de ligne de commande gcloud.

Pour obtenir une vue d'ensemble des métriques basées sur les journaux, consultez la page Présentation des métriques basées sur les journaux.

Créer une métrique de compteur

Lorsque vous réalisez un filtrage sur les entrées de journal que vous souhaitez comptabiliser dans votre métrique, vous pouvez utiliser des expressions régulières.

Console

Pour créer une métrique basée sur les journaux dans Cloud Console, procédez comme suit :

  1. Cliquez sur Logging de la suite des opérations Google Cloud > Métriques basées sur les journaux dans la liste de navigation de gauche dans Cloud Console, ou cliquez sur le bouton suivant :

    Accéder aux métriques basées sur les journaux

  2. Sélectionnez un projet dans le menu déroulant en haut de la page.

  3. Cliquez sur Create Metric (Créer une métrique) en haut de la page. Le volet Metric Editor (Éditeur de métriques) s'affiche sur le côté droit de la page et le panneau de visualisation affichant vos journaux sur le côté gauche :

    Créer une métrique de compteur

  4. Dans le panneau de visualisation, créez une requête qui n'affiche que les entrées de journal que vous souhaitez comptabiliser dans votre métrique.

    La requête de base est disponible dans les menus déroulants situés au-dessus des entrées de journal. Autrement, vous pouvez aussi accéder à l'interface de requête avancée en cliquant sur le menu déroulant situé à droite de la barre de recherche et en sélectionnant Convertir en filtre avancé.

    Pour en savoir plus, consultez la page concernant la visionneuse de journaux.

  5. Dans le panneau Éditeur de métriques, définissez les champs suivants :

    • Name (Nom) : choisissez un nom unique parmi les métriques basées sur les journaux de votre projet. Certaines restrictions en termes de dénomination s'appliquent, consultez la section Dépannage pour plus de détails.
    • Description : ajoutez une description pour la métrique.
    • Labels (Libellés) : (facultatif) ajoutez des libellés en cliquant sur Ajouter un élément pour chaque libellé. Pour plus de détails sur la définition des libellés, consultez la section Libellés de métriques basées sur les journaux.
    • Units (Unités) : pour les métriques de compteur, laissez ce champ vide ou insérez le chiffre 1.
    • Type : sélectionnez Compteur.

  6. Cliquez sur Créer une métrique pour créer la métrique.

API Logging

Pour créer une métrique de compteur, utilisez la méthode projects.metrics.create de l'API Logging. Vous pouvez tester la méthode dans l'explorateur d'API. Préparez les arguments de la méthode comme suit :

  1. Définissez le champ parent sur le projet dans lequel la métrique doit être créée :

    projects/[PROJECT_ID]

  2. Définissez le corps de la requête sur un objet LogMetric. En voici un exemple :

    {
  name:        "my-metric"
  description: "This is my metric."
  filter:      "resource.type=gce_instance AND logName:\"logs/syslog\"",
  metricDescriptor: {
      labels: [
        {
          key: "my-label",
          valueType: STRING,
          description: "This is my label.",
        }
      ]
  },
  labelExtractors: {
    "my-label":
      "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
    ...
  },
}

Notes :

  • Choisissez un nom de métrique unique parmi les métriques basées sur les journaux de votre projet. Certaines restrictions en termes de dénomination s'appliquent, consultez la section Dépannage pour plus de détails.

  • Pour les métriques de compteur, les champs LogMetric valueExtractor et bucketOptions n'ont aucune utilité et sont donc omis.

  • Si votre métrique ne comporte aucun libellé, vous pouvez omettre les champs metricDescriptor et labelExtractors. Si la métrique comporte des libellés, consultez la section Libellés de métriques basées sur les journaux pour obtenir plus d'informations sur les libellés et leur création dans l'API.

Pour plus de détails, reportez-vous au type LogMetric.

SDK Cloud

L'outil de ligne de commande gcloud accepte les métriques basées sur les journaux de type compteur sans libellés. Exécutez la commande suivante pour créer une métrique basée sur les journaux :

gcloud logging metrics create [METRIC_NAME] [METRIC_DESCRIPTION] [FILTER]

Par exemple, la commande suivante crée une métrique de compteur basée sur les journaux, nommée error_count.

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND logName:logs/syslog AND severity>=ERROR"

Choisissez un nom de métrique unique parmi les métriques basées sur les journaux de votre projet. Certaines restrictions en termes de dénomination s'appliquent, consultez la section Dépannage pour plus de détails.

Latence de création

Votre nouvelle métrique apparaît immédiatement dans la liste de métriques de la visionneuse de journaux et dans les menus Monitoring correspondants. Les données devraient être disponibles en moins d'une minute.

Inspecter les métriques de compteur

Pour répertorier les métriques basées sur les journaux dans votre projet GCP ou pour inspecter une métrique particulière dans votre projet, procédez comme suit :

Console de journalisation

Accédez à la page Métriques basées sur les journaux, qui répertorie toutes les métriques basées sur les journaux du projet actuellement sélectionné, en cliquant sur le bouton suivant :

Accéder aux métriques basées sur les journaux

Pour afficher les données d'une métrique basée sur les journaux, sélectionnez Afficher dans l'explorateur de métriques dans le menu à développer situé à droite de la liste des métriques.

API Logging

Répertorier les métriques

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans un projet, utilisez la méthode API projects.metrics.list. Spécifiez les paramètres associés à la méthode comme suit :

  • parent : nom de la ressource du projet : projects/[PROJECT_ID].
  • pageSize : nombre maximal de résultats.
  • pageToken : obtient la page suivante des résultats. Consultez la section projects.metrics.list.

Récupérer les définitions de métrique

Pour extraire une seule métrique basée sur les journaux définie par l'utilisateur, utilisez la méthode API projects.metrics.get. Spécifiez les paramètres associés à la méthode comme suit :

  • metricName : nom de la ressource de la métrique au format

    projects/[PROJECT_ID]/metrics/[METRIC_ID]

Lire les données de métrique

Pour lire les données de séries temporelles d'une métrique basée sur les journaux, utilisez la méthode projects.timeseries.list dans l'API Cloud Monitoring. Pour plus d'informations, consultez la section Lire les séries temporelles. Vous aurez besoin de l'information suivante pour les métriques basées sur les journaux :

  • Le type de métrique est logging.googleapis.com/user/[METRIC_ID].

SDK Cloud

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans votre projet, utilisez la commande suivante :

gcloud logging metrics list

Pour afficher une métrique basée sur les journaux définie par l'utilisateur dans votre projet, utilisez la commande suivante :

gcloud logging metrics describe [METRIC_NAME]

Pour plus de détails, exécutez la commande suivante :

gcloud logging metrics --help

Vous ne pouvez pas lire les données des séries temporelles d'une métrique à partir du SDK Cloud.

Mettre à jour les métriques de compteur

Vous pouvez mettre à jour une métrique basée sur les journaux pour modifier la description, les requêtes et les noms des champs y étant référencés. Vous pouvez ajouter de nouveaux libellés à la métrique, et modifier les expressions régulières utilisées pour extraire des valeurs associées à la métrique et à ses libellés.

Vous ne pouvez pas modifier les noms ni les types de métriques basées sur les journaux (ni leurs libellés) et vous ne pouvez pas supprimer les libellés existants dans une métrique basée sur les journaux.

Pour modifier ou mettre à jour une métrique basée sur les journaux, procédez comme suit :

Console Logging

  1. Accédez à la page Métriques basées sur les journaux :

    Accéder aux métriques basées sur les journaux

  2. Cliquez sur Modifier la métrique dans le menu situé à droite de la métrique basée sur les journaux que vous souhaitez modifier.

  3. Ne modifiez que les éléments autorisés dans la métrique.

  4. Cliquez sur OK.

API Logging

Pour modifier ou mettre à jour une métrique basée sur les journaux, appelez la méthode projects.metrics.update dans l'API. Définissez les champs comme suit :

  • metricName : nom complet de la ressource au format

    projects/[PROJECT_ID]/metrics/[METRIC_ID]

    Exemple :

    projects/my-gcp-project/metrics/my-error-metric

  • Dans le corps de la requête, incluez un objet LogMetric identique à la métrique existante, à l'exception des modifications et des ajouts que vous souhaitez effectuer.

SDK Cloud

Vous ne pouvez modifier la description et la requête d'une métrique existante qu'à l'aide du SDK Cloud.

Pour mettre à jour une métrique basée sur les journaux, exécutez la commande suivante. Vous pouvez spécifier l'un des indicateurs ou les deux :

gcloud logging metrics update [METRIC_NAME] --description=[DESCRIPTION] --log-filter=[FILTER]

Pour plus de détails, exécutez la commande suivante :

gcloud logging metrics update --help

Supprimer les métriques de compteur

Pour supprimer une métrique basée sur les journaux, procédez comme suit :

Console de journalisation

  1. Accédez à la page Métriques basées sur les journaux :

    Accéder aux métriques basées sur les journaux

  2. Sélectionnez les métriques que vous souhaitez supprimer et cliquez sur Supprimer en haut de la page.

    Vous pouvez également cliquer sur Supprimer la métrique dans le menu situé à droite de la métrique basée sur les journaux que vous souhaitez supprimer.

API Logging

Appelez la méthode projects.metrics.delete dans l'API.

SDK Cloud

Exécutez la commande suivante pour supprimer une métrique basée sur les journaux définie par l'utilisateur dans le projet en cours :

gcloud logging metrics delete [METRIC_NAME]

Pour plus de détails, exécutez la commande suivante :

gcloud logging metrics delete --help