Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Google Cloud Load Balancing

Monitor Google Cloud Scalable Load Balancing Service

📘

Not Included in the BindPlane with Google Stackdriver offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Stackdriver offering.

For more information on how to use the below LPU and other Google Cloud Data Collection setup. See the Google Cloud Platform Sources

Least Privileged User

A user role with the at least the following permissions is required:

📘

Deploying a Least Privileged User

To learn more about how to deploy a role with these permissions to a GCP Organization, or a GCP Project, please refer to this documentation:
Deploy an Individual LPU role to a GCP Project, or GCP Organization

- cloudnotifications.activities.list
- monitoring.alertPolicies.get
- monitoring.alertPolicies.list
- monitoring.dashboards.get
- monitoring.dashboards.list
- monitoring.groups.get
- monitoring.groups.list
- monitoring.metricDescriptors.get
- monitoring.metricDescriptors.list
- monitoring.monitoredResourceDescriptors.get
- monitoring.monitoredResourceDescriptors.list
- monitoring.notificationChannelDescriptors.get
- monitoring.notificationChannelDescriptors.list
- monitoring.notificationChannels.get
- monitoring.notificationChannels.list
- monitoring.publicWidgets.get
- monitoring.publicWidgets.list
- monitoring.timeSeries.list
- monitoring.uptimeCheckConfigs.get
- monitoring.uptimeCheckConfigs.list
- resourcemanager.projects.get
- resourcemanager.projects.list
- stackdriver.projects.get
- compute.addresses.get
- compute.addresses.list
- compute.backendBuckets.get
- compute.backendBuckets.list
- compute.backendServices.get
- compute.backendServices.list
- compute.firewalls.get
- compute.firewalls.list
- compute.forwardingRules.get
- compute.forwardingRules.list
- compute.globalAddresses.get
- compute.globalAddresses.list
- compute.globalForwardingRules.get
- compute.globalForwardingRules.list
- compute.healthChecks.get
- compute.healthChecks.list
- compute.httpHealthChecks.get
- compute.httpHealthChecks.list
- compute.httpsHealthChecks.get
- compute.httpsHealthChecks.list
- compute.instanceGroups.get
- compute.instanceGroups.list
- compute.instances.get
- compute.instances.getGuestAttributes
- compute.instances.getSerialPortOutput
- compute.instances.list
- compute.instances.listReferrers
- compute.interconnectAttachments.get
- compute.interconnectAttachments.list
- compute.interconnectLocations.get
- compute.interconnectLocations.list
- compute.interconnects.get
- compute.interconnects.list
- compute.networks.get
- compute.networks.list
- compute.projects.get
- compute.regionBackendServices.get
- compute.regionBackendServices.list
- compute.regions.get
- compute.regions.list
- compute.routers.get
- compute.routers.list
- compute.routes.get
- compute.routes.list
- compute.sslCertificates.get
- compute.sslCertificates.list
- compute.sslPolicies.get
- compute.sslPolicies.list
- compute.sslPolicies.listAvailableFeatures
- compute.subnetworks.get
- compute.subnetworks.list
- compute.targetHttpProxies.get
- compute.targetHttpProxies.list
- compute.targetHttpsProxies.get
- compute.targetHttpsProxies.list
- compute.targetInstances.get
- compute.targetInstances.list
- compute.targetPools.get
- compute.targetPools.list
- compute.targetSslProxies.get
- compute.targetSslProxies.list
- compute.targetTcpProxies.get
- compute.targetTcpProxies.list
- compute.targetVpnGateways.get
- compute.targetVpnGateways.list
- compute.urlMaps.get
- compute.urlMaps.list
- compute.vpnTunnels.get
- compute.vpnTunnels.list
- compute.zones.get
- compute.zones.list
- serviceusage.quotas.get
- serviceusage.services.get
- serviceusage.services.list

Connection Parameters

NameRequired?Description
Private Key JSONRequiredThe contents of the private key JSON file created when setting up a service account.
Metric CollectionControls which metrics get requested from GCP's Stackdriver API.
ProjectsRequiredA comma separated whitelist of project IDs. If the wildcard "*" is used, resources will be collected from all available projects.
Regional CollectionDetermines if regional Forwarding Rules & Backend Services will be collected (in addition to global ones).
RegionsRequiredA comma separated whitelist of regions. At least one region must be specified.
Connection TimeoutThe number of seconds to allow for connecting to the target.

