OCI API Gateway monitoring
Oracle Cloud Infrastructure (OCI) API Gateway is a fully managed service that enables you to publish, secure, monitor, and manage APIs at scale. It acts as a single entry point for back-end services, routing client requests to supported back-end resources while enforcing authentication, request validation, rate limiting, and traffic management policies.
Integration with OCI API Gateway provides end-to-end visibility into the health and performance of your API Gateway resources and deployments. Monitor gateway activity, analyze deployment performance, configure thresholds, and receive alerts to quickly identify issues affecting API availability and responsiveness.
Integrating with OCI API Gateway provides monitoring for the following monitor types:
- API Gateway: Monitors the overall health, availability, and operational performance of an OCI API Gateway instance.
- API Deployment: Monitors individual API Deployments running within an OCI API Gateway instance and tracks the performance of the configured back-end service.
- API Route: Monitors the routes configured within an API Deployment to provide visibility into their configuration and associated back-end routing.
By monitoring both gateways and deployments, operations teams can quickly isolate whether an issue originates at the gateway layer or within a specific deployment. Combined with your monitoring application's alerting capabilities, threshold profiles, dashboards, and reports, OCI API Gateway monitoring helps ensure reliable API delivery across cloud environments.
Use cases
Ensure uninterrupted API availability
An organization publishes customer-facing APIs through OCI API Gateway. During peak business hours, response times begin increasing because one deployment experiences abnormal traffic. The monitoring application detects the performance degradation, generates alerts based on configured thresholds, and enables administrators to quickly identify the affected deployment before customers experience widespread service disruption.
Monitor multiple back-end services
A development team deploys several APIs through a single gateway, each routing requests to different back-end services such as compute instances, OCI Functions, and Load Balancers. Every deployment is monitored individually, allowing administrators to determine which back end is responsible for performance degradation without manually inspecting each service.
Validate production deployments
A new API version is deployed into production. By monitoring deployment metrics immediately after release, the operations team verifies that traffic is processed normally and confirms that no unexpected performance issues have been introduced.
Benefits of OCI API Gateway integration
Integrating with OCI API Gateway provides the following benefits:
- Monitor API Gateway availability and operational health from a single console.
- Track the performance of individual deployments independently of the gateway.
- Detect performance degradation before it impacts API consumers.
- Configure threshold profiles to receive proactive alerts.
- View gateway and deployment information together for faster root cause analysis.
- Organize monitored API Gateways using Monitor Groups for simplified operations.
- Integrate API Gateway monitoring with dashboards, reports, and incident management workflows.
Setup and configuration
- The monitoring application uses cross-tenancy access to monitor your resources using the tenancy user. Log in to your account and create a specific policy to allow the monitoring application to view your resources without affecting your security.
- On the Integrate OCI Monitor page, select API Gateway from the Services to be discovered list.
Policies and permissions
Ensure that the associated OCI policy has the following statement:
- "ListGateways",
- "GetGateway",
- "ListDeployments",
- "GetDeployment"
Polling frequency
The monitoring application queries OCI service-level APIs according to the set polling frequency (from once a minute to once a day) to collect metrics from the API Gateway monitor.
Supported metrics
The supported metrics for the API Gateway monitors are given below.
API Gateway and API Deployment
| Metric name | Description | Statistics | Unit |
|---|---|---|---|
| Bytes Received | Measures the total number of bytes received. | Sum | Bytes |
| GET Type Bytes Received | Measures the total number of bytes received for GET type. | Sum | Bytes |
| HEAD Type Bytes Received | Measures the total number of bytes received for HEAD type. | Sum | Bytes |
| POST Type Bytes Received | Measures the total number of bytes received for POST type. | Sum | Bytes |
| PUT Type Bytes Received | Measures the total number of bytes received for PUT type. | Sum | Bytes |
| DELETE Type Bytes Received | Measures the total number of bytes received for DELETE type. | Sum | Bytes |
| 200 Bytes Received | Measures the total number of bytes received for 200. | Sum | Bytes |
| 201 Bytes Received | Measures the total number of bytes received for 201. | Sum | Bytes |
| 502 Bytes Received | Measures the total number of bytes received for 502. | Sum | Bytes |
| 504 Bytes Received | Measures the total number of bytes received for 504. | Sum | Bytes |
| 2XX Bytes Received | Measures the total number of bytes received for 2xx. | Sum | Bytes |
| 3XX Bytes Received | Measures the total number of bytes received for 3xx. | Sum | Bytes |
| 4XX Bytes Received | Measures the total number of bytes received for 4xx. | Sum | Bytes |
| 5XX Bytes Received | Measures the total number of bytes received for 5xx. | Sum | Bytes |
| HTTP Backend Bytes Received | Measures the total number of bytes received for HTTP back end. | Sum | Bytes |
| Oracle Functions Backend Bytes Received | Measures the total number of bytes received for Oracle Functions back end. | Sum | Bytes |
| Stock Response Backend Bytes Received | Measures the total number of bytes received for stock response back end. | Sum | Bytes |
| Bytes Sent | Measures the total number of bytes sent. | Sum | Bytes |
| GET Type Bytes Sent | Measures the total number of bytes sent for GET type. | Sum | Bytes |
| HEAD Type Bytes Sent | Measures the total number of bytes sent for HEAD type. | Sum | Bytes |
| POST Type Bytes Sent | Measures the total number of bytes sent for POST type. | Sum | Bytes |
| PUT Type Bytes Sent | Measures the total number of bytes sent for PUT type. | Sum | Bytes |
| DELETE Type Bytes Sent | Measures the total number of bytes sent for DELETE type. | Sum | Bytes |
| 200 Bytes Sent | Measures the total number of bytes sent for 200. | Sum | Bytes |
| 201 Bytes Sent | Measures the total number of bytes sent for 201. | Sum | Bytes |
| 502 Bytes Sent | Measures the total number of bytes sent for 502. | Sum | Bytes |
| 504 Bytes Sent | Measures the total number of bytes sent for 504. | Sum | Bytes |
| 2XX Bytes Sent | Measures the total number of bytes sent for 2xx. | Sum | Bytes |
| 3XX Bytes Sent | Measures the total number of bytes sent for 3xx. | Sum | Bytes |
| 4XX Bytes Sent | Measures the total number of bytes sent for 4xx. | Sum | Bytes |
| 5XX Bytes Sent | Measures the total number of bytes sent for 5xx. | Sum | Bytes |
| HTTP Backend Bytes Sent | Measures the total number of bytes sent for HTTP back end. | Sum | Bytes |
| Oracle Functions Backend Bytes Sent | Measures the total number of bytes sent for Oracle Functions back end. | Sum | Bytes |
| Stock Response Backend Bytes Sent | Measures the total number of bytes sent for stock response back end. | Sum | Bytes |
| Total HTTP Requests | Measures the total number of HTTP requests received. | Sum | Count |
| GET Type HTTP Requests | Measures the total number of HTTP requests for GET type. | Sum | Count |
| HEAD Type HTTP Requests | Measures the total number of HTTP requests for HEAD type. | Sum | Count |
| POST Type HTTP Requests | Measures the total number of HTTP requests for POST type. | Sum | Count |
| PUT Type HTTP Requests | Measures the total number of HTTP requests for PUT type. | Sum | Count |
| DELETE Type HTTP Requests | Measures the total number of HTTP requests for DELETE type. | Sum | Count |
| HTTP Backend HTTP Requests | Measures the total number of HTTP requests for HTTP back end. | Sum | Count |
| Oracle Functions Backend HTTP Requests | Measures the total number of HTTP requests for Oracle Functions back end. | Sum | Count |
| Stock Response Backend HTTP Requests | Measures the total number of HTTP requests for stock response back end. | Sum | Count |
| Total HTTP Responses | Measures the total number of HTTP responses. | Sum | Count |
| GET Type HTTP Responses | Measures the total number of HTTP responses for GET type. | Sum | Count |
| HEAD Type HTTP Responses | Measures the total number of HTTP responses for HEAD type. | Sum | Count |
| POST Type HTTP Responses | Measures the total number of HTTP responses for POST type. | Sum | Count |
| PUT Type HTTP Responses | Measures the total number of HTTP responses for PUT type. | Sum | Count |
| DELETE Type HTTP Responses | Measures the total number of HTTP responses for DELETE type. | Sum | Count |
| 200 HTTP Responses | Measures the total number of HTTP responses for 200. | Sum | Count |
| 201 HTTP Responses | Measures the total number of HTTP responses for 201. | Sum | Count |
| 502 HTTP Responses | Measures the total number of HTTP responses for 502. | Sum | Count |
| 504 HTTP Responses | Measures the total number of HTTP responses for 504. | Sum | Count |
| 2XX HTTP Responses | Measures the total number of HTTP responses for 2xx. | Sum | Count |
| 3XX HTTP Responses | Measures the total number of HTTP responses for 3xx. | Sum | Count |
| 4XX HTTP Responses | Measures the total number of HTTP responses for 4xx. | Sum | Count |
| 5XX HTTP Responses | Measures the total number of HTTP responses for 5xx. | Sum | Count |
| HTTP Backend HTTP Responses | Measures the total number of HTTP responses for HTTP back end. | Sum | Count |
| Oracle Functions Backend HTTP Responses | Measures the total number of HTTP responses for Oracle Functions back end. | Sum | Count |
| Stock Response Backend HTTP Responses | Measures the total number of HTTP responses for stock response back end. | Sum | Count |
| Total Backend HTTP Responses | Measures the total number of HTTP responses returned by back ends. | Sum | Count |
| GET Type Backend HTTP Responses | Measures the total number of back-end HTTP responses for GET type. | Sum | Count |
| HEAD Type Backend HTTP Responses | Measures the total number of back-end HTTP responses for HEAD type. | Sum | Count |
| POST Type Backend HTTP Responses | Measures the total number of back-end HTTP responses for POST type. | Sum | Count |
| PUT Type Backend HTTP Responses | Measures the total number of back-end HTTP responses for PUT type. | Sum | Count |
| DELETE Type Backend HTTP Responses | Measures the total number of back-end HTTP responses for DELETE type. | Sum | Count |
| 200 Backend HTTP Responses | Measures the total number of back-end HTTP responses for 200. | Sum | Count |
| 201 Backend HTTP Responses | Measures the total number of back-end HTTP responses for 201. | Sum | Count |
| 502 Backend HTTP Responses | Measures the total number of back-end HTTP responses for 502. | Sum | Count |
| 504 Backend HTTP Responses | Measures the total number of back-end HTTP responses for 504. | Sum | Count |
| 2XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for 2xx. | Sum | Count |
| 3XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for 3xx. | Sum | Count |
| 4XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for 4xx. | Sum | Count |
| 5XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for 5xx. | Sum | Count |
| HTTP Backend Backend HTTP Responses | Measures the total number of back-end HTTP responses for HTTP back end. | Sum | Count |
| Oracle Functions Backend Backend HTTP Responses | Measures the total number of back-end HTTP responses for Oracle Functions back end. | Sum | Count |
| Stock Response Backend Backend HTTP Responses | Measures the total number of back-end HTTP responses for stock response back end. | Sum | Count |
| Backend 200 Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 200. | Sum | Count |
| Backend 201 Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 201. | Sum | Count |
| Backend 502 Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 502. | Sum | Count |
| Backend 504 Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 504. | Sum | Count |
| Backend 2XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 2xx. | Sum | Count |
| Backend 3XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 3xx. | Sum | Count |
| Backend 4XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 4xx. | Sum | Count |
| Backend 5XX Backend HTTP Responses | Measures the total number of back-end HTTP responses for back-end 5xx. | Sum | Count |
| Total Latency | Measures the total average latency. | Mean | Seconds |
| GET Type Latency | Measures the average latency for GET HTTP method. | Mean | Seconds |
| HEAD Type Latency | Measures the average latency for HEAD HTTP method. | Mean | Seconds |
| POST Type Latency | Measures the average latency for POST HTTP method. | Mean | Seconds |
| PUT Type Latency | Measures the average latency for PUT HTTP method. | Mean | Seconds |
| DELETE Type Latency | Measures the average latency for DELETE HTTP method. | Mean | Seconds |
| 200 Latency | Measures the average latency for 200. | Mean | Seconds |
| 201 Latency | Measures the average latency for 201. | Mean | Seconds |
| 502 Latency | Measures the average latency for 502. | Mean | Seconds |
| 504 Latency | Measures the average latency for 504. | Mean | Seconds |
| 2XX Latency | Measures the average latency for 2xx. | Mean | Seconds |
| 3XX Latency | Measures the average latency for 3xx. | Mean | Seconds |
| 4XX Latency | Measures the average latency for 4xx. | Mean | Seconds |
| 5XX Latency | Measures the average latency for 5xx. | Mean | Seconds |
| HTTP Backend Latency | Measures the average latency for HTTP back end. | Mean | Seconds |
| Oracle Functions Backend Latency | Measures the average latency for Oracle Functions back end. | Mean | Seconds |
| Stock Response Backend Latency | Measures the average latency for stock response back end. | Mean | Seconds |
| Total Integration Latency | Measures the total average integration latency. | Mean | Seconds |
| GET Type Integration Latency | Measures the average integration latency for GET HTTP method. | Mean | Seconds |
| HEAD Type Integration Latency | Measures the average integration latency for HEAD HTTP method. | Mean | Seconds |
| POST Type Integration Latency | Measures the average integration latency for POST HTTP method. | Mean | Seconds |
| PUT Type Integration Latency | Measures the average integration latency for PUT HTTP method. | Mean | Seconds |
| DELETE Type Integration Latency | Measures the average integration latency for DELETE HTTP method. | Mean | Seconds |
| 200 Integration Latency | Measures the average integration latency for 200. | Mean | Seconds |
| 201 Integration Latency | Measures the average integration latency for 201. | Mean | Seconds |
| 502 Integration Latency | Measures the average integration latency for 502. | Mean | Seconds |
| 504 Integration Latency | Measures the average integration latency for 504. | Mean | Seconds |
| 2XX Integration Latency | Measures the average integration latency for 2xx. | Mean | Seconds |
| 3XX Integration Latency | Measures the average integration latency for 3xx. | Mean | Seconds |
| 4XX Integration Latency | Measures the average integration latency for 4xx. | Mean | Seconds |
| 5XX Integration Latency | Measures the average integration latency for 5xx. | Mean | Seconds |
| HTTP Backend Integration Latency | Measures the average integration latency for HTTP back end. | Mean | Seconds |
| Oracle Functions Backend Integration Latency | Measures the average integration latency for Oracle Functions back end. | Mean | Seconds |
| Stock Response Backend Integration Latency | Measures the average integration latency for stock response back end. | Mean | Seconds |
| Total Internal Latency | Measures the total average internal latency. | Mean | Seconds |
| GET Type Internal Latency | Measures the average internal latency for GET HTTP method. | Mean | Seconds |
| HEAD Type Internal Latency | Measures the average internal latency for HEAD HTTP method. | Mean | Seconds |
| POST Type Internal Latency | Measures the average internal latency for POST HTTP method. | Mean | Seconds |
| PUT Type Internal Latency | Measures the average internal latency for PUT HTTP method. | Mean | Seconds |
| DELETE Type Internal Latency | Measures the average internal latency for DELETE HTTP method. | Mean | Seconds |
| 200 Internal Latency | Measures the average internal latency for 200. | Mean | Seconds |
| 201 Internal Latency | Measures the average internal latency for 201. | Mean | Seconds |
| 502 Internal Latency | Measures the average internal latency for 502. | Mean | Seconds |
| 504 Internal Latency | Measures the average internal latency for 504. | Mean | Seconds |
| 2XX Internal Latency | Measures the average internal latency for 2xx. | Mean | Seconds |
| 3XX Internal Latency | Measures the average internal latency for 3xx. | Mean | Seconds |
| 4XX Internal Latency | Measures the average internal latency for 4xx. | Mean | Seconds |
| 5XX Internal Latency | Measures the average internal latency for 5xx. | Mean | Seconds |
| Total Response Cache Action | Measures the total number of response cache actions. | Sum | Count |
| HIT Response Cache Action | Measures the number of response cache actions with a HIT result. | Sum | Count |
| MISS Response Cache Action | Measures the number of response cache actions with a MISS result. | Sum | Count |
| BYPASS Response Cache Action | Measures the number of response cache actions with a BYPASS result. | Sum | Count |
| Total Response Cache Availability | Measures the total number of response cache availability events. | Sum | Count |
| Total Response Cache Latency | Measures the average time taken for response cache operations. | Mean | ms |
API Route table
| Metric name | Description | Statistics | Unit |
|---|---|---|---|
| Bytes Received | Measures the total number of bytes received. | Sum | Bytes |
| Bytes Sent | Measures the total number of bytes sent. | Sum | Bytes |
| HTTP Requests | Measures the total number of HTTP requests. | Sum | Count |
| HTTP Responses | Measures the total number of HTTP responses. | Sum | Count |
| Backend HTTP Responses | Measures the total number of back-end HTTP responses. | Sum | Count |
| Latency | Measures the average time taken to process a request. | Mean | ms |
| Integration Latency | Measures the average time spent integrating with the back end. | Mean | ms |
| Internal Latency | Measures the average time spent on internal request processing. | Mean | ms |
| Response Cache Action | Measures the total number of response cache actions for the route. | Sum | Count |
| Response Cache Latency | Measures the average time taken for response cache operations. | Mean | ms |
Threshold configuration
To configure thresholds for the API Gateway monitor:
- Log in to your account and navigate to Admin > Configuration Profiles > Threshold and Availability .
- Click Add Threshold Profile.
- Select API Gateway or API Deployment from the Monitor Type drop-down menu and provide an appropriate name in the Display Name field.
- The supported metrics are displayed in the Threshold Configuration section. You can set threshold values for all the metrics mentioned above.
- Click Save.
Status-based alerts
In addition to metric-based thresholds, you can configure alerts based on the status of the API Gateway and its deployments.
- Notify When Gateway Is in Failed Status: Enable this option to receive an alert when the API Gateway enters a failed status.
- Notify When Deployment Is in Failed Status: Enable this option to receive an alert when an API Deployment enters a failed status.
- Notify When Route Is in Failed Status: Enable this option to receive an alert when the API Route enters a failed status.
Licensing
- Each API Gateway and API Deployment monitor utilizes one basic monitor license.
- API Route monitor is a free monitor.
Organize OCI API Gateway using Monitor Groups
Monitor Groups help organize OCI API Gateway resources based on applications, environments, business units, or projects, making it easier to manage largescale API environments.
For example, you can group an API Gateway and its associated API Deployments that belong to the same application into a single Monitor Group. This enables administrators to monitor the health of the complete API infrastructure from one location and quickly understand the impact of issues across the gateway, deployments, and routes.
Monitor Groups also simplify alert management by allowing notifications, reports, dashboards, and Business Views to be configured at the group level.
Capacity planning
Capacity planning helps you analyze historical performance trends across OCI API Gateway resources to understand workload growth and plan future infrastructure requirements.
By monitoring request volume, traffic patterns, latency, and other available performance metrics across API Gateways and API Deployments, you can identify increasing API demand, analyze workload patterns, and proactively plan back-end capacity.
Historical performance data also helps validate infrastructure changes, identify performance trends across individual deployments and routes, and ensure API services continue to meet expected performance levels as workloads grow.
Viewing API Gateway data
To monitor your service gateway environment, log in to your account and navigate to Cloud > OCI > API Gateway.
Monitor data
The monitor data for each API Gateway monitor is given below.
API Gateway
Summary
The Summary tab offers a comprehensive overview of the events timeline and metrics, presenting insightful charts that shed light on the performance of the API Gateway monitor.
API Deployment
The API Deployment tab lists all Deployment monitors associated with the selected API Gateway. Click an API Deployment monitor to open its monitor details and investigate its health, configuration, performance, and back-end information.
OCI Certificate Authority
The OCI Certificate Authority tab lists the Certificate Authority (CA) monitors associated with the selected API Gateway. It provides visibility into the health and availability of the certificate authorities used to secure API Gateway endpoints and manage SSL/TLS certificates.
Configuration
The Configuration tab summarizes essential details of the API Gateway monitor, including its Region , Time Created , Lifecycle State , and other configuration details.
Outages
The Outages tab provides details on an outage's Start Time , End Time , Duration , and Comments (if any).
Notes
The Notes tab displays a brief note section where you can add or view notes associated with the API Gateway monitor. It also provides inventory and monitor configuration details, including the Resource ID , Region , and Monitor Licensing Category .
Log Report
The Log Report tab offers a consolidated report of the API Gateway monitor's log status, which can be downloaded as a CSV file.
Alert Logs
The Alert Logs tab displays a chronological list of all triggered alerts related to the API Gateway monitor. This tab helps you trace alert history and severity to assess issues and validate threshold settings.
Audit Logs
The Audit Logs tab displays audit log activities associated with the API Gateway monitor. You can use the query bar to filter audit logs based on specific conditions, such as the resource ID, and select a time period to view relevant activities.
Enable Include related audit activities to include audit activities related to the selected resource. The tab also allows you to search and share the audit log results.
API Deployment
Summary
The Summary tab offers a comprehensive overview of the events timeline and metrics, presenting insightful charts that shed light on the performance of the API Deployment monitor.
API Route
The API Route tab lists all API Route monitors associated with the selected API Deployment monitor. Click an API Route monitor to open its monitor details and investigate its health, configuration, performance, and back-end information.
Configuration
The Configuration tab summarizes essential details of the API Deployment monitor, including its Region , Time Created , Lifecycle State , and other configuration details.
Outages
The Outages tab provides details on an outage's Start Time , End Time , Duration , and Comments (if any).
Notes
The Notes tab displays a brief note section where you can add or view notes associated with the API Deployment monitor. It also provides inventory and monitor configuration details, including the Resource ID , Region , and Monitor Licensing Category .
Log Report
The Log Report tab offers a consolidated report of the API Deployment monitor's log status, which can be downloaded as a CSV file.
Alert Logs
The Alert Logs tab displays a chronological list of all triggered alerts related to the API Deployment monitor. This tab helps you trace alert history and severity to assess issues and validate threshold settings.
Audit Logs
The Audit Logs tab displays audit log activities associated with the API Deployment monitor. You can use the query bar to filter audit logs based on specific conditions, such as the resource ID, and select a time period to view relevant activities.
Enable Include related audit activities to include audit activities related to the selected resource. The tab also allows you to search and share the audit log results.
API Route
Summary
The Summary tab offers a comprehensive overview of the events timeline and metrics, presenting insightful charts that shed light on the performance of the API Route monitor.
Configuration
The Configuration tab summarizes essential details of the API Route monitor, including its Region , Time Created , Lifecycle State , and other configuration details.
Zia Forecast
The Zia Forecast tab displays the forecast chart with future points of a performance metric (measurement of resource usage) based on historical time series data. Historical data, of up to 30 days, is used to predict what your metric usage will be in the next seven days.
Outages
The Outages tab provides details on an outage's Start Time, End Time, Duration, and Comments (if any).
Notes
The Notes tab displays a brief note section where you can add or view notes associated with the API Route monitor. It also provides inventory and monitor configuration details, including the Resource ID , Region , and Monitor Licensing Category .
Log Report
The Log Report tab offers a consolidated report of the API Route monitor's log status, which can be downloaded as a CSV file.
Alert Logs
The Alert Logs tab displays a chronological list of all triggered alerts related to the API Route monitor. This tab helps you trace alert history and severity to assess issues and validate threshold settings.
Audit Logs
The Audit Logs tab displays audit log activities associated with the API Route monitor. You can use the query bar to filter audit logs based on specific conditions, such as the resource ID, and select a time period to view relevant activities.
Enable Include related audit activities to include audit activities related to the selected resource. The tab also allows you to search and share the audit log results.