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

Les métriques définies par l'utilisateur correspondent à toutes les métriques qui ne sont pas définies par Google Cloud. Il s'agit de métriques que vous pouvez définir et de métriques définies par une application tierce. Les métriques définies par l'utilisateur permettent de capturer des données propres à une application ou des données système côté client. Les métriques intégrées collectées par Cloud Monitoring peuvent vous fournir 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 section 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 intégrées de Cloud Monitoring ne peuvent pas définir. Vous pouvez capturer ces métriques à l'aide d'une API fournie par une bibliothèque pour instrumenter votre code, puis les envoyer à 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, en utilisant directement l'API Cloud Monitoring. Toutefois, nous vous recommandons d'utiliser OpenTelemetry. Pour en savoir plus sur la création de 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, telles que les métriques intégrées. Vous pouvez les représenter sous forme de graphique, définir des alertes, les lire et les surveiller. Pour en savoir plus sur la lecture des données de métriques, consultez les documents suivants:

  • Répertorier les types de métriques et de ressources : explique comment répertorier et examiner vos types de métriques intégrées et définies par l'utilisateur. Par exemple, vous pouvez utiliser les informations de ce document pour répertorier 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 connaître l'utilisation du processeur pour les instances de machines virtuelles (VM) de votre projet Google Cloud.

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

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

Chaque type de métrique doit posséder un descripteur de la métrique qui définit la manière dont les données de métriques sont organisées. Le descripteur de la métrique définit également les étiquettes et le nom de la métrique. Par exemple, les listes de métriques affichent les descripteurs de métriques 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étriques que vous écrivez. Vous pouvez également créer explicitement le descripteur de métrique, puis écrire les données de métrique. Dans les deux cas, vous devez décider comment vous souhaitez organiser vos données de métriques.

Exemple de conception

Supposons que vous ayez un programme qui s'exécute sur une seule machine, et qu'il appelle les programmes auxiliaires A et B. Vous souhaitez savoir à quelle fréquence les programmes A et B sont appelés. Vous souhaitez également savoir quand le programme A est appelé plus de 10 fois par minute et lorsque le programme B est appelé plus de cinq fois par minute. Enfin, supposons que vous disposez d'un seul projet Google Cloud et que vous envisagez d'écrire les données sur la ressource surveillée global.

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

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

    Vous pouvez créer une seule règle d'alerte avec deux conditions, ou créer deux règles d'alerte avec chacune une condition avec ce mode de données. 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 d'étiquettes. Par conséquent, il existe une série temporelle dont la valeur d'étiquette est A et une autre série temporelle dont la valeur d'étiquette 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 pour le programme A dépasse un seuil doit utiliser un filtre n'incluant que les points de données dont la valeur de 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 compter le nombre d'appels, mais vous n'utilisez pas de libellé pour enregistrer le programme 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 en matière d'analyse de données, mais la dernière ne le permet 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 représentant le type de métrique. Cette chaîne doit être unique parmi les métriques définies par l'utilisateur dans votre projet Google Cloud et utiliser un préfixe qui marque la métrique comme 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. Il est suivi d'un nom décrivant ce que vous collectez. Pour plus d'informations sur la méthode recommandée pour nommer une métrique, consultez Conventions d'attribution de noms de 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, mais utilisent des modèles organisationnels différents. Si vous prévoyez de disposer d'un grand nombre de métriques définies par l'utilisateur, nous vous recommandons d'utiliser une structure de nommage hiérarchique telle que 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, choisissez un type de ressource surveillée qui représente la provenance de vos données, puis utilisez-le pour décrire l'origine spécifique. La ressource surveillée ne fait pas partie du type de métrique. À la place, 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 leur origine.

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 étiquettes pour l'ID de projet, l'ID d'instance et la zone de l'instance. Par conséquent, si vous envisagez d'écrire votre métrique sur une ressource de VM Compute Engine, les étiquettes de ressources incluent l'ID d'instance. Vous n'avez donc pas besoin d'étiquette 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 des différents objets de ressources surveillées sont conservé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étriques définies par l'utilisateur avec d'autres données de métriques 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 dispose que des libellés project_id et location. Lorsque vous disposez de 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 À utiliser 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 liées aux métriques définies par l'utilisateur et à la conservation des données, consultez la page Quotas et limites.

Pour conserver vos données de métriques au-delà de la période 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 des métriques définies par l'utilisateur, consultez la section Latence des données de métriques.

Étapes suivantes