Service Gateway Metrics

You can monitor the health, capacity, and performance of your service gateways by using metrics, alarms, and notifications. For more information, see Monitoring Overview and Notifications Overview.

This topic describes the metrics emitted by the metric namespace oci_service_gateway.

Resources: Service gateways

Overview of Metrics: oci_service_gateway

A service gateway is used to enable on-premises hosts or VCN hosts to privately access Oracle services (such as Object Storage and Autonomous Database) without exposing the resources to the public internet.

The available metrics help you determine quickly if your service gateway is up, how much data is flowing through the gateway, and if packets are being dropped for unexpected errors.

  • Traffic to and from the service gateway: Per-gateway traffic levels (packets and bytes), which can help you identify meaningful increases or decreases in traffic coming in and out of the gateway.
  • Packets dropped: Per-gateway drops (dropped packets), which can help you identify changes in traffic caused by issues such as gateway misconfiguration or unrecognized packet protocol.

Required IAM Policy

To monitor resources, you must be given the required type of access in a policy  written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment  you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.

Available Metrics: oci_service_gateway

The metrics listed in the following table are automatically available for each service gateway that you create. You do not need to enable monitoring to get these metrics.

You also can use the Monitoring service to create custom queries.

Each metric includes one or more of the following dimensions: 

resourceId
The OCID  of the service gateway.
dropType
The type of packet drop:
  • sgwDisabledDrops: Packets dropped because the service gateway is disabled.
  • sgwMtuExceededDrops: Packets dropped because the Maximum Transmission Unit (MTU) has been exceeded.
  • sgwServiceDestUnknown: Packets dropped because of an unknown or incorrect service destination.
  • sgwTtlExpiryDrops: Packets dropped because the TTL (Time To Live) value in the IPv4 header of the packet has expired.
  • sgwMisconfigurationDrops: Packets dropped because the gateway service moniker is misconfigured. For example, the gateway's associated route table points to a different CIDR service than the one specified in the gateway configuration.
  • sgwUnknownProtocolDrops: Packets dropped because the protocol in the IPv4 header of the packet is not recognized.
Metric Metric Display Name Unit Description Dimensions

packetsToService

Packets to Service

Packets

The number of packets successfully sent from the service gateway toward Oracle services.

resourceId

packetsFromService

Packets from Service

Packets

The number of packets successfully sent from the service gateway toward customer instances.

bytesToService

Bytes to Service

Bytes

The number of bytes successfully sent from the service gateway toward Oracle services.

bytesFromService

Bytes from Service

Bytes

The number of bytes successfully sent from the service gateway toward customer instances.

sgwDropsFromService

Packet Drops from Service

Packets

The number of packets dropped while sending packets from the service gateway toward customer instances.

sgwDropsToService

Packet Drops to Service

Packets

The number of packets dropped while sending packets from the service gateway toward Oracle services.

resourceId

dropType

Using the Console

To view default metric charts for all service gateways in a compartment

Using the API

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use the following APIs for monitoring: