Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Surveiller une API
Cette page explique comment surveiller l'état de vos API API Gateway à l'aide des journaux et des métriques qu'API Gateway gère automatiquement pour vous.
Lorsque vous créez une API, API Gateway crée automatiquement un service géré correspondant. Le nom du service géré créé figure dans la sortie de la commande suivante:
gcloud api-gateway apis describe API_ID
Le nom de votre service correspond à la valeur du champ managedService.
Lorsque des utilisateurs adressent des requêtes à votre API, API Gateway enregistre des informations sur ces requêtes et sur les réponses renvoyées. API Gateway suit également trois des quatre signaux clés de surveillance : la latence, le trafic et les erreurs. Ces métriques d'utilisation et de performances vous aident à surveiller l'API.
Avant de commencer
Pour générer des journaux et des métriques à afficher, déployez une API et lui envoyez des requêtes. Si vous n'avez pas encore créé et déployé d'API sur une passerelle, essayez le guide de démarrage rapide d'API Gateway.
Présentation de l'API
Lorsque vous corrigez un problème lié au service ou que vous souhaitez simplement vérifier que tout s'exécute comme prévu, accédez à la présentation de l'API :
Dans la console Google Cloud , accédez à la page API Gateway > API de votre projet:
Si vous possédez plusieurs API, cliquez sur celle que vous souhaitez surveiller.
Assurez-vous que vous êtes sur l'onglet Aperçu.
Graphes
La page "Présentation" fournit un certain nombre de graphiques pour certaines métriques, ce qui vous permet de repérer immédiatement les pics, les baisses ou toute activité inattendue. Les filtres en haut de la page vous permettent d'effectuer les opérations suivantes:
Utiliser la liste déroulante Sélectionner des graphiques pour afficher les graphiques des métriques qui vous intéressent et supprimer ceux que vous ne souhaitez pas afficher.
Ajustez la portée des graphiques en sélectionnant différentes périodes. Cette action permet de modifier la période appliquée aux valeurs affichées, modifiant également le niveau de précision des points.
Table des méthodes
Pour une exploration plus approfondie, consultez le tableau situé en dessous des graphiques contenant les métriques par méthode de votre API. Vous pouvez :
En haut à gauche du tableau, cliquez sur l'icône Filtrer le tableau pour sélectionner des options de requête de filtre affinées dans le tableau déroulant. Ajoutez OR entre chaque requête de filtre pour rechercher plusieurs termes.
En haut à droite du tableau, cliquez sur l'icône Options d'affichage des colonnes pour afficher une liste déroulante. Cochez les métriques qui vous intéressent et décochez celles que vous ne souhaitez pas afficher.
Dans le coin supérieur droit de l'aperçu, sélectionnez une période pour les valeurs de métriques du tableau à l'aide de l'outil de sélection de périodes. Cette sélection s'applique aux graphiques ainsi qu'au tableau.
Journaux
Lorsque vous repérez un problème dans les métriques, vous pouvez utiliser la page Explorateur de journaux de la consoleGoogle Cloud pour consulter les journaux des requêtes et des réponses de votre API.
Pour afficher les journaux par méthode de l'API, cliquez sur Afficher les journaux dans le tableau.
Pour afficher les journaux de toutes les méthodes de l'API, cliquez sur Afficher tous les journaux dans le coin inférieur droit.
Pour localiser les journaux d'API Gateway directement à partir de la page de l'explorateur de journaux, procédez comme suit :
Dans la Google Cloud console, accédez à la page Explorateur de journaux:
Utilisez le volet de requête pour spécifier l'ensemble des entrées de journal à afficher, par exemple l'obtention de toutes les requêtes dont la latence est supérieure à 300 millisecondes.
Configurez et gérez les récepteurs.
Vous pouvez ainsi transférer les journaux vers BigQuery pour les analyser plus en détail, enregistrer les journaux bruts dans Cloud Storage, ou les envoyer aux sujets de messagerie Pub/Sub.
Filtrer selon un projet client spécifique
Pour filtrer les métriques pour un projet client spécifique, procédez comme suit :
Obtenez le numéro du projet du client utilisant l'API. Si vous n'êtes pas autorisé à accéder au projet du client de l'API, demandez à une personne disposant des autorisations nécessaires d'obtenir le numéro de projet pour vous.
Dans la console Google Cloud , accédez à la page API Gateway > API de votre projet.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/03 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/03 (UTC)."],[[["\u003cp\u003eAPI Gateway automatically maintains logs and metrics for monitoring API health, including latency, traffic, and errors, and creates a managed service for each created API.\u003c/p\u003e\n"],["\u003cp\u003eThe API overview page displays graphs for various metrics, which can be customized and filtered by time span and specific metrics.\u003c/p\u003e\n"],["\u003cp\u003eThe methods table allows for in-depth examination of individual API methods, with options to filter queries, adjust displayed metrics, and select a time span.\u003c/p\u003e\n"],["\u003cp\u003eThe Logs Explorer can be used to view detailed logs of requests and responses for your API, either for specific methods or for all methods.\u003c/p\u003e\n"],["\u003cp\u003eMetrics can be filtered to show data from a specific consumer project by entering the project number in the "Filter by Project Number" field.\u003c/p\u003e\n"]]],[],null,["# Monitoring your API\n===================\n\nThis page describes how you can monitor the health of your API Gateway APIs using the logs and metrics that API Gateway maintains for you automatically.\n\nWhen you create an API, API Gateway automatically creates a corresponding [managed service](/service-infrastructure/docs/overview#creating_apis_and_services). The name of the managed service created can be found in the output of the following command: \n\n```\ngcloud api-gateway apis describe API_ID\n```\n\nThe name of your service is the value of the `managedService` field.\n\nWhen users make requests to your API, API Gateway logs information about\nthe requests and responses. API Gateway also tracks three of the\n[four golden signals of monitoring](https://landing.google.com/sre/book/chapters/monitoring-distributed-systems.html#xref_monitoring_golden-signals):\nlatency, traffic, and errors. These usage and performance metrics help you monitor\nyour API.\n\nBefore you begin\n----------------\n\nTo generate logs and metrics for viewing, deploy an API and send requests to it. If you have not created and deployed an API to a gateway yet, try the\n[API Gateway quickstart](/api-gateway/docs/quickstart).\n\nAPI overview\n------------\n\nWhen you are debugging an issue with your service or just want to ensure that\neverything is running as expected, go to your API's overview:\n\n1. In the Google Cloud console, go to the **API Gateway** \\\u003e **APIs** page for\n your project:\n\n [Go to APIs](https://console.cloud.google.com/api-gateway/api)\n2. If you have more than one API, click the one you want to monitor.\n\n3. Ensure you are on the **Overview** tab.\n\n### Graphs\n\nThe overview page provides a number of graphs for some of the metrics, so you can spot any spikes, drops, or unexpected activity right away. Using the filters at the top of the page, you can:\n\n- Use the **Select graphs** drop-down list to show graphs for metrics you are interested in, and remove the ones you don't want to view.\n- Adjust the scope of the graphs by selecting from the various time spans. This adjusts the time range of values displayed, which also alters the point granularity.\n\n### Methods table\n\nWhen you are ready to drill down further, scroll below the graphs for a table\nwith metrics for individual methods in your API. You can:\n\n- In the top-left corner of the table, click the **Filter Table** icon to select refined filter query options from the drop-down table. Add an `OR` between each filter query to search for multiple terms.\n- In the top-right corner of the table, click the **Column Display Options** icon to display a drop-down list. Check the metrics you are interested in and clear the ones you don't want displayed.\n- In the top-right corner of the **Overview** page, select a time span for the metric values in the table by using the time span picker. This picks a time span for both the graphs and the table.\n\n### Logs\n\nWhen you spot an issue in the metrics, you can use the **Logs Explorer** page in the\nGoogle Cloud console to see logs of the requests and responses for your API.\n\n- To see logs for individual methods of your API, in the table click\n **View logs**.\n\n- To see logs for all methods in your API, in the bottom-right corner click\n [**View all logs**](https://console.cloud.google.com/logs/query).\n\n- To locate API Gateway logs directly from the Logs Explorer page:\n\n 1. In the Google Cloud console, go to the **Logs Explorer**\n page:\n\n [Go toLogs Explorer](https://console.cloud.google.com/logs/query)\n 2. Select **Produced API, \u003cvar translate=\"no\"\u003eSERVICE_NAME\u003c/var\u003e** , where\n \u003cvar translate=\"no\"\u003eSERVICE_NAME\u003c/var\u003e is the name of the\n managed service.\n\nSee the\n[API Gateway logs reference](/api-gateway/docs/audit-logging)\nfor details on the structure of the logs in the Logs Explorer.\n\nLearn what else you can do with the logs:\n\n- Get started using the\n [Logs Explorer](/logging/docs/view/logs-explorer-interface).\n\n Use the query pane to specify the set of log entries that you want to view,\n such as getting all requests with a latency greater than 300 milliseconds.\n- [Configure and manage sinks](/logging/docs/export/configure_export_v2).\n This lets you stream logs to BigQuery for further analysis, save the\n raw logs to Cloud Storage, or send them to Pub/Sub messaging\n topics.\n\n### Filter for a specific consumer project\n\nTo filter metrics for a specific consumer project:\n\n1. Get the\n [project number](/resource-manager/docs/creating-managing-projects#identifying_projects)\n of the API consumer's project. If you don't have permission to access the\n API consumer's project, ask someone who has permission to get the project\n number for you.\n\n2. In the Google Cloud console, go to the **API Gateway** \\\u003e **APIs** page\n for your project.\n\n [Go to APIs](https://console.cloud.google.com/api-gateway/api)\n3. In the top-left corner of the **Overview** page, enter the project number in\n the **Filter by Project Number** field.\n\n4. Click **Filter**.\n\nThe metrics on the page update to reflect traffic only from the specified\nproject.\n\nWhat's next\n-----------\n\n- [Tracing your API](/api-gateway/docs/tracing)"]]
