Cette page s'applique à Apigee, mais pas à Apigee hybrid.
Consultez la documentation d' Apigee Edge.
Plusieurs outils vous permettent d'afficher et de surveiller l'utilisation de votre ressource Apigee. Cet article explique comment les administrateurs de facturation et d'organisation peuvent effectuer les opérations suivantes :
- Afficher l'utilisation des ressources dans l'explorateur de métriques
- Configurer une alerte Cloud Monitoring
- Afficher l'utilisation des ressources par compte de facturation
- Surveiller les ressources avec Cloud Audit Logging
Pour afficher l'utilisation des ressources de l'organisation et configurer des alertes, vous devez disposer des rôles suivants :
- Administrateur d'organisation Apigee (
roles/apigee.admin
) - Lecteur de journaux
(roles/logging.viewer
) - Lecteur de compte de facturation (
roles/billing.viewer
)
Afficher l'utilisation des ressources dans l'explorateur de métriques
Vous pouvez utiliser l'explorateur de métriques afin d'afficher l'utilisation des ressources Apigee qui sont des attributs clés pour déterminer les coûts dans votre formule de paiement à l'usage. En sélectionnant des métriques et des filtres spécifiques, vous pouvez générer un rapport d'utilisation pour les unités de déploiement de proxy/flux partagé Apigee, les environnements actifs Apigee, ou les deux.
Pour en savoir plus sur les métriques Apigee et leurs valeurs possibles, consultez la section Apigee sur la page des métriques Google Cloud.
Utilisation des unités de déploiement de proxy/flux partagé Apigee
Interface utilisateur de l'explorateur de métriques
Pour afficher l'utilisation des unités de déploiement de proxy/flux partagé Apigee dans l'explorateur de métriques, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans le volet Sélectionner une métrique, développez le menu Métrique et saisissez
Apigee
dans la barre de filtre.Utilisez les sous-menus pour sélectionner le type de ressource, la catégorie et la métrique :
- Dans le menu Ressources actives, sélectionnez Proxy Apigee.
- Dans le menu Catégories de métriques actives, sélectionnez Proxy.
- Dans le menu Métriques actives, sélectionnez Détails du proxy Apigee.
- Cliquez sur Appliquer.
- Dans la section Filtres :
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
proxy_deployment_type
etenv
dans les options de la liste pour regrouper les données par type de déploiement de proxy et par environnement. - Cliquez sur OK pour appliquer les filtres.
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
- Sélectionnez Nombre dans le menu Fonction de regroupement.
MQL
Pour afficher l'utilisation des unités de déploiement de proxy/flux partagé Apigee avec une requête MQL, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser MQL :
- Sélectionnez MQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
fetch apigee.googleapis.com/Proxy | metric 'apigee.googleapis.com/proxy/details' | group_by [metric.proxy_deployment_type, resource.env]
PromQL
Pour afficher l'utilisation des unités de déploiement de proxy/flux partagé Apigee avec une requête PromQL, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser PromQL :
- Sélectionnez PromQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
count(apigee_googleapis_com:proxy_details{monitored_resource="apigee.googleapis.com/Proxy"}) by (proxy_deployment_type, env)
Utilisation de l'environnement actif Apigee
Interface utilisateur de l'explorateur de métriques
Pour afficher l'utilisation de l'environnement actif Apigee dans l'explorateur de métriques, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans le volet Sélectionner une métrique, développez le menu Métrique et saisissez
Apigee
dans la barre de filtre.Utilisez les sous-menus pour sélectionner le type de ressource, la catégorie et la métrique :
- Dans le menu Ressources actives, sélectionnez Environnement Apigee.
- Dans le menu Catégories de métriques actives, sélectionnez Environnement.
- Dans le menu Métriques actives, sélectionnez Environnement actif Apigee.
- Cliquez sur Appliquer.
- Dans la section Filtres :
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
type
dans les options de la liste pour regrouper les données par type d'environnement. - Cliquez sur OK pour appliquer les filtres.
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
- Sélectionnez Nombre dans le menu Fonction de regroupement.
MQL
Pour afficher l'utilisation de l'environnement actif Apigee avec une requête MQL, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser MQL :
- Sélectionnez MQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
fetch apigee.googleapis.com/Environment | metric 'apigee.googleapis.com/environment/active' | group_by [metric.type, resource.env]
PromQL
Pour afficher l'utilisation de l'environnement actif Apigee avec une requête PromQL, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser PromQL :
- Sélectionnez PromQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
count(apigee_googleapis_com:environment_active{monitored_resource="apigee.googleapis.com/Environment"}) by (env, type)
Appels d'API standards et extensibles
Interface utilisateur de l'explorateur de métriques
Pour afficher les appels d'API standards et extensibles par environnement dans l'explorateur de métriques, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans le volet Sélectionner une métrique, développez le menu Métrique et saisissez
Apigee
dans la barre de filtre.Utilisez les sous-menus pour sélectionner le type de ressource, la catégorie et la métrique :
- Dans le menu Ressources actives, sélectionnez Environnement Apigee.
- Dans le menu Catégories de métriques actives, sélectionnez Environnement.
- Dans le menu Métriques actives, sélectionnez Nombre d'appels d'API dans l'environnement Apigee.
- Cliquez sur Appliquer.
- Dans la section Filtres :
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
proxy_deployment_type
dans les options de la liste pour regrouper les données par type d'environnement. - Cliquez sur OK pour appliquer les filtres.
- Utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
- Sélectionnez Somme dans le menu Fonction de regroupement.
MQL
Pour afficher les appels d'API standards et extensibles par environnement avec une requête MQL, procédez comme suit :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser MQL :
- Sélectionnez MQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
fetch apigee.googleapis.com/Environment | metric 'apigee.googleapis.com/environment/api_call_count' | delta(1m) | group_by [metric.proxy_deployment_type, resource.env, resource.location]
PromQL
Pour afficher les appels d'API standards et extensibles par environnement avec une requête PromQL :
- Ouvrez la page Surveillance > Explorateur de métriques dans la console Google Cloud.
- Dans la barre d'outils du volet Sélectionner une métrique, sélectionnez Éditeur de code.
- Pour utiliser PromQL :
- Sélectionnez PromQL dans les options du bouton Langage.
- Saisissez la requête suivante dans l'éditeur de requête :
sum(delta(apigee_googleapis_com:environment_api_call_countmonitored_resource="apigee.googleapis.com/Environment"}[1m])) by (proxy_deployment_type,env,location)
Créer un tableau de bord des métriques
Le résultat graphique de l'explorateur de métriques sur l'onglet Graphique représente une métrique de jauge. Autrement dit, chaque point du graphique enregistre l'utilisation des ressources de votre instance Apigee dans tous les environnements de chaque région au moment de la mesure.
Une fois que vous avez configuré l'affichage des données à l'aide de la sélection Ressource et métrique, vous pouvez enregistrer les données dans un tableau de bord personnalisé afin de vous y reporter ultérieurement. Pour enregistrer la vue sélectionnée, procédez comme suit :
- Cliquez sur le bouton Enregistrer le graphique dans le volet du graphique de l'onglet Explorateur.
- Dans la boîte de dialogue Enregistrer le graphique, saisissez les informations suivantes :
- Champ Titre du graphique : saisissez un nom pour le graphique ou utilisez le titre suggéré.
- Menu déroulant Tableau de bord : sélectionnez un tableau de bord existant ou sélectionnez Nouveau tableau de bord pour créer et nommer un tableau de bord. Votre graphique sera enregistré dans le tableau de bord sélectionné.
- Cliquez sur Enregistrer.
Une fois enregistré, vous pouvez accéder à votre graphique en accédant à la page Aperçu des tableaux de bord de la console Google Cloud et en affichant le tableau de bord sélectionné.
Pour en savoir plus sur la création et la gestion des vues personnalisées à l'aide de Cloud Monitoring, consultez la page Tableaux de bord et graphiques.
Configurer une alerte Cloud Monitoring
Une fois que vous avez configuré les rapports sur les métriques pour l'utilisation des ressources Apigee dans Cloud Monitoring, vous pouvez activer des règles d'alerte basées sur les métriques. Vous pouvez configurer des règles d'alerte pour surveiller l'utilisation des ressources en rapport à votre formule de paiement à l'usage et être informé rapidement des problèmes potentiels. Pour en savoir plus, consultez la section Fonctionnement des alertes.
Vous pouvez ajouter une règle d'alerte basée sur les métriques à votre projet Google Cloud à l'aide de la console Google Cloud, de l'API Cloud Monitoring ou de Google Cloud CLI. Lorsque vous utilisez la console Google Cloud, vous pouvez activer les alertes recommandées ou configurer des alertes personnalisées depuis la page Alertes de Cloud Monitoring.
Les étapes générales requises pour créer une règle d'alerte basée sur les métriques sont décrites dans la section Créer des règles d'alerte basées sur un seuil de métrique. Pour configurer une règle d'alerte spécifiquement basée sur l'utilisation des ressources, vous pouvez suivre les étapes décrites dans la section Créer une règle d'alerte.
Vous pouvez utiliser les mêmes métriques et filtres que ceux utilisés dans la section précédente pour personnaliser votre alerte en fonction de l'utilisation des ressources. Par exemple, pour créer une alerte basée sur l'utilisation du proxy Apigee, procédez comme suit :
- Ouvrez la page Surveillance > Alertes dans la console Google Cloud.
- Cliquez sur + Créer une règle.
- Dans la section Sélectionner une métrique du volet Créer une règle, saisissez
Apigee
dans la barre de filtre, puis utilisez les sous-menus pour sélectionner le type de ressource, une catégorie et une métrique :- Dans le menu Ressources actives, sélectionnez Proxy Apigee.
- Dans le menu Catégories de métriques actives, sélectionnez Proxy.
- Dans le menu Métriques actives, sélectionnez Détails du proxy Apigee.
- Dans la section Ajouter des filtres, utilisez le menu Grouper par pour regrouper les données par libellé de ressource. Sélectionnez
proxy_deployment_type
etenv
dans les options de la liste pour regrouper les données par type de déploiement de proxy et par environnement.
Pour créer une alerte basée sur l'utilisation de l'environnement actif Apigee, sélectionnez les métriques et les filtres utilisés pour afficher l'utilisation de l'environnement Apigee.
Afficher l'utilisation des ressources par compte de facturation
Pour afficher l'utilisation des ressources par compte de facturation, procédez comme suit :
- Ouvrez la page Facturation dans la console Google Cloud.
- Si vous disposez de plusieurs comptes de facturation, sélectionnez Accéder au compte de facturation associé pour voir le compte de facturation du projet actuel. Pour localiser un autre compte de facturation, sélectionnez Gérer les comptes de facturation, puis le compte que vous souhaitez afficher.
- Sélectionnez Rapports.
- Cliquez sur Afficher les filtres pour accéder au menu Filtres s'il n'est pas déjà ouvert.
- Dans le champ Période, sélectionnez Date d'utilisation pour afficher un instantané de la facturation sur une période ou sélectionnez Mois de facturation pour afficher les frais d'utilisation d'une facture spécifique.
- Sélectionnez Grouper par > SKU.
- Dans la liste déroulante Services, sélectionnez Apigee. La liste des codes SKU inclus dans votre facture s'affiche.
- Pour filtrer la liste des SKU, sélectionnez ceux que vous souhaitez afficher dans la liste déroulante SKU.
Les codes SKU pour lesquels votre utilisation est nulle (0)n'apparaîtront pas dans le menu déroulant Grouper par > SKU.
Surveiller l'utilisation des ressources avec Cloud Audit Logging
Vous pouvez utiliser les journaux d'audit Cloud pour surveiller l'utilisation des ressources qui affectera votre facturation à l'usage. Pour afficher les journaux d'audit appropriés, procédez comme suit :
- Ouvrez la page Explorateur de journaux dans la console Cloud.
- Dans la Requête, utilisez la barre de recherche pour rechercher les événements impactant les ressources facturables suivantes :
- Créer une instance avec un ou plusieurs environnements associés :
google.cloud.apigee.v1.InstanceService.CreateInstanceAndAttachments
- Mettre à jour une instance et ses rattachements :
google.cloud.apigee.v1.InstanceService.UpdateInstanceAndAttachments
- Supprimer une instance avec un ou plusieurs environnements associés :
google.cloud.apigee.v1.InstanceService.DeleteInstance
- Créer un rattachement d'instance :
google.cloud.apigee.v1.InstanceAttachmentService.CreateInstanceAttachment
- Supprimer un rattachement d'instance :
google.cloud.apigee.v1.InstanceAttachmentService.DeleteInstanceAttachment
- Déployer un proxy :
google.cloud.apigee.v1.DeploymentService.DeployApiProxy
- Annuler le déploiement d'un proxy :
google.cloud.apigee.v1.DeploymentService.UndeployApiProxy
- Déployer un flux partagé :
google.cloud.apigee.v1.DeploymentService.DeploySharedFlow
- Annuler le déploiement d'un flux partagé :
google.cloud.apigee.v1.DeploymentService.UndeploySharedFlow
- Activer/Désactiver le module complémentaire Apigee API Analytics ou Advanced API Security :
google.cloud.apigee.v1.EnvironmentAddons.SetAddonEnablement
Par exemple, vous pourriez saisir l'exemple de requête suivant :
resource.type="audited_resource" resource.labels.method="google.cloud.apigee.v1.InstanceService.CreateInstanceAndAttachments" resource.labels.service="apigee.googleapis.com"
Pour en savoir plus sur la surveillance des ressources Apigee à l'aide de Cloud Audit Logging, consultez la page Informations sur les journaux d'audit Apigee.
- Créer une instance avec un ou plusieurs environnements associés :