Metrics

Backend Bucket

NameDescription
Backend Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Backend Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Backend Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Backend Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
Bucket NameCloud Storage bucket name.
CDN Policy Signed URL Cache Maximum Age (Seconds)Maximum time the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
CDN Policy Signed URL Key NamesNames of the keys for signing request URLs.
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional textual description of the resource; provided by the client when the resource is created.
Enable CDNIf true, enable Cloud CDN for this BackendBucket.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IDThe unique identifier for the resource. This identifier is defined by the server.
NameThe name of the backend target.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
Self LinkServer-defined URL for the resource.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Backend Service

NameDescription
Affinity Cookie TTL (Seconds)Lifetime of cookies if sessionAffinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
Backend Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Backend Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Backend Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Backend Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
CDN Policy Cache Key Policy Include HostIf true, requests to different hosts will be cached separately.
CDN Policy Cache Key Policy Include ProtocolIf true, http and https requests will be cached separately.
CDN Policy Cache Key Policy Include Query StringIf true, include query string parameters in the cache key according to queryStringWhitelist and queryStringBlacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.
CDN Policy Cache Key Policy Query String BlacklistNames of query string parameters to exclude in cache keys. All other parameters will be included. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
CDN Policy Cache Key Policy Query String WhitelistNames of query string parameters to include in cache keys. All other parameters will be excluded. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.
CDN Policy Signed URL Cache Maximum Age (Seconds)Maximum time the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
CDN Policy Signed URL Key NamesNames of the keys for signing request URLs.
Closed Connections (Connections)Number of connections that were terminated over TCP/SSL proxy.
Connection Draining Draining Timeout (Seconds)Time for which instance will be drained (not accept new connections, but still work to finish started).
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Egress Data (Bytes per Second)Amount of data sent from VM to client using proxy.
Enable CDNIf true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used.
FingerprintFingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.
Health ChecksThe list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead.
HTTPS Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IAP EnabledWhether IAP is enabled.
IAP OAuth2 Client IDThe IAP OAuth2 Client ID.
IAP OAuth2 Client SecretThe IAP OAuth2 Client Secret.
IAP OAuth2 Client Secret SHA256SHA256 hash value for the field oauth2ClientSecret above.
IDThe unique identifier for the resource. This identifier is defined by the server.
Ingress Data (Bytes per Second)Amount of data sent from client to VM using proxy.
Internal Egress Data (Bytes per Second)The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).
Internal Egress Packets (Packets per Second)The number of packets sent from ILB backend to client of the flow.
Internal Ingress Data (Bytes per Second)The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).
Internal Ingress Packets (Packets per Second)The number of packets sent from client to ILB backend.
Internal RTT Latencies (Milliseconds)A distribution of RTT measured over TCP connections for ILB flows.
Load Balancing SchemeIndicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
NameThe name of the backend target.
New Connections Opened (Connections)Number of connections that were created over TCP/SSL proxy.
Open Connections (Connections)Current number of outstanding connections through the TCP/SSL proxy.
Port NameName of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
ProtocolThe protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
RegionThe region of the backend.
Self LinkServer-defined URL for the resource.
Session AffinityType of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used.
Timeout (Seconds)How much time to wait for the backend before considering it a failed request.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Backend Service Backend

NameDescription
Backend Target NameThe name of the backend target.
Balancing ModeSpecifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION.
Capacity Scaler (%)A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). This cannot be used for internal load balancing.
Closed Connections (Connections)Number of connections that were terminated over TCP/SSL proxy.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Egress Data (Bytes per Second)Amount of data sent from VM to client using proxy.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.
HTTPS Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IDThe unique identifier for the resource. This identifier is defined by the server.
Ingress Data (Bytes per Second)Amount of data sent from client to VM using proxy.
Internal Egress Data (Bytes per Second)The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).
Internal Egress Packets (Packets per Second)The number of packets sent from ILB backend to client of the flow.
Internal Ingress Data (Bytes per Second)The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).
Internal Ingress Packets (Packets per Second)The number of packets sent from client to ILB backend.
Internal RTT Latencies (Milliseconds)A distribution of RTT measured over TCP connections for ILB flows.
Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Maximum Connections (Connections)The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.
Maximum Connections Per Instance (Connections)The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.
Maximum Rate (Requests per Second)The max request rate of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.
Maximum Rate Per Instance (Requests per Second)The max request rate that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.
Maximum Utilization (%)This defines the CPU utilization target for the group. Used when balancingMode is UTILIZATION. This cannot be used for internal load balancing.
NameThe name of the backend group that handled the connection.
New Connections Opened (Connections)Number of connections that were created over TCP/SSL proxy.
Open Connections (Connections)Current number of outstanding connections through the TCP/SSL proxy.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
RegionThe region of the backend.
Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Forwarding Rule

