Présentation des métriques définies par l'utilisateur

Les métriques définies par l'utilisateur sont toutes les métriques qui ne sont pas définies par Google Cloud. Il s'agit des métriques que vous pouvez définir et des métriques définies par une application tierce. Les métriques définies par l'utilisateur vous permettent de capturer des données spécifiques à une application ou des données système côté client. Les métriques intégrées collectées par Cloud Monitoring peuvent vous donner des informations sur la latence du backend ou l'utilisation du disque, mais elles ne peuvent pas vous indiquer, par exemple, le nombre de routines d'arrière-plan générées par votre application.

Vous pouvez également créer des métriques basées sur le contenu des entrées de journal. Les métriques basées sur les journaux sont une classe de métriques définies par l'utilisateur, mais vous devez les créer à partir de Cloud Logging. Pour en savoir plus sur les métriques basées sur les journaux, consultez la présentation des métriques basées sur les journaux.

Les métriques définies par l'utilisateur sont parfois appelées métriques personnalisées ou métriques spécifiques à une application. Ces métriques vous permettent, ou à une application tierce, de définir et de collecter des informations que les métriques Cloud Monitoring intégrées ne peuvent pas obtenir. Vous pouvez capturer ces métriques à l'aide d'une API fournie par une bibliothèque pour qu'elle instrumente votre code, puis envoyer les métriques à une application backend telle que Cloud Monitoring.

Vous pouvez créer des métriques définies par l'utilisateur, à l'exception des métriques basées sur les journaux, directement à l'aide de l'API Cloud Monitoring. Toutefois, nous vous recommandons d'utiliser OpenTelemetry. Pour savoir comment créer des métriques définies par l'utilisateur, consultez les documents suivants:

En ce qui concerne Cloud Monitoring, vous pouvez utiliser des métriques définies par l'utilisateur comme les métriques intégrées. Vous pouvez les représenter, y définir des alertes, les lire et les surveiller. Pour en savoir plus sur la lecture des données de métrique, consultez les documents suivants:

  • La section List metric and resource types (Liste des types de métriques et de ressources) explique comment lister et examiner vos types de métriques définis par l'utilisateur et intégrés. Par exemple, vous pouvez utiliser les informations de ce document pour lister tous les descripteurs de métriques définis par l'utilisateur dans votre projet.
  • Récupérer des données de séries temporelles explique comment récupérer des données de séries temporelles à partir de métriques à l'aide de l'API Monitoring. Par exemple, ce document explique comment utiliser l'API pour obtenir l'utilisation du processeur pour les instances de machine virtuelle (VM) de votre projet Google Cloud.

La console Google Cloud propose une page dédiée pour vous aider à consulter votre utilisation des métriques définies par l'utilisateur. Pour en savoir plus sur le contenu de cette page, consultez la section Afficher et gérer l'utilisation des métriques.

Descripteurs de métriques pour les métriques définies par l'utilisateur

Chaque type de métrique doit comporter un descripteur de la métrique qui définit l'organisation des données de métrique. Le descripteur de la métrique définit également les libellés et le nom de la métrique. Par exemple, les listes de métriques affichent les descripteurs de métrique pour tous les types de métriques intégrés.

Cloud Monitoring peut créer le descripteur de la métrique à votre place à l'aide des données de métrique que vous écrivez, ou vous pouvez créer explicitement le descripteur de métrique, puis écrire des données de métrique. Dans les deux cas, vous devez décider comment organiser vos données de métrique.

Exemple de conception

Supposons que vous disposiez d'un programme qui s'exécute sur une seule machine et que ce programme appelle les programmes auxiliaires A et B. Vous souhaitez comptabiliser la fréquence d'appel des programmes A et B. Vous souhaitez également savoir quand le programme A est appelé plus de 10 fois par minute et que le programme B est appelé plus de 5 fois par minute. Enfin, supposons que vous n'ayez qu'un seul projet Google Cloud et que vous prévoyiez d'écrire les données dans la ressource surveillée global.

