Load Balancing Metrics
You can monitor the health, capacity, and performance of your load balancers by using metrics , alarms , and notifications.
This topic describes the metrics emitted by the Load Balancing service in the oci_lbaas
metric namespace.
Resources: Load balancers, listeners, and backend sets.
Overview of the Load Balancing Service Metrics
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 Balancing for a high-level view of a simple public load balancing system configuration.
The Load Balancing 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 click Metrics. You also can use the Monitoring service to create custom queries.
Prerequisites
- IAM policies: 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.
-
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
- 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.
- 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. |
|
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. |
|
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. |
Metrics for the lbComponent Dimension Value "Listener"
Metric | Metric Display Name | Unit | Description | Dimensions |
---|---|---|---|---|
HttpResponses200
|
HTTP 200 Responses |
count |
The number of HTTP 200 responses received from backend sets. |
|
HttpResponses2xx
|
HTTP 2xx Responses |
count |
The number of HTTP 2xx responses received from backend sets. |
|
HttpResponses3xx
|
HTTP 3xx Responses |
count |
The number of HTTP 3xx responses received from backend sets. |
|
HttpResponses4xx
|
HTTP 4xx Responses |
count |
The number of HTTP 4xx responses received from backend sets. |
|
HttpResponses502
|
HTTP 502 Responses |
count |
The number of HTTP 502 responses received from backend sets. |
|
HttpResponses504
|
HTTP 504 Responses |
count |
The number of HTTP 504 responses received from backend sets. |
|
HttpResponses5xx
|
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. |
Using the Console
-
Open the navigation menu. Under the Core Infrastructure group, go to Networking and click Load Balancers.
- Choose the Compartment that contains the load balancer you want to view, and then click the load balancer's name.
-
In the Resources menu, click Metrics (if necessary).
The Metrics page displays a default set of charts for the current load balancer.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
- Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
-
For Metric Namespace, select oci_lbaas.
The Service Metrics page displays a default set of charts for the selected metric namespace. For more information about the emitted metrics, see the foregoing table. You can also use the Monitoringservice to create custom queries.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
Using the API
Use the following APIs for monitoring:
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)