NameDescription
Backend Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Backend Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Backend Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Backend Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
Backend ServiceThis field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
Closed Connections (Connections)Number of connections that were terminated over TCP/SSL proxy.
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Egress Data (Bytes per Second)Amount of data sent from VM to client using proxy.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.
HTTPS Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IDThe unique identifier for the resource. This identifier is defined by the server.
Ingress Data (Bytes per Second)Amount of data sent from client to VM using proxy.
Internal Egress Data (Bytes per Second)The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).
Internal Egress Packets (Packets per Second)The number of packets sent from ILB backend to client of the flow.
Internal Ingress Data (Bytes per Second)The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).
Internal Ingress Packets (Packets per Second)The number of packets sent from client to ILB backend.
Internal RTT Latencies (Milliseconds)A distribution of RTT measured over TCP connections for ILB flows.
IP AddressThe IP address that this forwarding rule is serving on behalf of.
IP ProtocolThe IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.
IP VersionThe IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.
Load Balancing SchemeThis signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy).
NameThe name of the forwarding rule.
NetworkIdentifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
Network TierThis signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
New Connections Opened (Connections)Number of connections that were created over TCP/SSL proxy.
Open Connections (Connections)Current number of outstanding connections through the TCP/SSL proxy.
Port RangeThis field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
PortsThis field is used along with the backendService field for internal load balancing.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
RegionThe region on which the forwarding rule is applied, such as 'global' or 'us-central1'. Various other objects are defined per that locality.
Self LinkServer-defined URL for the resource.
SubnetworkIdentifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. This field is only used for INTERNAL load balancing.
TargetThe URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED" load balancing, only HTTP and HTTPS targets are valid.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Health Check

NameDescription
Check Interval (Seconds)How often to send a health check.
Creation TimestampCreation timestamp in 3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Healthy ThresholdA so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Http Health Check HostThe value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
Http Health Check PortThe TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Http Health Check Port NamePort name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
Http Health Check Proxy HeaderSpecifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Http Health Check Request PathThe request path of the HTTP health check request. The default value is /.
Https Health Check HostThe value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
Https Health Check PortThe TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Https Health Check Port NamePort name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
Https Health Check Proxy HeaderSpecifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Https Health Check Request PathThe request path of the HTTPS health check request. The default value is /.
IDThe unique identifier for the resource. This identifier is defined by the server.
NameName of the resource.
Project IDThe project ID in which this resource was created.
Self LinkServer-defined URL for the resource.
SSL Health Check PortThe TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
SSL Health Check Port NamePort name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
SSL Health Check Proxy HeaderSpecifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
SSL Health Check RequestThe application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
SSL Health Check ResponseThe data to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
TCP Health Check PortThe TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
TCP Health Check Port NamePort name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.
TCP Health Check Proxy HeaderSpecifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
TCP Health Check RequestThe application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
TCP Health Check ResponseThe data to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
Timeout (Seconds)How long to wait before claiming failure.
TypeSpecifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Unhealthy ThresholdA so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HTTP Health Check

NameDescription
Check Interval (Seconds)How often to send a health check.
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Healthy ThresholdA so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
HostThe value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
IDThe unique identifier for the resource. This identifier is defined by the server.
NameName of the resource.
PortThe TCP port number for the HTTP health check request. The default value is 80.
Project IDThe project ID in which this resource was created.
Request PathThe request path of the HTTP health check request. The default value is /.
Self LinkServer-defined URL for the resource.
Timeout (Seconds)How long to wait before claiming failure.
Unhealthy ThresholdA so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HTTPS Health Check

NameDescription
Check Interval (Seconds)How often to send a health check.
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Healthy ThresholdA so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
HostThe value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
IDThe unique identifier for the resource. This identifier is defined by the server.
NameName of the resource.
PortThe TCP port number for the HTTPS health check request. The default value is 443.
Project IDThe project ID in which this resource was created.
Request PathThe request path of the HTTPS health check request. The default value is "/".
Self LinkServer-defined URL for the resource.
Timeout (Seconds)How long to wait before claiming failure.
Unhealthy ThresholdA so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Load Balancer

