Overview
OCI API Gateway is a fully managed service that enables you to create and deploy APIs with private or public endpoints, facilitating secure and scalable access to your backend services. It offers features such as request and response transformation, authentication and authorization, rate limiting, and CORS support, all of which ensure robust API management and governance.
This integration allows you to monitor your API Gateway’s health, capacity, and performance by collecting metrics and tags from the oci_apigateway namespace.
Setup
Installation
Once you set up the Oracle Cloud Infrastructure integration, ensure that any namespaces mentioned above are included in your Connector Hub.
Data Collected
Metrics
oci.apigateway.backend_http_responses
(count) | Count of the HTTP responses returned by the back-end services.
Shown as response |
oci.apigateway.bytes_received
(count) | Number of bytes received by the API gateway from API clients.
Shown as byte |
oci.apigateway.bytes_sent
(count) | Number of bytes sent by the API gateway to API clients.
Shown as byte |
oci.apigateway.http_requests
(count) | Number of incoming API client requests to the API gateway.
Shown as request |
oci.apigateway.http_responses
(count) | Number of http responses that the API gateway has sent back.
Shown as response |
oci.apigateway.integration_latency
(gauge) | Time between the API gateway sending a request to the back-end service and receiving a response from the back-end service.
Shown as second |
oci.apigateway.internal_latency
(gauge) | Time spent internally in the API gateway to process the request.
Shown as second |
oci.apigateway.latency
(gauge) | Average time that it takes for a request to be processed and its response to be sent. This is calculated from the time the API gateway receives the first byte of an HTTP request to the time when the response send operation is completed.
Shown as second |
oci.apigateway.response_cache_action
(gauge) | The action taken by the response cache. |
oci.apigateway.response_cache_availability
(gauge) | Availability of the response cache as seen by the API gateway. |
oci.apigateway.response_cache_latency
(gauge) | Total time taken for connect, read, and store operations on the response cache.
Shown as millisecond |
oci.apigateway.subscriber_quota_proportion_used
(gauge) | Proportion of an entitlement's quota that has been consumed by a subscriber. Emitted per request.Calculated as: / .
Shown as fraction |
oci.apigateway.subscriber_rate_limit_proportion_used
(gauge) | Proportion of an entitlement's rate limit that has been consumed by a subscriber. Emitted per request.Calculated as: / .
Shown as fraction |
oci.apigateway.subscriber_requests
(count) | Number of requests made by a subscriber. Emitted per request.
Shown as request |
oci.apigateway.usage_plan_requests
(count) | Number of requests to a given entitlement. Emitted per request.
Shown as request |
Service Checks
OCI API Gateway does not include any service checks.
Events
OCI API Gateway does not include any events.
Troubleshooting
Need help? Contact Datadog support.
