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 App Engine

Monitor Google Cloud App Engine Web and Compute Hosting Platform

📘

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 following permissions are required:

📘

Deploying the 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
- appengine.applications.get
- appengine.instances.get
- appengine.instances.list
- appengine.operations.get
- appengine.operations.list
- appengine.services.get
- appengine.services.list
- appengine.versions.get
- appengine.versions.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.
Connection TimeoutThe number of seconds to allow for connecting to the target.

Metrics

App

NameDescription
Auth DomainGoogle Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account.
Checks Content Mismatch (%)Ratio of responses that had content that did not match the check.
Checks Passed (%)Ratio of checks passed.
Code BucketGoogle Cloud Storage bucket that can be used for storing files associated with this application.
CPU MegacyclesCPU usage in megacycles.
CPU Utilization (%)The allocated CPU in use across an App Engine flexible environment version. Note that some machine types allow bursting above 100%.
Default BucketGoogle Cloud Storage bucket that can be used by this application to store content.
Default Cookie Expiration (Seconds)Cookie expiration policy for this application.
Default HostnameHostname used to reach this application, as resolved by App Engine.
Delta of Serve Style ResponseDelta count of responses on the HTTP serve style.
Disk Data Read (Bytes per Second)Rate of data read from disk across an App Engine flexible environment version.
Disk Data Written (Bytes per Second)Rate of data written from disk across an App Engine flexible environment version.
EnabledWhether the serving infrastructure will authenticate and authorize all incoming requests.
GCR DomainThe Google Container Registry domain used for storing managed build docker images for this application.
Instance CountNumber of instances that exist.
Interception CountDelta count of interceptions performed to prevent DoS attacks.
Location IDLocation from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored. Defaults to us-central.
Memcache OperationsCount of memcache key operations, grouped by command and status.
Memcache Received Data (Bytes)Amount of data received by app from the memcache API.
Memcache Sent Data (Bytes)Amount of data sent by app through the memcache API, grouped by memcache command.
Memcache UtilizationMemcache utilization in one hundredth of Memcache Compute Unit.
Memory Usage (Bytes)Total memory used by running instances.
Network Data Received (Bytes per Second)Rate of incoming network data across all VMs in an App Engine flexible environment version.
Network Data Sent (Bytes per Second)Rate of outgoing network data across all VMs in an App Engine flexible environment version.
Oauth2 Client IDOAuth2 client ID to use for the authentication flow.
Oauth2 Client SecretOAuth2 client secret to use for the authentication flow.
Oauth2 Client Secret Sha256Hex-encoded SHA-256 hash of the client secret.
Project IDThe identifier of the GCP project associated with this resource.
Quota Denial CountDelta count of requests that failed due to the app being over quota.
Received Data (Bytes)Delta count of incoming network bandwidth.
Reserved CPU (Cores)Total amount of CPU allocated to an App Engine flexible environment version.
Response CountDelta HTTP response count.
Response Latency (Milliseconds)HTTP response latency.
Sent Data (Bytes)Delta count of outgoing network bandwidth.
Serving StatusServing status of this application.
Split Health ChecksIndicates if split health checks should be used instead of the legacy health checks.

Authorized Certificates

NameDescription
Certificate Raw Data Private KeyUnencrypted PEM encoded RSA private key.
Certificate Raw Data Public CertificatePEM encoded x.509 public key certificate.
Display NameThe user-specified display name of the certificate.
Domain Mappings CountAggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions. Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.
Domain NamesTopmost applicable domains of this certificate. This certificate applies to these domains and their subdomains.
Expire TimeThe time when this certificate expires.
IDUnique name of the certificate.
NameFull path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.
Project IDThe project ID in which this resource was created.
Visible Domain MappingsThe full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com. This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domainMappingsCount for a complete count.

Authorized Domains

NameDescription
IDFully qualified domain name of the domain authorized for use.
NameFull path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.

Domain Mapping

NameDescription
IDRelative name of the domain serving the application. Example: example.com.
NameFull path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
Project IDThe project ID in which this resource was created.
Resource Records DataData for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Resource Records NameRelative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
Resource Records TypeResource record type.
SSL Settings Certificate IDID of the AuthorizedCertificate resource configuring SSL for the application.

Firewall Ingress Rules

