Configurer des métriques de compteur

Cette page explique comment créer des métriques basées sur les journaux de type compteur avec la console, l'API Logging et la CLI Google Cloud.

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 créez un filtre pour les entrées de journal que vous souhaitez comptabiliser dans votre métrique, vous pouvez utiliser des expressions régulières. Notez que la longueur d'un filtre ne peut pas dépasser 20 000 caractères.

Console

Procédez comme suit pour créer une métrique de compteur dans la console de votre projet Google Cloud:

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

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

  2. Cliquez sur Créer la métrique. Le panneau Créer une métrique de journaux s'affiche.

  3. Définissez le Type de métrique : sélectionnez Compteur.

  4. Définissez les champs suivants dans la section Détails :

    • Nom de la métrique de journaux: choisissez un nom unique parmi les métriques basées sur les journaux de votre projet Cloud. Certaines restrictions en termes de dénomination s'appliquent, consultez la section Dépannage pour plus de détails.
    • Description : saisissez une description de la métrique.
    • Unités : laissez ce champ vide ou insérez le chiffre 1.

  5. Définissez le filtre de votre métrique dans la section Sélection du filtre.

    Créez un filtre qui ne collecte que les entrées de journal que vous souhaitez comptabiliser dans votre métrique à l'aide du langage de requête de journalisation. Vous pouvez également utiliser des expressions régulières pour créer les filtres de votre métrique.

    Cliquez sur Prévisualiser les journaux pour ouvrir un panneau affichant les entrées de journal qui correspondent à votre filtre.

  6. (Facultatif) Ajoutez un libellé dans la section Libellés. Pour obtenir des instructions sur la création de libellés, consultez la page Créer un libellé.

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

gcloud

La CLI Google Cloud accepte les métriques basées sur les journaux de type compteur sans étiquette. Exécutez la commande suivante pour créer une métrique basée sur les journaux :

gcloud logging metrics create METRIC_NAME \
      --description "METRIC_DESCRIPTION" \
      --log-filter "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 Cloud. Certaines restrictions en termes de dénomination s'appliquent. Pour en savoir plus, consultez la section Résoudre les problèmes liés aux métriques basées sur les journaux.

API

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\")",
    ...
  },
}

Remarques :

  • 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.

Latence de création

Votre nouvelle métrique apparaît immédiatement dans la liste des métriques de l'explorateur de journaux et dans les menus de Monitoring correspondants. Les données sont généralement disponibles en moins d'une minute.

Inspecter les métriques de compteur

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans votre projet Google Cloud ou pour inspecter une métrique particulière dans votre projet Cloud, procédez comme suit :

Console

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

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

Dans le volet Métriques définies par l'utilisateur, les métriques basées sur les journaux définies par l'utilisateur s'affichent dans le projet Cloud en cours:

Pour afficher les données d'une métrique basée sur les journaux, cliquez sur le menu sur la ligne de la métrique, puis sélectionnez Afficher dans l'explorateur de métriques.

gcloud

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans votre projet cloud, 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 cloud, utilisez la commande suivante :

gcloud logging metrics describe METRIC_NAME

Pour obtenir de l'aide, utilisez la commande suivante:

gcloud logging metrics --help

Vous ne pouvez pas lire les données des séries temporelles d'une métrique à partir de la CLI Google Cloud.

API

Répertorier les statistiques

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans un projet cloud, 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 Cloud : `projects/PROJECT_ID.
  • pageSize : nombre maximal de résultats.
  • pageToken : obtient la page suivante des résultats. Pour en savoir plus sur l'utilisation des jetons de page, consultez la page 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 sur les données de séries temporelles, consultez la page Lire les séries temporelles.

Pour lire une seule métrique basée sur les journaux définie par l'utilisateur, renseignez les paramètres de la méthode avec ce type de métrique et cet identifiant :

logging.googleapis.com/user/METRIC_ID

Mettre à jour les métriques de compteur

Vous pouvez modifier une métrique basée sur les journaux définie par l'utilisateur pour modifier sa description, son filtre 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 définies par l'utilisateur ou leurs libellés, et vous ne pouvez pas supprimer les libellés existants dans une métrique basée sur les journaux.

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

Console

  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 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 Mettre à jour la métrique.

gcloud

Vous ne pouvez modifier la description et la requête d'une métrique existante qu'à l'aide de la CLI Google 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

API

Pour modifier une métrique basée sur les journaux, utilisez 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.

Supprimer les métriques de compteur

Pour supprimer une métrique basée sur les journaux définie par l'utilisateur, procédez comme suit :

Console

  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 la métrique que vous souhaitez supprimer et cliquez sur Supprimer.

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

gcloud

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

gcloud logging metrics delete METRIC_NAME

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

gcloud logging metrics delete --help

API

Pour supprimer une métrique basée sur les journaux définie par l'utilisateur, utilisez la méthode projects.metrics.delete de l'API.

De plus, dans la page Métriques basées sur les journaux de Google Cloud Console, le volet Métriques définies par l'utilisateur de l'interface des métriques basées sur les journaux offre davantage de fonctionnalités pour vous aider à gérer les métriques définies par l'utilisateur dans votre projet Cloud. Pour en savoir plus, consultez le volet de métriques définies par l'utilisateur.