Depois de criar e lançar suas APIs na Apigee, você precisa
garantir que elas estejam disponíveis e funcionando conforme o esperado para
manter o serviço ininterrupto. O monitoramento de APIs da Apigee permite
que você rastreie suas APIs para garantir que elas estejam funcionando corretamente.
O monitoramento de APIs fornece insights quase em tempo real sobre o tráfego e o desempenho da API para
ajudar você a diagnosticar e resolver problemas rapidamente conforme eles surgem.
O API Monitoring possibilita as seguintes abordagens:
Crie alertas para notificar você sobre mudanças no tráfego da API para que possa
realizar uma ação apropriada antes que os clientes sejam afetados.
Aumentar a disponibilidade da API e reduzir o tempo médio para diagnóstico (MTTD, na sigla em inglês)
ao investigar rapidamente problemas com as APIs.
Aproveitar os códigos de falha para acelerar o diagnóstico.
Isole as áreas do problema rapidamente para diagnosticar erros, problemas de
desempenho e latência e a origem deles.
Como cliente da Apigee, também é possível usar as ferramentas do
Cloud Monitoring
para oferecer compatibilidade com o monitoramento de APIs.
Papéis do monitoramento da API
Para acessar o monitoramento de API, você precisa receber os seguintes papéis:
roles/apigee.readOnlyAdmin
roles/monitoring.viewer
Consulte os papéis da Apigee para mais informações sobre quais papéis são apropriados para usar o monitoramento de APIs.
Como acessar o monitoramento da API
É possível acessar o monitoramento da API por meio da interface da Apigee seguindo estas
etapas:
Apigee no console do Cloud
No Google Cloud console, acesse a página Desenvolvimento de proxy > Monitoramento de API.
Isso exibe a visualização principal do monitoramento da API. No menu Visualização, selecione uma das seguintes visualizações:
Cronograma: exibe cronogramas de dados de tráfego recente da API.
Investigar: exibe tabelas de dados de tráfego da API, como código de falha por região.
Recente: exibe mapas de árvore de dados em que cada proxy é representado por um retângulo, cujo tamanho é proporcional à quantidade de tráfego da API para o proxy e cujas cores indicam o tamanho relativo das métricas relacionadas.
As seções a seguir descrevem essas visualizações em detalhes:
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-18 UTC."],[[["\u003cp\u003eThis page covers API Monitoring for both Apigee and Apigee hybrid, enabling users to track API performance and availability.\u003c/p\u003e\n"],["\u003cp\u003eAPI Monitoring provides near real-time insights into API traffic and performance, allowing users to diagnose and resolve issues promptly, create alerts, and reduce mean-time-to-diagnosis.\u003c/p\u003e\n"],["\u003cp\u003eAPI Monitoring data, including query parameters and user agent information, is retained for six weeks before being deleted in accordance with Google's Privacy Policy.\u003c/p\u003e\n"],["\u003cp\u003eAccessing API Monitoring is available through either the Apigee UI in Cloud console or the classic Apigee UI, providing options to view timelines, investigate issues, or examine recent data.\u003c/p\u003e\n"],["\u003cp\u003eTo use API Monitoring, users need the \u003ccode\u003eroles/apigee.readOnlyAdmin\u003c/code\u003e and \u003ccode\u003eroles/monitoring.viewer\u003c/code\u003e roles, and Apigee hybrid users must have metrics enabled in their hybrid configuration.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nAfter you build and launch your APIs on Apigee, you need\nto ensure that they are available and performing as expected in order to\nmaintain uninterrupted service. Apigee's API Monitoring enables you to\ntrack your APIs to make sure they are up and running correctly.\nAPI Monitoring provides near real-time insights into API traffic and performance, to\nhelp you quickly diagnose and solve issues as they arise.\n\nAPI Monitoring enables you to:\n\n- Create alerts to notify you of changes in API traffic so you can take appropriate action before customers are affected.\n- Increase API availability and reduce the mean-time-to-diagnosis (MTTD) by quickly investigating issues with your APIs.\n- Leverage fault codes to speed diagnosis.\n- Isolate problem areas quickly to diagnose errors, performance, and latency issues and their source.\n\nAs an Apigee customer, you can also use\n[Cloud Monitoring](https://cloud.google.com/monitoring/docs)\ntools to support API Monitoring.\n| **About data retention** : API Monitoring logs capture query parameter and user agent data. Since this data may contain personally identifiable information (PII), it is retained for **6 weeks** , then deleted per the [Google Privacy Policy](https://www.google.com/policies/privacy). For more details, see [Data retention](https://cloud.google.com/monitoring/quotas#data_retention_policy).\n| **Apigee hybrid users** : Do not disable metrics in your hybrid configuration if you intend to view API Monitoring data. [Metrics](/apigee/docs/hybrid/latest/metrics-enable) must be enabled in your hybrid configuration for API Monitoring data to show up. Metrics is enabled for hybrid by default.\n\nAPI Monitoring roles\n\nTo access API Monitoring, you need to be assigned the following roles:\n\n- `roles/apigee.readOnlyAdmin`\n- `roles/monitoring.viewer`\n\nSee [Apigee roles](https://cloud.google.com/iam/docs/understanding-roles#apigee-roles) for more\ninformation about what roles are appropriate for using API Monitoring.\n\nAccessing API Monitoring\n\nYou can access API Monitoring through the Apigee UI by doing the following\nsteps:\n\n\u003cbr /\u003e\n\nApigee in Cloud console\n\n1. In the Google Cloud console, go to the **Proxy Development \\\u003e API monitoring** page.\n2. [Go to API monitoring](https://console.cloud.google.com/apigee/apimonitoring)\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nClassic Apigee\n\n\u003cbr /\u003e\n\n1. Sign in to [Apigee UI](https://apigee.google.com).\n2. Select one of the following views:\n\n - **Analyze \\\u003e API Monitoring \\\u003e Timeline**\n - **Analyze \\\u003e API Monitoring \\\u003e Investigate**\n - **Analyze \\\u003e API Monitoring \\\u003e Recent**\n\nThis displays the main API Monitoring view. In the **View** menu, you can\nselect one of the following views:\n\n\u003cbr /\u003e\n\n- **Timeline**: Displays timelines of recent API traffic data.\n- **Investigate**: Displays tables of API traffic data, such as fault code by region.\n- **Recent**: Displays treemaps of data in which each proxy is represented by a rectangle, whose size is proportional to the amount of API traffic for the proxy, and whose color denotes the relative size of related metrics.\n\nThe following sections describe these views in detail:\n\n\u003c!-- --\u003e\n\n- [Timeline](/apigee/docs/api-monitoring/timeline)\n- [Investigate](/apigee/docs/api-monitoring/investigate)\n- [Recent](/apigee/docs/api-monitoring/recent)\n\n\u003cbr /\u003e"]]
