Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Connectez-vous à une source de données Google Cloud Monitoring
Note
Dans les versions antérieures de Grafana, cette source de données s'appelait Google Stackdriver.
Ajoutez la source de données Google Cloud Monitoring pour pouvoir créer des tableaux de bord pour vos statistiques Google Cloud Monitoring.
Ajouter la source de données
-
Ouvrez le menu latéral en choisissant l'icône Grafana dans l'en-tête supérieur.
-
Dans le menu latéral, sous le lien Tableaux de bord, vous devriez trouver le lien Sources de données.
-
Cliquez sur le bouton + Ajouter une source de données dans l'en-tête supérieur.
-
Sélectionnez Google Cloud Monitoring dans la liste déroulante Type.
-
Téléchargez ou collez le fichier clé du compte de service. Voir plus loin dans ce document les étapes à suivre pour créer un fichier de clé de compte de service.
Note
Si le lien Sources de données n'apparaît pas dans le menu latéral, cela signifie que votre utilisateur actuel n'a pas le Admin rôle.
| Name (Nom) | Description |
|---|---|
Name
|
Le nom de la source de données. C'est ainsi que vous faites référence à la source de données dans les panneaux et les requêtes. |
Default
|
La source de données par défaut signifie qu'elle sera présélectionnée pour les nouveaux panneaux. |
Service Account Key
|
Fichier clé de compte de service pour un projet GCP. Consultez les instructions plus loin dans ce document pour savoir comment le créer. |
Authentification
Il existe deux manières d'authentifier le plugin Google Cloud Monitoring
-
Importer un fichier Google JWT
-
Récupérez automatiquement les informations d'identification du serveur de métadonnées Google
Cette dernière option n'est disponible que lors de l'exécution de Grafana sur une machine virtuelle GCE.
Utilisation d'un fichier clé de compte de service Google
Pour vous authentifier avec l'API Google Cloud Monitoring, vous devez créer un compte de service Google Cloud Platform (GCP) pour le projet dont vous souhaitez afficher les données. Une source de données Grafana s'intègre à un projet GCP. Pour visualiser les données de plusieurs projets GCP, vous devez créer une source de données par projet GCP.
Activation des API
Les API suivantes doivent d'abord être activées :
Choisissez les liens répertoriés, puis cliquez sur le bouton Activer.
Création d'un compte de service GCP pour un projet
-
Accédez à la page API et informations d'identification des services
. -
Choisissez le menu déroulant/le bouton Créer des informations d'identification et choisissez l'option clé de compte de service.
{{< docs-imagebox img= » /img/docs/v71/cloudmonitoring_create_service_account_button.png "class="docs-image—no-shadow » caption="Bouton de création d'un compte de service » >}}
-
Sur la page Créer une clé de compte de service, choisissez le type de clé
JSON. Ensuite, dans la liste déroulante Compte de service, choisissez l'option Nouveau compte de service.{{< docs-imagebox img= » /img/docs/v71/cloudmonitoring_create_service_account_key.png "class="docs-image—no-shadow » caption="Créer une clé de compte de service » >}}
-
De nouveaux champs apparaîtront. Entrez le nom du compte de service dans le champ Nom du compte de service, puis choisissez le rôle Monitoring Viewer dans la liste déroulante Rôle.
{{< docs-imagebox img= » /img/docs/v71/cloudmonitoring_service_account_choose_role.png "class="docs-image—no-shadow » caption="Choisissez un rôle » >}}
-
Choisissez le bouton Créer. Un fichier clé JSON sera créé et téléchargé sur votre ordinateur. Stockez ce fichier dans un endroit sécurisé car il permet d'accéder à vos données de surveillance Google Cloud.
-
Téléchargez-le sur Grafana sur la page de configuration de la source de données. Vous pouvez soit télécharger le fichier, soit coller le contenu du fichier.
{{< docs-imagebox img= » /img/docs/v71/cloudmonitoring_grafana_upload_key.png "class="docs-image—no-shadow » caption="Importer le fichier de clé de service vers Grafana » >}}
-
Le contenu du fichier sera crypté et enregistré dans la base de données Grafana. N'oubliez pas de sauvegarder après avoir téléchargé le fichier !
{{< docs-imagebox img= » /img/docs/v71/cloudmonitoring_grafana_key_uploaded.png "class="docs-image—no-shadow » caption="Le fichier clé de service est chargé sur Grafana » >}}
Utilisation de l’éditeur de requêtes
L'éditeur de requêtes Google Cloud Monitoring vous permet de créer deux types de requêtes : Metric et Service Level Objective (SLO). Les deux types renvoient des données de séries chronologiques.
Requêtes métriques
L'éditeur de requêtes métriques vous permet de sélectionner des métriques, de grouper/agréger par étiquettes et par heure, et d'utiliser des filtres pour spécifier les séries temporelles que vous souhaitez voir apparaître dans les résultats.
Pour créer une requête métrique, procédez comme suit :
-
Choisissez l'option Metrics dans la liste déroulante des types de requête.
-
Choisissez un projet dans la liste déroulante des projets.
-
Choisissez un service Google Cloud Platform dans la liste déroulante des services.
-
Choisissez une métrique dans la liste déroulante des métriques.
-
Pour ajouter ou supprimer des filtres ou grouper par clauses, utilisez les icônes plus et moins dans le filtre et regroupez par sections. Cette étape est facultative.
Les métriques de Google Cloud Monitoring peuvent être de différents types (GAUGE, DELTA, CUMULATIVE) et ces types prennent en charge différentes options d'agrégation (réducteurs et aligneurs). L'éditeur de requêtes Grafana affiche la liste des méthodes d'agrégation disponibles pour une métrique sélectionnée et définit un réducteur et un aligneur par défaut lorsque vous sélectionnez la métrique. Les unités de l'axe Y sont également sélectionnées automatiquement par l'éditeur de requêtes.
Filtres
Pour ajouter un filtre, cliquez sur l'icône plus, choisissez un champ à filtrer et entrez une valeur de filtre. Par exemple, saisissez instance_name =
grafana-1. Vous pouvez supprimer le filtre en choisissant le nom du filtre, puis en sélectionnant--remove filter--.
Caractères génériques simples
Lorsque l'opérateur est défini sur ou, = != il est possible d'ajouter des caractères génériques dans le champ de valeur du filtre. Par exemple, us-* capture toutes les valeurs commençant par « us- » et *central-a capture toutes les valeurs se terminant par « central-a ». *-central-*capture toutes les valeurs dont la sous-chaîne est de. central- Les caractères génériques simples sont moins coûteux que les expressions régulières.
Expressions régulières
Lorsque l'opérateur est défini sur ou, =~ !=~ il est possible d'ajouter des expressions régulières au champ de valeur du filtre. Par exemple, us-central[1-3]-[af] correspond à toutes les valeurs commençant par « us-central », suivi d'un nombre compris entre 1 et 3, d'un tiret puis d'un « a » ou d'un « f ». Les barres obliques de début et de fin ne sont pas nécessaires pour créer des expressions régulières.
Agrégation
Le champ d'agrégation vous permet de combiner des séries chronologiques en fonction de statistiques communes. Pour plus d'informations sur l'agrégation, reportez-vous aux options d'agrégation
Le Aligner champ vous permet d'aligner plusieurs séries chronologiques après le même groupe par intervalle de temps. Pour plus d'informations sur l'aligneur, reportez-vous au sélecteur de mesures d'alignement
Période d'alignement et regroupement par heure
Ils Alignment Period regroupent une métrique par heure si une agrégation est choisie. Par défaut, vous utilisez les groupements par défaut de GCP Google Cloud Monitoring (qui vous permettent de comparer les graphiques de Grafana aux graphiques de l'interface utilisateur de Google Cloud Monitoring). L'option est appelée cloud monitoring auto et les valeurs par défaut sont les suivantes :
-
1 m pour les plages de temps inférieures à 23 heures
-
5 m pour les plages de temps >= 23 heures et < 6 jours
-
1 h pour les plages de temps supérieures ou égales à 6 jours
L'autre option automatique estgrafana auto. Cela définira automatiquement le groupe par heure en fonction de la plage de temps choisie et de la largeur du panneau graphique. Pour plus d’informations, consultez Ajouter une variable d'intervalle.
Il est également possible de choisir des intervalles de temps fixes à regrouper, tels que 1h ou1d.
Grouper par
Regroupez par ressource ou par étiquette de mesure pour réduire le nombre de séries chronologiques et agréger les résultats par groupe par. Par exemple, regroupez-vous par instance_name pour obtenir une métrique agrégée pour une instance de calcul.
Étiquettes de métadonnées
Les étiquettes de métadonnées des ressources contiennent des informations permettant d'identifier de manière unique une ressource dans Google Cloud. Les étiquettes de métadonnées ne sont renvoyées dans la réponse à la série chronologique que si elles font partie du segment Grouper par de la demande de série chronologique. Aucune API ne permet de récupérer les étiquettes de métadonnées. Il n'est donc pas possible de renseigner le groupe par liste déroulante avec les étiquettes de métadonnées disponibles pour le service et la métrique sélectionnés. Cependant, la liste déroulante Grouper par champ contient une liste prédéfinie d'étiquettes de système courantes.
Les libellés utilisateur ne peuvent pas être prédéfinis, mais il est possible de les saisir manuellement dans le champ Grouper par. Si une étiquette de métadonnées, une étiquette utilisateur ou une étiquette système est incluse dans le segment Grouper par, vous pouvez créer des filtres basés sur celle-ci et étendre sa valeur dans le champ Alias.
Modèles d'alias
Le champ Alias By vous permet de contrôler le format des clés de légende. Par défaut, le nom et les libellés de la métrique sont affichés. Cela peut être long et difficile à lire. En utilisant les modèles suivants dans le champ d'alias, vous pouvez mettre en forme la clé de légende comme vous le souhaitez.
Modèles de type métrique
| Modèle d'alias | Description | Exemple de résultat |
|---|---|---|
{{metric.type}}
|
Renvoie le type de métrique complet. |
compute.googleapis.com/instance/cpu/utilization
|
{{metric.name}}
|
Renvoie la partie du nom de la métrique. |
instance/cpu/utilization
|
{{metric.service}}
|
Renvoie la pièce de rechange. |
compute
|
Modèles d'étiquettes
Dans la liste déroulante Grouper par, vous pouvez voir la liste des indicateurs et des libellés de ressources associés à un indicateur. Ils peuvent être inclus dans la clé de légende à l'aide de modèles d'alias.
| Format du modèle d'alias | Description | Exemple de modèle d'alias | Exemple de résultat |
|---|---|---|---|
{{metric.label.xxx}}
|
Renvoie la valeur de l'étiquette métrique. |
{{metric.label.instance_name}}
|
grafana-1-prod
|
{{resource.label.xxx}}
|
Renvoie la valeur de l'étiquette de la ressource. |
{{resource.label.zone}}
|
us-east1-b
|
{{metadata.system_labels.xxx}}
|
Renvoie la valeur de l'étiquette du système de métadonnées. |
{{metadata.system_labels.name}}
|
grafana
|
{{metadata.user_labels.xxx}}
|
Renvoie la valeur de l'étiquette utilisateur des métadonnées. |
{{metadata.user_labels.tag}}
|
production
|
Exemple d'alias par : {{metric.type}} -
{{metric.label.instance_name}}
Exemple de résultat : compute.googleapis.com/instance/cpu/usage_time
- server1-prod
Il est également possible de résoudre le nom du type de ressource surveillée.
| Format du modèle d'alias | Description | Exemple de résultat |
|---|---|---|
{{resource.type}}
|
Renvoie le nom du type de ressource surveillé. |
gce_instance
|
Exemple d'alias par : {{resource.type}} - {{metric.type}}
Exemple de résultat : gce_instance -
compute.googleapis.com/instance/cpu/usage_time
Requêtes SLO
Note
Les requêtes SLO ne sont disponibles que dans Grafana v7.0 et versions ultérieures
Le générateur de requêtes SLO de la source de données Google Cloud Monitoring vous permet d'afficher les données SLO sous forme de séries chronologiques. Pour comprendre les concepts de base de la surveillance des services, consultez la documentation officielle
Création d'une requête SLO
Pour créer une requête SLO, procédez comme suit :
-
Choisissez l'option Objectifs de niveau de service (SLO) dans la liste déroulante des types de requête.
-
Choisissez un projet dans la liste déroulante des projets.
-
Choisissez un service SLO
dans la liste déroulante des services. -
Choisissez un SLO
dans la liste déroulante SLO. -
Choisissez un sélecteur de séries chronologiques
dans la liste déroulante Sélecteur.
Les noms conviviaux des sélecteurs de séries chronologiques sont indiqués dans Grafana. Le tableau suivant montre le mappage entre le nom convivial et le nom du système utilisé dans la documentation de surveillance des services.
| Valeur de la liste déroulante du sélecteur | Sélecteur de série chronologique correspondant utilisé |
|---|---|
| Valeur SLI | select_slo_health |
| Conformité SLO | select_slo_compliance |
| Budget d'erreur SLO restant | select_slo_budget_fraction |
Modèles d'alias pour les requêtes SLO
Vous pouvez utiliser le champ Alias By pour contrôler le format des clés de légende pour les requêtes SLO.
| Modèle d'alias | Description | Exemple de résultat |
|---|---|---|
{{project}}
|
Renvoie le nom du projet GCP. |
myProject
|
{{service}}
|
Renvoie le nom du service. |
myService
|
{{slo}}
|
Renvoie le SLO. |
latency-slo
|
{{selector}}
|
Renvoie le sélecteur. |
select_slo_health
|
Période d'alignement et regroupement par heure pour les requêtes SLO
Les requêtes SLO utilisent la même fonctionnalité de période d'alignement que les requêtes métriques. Pour plus d’informations, consultez Requêtes métriques.
Création de modèles
Au lieu de coder en dur des éléments tels que le nom du serveur, de l'application et du capteur dans vos requêtes métriques, vous pouvez utiliser des variables à leur place. Les variables sont affichées sous forme de boîtes de sélection déroulantes en haut du tableau de bord. Vous pouvez utiliser ces listes déroulantes pour modifier les données affichées dans votre tableau de bord.
Pour plus d'informations sur les modèles et les variables de modèles, consultezModèles et variables.
Variable de requête
La variable de type Query vous permet d'interroger Google Cloud Monitoring pour différents types de données. Le plug-in de source de données Google Cloud Monitoring fournit les éléments suivantsQuery
Types.
| Name (Nom) | Description |
|---|---|
Metric Types
|
Renvoie une liste des noms de types de métriques disponibles pour le service spécifié. |
Labels Keys
|
Renvoie une liste de clés pour metric label et resource label dans la métrique spécifiée. |
Labels Values
|
Renvoie une liste de valeurs pour l'étiquette dans la métrique spécifiée. |
Resource Types
|
Renvoie une liste des types de ressources pour la métrique spécifiée. |
Aggregations
|
Renvoie une liste d'agrégations (réducteurs de séries croisées) pour la métrique spécifiée. |
Aligners
|
Renvoie une liste d'aligneurs (aligneurs par série) pour la métrique spécifiée. |
Alignment periods
|
Renvoie une liste de toutes les périodes d'alignement disponibles dans l'éditeur de requêtes Google Cloud Monitoring de Grafana. |
Selectors
|
Renvoie une liste de sélecteurs qui peuvent être utilisés dans les requêtes SLO (Service Level Objectives). |
SLO Services
|
Renvoie une liste des services de surveillance des services qui peuvent être utilisés dans les requêtes SLO. |
Service Level Objectives (SLO)
|
Renvoie une liste des SLO pour le service SLO spécifié. |
Utilisation de variables dans les requêtes
Il existe deux syntaxes :
-
$<varname>Exemple :metric.label.$metric_label -
[[varname]]Exemple :metric.label.[[metric_label]]
Pourquoi de deux manières ? La première syntaxe est plus facile à lire et à écrire mais ne permet pas d'utiliser une variable au milieu d'un mot. Lorsque les options Multi-valeurs ou Inclure toutes les valeurs sont activées, Grafana convertit les étiquettes du texte brut en une chaîne compatible avec les regex, ce qui signifie que vous devez utiliser au lieu de. =~ =
Annotations
Vous pouvez utiliser des annotations pour superposer des informations détaillées sur les événements au-dessus des graphiques. Vous pouvez ajouter des requêtes d'annotation via le menu Tableau de bord/Vue des annotations. Le rendu des annotations est coûteux, il est donc important de limiter le nombre de lignes renvoyées. L'affichage des annotations et des événements de Google Cloud Monitoring n'est pas encore pris en charge, mais cela fonctionne bien avec les métriques personnalisées
Pour plus d'informations sur les annotations, consultezAnnotations.
Avec l'éditeur de requêtes pour les annotations, vous pouvez sélectionner une métrique et des filtres. Les champs Titre et Texte prennent en charge la création de modèles et peuvent utiliser les données renvoyées par la requête. Par exemple, le champ Titre peut contenir le texte suivant :
{{metric.type}} has value: {{metric.value}}
Exemple de résultat : monitoring.googleapis.com/uptime_check/http_status has
this value: 502
Modèles pour l'éditeur de requêtes d'annotation
| Format du modèle d'alias | Description | Exemple de modèle d'alias | Exemple de résultat |
|---|---|---|---|
{{metric.value}}
|
Valeur de la métrique/du point. |
{{metric.value}}
|
555
|
{{metric.type}}
|
Renvoie le type de métrique complet. |
{{metric.type}}
|
compute.googleapis.com/instance/cpu/utilization
|
{{metric.name}}
|
Renvoie la partie du nom de la métrique. |
{{metric.name}}
|
instance/cpu/utilization
|
{{metric.service}}
|
Renvoie la pièce de rechange. |
{{metric.service}}
|
compute
|
{{metric.label.xxx}}
|
Renvoie la valeur de l'étiquette métrique. |
{{metric.label.instance_name}}
|
grafana-1-prod
|
{{resource.label.xxx}}
|
Renvoie la valeur de l'étiquette de la ressource. |
{{resource.label.zone}}
|
us-east1-b
|
Liens profonds entre les panneaux Grafana et l'explorateur de métriques dans la console Google Cloud
Note
Cette fonctionnalité n'est disponible que pour les requêtes métriques.
Choisissez une série chronologique dans le panneau pour afficher un menu contextuel contenant un lien vers Afficher dans l'explorateur de mesures de la console Google Cloud. Le choix de ce lien ouvre l'explorateur de métriques dans la console Google Cloud et exécute la requête depuis le panneau Grafana qui s'y trouve. Le lien dirige d'abord l'utilisateur vers le sélecteur de compte Google. Après avoir sélectionné un compte avec succès, l'utilisateur est redirigé vers l'explorateur de métriques. Le lien fourni est valide pour n'importe quel compte, mais il affiche la requête uniquement si votre compte a accès au projet GCP spécifié dans la requête.