NameDescription
ActionThe action to take on matched requests.
DescriptionA Description of this rule.
PriorityA positive integer between [1, Int32.MaxValue-1] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first. A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches.
Project IDThe project ID in which this resource was created.
Source RangeIP address or range, defined using CIDR notation, of requests that this rule applies to.

Instance

NameDescription
App Engine ReleaseApp Engine release this instance is running on.
AvailabilityAvailability of the instance.
Average Latency (Milliseconds)Average latency over the last minute.
Errors (Errors)Number of errors since this instance was started.
IDRelative name of the instance within the version. Example: instance-1.
Memory Usage (Bytes)Total memory in use.
NameFull path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
Project IDThe project ID in which this resource was created.
Query Rate (per Second)Average rate of queries over the last minute.
Requests (Requests)Number of requests since this instance was started.
Start TimeTime that this instance was started.
VM Debug EnabledWhether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
VM IDVirtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
VM IPThe IP address of this instance. Only applicable for instances in App Engine flexible environment.
VM NameName of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
VM StatusStatus of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
VM Zone NameZone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.

Service

NameDescription
Checks Content Mismatch (%)Ratio of responses that had content that did not match the check.
Checks Passed (%)Ratio of checks passed.
CPU MegacyclesCPU usage in megacycles.
CPU Utilization (%)The amount of allocated CPU in use across an App Engine flexible environment version. Note that some machine types allow bursting above 100%.
Delta of Serve Style Response (per Second)Delta counts on the HTTP serve style.
Disk Data Read (Bytes per Second)Rate of data read from disk across an App Engine flexible environment version.
Disk Data Written (Bytes per Second)Rate of data written from disk across an App Engine flexible environment version.
Instance CountNumber of instances that exist.
Interception CountDelta count of interceptions performed to prevent DoS attacks.
Memcache OperationsCount of memcache key operations, grouped by command and status.
Memcache Received Data (Bytes)Amount of data received by app from the memcache API.
Memcache Sent Data (Bytes)Amount of data sent by app through the memcache API, grouped by memcache command.
Memcache UtilizationMemcache utilization in one hundredth of Memcache Compute Unit.
Memory Usage (Bytes)Total memory used by running instances.
Module IDThe service/module name.
Network Data Received (Bytes per Second)Rate of incoming network data across all VMs in an App Engine flexible environment version.
Network Data Sent (Bytes per Second)Rate of outgoing network data across all VMs in an App Engine flexible environment version.
Project IDThe identifier of the GCP project associated with this resource.
Quota Denial CountDelta count of requests that failed due to the app being over quota.
Received Data (Bytes)Delta count of incoming network bandwidth.
Reserved CPU (Cores)Total amount of CPU allocated to an App Engine flexible environment version.
Response CountDelta HTTP response count.
Response Latency (Milliseconds)HTTP response latency.
Sent Data (Bytes)Delta count of outgoing network bandwidth.
Split AllocationsMapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
Split Shard ByMechanism used to determine which version a request is sent to when routing configuration for versions within a single service.

Usage

NameDescription
Average Request RetriesThe average number of retry requests per unique requests made.
Average Retry AttemptsThe average number of retry requests made per unique request that was retried.
Failed RequestsThe total number of requests that returned a failure response.
HostnameThe name of the host that this counter is tracking the usage of.
Most RetriesThe highest number of retries made for a single request.
Request TimeoutsThe total number of requests that timed out waiting for a response.
Requests RetriedThe number of unique requests that were retried.
Retry TimeoutsThe total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.
Average Retry Wait (Milliseconds)The average amount of time retried requests spent waiting.
Maximum Retry Wait (Milliseconds)The most amount of time a retried request spent waiting.
Minimum Retry Wait (Milliseconds)The least amount of time a retried request spent waiting.
Status OK ResponsesThe total number of successful requests that responded with the status OK (200).
Other Status ResponsesThe total number of successful requests that responded with some other accepted status.
Status Too Many Requests ResponsesThe total number of successful requests that responded with the status TOO MANY REQUESTS (429).
Successful RequestsThe total number of requests that returned a successful response.
Total RequestsThe total number of requests made during collection.
Total RetriesThe total number of retry requests that were made.
Unique RequestsThe number of requests made with unique endpoints.

Version

