Download PDF
Download page GCP API Gateway.
GCP API Gateway
GCP API Gateway enables you to provide secure access to your backend services through a well-defined REST API that is consistent across all of your services, regardless of the service implementation. Cisco Cloud Observability does not currently support monitoring GCP Apigee API Management.
Cisco Cloud Observability supports monitoring the following GCP API Gateway entities:
- API: The API configuration created when you upload an API definition. You create the API definition as an OpenAPI spec. If your API manages gRPC services on Cloud Run, you can define your API with a gRPC service definition and configuration. The API entity represents an API created by a user, not Google Cloud APIs.
- Gateway: An Envoy-based, high-performance, scalable proxy that hosts the deployed API config. Deploying an API config to a gateway creates the external facing URL that your API clients use to access the API.
You must configure cloud connections to monitor this entity. See Configure Google Cloud Platform Connection.
Cisco Cloud Observability displays GCP entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.
This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.
Detail View
To display the detail view of a GCP API:
- Navigate to the Observe page.
- Under App Integrations, click GCP API Gateway APIs.
The list view now displays. - From the list, click a Name to display the detail view.
The detail view displays metrics, key performance indicators, and properties (attributes) related to the instance you selected. It also displays a list of the Gateways in your environment and their properties.
Metrics and Key Performance Indicators
Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for GCP API Gateway APIs.
Some GCP metrics have been modified in Cisco Cloud Observability. Metric display names and descriptions may differ from the source metric.
| Display Name | Source Metric Name | Description |
|---|---|---|
| Requests (Count) | api/request_count | The count of completed requests. |
| Request Latencies (s) | api/request_latencies | The distribution of latencies in seconds for non-streaming requests. |
api/request_latencies_backend | The distribution of backend latencies in seconds for non-streaming requests. | |
api/request_latencies_overhead | The distribution of request latencies in seconds for non-streaming requests excluding the backend. | |
Message Sizes (By) |
| The distribution of message sizes in bytes recorded at request completion. |
Properties (Attributes)
Cisco Cloud Observability displays the following properties for GCP API Gateway entities.
| Display Name | Source Property Name | Description |
|---|---|---|
| ID | name | The ID of the API. Format: |
| Name |
| The name of the API. |
| Project ID | - | The ID of the GCP project. |
| Region | - | The region where the API is deployed; always global. |
| State | state | The state of the API. |
| Managed Service | managedService | References a Google Managed Service. |
| Create Time | createTime | The time the API was created. |
| Update Time | updateTime | The time the API was updated. |
The list of Gateways in your environment and their properties are displayed on the API detail view.
| Display Name | Source Property Name | Description |
|---|---|---|
| Name |
| The name of the API. |
| ID | name | The ID of the Gateway. Format: |
| Region | - | The geographical region the resource is running. |
| State | state | The current state of the Gateway. |
| Create Time | createTime | The time that the Gateway was created. |
| Update Time | updateTime | The time that the Gateway was updated. |
| API Config | apiConfig | The resource name of the API Config for this Gateway. Format: |
| Default Hostname | defaultHostname | The default API Gateway host name, in the format |
Retention and Purge Time-To-Live (TTL)
For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).
Third party names, logos, marks, and general references used in these materials are the property of their respective owners or their affiliates in the United States and/or other countries. Inclusion of such references are for informational purposes only and are not intended to promote or otherwise suggest a relationship between Splunk AppDynamics and the third party.