Configurer les métriques de distribution

Cette page explique comment créer des métriques basées sur les journaux de type distribution à l'aide de Cloud Console, de l'API Logging et de l'outil de ligne de commande gcloud. Pour obtenir une vue globale des métriques basées sur les journaux, consultez la page Présentation des métriques basées sur les journaux.

Présentation

Les métriques de distribution nécessitent à la fois un filtre pour sélectionner les entrées de journal pertinentes et un extracteur de valeur pour saisir la valeur numérique de distribution. L'extracteur de valeur est du même type que celui utilisé pour les libellés personnalisés.

Une métrique de distribution enregistre la distribution statistique des valeurs extraites dans des buckets d'histogramme. Les valeurs extraites ne sont pas enregistrées individuellement, mais leur distribution entre les buckets configurés est enregistrée, ainsi que le nombre, la moyenne et la somme des écarts au carré des valeurs. Vous pouvez utiliser la disposition par défaut des buckets d'histogramme dans votre distribution ou vous pouvez affiner les limites des buckets pour capturer approximativement les valeurs.

Créer une métrique de distribution

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. Notez que le filtre ne doit pas dépasser 20 000 caractères.

Console

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

  1. Accédez à la page Logging > 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 Distribution.

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

    • Nom de la métrique de journal: choisissez un nom unique parmi les métriques basées sur les journaux de votre projet Cloud. Des restrictions de dénomination s'appliquent. Pour en savoir plus, consultez la section Dépannage.
    • Description: saisissez une description de la métrique.
    • Units (Unités) : (facultatif) pour les métriques de distribution, vous avez la possibilité de saisir des unités, telles que s, ms, etc. Pour en savoir plus, consultez le champ unit de l'objet MetricDescriptor.
  5. Définissez le filtre de la métrique dans la section Sélection du filtre.

    1. 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 des filtres pour votre métrique.

    2. Nom du champ: saisissez le champ d'entrée de journal qui contient la valeur de distribution. Des suggestions sont affichées à mesure que vous saisissez des caractères. Exemple :

       protoPayload.latency
      
    3. Extraction expression (Expression d'extraction) : (facultatif) si Field name (Nom du champ) contient toujours une valeur numérique convertible en type double, vous pouvez laisser ce champ vide. Sinon, spécifiez une expression régulière qui extrait la valeur de distribution numérique de la valeur du champ.

      Exemple : Supposons que votre champ d'entrée de journal latency contienne un nombre suivi de ms, pour "millisecondes". L'expression régulière suivante permet d'extraire le chiffre sans le suffixe d'unité :

      ([0-9.]+)
      

      Les parenthèses, connues sous le nom de groupe de capture de l'expression régulière, permettent d'identifier la partie de la correspondance de texte qui sera extraite. Pour plus de détails, consultez la section Utiliser des expressions régulières.

    • Avancé (buckets d'histogramme): (facultatif) cliquez sur Avancé pour ouvrir une section du formulaire dans laquelle vous pouvez spécifier des mises en page de buckets personnalisées. Si vous ne spécifiez pas la mise en page de vos buckets, une mise en page par défaut est fournie. Pour en savoir plus, consultez la section Buckets d'histogrammes sur cette page.

    Cliquez sur Prévisualiser les journaux pour ouvrir un panneau contenant les entrées de journal correspondant à 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 section Créer un libellé.

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

gcloud

Pour créer une métrique de distribution à l'aide de l'outil de ligne de commande gcloud, spécifiez la configuration complète de la métrique à l'aide de l'option --config-from-file. Le format de configuration est JSON ou YAML. Pour obtenir une description complète de la configuration LogMetric, consultez la documentation de la méthode projects.metrics.

API

Pour créer une métrique de distribution, utilisez la méthode projects.metrics.create de l'API Logging. Vous pouvez essayer la méthode dans [APIs Explorer][apis-explorer-create]. 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. Voici un exemple de l'objet pour une métrique de distribution :

    {
      name:        "my-metric"
      description: "Description of my-metric."
      filter:      "resource.type=gce_instance AND logName:\"logs/syslog\"",
      valueExtractor: "REGEXP_EXTRACT(jsonPayload.latencyField, \"([0-9.]+)ms\")",
    
      labelExtractors: {
        "my-label-1":
          "REGEXP_EXTRACT(jsonPayload.someField, \"before ([[:word:]]+) after\")",
        "my-label-2":
          "EXTRACT(jsonPayload.anotherField, \"before ([0-9]+) after\")",
      },
      bucketOptions: { [SEE_BELOW] },
    
      metricDescriptor: {
          metricKind: DELTA,
          valueType: DISTRIBUTION,
          unit: "ms",
    
          labels: [
            {
              key: "my-label-1",
              valueType: STRING,
              description: "Description of string my-label-1.",
            },
            {
              key: "my-label-2",
              valueType: INT64,
              description: "Description of integer my-label-2.",
            }
          ]
      },
    }
    

Remarques pour les métriques de distribution :

  • Certaines restrictions en termes de dénomination s'appliquent, consultez la section Dépannage pour plus de détails.

  • metricDescriptor : un objet MetricDescriptor. metricKind doit être DELTA. valueType doit être DISTRIBUTION.

Buckets d'histogrammes

Les métriques de distribution incluent un histogramme qui compte le nombre de valeurs comprises dans des plages spécifiées (buckets). Vous pouvez avoir jusqu'à 200 buckets dans une métrique de distribution.

Chaque bucket comprend deux valeurs limites (L et H) définissant la valeur la plus basse et la valeur la plus élevée qu'il couvre. La largeur du bucket est égale à H - L. Comme il ne peut pas y avoir d'intervalles entre les buckets, la limite inférieure d'un bucket correspond à la limite supérieure du bucket précédent, et ainsi de suite. Pour que les limites n'appartiennent pas à plus d'un bucket, un bucket inclut la limite inférieure, et la limite supérieure appartient au bucket suivant.

Toutes les dispositions de buckets peuvent être spécifiées en répertoriant, dans l'ordre croissant, les valeurs limites entre les buckets individuels. Le premier bucket, le bucket de dépassement de capacité négatif, inclut les valeurs inférieures à la première limite. Le dernier bucket, le bucket de dépassement de capacité positif, inclut les valeurs supérieures ou égales à la dernière limite. Les autres buckets incluent les valeurs supérieures ou égales à leur limite inférieure et les valeurs inférieures à leur limite supérieure. S'il y a n valeurs limites, il y a n+1 buckets. En excluant les buckets de dépassement de capacité négatif et positif, on obtient n-1 buckets finis.

Il existe trois manières différentes de spécifier les limites entre les buckets d'histogrammes pour les métriques de distribution. Vous pouvez spécifier une formule pour les valeurs limites ou les répertorier :

  • Linear (Linéaire) (offset, width, i) : tous les buckets ont la même largeur. Les limites sont offset + width * i, pour i=0,1,2,...,N. Pour en savoir plus sur les buckets linéaires, consultez la documentation de référence de l'API.

  • Exponential (Exponentielle) (scale, growth_factor, i) : la largeur des buckets augmente pour les valeurs plus élevées. Les limites sont scale * growth_factori, pour i=0,1,2,...,N. Pour plus d'informations sur les buckets exponentiels, consultez la documentation de référence de l'API.

  • Explicit (Explicite) : vous répertoriez toutes les limites des buckets dans le tableau bounds. Le bucket i comporte les limites suivantes :

    Limite supérieure : limites[i] pour (0 <= i < N-1)
    Limite inférieure : limites[i - 1] pour (1 <= i < N)

    Pour plus d'informations sur les buckets explicites, consultez la section Documentation de référence sur les API.

La façon dont vous spécifiez les buckets d'histogrammes est expliquée à la section suivante :

Console

Le sous-menu Histogram buckets (Buckets d'histogrammes) s'ouvre lorsque vous créez une métrique de distribution et que vous cliquez sur More (Plus) dans le formulaire Metric editor (Éditeur de métriques). Le sous-formulaire associé à la disposition du bucket linéaire se présente comme suit :

Buckets d&#39;histogrammes

Buckets linéaires : remplissez le formulaire du bucket d'histogrammes comme suit.

  • Type : linear (linéaire).
  • Start value (a) (Valeur de début) : limite inférieure du premier bucket fini. Cette valeur est appelée offset dans l'API.
  • Number of buckets (N) (Nombre de buckets) : nombre de buckets finis. La valeur doit être supérieure ou égale à 0.
  • Bucket width (b) (Largeur du bucket) : différence entre la limite supérieure et la limite inférieure dans chaque bucket fini. La valeur doit être supérieure à 0.

Par exemple, si la valeur de départ est 5, le nombre de buckets est de 4 et la largeur du bucket est de 15, les plages de buckets sont les suivantes :

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Buckets explicites : remplissez le formulaire de bucket d'histogrammes comme suit.

  • Type : explicite.
  • Bounds (b) (Limites) : liste séparée par des virgules des valeurs limites des buckets finis. Cette option détermine également le nombre de buckets et leur largeur.

Par exemple, si la liste des limites est la suivante :

0, 1, 2, 5, 10, 20

il y a cinq buckets finis avec les plages suivantes :

(-INF, 0), [0, 1), [1, 2), [2,5), [5, 10), [10, 20), [20, +INF)

Buckets exponentiels : remplissez le formulaire du bucket d'histogrammes comme suit.

  • Type : exponential (exponentiel).
  • Number of buckets (N) (Nombre de buckets) : nombre total de buckets finis. La valeur doit être supérieure à 0.

  • Linear scale (a)(Échelle linéaire) : échelle linéaire pour les buckets. La valeur doit être supérieure à 0.

  • Exponential growth factor (b) (Facteur de croissance exponentiel) : facteur de croissance exponentiel pour les buckets. La valeur doit être supérieure à 1.

Par exemple, si N=4, a=3 et b=2, les plages de bucket sont les suivantes :

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

Pour plus d'informations sur les buckets, consultez BucketOptions dans l'API Cloud Monitoring.

API

La disposition facultative du bucket est spécifiée par le champ bucketOptions de l'objet LogMetric fourni à projects.metrics.create. Pour en savoir plus sur l'objet LogMetric, consultez Créer une métrique de distribution sur cette page. Les ajouts pour les dispositions de bucket sont indiqués ci-dessous :

Buckets linéaires

{ # LogMetric object
  ...
  bucketOptions: {
    linearBuckets: {
      numFiniteBuckets: 4,
      width: 15,
      offset: 5
    }
  },

Dans l'exemple précédent, les buckets suivants sont créés :

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Buckets explicites : les limites sont répertoriées individuellement.

{ # LogMetric object
  ...
  bucketOptions: {
    explicitBuckets: {
      bounds: [0, 1, 2, 5, 10, 20 ]
    }
  },

Dans l'exemple précédent, les buckets suivants sont créés :

(-INF, 0), [0, 1), [1, 2), [2, 5), [5, 10), [10, 20), [20, +INF)

Buckets exponentiels : les limites sont scale x growthFactor ^ ii=0,1,2, …, numFiniteBuckets.

{ # LogMetric object
  ...
  bucketOptions: {
    exponentialBuckets: {
      numFiniteBuckets: 4,
      growthFactor: 2,
      scale: 3
    }
  },
  ...
}

Dans l'exemple précédent, les buckets suivants sont créés :

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

Latence de création

Votre nouvelle métrique apparaît immédiatement dans la liste des statistiques et dans les menus Monitoring correspondants. Toutefois, la collecte de données pour les entrées de journal correspondantes peut prendre jusqu'à une minute.

Inspecter les métriques de distribution

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 actuel:

Pour afficher les données dans une métrique basée sur les journaux, cliquez sur le menu sur la ligne de la métrique et 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 de séries temporelles d'une métrique à partir du SDK 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 de 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 documentation sur projects.metrics.list.

Récupérer les définitions des métriques

Pour récupérer une seule métrique basée sur les journaux définie par l'utilisateur, utilisez la méthode API projects.metrics.get. Renseignez les paramètres de 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 dans une métrique basée sur les journaux, utilisez la méthode 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 le type de métrique et l'identifiant suivants:

logging.googleapis.com/user/METRIC_ID

Mettre à jour les métriques de distribution

Vous pouvez modifier une métrique basée sur les journaux définie par l'utilisateur afin de modifier sa description, son filtre et le nom des champs référencés dans la métrique. Vous pouvez ajouter des libellés à la métrique ainsi que les expressions régulières utilisées pour extraire des valeurs de la métrique et de 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, ni leurs libellés. Vous ne pouvez pas non plus supprimer les libellés existants dans une métrique basée sur les journaux.

Pour modifier 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. Modifiez 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 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

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 distribution

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, puis 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

Utilisez 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 dans l'API.

De plus, sur 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 la section Volet de métriques définies par l'utilisateur.