Cet exemple décrit quelques conceptions différentes que vous pouvez utiliser pour vos métriques définies par l'utilisateur:

  • Vous utilisez deux métriques: Metric-type-A comptabilise les appels vers le programme A et Metric-type-B les appels vers le programme B. Dans ce cas, Metric-type-A contient une série temporelle et Metric-type-B contient une série temporelle.

    Avec ce mode de données, vous pouvez créer une règle d'alerte unique avec deux conditions ou deux règles d'alerte chacune avec une condition. Une règle d'alerte peut accepter plusieurs conditions, mais elle possède une configuration unique pour les canaux de notification.

    Ce modèle peut être approprié lorsque vous n'êtes pas intéressé par des similitudes entre les données des activités surveillées. Dans cet exemple, les activités correspondent au taux d'appels aux programmes A et B.

  • Vous utilisez une seule métrique et un libellé pour stocker un identifiant de programme. Par exemple, le libellé peut stocker la valeur A ou B. Monitoring crée une série temporelle pour chaque combinaison unique de libellés. Par conséquent, il existe une série temporelle dont la valeur de libellé est A et une autre dont la valeur de libellé est B.

    Comme avec le modèle précédent, vous pouvez créer une ou deux règles d'alerte. Cependant, les conditions de la règle d'alerte sont plus complexes. Une condition qui génère un incident lorsque le taux d'appels du programme A dépasse un seuil doit utiliser un filtre qui n'inclut que des points de données dont la valeur du libellé est A.

    L'un des avantages de ce modèle est qu'il facilite le calcul des ratios. Par exemple, vous pouvez déterminer la somme totale due aux appels à A.

  • Vous utilisez une seule métrique pour comptabiliser le nombre d'appels, mais vous n'utilisez pas de libellé pour enregistrer le programme ayant été appelé. Dans ce modèle, il existe une seule série temporelle qui combine les données des deux programmes. Cependant, vous ne pouvez pas créer une règle d'alerte qui répond à vos objectifs, car les données de deux programmes ne peuvent pas être séparées.

Les deux premières conceptions vous permettent de répondre à vos exigences d'analyse des données. En revanche, la dernière ne le fait pas.

Pour en savoir plus, consultez la section Créer une métrique définie par l'utilisateur.

Noms des métriques définies par l'utilisateur

Lorsque vous créez une métrique définie par l'utilisateur, vous définissez un identifiant de chaîne qui représente le type de métrique. Cette chaîne doit être unique parmi les métriques définies par l'utilisateur de votre projet Google Cloud. Elle doit utiliser un préfixe qui marque la métrique comme étant une métrique définie par l'utilisateur. Pour Monitoring, les préfixes autorisés sont custom.googleapis.com/, workload.googleapis.com/, external.googleapis.com/user et external.googleapis.com/prometheus. Le préfixe est suivi d'un nom qui décrit les éléments que vous collectez. Pour en savoir plus sur la méthode recommandée pour nommer une métrique, consultez la section Conventions d'attribution de noms aux métriques. Voici des exemples des deux genres d'identifiants employés pour les types de métriques :

    custom.googleapis.com/cpu_utilization
    custom.googleapis.com/instance/cpu/utilization

Dans l'exemple précédent, le préfixe custom.googleapis.com indique que les deux métriques sont des métriques définies par l'utilisateur. Les deux exemples concernent des métriques qui mesurent l'utilisation du processeur. Toutefois, ils utilisent des modèles organisationnels différents. Si vous prévoyez d'utiliser un grand nombre de métriques définies par l'utilisateur, nous vous recommandons d'utiliser une structure d'attribution de noms hiérarchique comme celle utilisée dans le deuxième exemple.

Tous les types de métriques possèdent des identifiants uniques globaux appelés noms de ressources. La structure d'un nom de ressource pour un type de métrique est la suivante :

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

où METRIC_TYPE est l'identifiant de chaîne du type de métrique. Si les exemples de métriques précédents sont créés dans le projet my-project-id, leurs noms de ressource pour ces métriques seront les suivants:

    projects/my-project-id/metricDescriptors/custom.googleapis.com/cpu_utilization
    projects/my-project-id/metricDescriptors/custom.googleapis.com/instance/cpu/utilization

