- Resource: UptimeCheckConfig
- MonitoredResource
- ResourceGroup
- GroupResourceType
- HttpCheck
- RequestMethod
- BasicAuthentication
- ContentType
- TcpCheck
- ContentMatcher
- ContentMatcherOption
- UptimeCheckRegion
- InternalChecker
- State
- Methods
Resource: UptimeCheckConfig
This message configures which resources and services to monitor for availability.
JSON representation | |
---|---|
{ "name": string, "displayName": string, "period": string, "timeout": string, "contentMatchers": [ { object ( |
Fields | ||
---|---|---|
name |
A unique resource name for this Uptime check configuration. The format is:
This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. |
|
displayName |
A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. |
|
period |
How often, in seconds, the Uptime check is performed. Currently, the only supported values are |
|
timeout |
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. |
|
contentMatchers[] |
The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the |
|
selectedRegions[] |
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. |
|
isInternal |
If this is |
|
internalCheckers[] |
The internal checkers that this check will egress from. If |
|
Union field resource . The resource the check is checking. Required. resource can be only one of the following: |
||
monitoredResource |
The monitored resource associated with the configuration. The following monitored resource types are supported for Uptime checks: |
|
resourceGroup |
The group resource associated with the configuration. |
|
Union field check_request_type . The type of Uptime check request. check_request_type can be only one of the following: |
||
httpCheck |
Contains information needed to make an HTTP or HTTPS check. |
|
tcpCheck |
Contains information needed to make a TCP check. |
MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type
field identifies a MonitoredResourceDescriptor
object that describes the resource's schema. Information in the labels
field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor
for "gce_instance"
has labels "instance_id"
and "zone"
:
{ "type": "gce_instance",
"labels": { "instance_id": "12345678901234",
"zone": "us-central1-a" }}
JSON representation | |
---|---|
{ "type": string, "labels": { string: string, ... } } |
Fields | |
---|---|
type |
Required. The monitored resource type. This field must match the |
labels |
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels An object containing a list of |
ResourceGroup
The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
JSON representation | |
---|---|
{
"groupId": string,
"resourceType": enum ( |
Fields | |
---|---|
groupId |
The group of resources being monitored. Should be only the |
resourceType |
The resource type of the group members. |
GroupResourceType
The supported resource types that can be used as values of group_resource.resource_type
. INSTANCE
includes gce_instance
and aws_ec2_instance
resource types. The resource types gae_app
and uptime_url
are not valid here because group checks on App Engine modules and URLs are not allowed.
Enums | |
---|---|
RESOURCE_TYPE_UNSPECIFIED |
Default value (not valid). |
INSTANCE |
A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS). |
AWS_ELB_LOAD_BALANCER |
A group of Amazon ELB load balancers. |
HttpCheck
Information involved in an HTTP/HTTPS Uptime check request.
JSON representation | |
---|---|
{ "requestMethod": enum ( |
Fields | |
---|---|
requestMethod |
The HTTP request method to use for the check. If set to |
useSsl |
If |
path |
Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the |
port |
Optional (defaults to 80 when |
authInfo |
The authentication information. Optional when creating an HTTP check; defaults to empty. |
maskHeaders |
Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if |
headers |
The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. An object containing a list of |
contentType |
The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the |
validateSsl |
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where |
body |
The request body associated with the HTTP POST request. If A base64-encoded string. |
RequestMethod
The HTTP request method options.
Enums | |
---|---|
METHOD_UNSPECIFIED |
No request method specified. |
GET |
GET request. |
POST |
POST request. |
BasicAuthentication
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication is supported in Uptime checks.
JSON representation | |
---|---|
{ "username": string, "password": string } |
Fields | |
---|---|
username |
The username to use when authenticating with the HTTP server. |
password |
The password to use when authenticating with the HTTP server. |
ContentType
Header options corresponding to the content type of a HTTP request body.
Enums | |
---|---|
TYPE_UNSPECIFIED |
No content type specified. |
URL_ENCODED |
body is in URL-encoded form. Equivalent to setting the Content-Type to application/x-www-form-urlencoded in the HTTP request. |
TcpCheck
Information required for a TCP Uptime check request.
JSON representation | |
---|---|
{ "port": integer } |
Fields | |
---|---|
port |
The TCP port on the server against which to run the check. Will be combined with host (specified within the |
ContentMatcher
Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.
JSON representation | |
---|---|
{
"content": string,
"matcher": enum ( |
Fields | |
---|---|
content |
String or regex content to match. Maximum 1024 bytes. An empty |
matcher |
The type of content matcher that will be applied to the server output, compared to the |
ContentMatcherOption
Options to perform content matching.
Enums | |
---|---|
CONTENT_MATCHER_OPTION_UNSPECIFIED |
No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING . |
CONTAINS_STRING |
Selects substring matching. The match succeeds if the output contains the content string. This is the default value for checks without a matcher option, or where the value of matcher is CONTENT_MATCHER_OPTION_UNSPECIFIED . |
NOT_CONTAINS_STRING |
Selects negation of substring matching. The match succeeds if the output does NOT contain the content string. |
MATCHES_REGEX |
Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the content string. |
NOT_MATCHES_REGEX |
Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string. |
UptimeCheckRegion
The regions from which an Uptime check can be run.
Enums | |
---|---|
REGION_UNSPECIFIED |
Default value if no region is specified. Will result in Uptime checks running from all regions. |
USA |
Allows checks to run from locations within the United States of America. |
EUROPE |
Allows checks to run from locations within the continent of Europe. |
SOUTH_AMERICA |
Allows checks to run from locations within the continent of South America. |
ASIA_PACIFIC |
Allows checks to run from locations within the Asia Pacific area (ex: Singapore). |
InternalChecker
An internal checker allows Uptime checks to run on private/internal GCP resources.
JSON representation | |
---|---|
{
"name": string,
"displayName": string,
"network": string,
"gcpZone": string,
"peerProjectId": string,
"state": enum ( |
Fields | |
---|---|
name |
A unique resource name for this InternalChecker. The format is:
|
displayName |
The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. |
network |
The GCP VPC network where the internal resource lives (ex: "default"). |
gcpZone |
The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. |
peerProjectId |
The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project. |
state |
The current operational state of the internal checker. |
State
Operational states for an internal checker.
Enums | |
---|---|
UNSPECIFIED |
An internal checker should never be in the unspecified state. |
CREATING |
The checker is being created, provisioned, and configured. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker , as well as by examining the long running Operation that created it. |
RUNNING |
The checker is running and available for use. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker as well as by examining the long running Operation that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state. |
Methods |
|
---|---|
|
Creates a new Uptime check configuration. |
|
Deletes an Uptime check configuration. |
|
Gets a single Uptime check configuration. |
|
Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). |
|
Updates an Uptime check configuration. |