UptimeCheckConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)This message configures which resources and services to monitor for availability.
Attributes | |
|---|---|
| Name | Description |
name |
str
A unique resource name for this Uptime check configuration. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project
associated with the Uptime check.
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.
|
display_name |
str
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. |
monitored_resource |
google.api.monitored_resource_pb2.MonitoredResource
The `monitored resource |
resource_group |
google.cloud.monitoring_v3.types.UptimeCheckConfig.ResourceGroup
The group resource associated with the configuration. |
http_check |
google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck
Contains information needed to make an HTTP or HTTPS check. |
tcp_check |
google.cloud.monitoring_v3.types.UptimeCheckConfig.TcpCheck
Contains information needed to make a TCP check. |
period |
google.protobuf.duration_pb2.Duration
How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute),
300s (5 minutes), 600s (10 minutes), and 900s
(15 minutes). Optional, defaults to 60s.
|
timeout |
google.protobuf.duration_pb2.Duration
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. |
content_matchers |
Sequence[google.cloud.monitoring_v3.types.UptimeCheckConfig.ContentMatcher]
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 content_matchers
list is supported, and additional entries will be ignored.
This field is optional and should only be specified if a
content match is required as part of the/ Uptime check.
|
selected_regions |
Sequence[google.cloud.monitoring_v3.types.UptimeCheckRegion]
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. |
is_internal |
bool
If this is true, then checks are made only from the
'internal_checkers'. If it is false, then checks are
made only from the 'selected_regions'. It is an error to
provide 'selected_regions' when is_internal is true, or
to provide 'internal_checkers' when is_internal is
false.
|
internal_checkers |
Sequence[google.cloud.monitoring_v3.types.InternalChecker]
The internal checkers that this check will egress from. If is_internal is true and this list is empty, the
check will egress from all the InternalCheckers configured
for the project that owns this UptimeCheckConfig.
|
Classes
ContentMatcher
ContentMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
HttpCheck
HttpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)Information involved in an HTTP/HTTPS Uptime check request. .. attribute:: request_method
The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED then request_method defaults to
GET.
:type: google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck.RequestMethod
ResourceGroup
ResourceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
TcpCheck
TcpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)Information required for a TCP Uptime check request. .. attribute:: port
The TCP port on the server against which to run the check.
Will be combined with host (specified within the
monitored_resource) to construct the full URL. Required.
:type: int