Configurer des métriques de compteur

Console

Pour créer une métrique de compteur dans la console Google Cloud de votre projet Google Cloud, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Métriques basées sur les journaux.

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

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. Cliquez sur Créer une 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 Google 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.

   1. Utilisez le menu Sélectionner un projet ou un bucket de journaux pour choisir si la métrique compte les entrées de journal de votre projet Google Cloud ou uniquement celles d'un bucket de journaux spécifique.

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

   3. Pour voir les entrées de journal qui correspondent à votre filtre, cliquez sur Prévisualiser les journaux.

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

Vous pouvez créer une métrique basée sur les journaux sans libellés personnalisés à l'aide de la commande suivante:

gcloud logging metrics create METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  [--bucket-name="BUCKET_NAME"]

Par exemple, la commande suivante crée une métrique basée sur les journaux à l'échelle du projet appelée error_count.

gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"

Pour créer plutôt une métrique basée sur les journaux à l'échelle du bucket, fournissez l'indicateur --bucket_name:

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \
    --bucket-name projects/my-project/locations/global/buckets/my-test-bucket

Pour obtenir des instructions sur la création de libellés, consultez la section Configurer des libellés sur les 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. Si vous utilisez le volet APIs Explorer sur la page de référence, préparez les arguments comme suit:

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

   • Pour une métrique basée sur les journaux de portée projet, spécifiez le projet:

   projects/PROJECT_ID
   

   • Pour une métrique basée sur les journaux à l'échelle du bucket, spécifiez le bucket:

   projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
   

2. Définissez le corps de la requête sur un objet LogMetric. Voici un exemple d'objet pour une métrique de compteur:

   {
     name:        "my-metric"
     description: "This is my metric."
     filter:      "resource.type=gce_instance AND log_id(\"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 en savoir plus, consultez le type LogMetric.

Console

1. Dans la console Google Cloud, accédez à la page Métriques basées sur les journaux.

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

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. 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 Google Cloud en cours:

3. Pour afficher les données d'une métrique basée sur les journaux, cliquez sur le menu more_vert 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 Google 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 Google 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 Google Cloud CLI.

API

Répertorier les statistiques

Pour répertorier les métriques basées sur les journaux définies par l'utilisateur dans un projet Google 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 Google 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 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 projects.timeseries.list dans l'API Cloud Monitoring. Pour en savoir plus sur les données de séries temporelles, consultez la section 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

Console

1. Dans la console Google Cloud, accédez à la page Métriques basées sur les journaux.

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

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. Cliquez sur Modifier la métrique dans le menu more_vert pour 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

Utilisez la Google Cloud CLI pour modifier la description, la requête de filtrage et le bucket d'une métrique de compteur. Vous pouvez mettre à jour un ou tous les champs en même temps.

gcloud logging update METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  --bucket-name=BUCKET_NAME

Si vous modifiez le bucket associé à une métrique de portée bucket, toutes les données de métrique collectées avant la modification ne reflètent plus la configuration actuelle. Les données de métrique collectées pour le bucket précédent ne sont pas supprimées.

Pour mettre à jour les métriques de distribution ou d'autres champs de métrique de compteur, à l'exception de METRIC_NAME, créez un fichier contenant la spécification révisée de votre LogMetric au format JSON ou YAML. Mettez ensuite à jour la métrique en appelant la commande update avec le champ --config-from-file, en remplaçant FILENAME par le nom de votre fichier JSON ou YAML:

gcloud logging update METRIC_NAME --config-from-file FILENAME

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.

Console

1. Dans la console Google Cloud, accédez à la page Métriques basées sur les journaux.

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

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

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 more_vert 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 Google 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.