Nom ou type ? Dans le descripteur de métrique, le champ name enregistre le nom de ressource du type de métrique et le champ type enregistre la chaîne METRIC_TYPE.

Types de ressources surveillées pour les métriques définies par l'utilisateur

Lorsque vous écrivez vos données dans une série temporelle, vous devez indiquer leur origine. Pour spécifier la source des données, vous devez choisir un type de ressource surveillée qui représente l'origine de vos données, puis l'utiliser pour décrire l'origine spécifique. La ressource surveillée ne fait pas partie du type de métrique. La série temporelle dans laquelle vous écrivez des données inclut une référence au type de métrique et une référence à la ressource surveillée. Le type de métrique décrit les données, tandis que la ressource surveillée décrit l'origine des données.

Examinez la ressource surveillée avant de créer votre descripteur de la métrique. Le type de ressource surveillée que vous utilisez a une incidence sur les libellés que vous devez inclure dans le descripteur de métrique. Par exemple, la ressource de VM Compute Engine contient des libellés pour l'ID de projet, l'ID de l'instance et la zone de l'instance. Par conséquent, si vous prévoyez d'écrire votre métrique pour une ressource de VM Compute Engine, les libellés de ressources incluent l'ID d'instance. Vous n'avez donc pas besoin d'un libellé pour l'ID d'instance dans le descripteur de la métrique.

Chacun des points de données de votre métrique doit être associé à un objet de type "ressource surveillée". Les points de données des différents objets de type "ressource surveillée" sont stockés dans des séries temporelles distinctes.

Vous devez utiliser l'un des types de ressources surveillées suivants avec des métriques définies par l'utilisateur:

Une pratique courante consiste à utiliser les objets de type "ressource surveillée" représentant les ressources physiques sur lesquelles le code de votre application est exécuté. Cette approche présente plusieurs avantages :

  • Vous obtenez de meilleures performances par rapport à l'utilisation d'un seul type de ressource.
  • Vous évitez les données hors service causées par plusieurs processus écrivant dans la même série temporelle.
  • Vous pouvez regrouper vos données de métrique définie par l'utilisateur avec d'autres données de métrique provenant des mêmes ressources.

global et ressources génériques

Les types de ressources generic_task et generic_node sont utiles lorsqu'aucun des types de ressources plus spécifiques n'est approprié. Le type generic_task sert à définir des ressources de type "tâche", telles que des applications. Le type generic_node sert à définir des ressources de type "nœud", telles que des machines virtuelles. Les deux types generic_* ont plusieurs libellés communs dont vous pouvez vous servir pour définir des objets de ressource uniques. Cela facilite leur utilisation dans les filtres de métriques pour les agrégations et les réductions.

En revanche, le type de ressource global ne comporte que le libellé project_id. Lorsque vous avez plusieurs sources de métriques dans un projet, l'utilisation du même objet de ressource global peut provoquer des conflits et des écrasements de vos données de métriques.

Méthodes d'API compatibles avec les métriques définies par l'utilisateur

Le tableau suivant indique les méthodes de l'API Monitoring compatibles avec les métriques définies par l'utilisateur et celles compatibles avec les métriques intégrées:

Méthode API Monitoring Utilisation avec des
métriques définies par l'utilisateur		 Utilisation avec des
métriques intégrées
monitoredResourceDescriptors.get oui oui
monitoredResourceDescriptors.list oui oui
metricDescriptors.get oui oui
metricDescriptors.list oui oui
timeSeries.list oui oui
timeSeries.create oui
metricDescriptors.create oui
metricDescriptors.delete oui

Limites et latences

Pour connaître les limites associées aux métriques définies par l'utilisateur et à la conservation des données, consultez la page Quotas et limites.

Pour conserver les données des métriques au-delà de la durée de conservation, vous devez les copier manuellement vers un autre emplacement, tel que Cloud Storage ou BigQuery.

Pour en savoir plus sur les latences associées à l'écriture de données dans les métriques définies par l'utilisateur, consultez la section Latence des données de métriques.

Étape suivante