NameDescription
Egress Data (Bytes per Second)The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).
Egress Packets (Packets per Second)The number of packets sent from ILB backend to client of the flow.
Ingress Data (Bytes per Second)The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).
Ingress Packets (Packets per Second)The number of packets sent from client to ILB backend.
NameThe name of the load balancer.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
RTT Latencies (Milliseconds)A distribution of RTT measured over TCP connections for ILB flows.

Target Pool

NameDescription
Backup PoolThis field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Failover RatioThis field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
Health ChecksThe URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
IDThe unique identifier for the resource. This identifier is defined by the server.
InstancesA list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
NameName of the resource.
Project IDThe project ID in which this resource was created.
RegionThe region in which this resource is located.
Self LinkServer-defined URL for the resource.
Session AffinitySesssion affinity option.

Target Proxy

NameDescription
Backend Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Backend Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Backend Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Backend Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
Closed Connections (Connections)Number of connections that were terminated over TCP/SSL proxy.
Creation TimestampCreation timestamp in RFC3339 text format.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
Egress Data (Bytes per Second)Amount of data sent from VM to client using proxy.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.
HTTPS Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IDThe unique identifier for the resource. This identifier is defined by the server.
Ingress Data (Bytes per Second)Amount of data sent from client to VM using proxy.
NameThe name of the target proxy.
New Connections Opened (Connections)Number of connections that were created over TCP/SSL proxy.
Open Connections (Connections)Current number of outstanding connections through the TCP/SSL proxy.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
Proxy HeaderSpecifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
QUIC OverrideSpecifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.
Self LinkServer-defined URL for the resource.
ServiceURL to the BackendService resource.
SSL CertificatesURLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
SSL PolicyURL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.
TypeThe type of Target Proxy (HTTP, HTTPS, TCP, SSL).
URL MapA fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService.

URL Map

NameDescription
Backend Latency (Milliseconds)A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.
Backend Request Count (Requests per Second)The number of requests served by backends of HTTP/S load balancer.
Backend Request Data (Bytes per Second)The amount of data sent as requests from HTTP/S load balancer to backends.
Backend Response Data (Bytes per Second)The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.
Creation TimestampCreation timestamp in RFC3339 text format.
Default ServiceThe URL of the BackendService resource if none of the hostRules match.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
FingerprintFingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
Frontend Request Count (Requests per Second)The number of requests served by HTTP/S load balancer.
Frontend Request Data (Bytes per Second)The amount of data sent as requests from clients to HTTP/S load balancer.
Frontend Response Data (Bytes per Second)The amount of data sent as responses from HTTP/S load balancer to clients.
Frontend RTT (Milliseconds)A distribution of the RTT measured for each connection between client and proxy.
IDThe unique identifier for the resource. This identifier is defined by the server.
NameThe name of the URL Map.
Project IDThe identifier of the GCP project associated with this resource, such as "my-project".
Self LinkServer-defined URL for the resource.
Total Latency (Milliseconds)A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

URL Map Host Rule

NameDescription
DescriptionAn optional description of this resource. Provide this property when you create the resource.
HostsThe list of host patterns to match. They must be valid hostnames, except will match any string of ([a-z0-9-.]). In that case, * must be the first character and must be followed in the pattern by either - or ..
Path MatcherThe name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Project IDThe project ID in which this resource was created.
URL Map NameName of the URL Map.

URL Map Path Matchers

NameDescription
Default ServiceThe full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion.
DescriptionAn optional description of this resource. Provide this property when you create the resource.
NameThe name to which this PathMatcher is referred by the HostRule.
Path Rules ServiceThe URL of the BackendService resource if this rule is matched.
Project IDThe project ID in which this resource was created.
URL Map NameName of the URL Map.

URL Map Test

NameDescription
DescriptionDescription of this test case.
HostHost portion of the URL.
PathPath portion of the URL.
Project IDThe project ID in which this resource was created.
ServiceExpected BackendService resource the given URL should be mapped to.
URL Map NameName of the URL Map.

Updated 8 months ago

Google Cloud Load Balancing


Monitor Google Cloud Scalable Load Balancing Service

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.