Oracle Cloud Infrastructure Documentation

Load Balancer Metrics

Understand the metrics emitted by the Load Balancer service in the oci_lbaas metric namespace.

You can monitor the health, capacity, and performance of your load balancers by using metrics, alarms, and notifications. See Monitoring and Notifications for general information on how to understand and use the various Oracle Cloud Infrastructure monitoring tools available to you.

Your load balancer acts as an intermediary for data traffic between clients and your application servers. Clients send requests to your load balancer and the load balancer distributes the requests to your backend servers according to rules you establish. See the diagram in Overview of Load Balancer for a high-level view of a simple public load balancing system configuration.

The Load Balancer service metrics help you measure the number and type of connections, and quantity of data managed by your load balancer. You can use metrics data to diagnose and troubleshoot load balancer and client issues. The metrics also help you analyze the HTTP responses returned by the servers in your backend set.

To view a default set of metrics charts in the Console, navigate to the load balancer or backend set you're interested in, and then select Metrics. You also can use the Monitoring service to create custom queries.

See Viewing Load Balancer Metrics to view the available types of metrics for a load balancer.

Prerequisites

  • IAM policies: To monitor resources, you must be granted 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 both the monitoring services and the resources being monitored. If you try to perform an action and get a message that you don't have permission or are unauthorized, contact the administrator to find out what type of access you were granted and which compartment  you need to work in. For more information about user authorizations for monitoring, see IAM Policies.

  • The metrics listed on this page are automatically available for any load balancer, listener, and backend set you create. You do not need to enable monitoring on the resource to get these metrics.

Available Metrics: oci_lbaas

Learn about the available metrics for a load balancer.

The Load Balancer service metrics include the following dimensions :

Metric

Description

AVAILABILITYDOMAIN

The availability domain  in which the load balancer resides.

BACKENDSETNAME

The name of the backend set to which the metrics apply.

LBCOMPONENT

The load balancer component to which the metrics apply.

Valid metrics for the Load Balancer service vary among the three lbComponent dimension values:

  • Backendset

  • Listener

  • Loadbalancer

The tables on this page describe which data is valid for each of these dimension values. If you choose a metric that does not apply to the specified dimension value, the metric returns no data.

LBHOSTID

A unique ID that represents the current load balancer host. This ID is subject to change.

LISTENERNAME

The name of the listener to which the metrics apply.

REGION

The region  in which the load balancer resides.

RESOURCEID

The OCID  of the resource to which the metrics apply.

Metrics for the lbComponent Dimension Value "Backendset"

Metric

Metric Display Name

Unit

Description

Dimensions

ActiveConnections

Active Connections

count

The number of active connections from the load balancer to all backend servers.

availabilityDomain

backendSetName

lbComponent

lbHostId

region

resourceId

BackendServers

Backend Servers

count

The number of backend servers in the backend set.

BackendTimeouts

Backend Timeouts

count

The number of timeouts across all backend servers.

BytesReceived

Bytes Received

bytes

The number of bytes received across all backend servers.

BytesSent

Bytes Sent

bytes

The number of bytes sent across all backend servers.

ClosedConnections

Closed Connections

count

The number of connections closed between the load balancer and backend servers.

HttpRequests

Inbound Requests

count

The number of incoming client requests to the backend set.

HttpResponses

Responses

count

The number of HTTP responses across all backend servers.

HttpResponses200

HTTP 200 Responses

count

The number of HTTP 200 responses received from backend servers.

HttpResponses2xx

HTTP 2xx Responses

count

The number of HTTP 2xx responses received from backend servers.

HttpResponses3xx

HTTP 3xx Responses

count

The number of HTTP 3xx responses received from backend servers.

HttpResponses4xx

HTTP 4xx Responses

count

The number of HTTP 4xx responses received from backend servers.

HttpResponses502

HTTP 502 Responses

count

The number of HTTP 502 responses received from backend servers.

HttpResponses504

HTTP 504 Responses

count

The number of HTTP 504 responses received from backend servers.

HttpResponses5xx

HTTP 5xx Responses

count

The number of HTTP 5xx responses received from backend servers.

InvalidHeaderResponses

Invalid Header Responses

count

The number of invalid header responses across all backend servers.

KeepAliveConnections

Keep-alive Connections

count

The number of keep-alive connections.

ResponseTimeFirstByte

Average Response Time (TCP only)

ms

Average time to the first byte of response from backend servers. TCP only.

ResponseTimeHttpHeader

Average Response Time (HTTP only)

ms

Average response time of backend servers. HTTP only.

UnhealthyBackendServers

Unhealthy Backend Servers

count

The number of unhealthy backend servers in the backend set.

Metrics for the lbComponent Dimension Value "Loadbalancer"

Metric

Metric Display Name

Unit

Description

Dimensions

AcceptedConnections

Accepted Connections

count

The number of connections accepted by the load balancer.

availabilityDomain

lbComponent

lbHostId

region

resourceId

AcceptedSSLHandshake

Accepted SSL Handshakes

count

The number of accepted SSL handshakes.

ActiveConnections

Active Connections

count

The number of active connections from clients to the load balancer.

ActiveSSLConnections

Active SSL Connections

count

The number of active SSL connections.

BytesReceived

Bytes Received

bytes

The number of bytes received by the load balancer.
BytesSent Bytes Sent

bytes

The number of bytes sent by the load balancer.

FailedSSLClientCertVerify

Failed Client SSL Cert Verifications

count

The number of failed client SSL certificate verifications.

FailedSSLHandshake

Failed SSL Handshakes

count

The number of failed SSL handshakes.

HandledConnections

Handled Connections

count

The number of connections handled by the load balancer.

HttpRequests

Inbound Requests

count

The number of incoming client requests to the load balancer.

PeakBandwidth

Peak Bandwidth

bits

Maximum bits per second bandwidth used during the specified interval.

Use the default.

Metrics for the lbComponent Dimension Value "Listener"

Metric

Metric Display Name

Unit

Description

Dimensions

HttpResponses 200

HTTP 200 Responses

count

The number of HTTP 200 responses received from backend sets.

availabilityDomain

lbComponent

lbHostId

listenerName

region

resourceId

HttpResponses 2xx

HTTP 2xx Responses

count

The number of HTTP 2xx responses received from backend sets.

HttpResponses 3xx

HTTP 3xx Responses

count

The number of HTTP 3xx responses received from backend sets.

HttpResponses 4xx

HTTP 4xx Responses

count

The number of HTTP 4xx responses received from backend sets.

HttpResponses 502

HTTP 502 Responses

count

The number of HTTP 502 responses received from backend sets.

HttpResponses 504

HTTP 504 Responses

count

The number of HTTP 504 responses received from backend sets.

HttpResponses 5xx

HTTP 5xx Responses

count

The number of HTTP 5xx responses received from backend sets.

HttpResponses

Responses

count

The number of incoming responses received from backend sets.