NameDescription
API Configuration Auth Fail ActionAction to take when users access resources that require authentication. Defaults to redirect.
API Configuration LoginLevel of login required to access this resource. Defaults to optional.
API Configuration ScriptPath to the script from the application root directory.
API Configuration Security LevelSecurity (HTTPS) enforcement for this URL.
API Configuration UrlURL to serve the endpoint at.
Automatic Scaling Cool Down Period (Seconds)Amount of time that the Autoscaler should wait between changes to the number of virtual machines.
Automatic Scaling Cpu Utilization Aggregation Window Length (Seconds)Period of time over which CPU utilization is calculated.
Automatic Scaling Cpu Utilization Target UtilizationTarget CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
Automatic Scaling Disk Utilization Target Read Data Rate (Bytes per Second)Target rate for data read.
Automatic Scaling Disk Utilization Target Read Operations Rate (per Second)Target rate for read operations.
Automatic Scaling Disk Utilization Target Write Data Rate (Bytes per Second)Target rate for data written.
Automatic Scaling Disk Utilization Target Write Operations Rate (per Second)Target rate for write operations.
Automatic Scaling Maximum Concurrent Requests (Requests)Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.
Automatic Scaling Maximum Idle Instances (Requests)Maximum number of idle instances that should be maintained for this version.
Automatic Scaling Maximum Pending Latency (Seconds)Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
Automatic Scaling Maximum Total InstancesMaximum number of instances that should be started to handle requests for this version.
Automatic Scaling Minimum Idle InstancesMinimum number of idle instances that should be maintained for this version.
Automatic Scaling Minimum Pending Latency (Seconds)Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
Automatic Scaling Minimum Total InstancesMinimum number of running instances that should be maintained for this version.
Automatic Scaling Network Utilization Target Received Data Rate (Bytes per Second)Target rate for data received.
Automatic Scaling Network Utilization Target Received Packets Rate (Packets per Second)Target rate for packets received.
Automatic Scaling Network Utilization Target Sent Data Rate (Bytes per Second)Target rate for data sent.
Automatic Scaling Network Utilization Target Sent Packets Rate (Packets per Second)Target rate for packets sent.
Automatic Scaling Request Utilization Target Concurrent Requests (Requests)Target number of concurrent requests.
Automatic Scaling Request Utilization Target Request Count Rate (Requests per Second)Target request rate.
Automatic Scaling Standard Scheduler Settings Maximum InstancesMaximum number of instances to run for this version.
Automatic Scaling Standard Scheduler Settings Minimum InstancesMinimum number of instances to run for this version.
Automatic Scaling Standard Scheduler Settings Target Cpu UtilizationTarget CPU utilization ratio to maintain when scaling.
Automatic Scaling Standard Scheduler Settings Target Throughput UtilizationTarget throughput utilization ratio to maintain when scaling.
Basic Scaling Idle Timeout (Seconds)Duration of time after the last request that an instance must wait before the instance is shut down.
Basic Scaling Maximum InstancesMaximum number of instances to create for this version.
Beta SettingsMetadata settings that are supplied to this version to enable beta runtime features.
Checks Content Mismatch (%)Ratio of responses that had content that did not match the check.
Checks Passed (%)Ratio of checks passed.
CPU MegacyclesCPU usage in megacycles.
CPU Utilization (%)The amount of allocated CPU in use across an App Engine flexible environment version. Note that some machine types allow bursting above 100%.
Create TimeTime that this version was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
Created ByEmail address of the user who created this version.
Default Expiration (Seconds)Duration that static files should be cached by web proxies and browsers.
Delta of Serve Style ResponseDelta count of responses on the HTTP serve style.
Deployment Cloud Build Options App Yaml PathPath to the yaml file used in deployment, used to determine runtime configuration details.
Deployment Cloud Build Options Cloud Build TimeoutThe Cloud Build timeout used as part of any dependent builds performed by version creation.
Deployment Container ImageURI to the hosted container image in Google Container Registry.
Deployment Zip Files CountAn estimate of the number of files in a zip for a zip deployment.
Deployment Zip Source UrlURL of the zip file to deploy from.
Disk Data Read (Bytes per Second)Rate of data read from disk across an App Engine flexible environment version.
Disk Data Written (Bytes per Second)Rate of data written from disk across an App Engine flexible environment version.
Disk UsageTotal size of all the files that are included in this version and currently hosted on the App Engine disk.
Endpoints Api Service Configuration IDEndpoints service configuration ID as specified by the Service Management API.
Endpoints Api Service NameEndpoints service name which is the name of the "service" resource in the Service Management API.
EnvApp Engine execution environment for this version. Defaults to standard.
Env VariablesEnvironment variables available to the application.
Health Check Check Interval (Seconds)Interval between health checks.
Health Check Disable Health CheckWhether to explicitly disable health checks for this instance.
Health Check Healthy ThresholdNumber of consecutive successful health checks required before receiving traffic.
Health Check HostHost header to send when performing an HTTP health check. Example: "myapp.appspot.com"
Health Check Restart ThresholdNumber of consecutive failed health checks required before an instance is restarted.
Health Check Timeout (Seconds)Time before the health check is considered failed.
Health Check Unhealthy ThresholdNumber of consecutive failed health checks required before removing traffic.
IDThe version name.
Inbound ServicesBefore an application can receive email or XMPP messages, the application must be configured to enable the service.
Instance ClassInstance class that is used to run this version. Valid values are: - AutomaticScaling: F1, F2, F4, F4_1G - ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1G - Defaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
Instance CountNumber of instances that exist.
Interception CountDelta count of interceptions performed to prevent DoS attacks.
Liveness Check Check Interval (Seconds)Interval between health checks.
Liveness Check Failure ThresholdNumber of consecutive failed checks required before considering the VM unhealthy.
Liveness Check HostHost header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
Liveness Check Initial Delay (Seconds)The initial delay before starting to execute the checks.
Liveness Check PathThe request path.
Liveness Check Success ThresholdNumber of consecutive successful checks required before considering the VM healthy.
Liveness Check Timeout (Seconds)Time before the check is considered failed.
Manual Scaling InstancesNumber of instances to assign to the service at the start.
Memcache OperationsCount of memcache key operations, grouped by command and status.
Memcache Received Data (Bytes)Amount of data received by app from the memcache API.
Memcache Sent Data (Bytes)Amount of data sent by app through the memcache API, grouped by memcache command.
Memcache UtilizationMemcache utilization in one hundredth of Memcache Compute Unit.
Memory Usage (Bytes)Total memory used by running instances.
Module IDThe service/module name.
Network Data Received (Bytes per Second)Rate of incoming network data across all VMs in an App Engine flexible environment version.
Network Data Sent (Bytes per Second)Rate of outgoing network data across all VMs in an App Engine flexible environment version.
Network Forwarded PortsList of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
Network Instance TagTag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
Network NameGoogle Compute Engine network where the virtual machines are created.
Network Subnetwork NameGoogle Cloud Platform sub-network where the virtual machines are created.
Nobuild Files RegexFiles that match this pattern will not be built into this version.
Project IDThe identifier of the GCP project associated with this resource.
Quota Denial CountDelta count of requests that failed due to the app being over quota.
Readiness Check App Start Timeout (Seconds)A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
Readiness Check Check Interval (Seconds)Interval between health checks.
Readiness Check Failure ThresholdNumber of consecutive failed checks required before removing traffic.
Readiness Check HostHost header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
Readiness Check PathThe request path.
Readiness Check Success ThresholdNumber of consecutive successful checks required before receiving traffic.
Readiness Check Timeout (Seconds)Time before the check is considered failed.
Received Data (Bytes)Delta count of incoming network bandwidth.
Reserved CPUTotal amount of CPU allocated to an App Engine flexible environment version.
Resources CpuCPU needed.
Resources Disk (Gigabits)Disk size needed.
Resources Memory (Gigabits)Memory needed.
Response CountDelta HTTP response count.
Response Latency (Milliseconds)HTTP response latency.
RuntimeDesired runtime. Example: python27.
Runtime API VersionThe version of the API in the given runtime environment.
Runtime ChannelThe channel of the runtime to use. Defaults to the default channel.
Sent Data (Bytes)Delta count of outgoing network bandwidth.
Serving StatusCurrent serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
ThreadsafeWhether multiple requests can be dispatched to this version at once.
UrlServing URL for this version.
VMWhether to deploy this version in a container on a virtual machine.
ZonesThe Google Compute Engine zones that are supported by this version in the App Engine flexible environment.

Updated 8 months ago

Google Cloud App Engine


Monitor Google Cloud App Engine Web and Compute Hosting Platform

Suggested Edits are limited on API Reference Pages

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