Index
AlertPolicyService(interface)GroupService(interface)MetricService(interface)NotificationChannelService(interface)QueryService(interface)ServiceMonitoringService(interface)UptimeCheckService(interface)Aggregation(message)Aggregation.Aligner(enum)Aggregation.Reducer(enum)AlertPolicy(message)AlertPolicy.Condition(message)AlertPolicy.Condition.MetricAbsence(message)AlertPolicy.Condition.MetricThreshold(message)AlertPolicy.Condition.Trigger(message)AlertPolicy.ConditionCombinerType(enum)AlertPolicy.Documentation(message)BasicSli(message)BasicSli.AvailabilityCriteria(message)BasicSli.LatencyCriteria(message)ComparisonType(enum)CreateAlertPolicyRequest(message)CreateGroupRequest(message)CreateMetricDescriptorRequest(message)CreateNotificationChannelRequest(message)CreateServiceLevelObjectiveRequest(message)CreateServiceRequest(message)CreateTimeSeriesError(message)CreateTimeSeriesRequest(message)CreateTimeSeriesSummary(message)CreateTimeSeriesSummary.Error(message)CreateUptimeCheckConfigRequest(message)DeleteAlertPolicyRequest(message)DeleteGroupRequest(message)DeleteMetricDescriptorRequest(message)DeleteNotificationChannelRequest(message)DeleteServiceLevelObjectiveRequest(message)DeleteServiceRequest(message)DeleteUptimeCheckConfigRequest(message)DistributionCut(message)DroppedLabels(message)GetAlertPolicyRequest(message)GetGroupRequest(message)GetMetricDescriptorRequest(message)GetMonitoredResourceDescriptorRequest(message)GetNotificationChannelDescriptorRequest(message)GetNotificationChannelRequest(message)GetNotificationChannelVerificationCodeRequest(message)GetNotificationChannelVerificationCodeResponse(message)GetServiceLevelObjectiveRequest(message)GetServiceRequest(message)GetUptimeCheckConfigRequest(message)Group(message)GroupResourceType(enum)InternalChecker(message) (deprecated)InternalChecker.State(enum)LabelValue(message)ListAlertPoliciesRequest(message)ListAlertPoliciesResponse(message)ListGroupMembersRequest(message)ListGroupMembersResponse(message)ListGroupsRequest(message)ListGroupsResponse(message)ListMetricDescriptorsRequest(message)ListMetricDescriptorsResponse(message)ListMonitoredResourceDescriptorsRequest(message)ListMonitoredResourceDescriptorsResponse(message)ListNotificationChannelDescriptorsRequest(message)ListNotificationChannelDescriptorsResponse(message)ListNotificationChannelsRequest(message)ListNotificationChannelsResponse(message)ListServiceLevelObjectivesRequest(message)ListServiceLevelObjectivesResponse(message)ListServicesRequest(message)ListServicesResponse(message)ListTimeSeriesRequest(message)ListTimeSeriesRequest.TimeSeriesView(enum)ListTimeSeriesResponse(message)ListUptimeCheckConfigsRequest(message)ListUptimeCheckConfigsResponse(message)ListUptimeCheckIpsRequest(message)ListUptimeCheckIpsResponse(message)MutationRecord(message)NotificationChannel(message)NotificationChannel.VerificationStatus(enum)NotificationChannelDescriptor(message)Point(message)QueryError(message)QueryErrorList(message)QueryTimeSeriesRequest(message)QueryTimeSeriesResponse(message)Range(message)RequestBasedSli(message)SendNotificationChannelVerificationCodeRequest(message)Service(message)Service.AppEngine(message)Service.CloudEndpoints(message)Service.ClusterIstio(message) (deprecated)Service.Custom(message)Service.MeshIstio(message)Service.Telemetry(message)ServiceLevelIndicator(message)ServiceLevelObjective(message)ServiceLevelObjective.View(enum)SpanContext(message)TextLocator(message)TextLocator.Position(message)TimeInterval(message)TimeSeries(message)TimeSeriesData(message)TimeSeriesData.PointData(message)TimeSeriesDescriptor(message)TimeSeriesDescriptor.ValueDescriptor(message)TimeSeriesRatio(message)TypedValue(message)UpdateAlertPolicyRequest(message)UpdateGroupRequest(message)UpdateNotificationChannelRequest(message)UpdateServiceLevelObjectiveRequest(message)UpdateServiceRequest(message)UpdateUptimeCheckConfigRequest(message)UptimeCheckConfig(message)UptimeCheckConfig.ContentMatcher(message)UptimeCheckConfig.ContentMatcher.ContentMatcherOption(enum)UptimeCheckConfig.HttpCheck(message)UptimeCheckConfig.HttpCheck.BasicAuthentication(message)UptimeCheckConfig.HttpCheck.ContentType(enum)UptimeCheckConfig.HttpCheck.RequestMethod(enum)UptimeCheckConfig.ResourceGroup(message)UptimeCheckConfig.TcpCheck(message)UptimeCheckIp(message)UptimeCheckRegion(enum)VerifyNotificationChannelRequest(message)WindowsBasedSli(message)WindowsBasedSli.MetricRange(message)WindowsBasedSli.PerformanceThreshold(message)
AlertPolicyService
The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.
| CreateAlertPolicy | |
|---|---|
|
Creates a new alerting policy.
|
|
| DeleteAlertPolicy | |
|---|---|
|
Deletes an alerting policy.
|
|
| GetAlertPolicy | |
|---|---|
|
Gets a single alerting policy.
|
|
| ListAlertPolicies | |
|---|---|
|
Lists the existing alerting policies for the workspace.
|
|
| UpdateAlertPolicy | |
|---|---|
|
Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via
|
|
GroupService
The Group API lets you inspect and manage your groups.
A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.
| CreateGroup | |
|---|---|
|
Creates a new group.
|
|
| DeleteGroup | |
|---|---|
|
Deletes an existing group.
|
|
| GetGroup | |
|---|---|
|
Gets a single group.
|
|
| ListGroupMembers | |
|---|---|
|
Lists the monitored resources that are members of a group.
|
|
| ListGroups | |
|---|---|
|
Lists the existing groups.
|
|
| UpdateGroup | |
|---|---|
|
Updates an existing group. You can change any group attributes except
|
|
MetricService
Manages metric descriptors, monitored resource descriptors, and time series data.
| CreateMetricDescriptor | |
|---|---|
|
Creates a new metric descriptor. User-created metric descriptors define custom metrics.
|
|
| CreateTimeSeries | |
|---|---|
|
Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.
|
|
| DeleteMetricDescriptor | |
|---|---|
|
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
|
|
| GetMetricDescriptor | |
|---|---|
|
Gets a single metric descriptor. This method does not require a Workspace.
|
|
| GetMonitoredResourceDescriptor | |
|---|---|
|
Gets a single monitored resource descriptor. This method does not require a Workspace.
|
|
| ListMetricDescriptors | |
|---|---|
|
Lists metric descriptors that match a filter. This method does not require a Workspace.
|
|
| ListMonitoredResourceDescriptors | |
|---|---|
|
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
|
|
| ListTimeSeries | |
|---|---|
|
Lists time series that match a filter. This method does not require a Workspace.
|
|
NotificationChannelService
The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.
| CreateNotificationChannel | |
|---|---|
|
Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.
|
|
| DeleteNotificationChannel | |
|---|---|
|
Deletes a notification channel.
|
|
| GetNotificationChannel | |
|---|---|
|
Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.
|
|
| GetNotificationChannelDescriptor | |
|---|---|
|
Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.
|
|
| GetNotificationChannelVerificationCode | |
|---|---|
|
Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state). There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.
|
|
| ListNotificationChannelDescriptors | |
|---|---|
|
Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.
|
|
| ListNotificationChannels | |
|---|---|
|
Lists the notification channels that have been created for the project.
|
|
| SendNotificationChannelVerificationCode | |
|---|---|
|
Causes a verification code to be delivered to the channel. The code can then be supplied in
|
|
| UpdateNotificationChannel | |
|---|---|
|
Updates a notification channel. Fields not specified in the field mask remain unchanged.
|
|
| VerifyNotificationChannel | |
|---|---|
|
Verifies a
|
|
QueryService
The QueryService API is used to manage time series data in Stackdriver Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric.
| QueryTimeSeries | |
|---|---|
|
Queries time series using Monitoring Query Language. This method does not require a Workspace.
|
|
ServiceMonitoringService
The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.
| CreateService | |
|---|---|
|
Create a
|
|
| CreateServiceLevelObjective | |
|---|---|
|
Create a
|
|
| DeleteService | |
|---|---|
|
Soft delete this
|
|
| DeleteServiceLevelObjective | |
|---|---|
|
Delete the given
|
|
| GetService | |
|---|---|
|
Get the named
|
|
| GetServiceLevelObjective | |
|---|---|
|
Get a
|
|
| ListServiceLevelObjectives | |
|---|---|
|
List the
|
|
| ListServices | |
|---|---|
|
List
|
|
| UpdateService | |
|---|---|
|
Update this
|
|
| UpdateServiceLevelObjective | |
|---|---|
|
Update the given
|
|
UptimeCheckService
The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the Cloud Console, selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".
| CreateUptimeCheckConfig | |
|---|---|
|
Creates a new Uptime check configuration.
|
|
| DeleteUptimeCheckConfig | |
|---|---|
|
Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.
|
|
| GetUptimeCheckConfig | |
|---|---|
|
Gets a single Uptime check configuration.
|
|
| ListUptimeCheckConfigs | |
|---|---|
|
Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
|
|
| ListUptimeCheckIps | |
|---|---|
|
Returns the list of IP addresses that checkers run from
|
|
| UpdateUptimeCheckConfig | |
|---|---|
|
Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via
|
|
Aggregation
Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.
Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.
Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.
The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation.
| Fields | |
|---|---|
alignment_period |
The The value must be at least 60 seconds, at most 104 weeks. If a per-series aligner other than The maximum value of the |
per_series_aligner |
An Not all alignment operations may be applied to all time series. The valid choices depend on the Time series data must be aligned in order to perform cross-time series reduction. If |
cross_series_reducer |
The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the Time series data must first be aligned (see |
group_by_fields[] |
The set of fields to preserve when |
Aligner
The Aligner specifies the operation that will be applied to the data points in each alignment period in a time series. Except for ALIGN_NONE, which specifies that no operation be applied, each alignment operation replaces the set of data values in each alignment period with a single value: the result of applying the operation to the data values. An aligned time series has a single data value at the end of each alignment_period.
An alignment operation can change the data type of the values, too. For example, if you apply a counting operation to boolean values, the data value_type in the original time series is BOOLEAN, but the value_type in the aligned result is INT64.
| Enums | |
|---|---|
ALIGN_NONE |
No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input. |
ALIGN_DELTA |
Align and convert to This alignment is valid for |
ALIGN_RATE |
Align and convert to a rate. The result is computed as This aligner is valid for If, by "rate", you mean "percentage change", see the |
ALIGN_INTERPOLATE |
Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input. |
ALIGN_NEXT_OLDER |
Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input. |
ALIGN_MIN |
Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input. |
ALIGN_MAX |
Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input. |
ALIGN_MEAN |
Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE. |
ALIGN_COUNT |
Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64. |
ALIGN_SUM |
Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input. |
ALIGN_STDDEV |
Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE. |
ALIGN_COUNT_TRUE |
Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64. |
ALIGN_COUNT_FALSE |
Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64. |
ALIGN_FRACTION_TRUE |
Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range [0.0, 1.0] and has value_type DOUBLE. |
ALIGN_PERCENTILE_99 |
Align the time series by using percentile aggregation. The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE. |
ALIGN_PERCENTILE_95 |
Align the time series by using percentile aggregation. The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE. |
ALIGN_PERCENTILE_50 |
Align the time series by using percentile aggregation. The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE. |
ALIGN_PERCENTILE_05 |
Align the time series by using percentile aggregation. The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE. |
ALIGN_PERCENT_CHANGE |
Align and convert to a percentage change. This aligner is valid for If the values of A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are |
Reducer
A Reducer operation describes how to aggregate data points from multiple time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.
| Enums | |
|---|---|
REDUCE_NONE |
No cross-time series reduction. The output of the Aligner is returned. |
REDUCE_MEAN |
Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE. |
REDUCE_MIN |
Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input. |
REDUCE_MAX |
Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input. |
REDUCE_SUM |
Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input. |
REDUCE_STDDEV |
Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE. |
REDUCE_COUNT |
Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64. |
REDUCE_COUNT_TRUE |
Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64. |
REDUCE_COUNT_FALSE |
Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64. |
REDUCE_FRACTION_TRUE |
Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range [0.0, 1.0] and has value_type DOUBLE. |
REDUCE_PERCENTILE_99 |
Reduce by computing the 99th percentile of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE. |
REDUCE_PERCENTILE_95 |
Reduce by computing the 95th percentile of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE. |
REDUCE_PERCENTILE_50 |
Reduce by computing the 50th percentile of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE. |
REDUCE_PERCENTILE_05 |
Reduce by computing the 5th percentile of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE. |
AlertPolicy
A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting.
| Fields | |
|---|---|
name |
Required if the policy exists. The resource name for this policy. The format is:
|
display_name |
A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters. |
documentation |
Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation. |
user_labels |
User-supplied key/value data to be used for organizing and identifying the The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. |
conditions[] |
A list of conditions for the policy. The conditions are combined by AND or OR according to the |
combiner |
How to combine the results of multiple conditions to determine if an incident should be opened. If |
enabled |
Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. |
validity |
Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents. |
notification_channels[] |
Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the |
creation_record |
A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. |
mutation_record |
A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. |
Condition
A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.
| Fields | ||
|---|---|---|
name |
Required if the condition exists. The unique resource name for this condition. Its format is:
When calling the When calling the Best practice is to preserve |
|
display_name |
A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy. |
|
Union field condition. Only one of the following condition types will be specified. condition can be only one of the following: |
||
condition_threshold |
A condition that compares a time series against a threshold. |
|
condition_absent |
A condition that checks that a time series continues to receive new data points. |
|
MetricAbsence
A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration.
| Fields | |
|---|---|
filter |
A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the |
aggregations[] |
Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified. This field is similar to the one in the |
duration |
The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The |
trigger |
The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by |
MetricThreshold
A condition type that compares a collection of time series against a threshold.
| Fields | |
|---|---|
filter |
A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the |
aggregations[] |
Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified. This field is similar to the one in the |
denominator_filter |
A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. |
denominator_aggregations[] |
Specifies the alignment of data points in individual time series selected by When computing ratios, the |
comparison |
The comparison to apply between the time series (indicated by Only |
threshold_value |
A value against which to compare the time series. |
duration |
The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the |
trigger |
The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by |
Trigger
Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used.
| Fields | ||
|---|---|---|
Union field type. A type of trigger. type can be only one of the following: |
||
count |
The absolute number of time series that must fail the predicate for the condition to be triggered. |
|
percent |
The percentage of time series that must fail the predicate for the condition to be triggered. |
|
ConditionCombinerType
Operators for combining conditions.
| Enums | |
|---|---|
COMBINE_UNSPECIFIED |
An unspecified combiner. |
AND |
Combine conditions using the logical AND operator. An incident is created only if all the conditions are met simultaneously. This combiner is satisfied if all conditions are met, even if they are met on completely different resources. |
OR |
Combine conditions using the logical OR operator. An incident is created if any of the listed conditions is met. |
AND_WITH_MATCHING_RESOURCE |
Combine conditions using logical AND operator, but unlike the regular AND option, an incident is created only if all conditions are met simultaneously on at least one resource. |
Documentation
A content string and a MIME type that describes the content string's format.
| Fields | |
|---|---|
content |
The text of the documentation, interpreted according to |
mime_type |
The format of the |
BasicSli
An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.
| Fields | ||
|---|---|---|
method[] |
OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error. |
|
location[] |
OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error. |
|
version[] |
OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error. |
|
Union field sli_criteria. This SLI can be evaluated on the basis of availability or latency. sli_criteria can be only one of the following: |
||
availability |
Good service is defined to be the count of requests made to this service that return successfully. |
|
latency |
Good service is defined to be the count of requests made to this service that are fast enough with respect to |
|
AvailabilityCriteria
Future parameters for the availability SLI.
LatencyCriteria
Parameters for a latency threshold SLI.
| Fields | |
|---|---|
threshold |
Good service is defined to be the count of requests made to this service that return in no more than |
ComparisonType
Specifies an ordering relationship on two arguments, called left and right.
| Enums | |
|---|---|
COMPARISON_UNSPECIFIED |
No ordering relationship is specified. |
COMPARISON_GT |
True if the left argument is greater than the right argument. |
COMPARISON_GE |
True if the left argument is greater than or equal to the right argument. |
COMPARISON_LT |
True if the left argument is less than the right argument. |
COMPARISON_LE |
True if the left argument is less than or equal to the right argument. |
COMPARISON_EQ |
True if the left argument is equal to the right argument. |
COMPARISON_NE |
True if the left argument is not equal to the right argument. |
CreateAlertPolicyRequest
The protocol for the CreateAlertPolicy request.
| Fields | |
|---|---|
name |
Required. The project in which to create the alerting policy. The format is: Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form Authorization requires the following IAM permission on the specified resource
|
alert_policy |
Required. The requested alerting policy. You should omit the |
CreateGroupRequest
The CreateGroup request.
| Fields | |
|---|---|
name |
Required. The project in which to create the group. The format is: |
group |
Required. A group definition. It is an error to define the |
validate_only |
If true, validate this request but do not create the group. |
CreateMetricDescriptorRequest
The CreateMetricDescriptor request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
metric_descriptor |
Required. The new custom metric descriptor. |
CreateNotificationChannelRequest
The CreateNotificationChannel request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add Authorization requires the following IAM permission on the specified resource
|
notification_channel |
Required. The definition of the |
CreateServiceLevelObjectiveRequest
The CreateServiceLevelObjective request.
| Fields | |
|---|---|
parent |
Required. Resource name of the parent |
service_level_objective_id |
Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern |
service_level_objective |
Required. The |
CreateServiceRequest
The CreateService request.
| Fields | |
|---|---|
parent |
Required. Resource name of the parent workspace. The format is: |
service_id |
Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern |
service |
Required. The |
CreateTimeSeriesError
DEPRECATED. Used to hold per-time-series error status.
| Fields | |
|---|---|
time_series |
DEPRECATED. Time series ID that resulted in the |
status |
DEPRECATED. The status of the requested write operation for |
CreateTimeSeriesRequest
The CreateTimeSeries request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
time_series[] |
Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each The maximum number of |
CreateTimeSeriesSummary
Summary of the result of a failed request to write data to a time series.
| Fields | |
|---|---|
total_point_count |
The number of points in the request. |
success_point_count |
The number of points that were successfully written. |
errors[] |
The number of points that failed to be written. Order is not guaranteed. |
Error
Detailed information about an error category.
| Fields | |
|---|---|
status |
The status of the requested write operation. |
point_count |
The number of points that couldn't be written because of |
CreateUptimeCheckConfigRequest
The protocol for the CreateUptimeCheckConfig request.
| Fields | |
|---|---|
parent |
Required. The project in which to create the Uptime check. The format is: Authorization requires the following IAM permission on the specified resource
|
uptime_check_config |
Required. The new Uptime check configuration. |
DeleteAlertPolicyRequest
The protocol for the DeleteAlertPolicy request.
| Fields | |
|---|---|
name |
Required. The alerting policy to delete. The format is: For more information, see Authorization requires the following IAM permission on the specified resource
|
DeleteGroupRequest
The DeleteGroup request. The default behavior is to be able to delete a single group without any descendants.
| Fields | |
|---|---|
name |
Required. The group to delete. The format is: |
recursive |
If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false. |
DeleteMetricDescriptorRequest
The DeleteMetricDescriptor request.
| Fields | |
|---|---|
name |
Required. The metric descriptor on which to execute the request. The format is: An example of |
DeleteNotificationChannelRequest
The DeleteNotificationChannel request.
| Fields | |
|---|---|
name |
Required. The channel for which to execute the request. The format is: Authorization requires the following IAM permission on the specified resource
|
force |
If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation. |
DeleteServiceLevelObjectiveRequest
The DeleteServiceLevelObjective request.
| Fields | |
|---|---|
name |
Required. Resource name of the |
DeleteServiceRequest
The DeleteService request.
| Fields | |
|---|---|
name |
Required. Resource name of the |
DeleteUptimeCheckConfigRequest
The protocol for the DeleteUptimeCheckConfig request.
| Fields | |
|---|---|
name |
Required. The Uptime check configuration to delete. The format is: Authorization requires the following IAM permission on the specified resource
|
DistributionCut
A DistributionCut defines a TimeSeries and thresholds used for measuring good service and total service. The TimeSeries must have ValueType =
DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE. The computed good_service will be the count of values x in the Distribution such that range.min <= x < range.max.
| Fields | |
|---|---|
distribution_filter |
A monitoring filter specifying a |
range |
Range of values considered "good." For a one-sided range, set one bound to an infinite value. |
DroppedLabels
A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.
The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.
Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.
| Fields | |
|---|---|
label |
Map from label to its value, for all labels dropped in any aggregation. |
GetAlertPolicyRequest
The protocol for the GetAlertPolicy request.
| Fields | |
|---|---|
name |
Required. The alerting policy to retrieve. The format is: Authorization requires the following IAM permission on the specified resource
|
GetGroupRequest
The GetGroup request.
| Fields | |
|---|---|
name |
Required. The group to retrieve. The format is: |
GetMetricDescriptorRequest
The GetMetricDescriptor request.
| Fields | |
|---|---|
name |
Required. The metric descriptor on which to execute the request. The format is: An example value of |
GetMonitoredResourceDescriptorRequest
The GetMonitoredResourceDescriptor request.
| Fields | |
|---|---|
name |
Required. The monitored resource descriptor to get. The format is: The |
GetNotificationChannelDescriptorRequest
The GetNotificationChannelDescriptor response.
| Fields | |
|---|---|
name |
Required. The channel type for which to execute the request. The format is: |
GetNotificationChannelRequest
The GetNotificationChannel request.
| Fields | |
|---|---|
name |
Required. The channel for which to execute the request. The format is: Authorization requires the following IAM permission on the specified resource
|
GetNotificationChannelVerificationCodeRequest
The GetNotificationChannelVerificationCode request.
| Fields | |
|---|---|
name |
Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. Authorization requires the following IAM permission on the specified resource
|
expire_time |
The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted). |
GetNotificationChannelVerificationCodeResponse
The GetNotificationChannelVerificationCode request.
| Fields | |
|---|---|
code |
The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number). |
expire_time |
The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration. |
GetServiceLevelObjectiveRequest
The GetServiceLevelObjective request.
| Fields | |
|---|---|
name |
Required. Resource name of the |
view |
View of the |
GetServiceRequest
The GetService request.
| Fields | |
|---|---|
name |
Required. Resource name of the |
GetUptimeCheckConfigRequest
The protocol for the GetUptimeCheckConfig request.
| Fields | |
|---|---|
name |
Required. The Uptime check configuration to retrieve. The format is: Authorization requires the following IAM permission on the specified resource
|
Group
The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.
Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.
For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.
The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
| Fields | |
|---|---|
name |
Output only. The name of this group. The format is: When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to |
display_name |
A user-assigned name for this group, used only for display purposes. |
parent_name |
The name of the group's parent, if it has one. The format is: For groups with no parent, |
filter |
The filter used to determine which monitored resources belong to this group. |
is_cluster |
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. |
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. |
InternalChecker
An internal checker allows Uptime checks to run on private/internal GCP resources.
| Fields | |
|---|---|
name |
A unique resource name for this InternalChecker. The format is:
|
display_name |
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"). |
gcp_zone |
The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. |
peer_project_id |
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. |
LabelValue
A label value.
| Fields | ||
|---|---|---|
Union field value. The label value can be a bool, int64, or string. value can be only one of the following: |
||
bool_value |
A bool label value. |
|
int64_value |
An int64 label value. |
|
string_value |
A string label value. |
|
ListAlertPoliciesRequest
The protocol for the ListAlertPolicies request.
| Fields | |
|---|---|
name |
Required. The project whose alert policies are to be listed. The format is: Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the Authorization requires the following IAM permission on the specified resource
|
filter |
If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see sorting and filtering. |
order_by |
A comma-separated list of fields by which to sort the result. Supports the same set of field references as the For more details, see sorting and filtering. |
page_size |
The maximum number of results to return in a single response. |
page_token |
If this field is not empty then it must contain the |
ListAlertPoliciesResponse
The protocol for the ListAlertPolicies response.
| Fields | |
|---|---|
alert_policies[] |
The returned alert policies. |
next_page_token |
If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as |
total_size |
The total number of alert policies in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 |
ListGroupMembersRequest
The ListGroupMembers request.
| Fields | |
|---|---|
name |
Required. The group whose members are listed. The format is: |
page_size |
A positive number that is the maximum number of results to return. |
page_token |
If this field is not empty then it must contain the |
filter |
An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: |
interval |
An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned. |
ListGroupMembersResponse
The ListGroupMembers response.
| Fields | |
|---|---|
members[] |
A set of monitored resources in the group. |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
total_size |
The total number of elements matching this request. |
ListGroupsRequest
The ListGroup request.
| Fields | ||
|---|---|---|
name |
Required. The project whose groups are to be listed. The format is: |
|
page_size |
A positive number that is the maximum number of results to return. |
|
page_token |
If this field is not empty then it must contain the |
|
Union field filter. An optional filter consisting of a single group name. The filters limit the groups returned based on their parent-child relationship with the specified group. If no filter is specified, all groups are returned. filter can be only one of the following: |
||
children_of_group |
A group name. The format is: Returns groups whose |
|
ancestors_of_group |
A group name. The format is: Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. |
|
descendants_of_group |
A group name. The format is: Returns the descendants of the specified group. This is a superset of the results returned by the |
|
ListGroupsResponse
The ListGroups response.
| Fields | |
|---|---|
group[] |
The groups that match the specified filters. |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
ListMetricDescriptorsRequest
The ListMetricDescriptors request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
filter |
If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: |
page_size |
A positive number that is the maximum number of results to return. |
page_token |
If this field is not empty then it must contain the |
ListMetricDescriptorsResponse
The ListMetricDescriptors response.
| Fields | |
|---|---|
metric_descriptors[] |
The metric descriptors that are available to the project and that match the value of |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
ListMonitoredResourceDescriptorsRequest
The ListMonitoredResourceDescriptors request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
filter |
An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an |
page_size |
A positive number that is the maximum number of results to return. |
page_token |
If this field is not empty then it must contain the |
ListMonitoredResourceDescriptorsResponse
The ListMonitoredResourceDescriptors response.
| Fields | |
|---|---|
resource_descriptors[] |
The monitored resource descriptors that are available to this project and that match |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
ListNotificationChannelDescriptorsRequest
The ListNotificationChannelDescriptors request.
| Fields | |
|---|---|
name |
Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. |
page_token |
If non-empty, |
ListNotificationChannelDescriptorsResponse
The ListNotificationChannelDescriptors response.
| Fields | |
|---|---|
channel_descriptors[] |
The monitored resource descriptors supported for the specified project, optionally filtered. |
next_page_token |
If not empty, indicates that there may be more results that match the request. Use the value in the |
ListNotificationChannelsRequest
The ListNotificationChannels request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the Authorization requires the following IAM permission on the specified resource
|
filter |
If provided, this field specifies the criteria that must be met by notification channels to be included in the response. For more details, see sorting and filtering. |
order_by |
A comma-separated list of fields by which to sort the result. Supports the same set of fields as in For more details, see sorting and filtering. |
page_size |
The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. |
page_token |
If non-empty, |
ListNotificationChannelsResponse
The ListNotificationChannels response.
| Fields | |
|---|---|
notification_channels[] |
The notification channels defined for the specified project. |
next_page_token |
If not empty, indicates that there may be more results that match the request. Use the value in the |
total_size |
The total number of notification channels in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 |
ListServiceLevelObjectivesRequest
The ListServiceLevelObjectives request.
| Fields | |
|---|---|
parent |
Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: |
filter |
A filter specifying what |
page_size |
A non-negative number that is the maximum number of results to return. When 0, use default page size. |
page_token |
If this field is not empty then it must contain the |
view |
View of the |
ListServiceLevelObjectivesResponse
The ListServiceLevelObjectives response.
| Fields | |
|---|---|
service_level_objectives[] |
The |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
ListServicesRequest
The ListServices request.
| Fields | |
|---|---|
parent |
Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: |
filter |
A filter specifying what
|
page_size |
A non-negative number that is the maximum number of results to return. When 0, use default page size. |
page_token |
If this field is not empty then it must contain the |
ListServicesResponse
The ListServices response.
| Fields | |
|---|---|
services[] |
The |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
ListTimeSeriesRequest
The ListTimeSeries request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
filter |
Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: |
interval |
Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response. |
aggregation |
Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels. By default (if no |
order_by |
Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). |
view |
Required. Specifies which information is returned about the time series. |
page_size |
A positive number that is the maximum number of results to return. If |
page_token |
If this field is not empty then it must contain the |
TimeSeriesView
Controls which fields are returned by ListTimeSeries.
| Enums | |
|---|---|
FULL |
Returns the identity of the metric(s), the time series, and the time series data. |
HEADERS |
Returns the identity of the metric and the time series resource, but not the time series data. |
ListTimeSeriesResponse
The ListTimeSeries response.
| Fields | |
|---|---|
time_series[] |
One or more time series that match the filter included in the request. |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
execution_errors[] |
Query execution errors that may have caused the time series data returned to be incomplete. |
unit |
The unit in which all |
ListUptimeCheckConfigsRequest
The protocol for the ListUptimeCheckConfigs request.
| Fields | |
|---|---|
parent |
Required. The project whose Uptime check configurations are listed. The format is: Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. |
page_token |
If this field is not empty then it must contain the |
ListUptimeCheckConfigsResponse
The protocol for the ListUptimeCheckConfigs response.
| Fields | |
|---|---|
uptime_check_configs[] |
The returned Uptime check configurations. |
next_page_token |
This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). |
total_size |
The total number of Uptime check configurations for the project, irrespective of any pagination. |
ListUptimeCheckIpsRequest
The protocol for the ListUptimeCheckIps request.
| Fields | |
|---|---|
page_size |
The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented |
page_token |
If this field is not empty then it must contain the |
ListUptimeCheckIpsResponse
The protocol for the ListUptimeCheckIps response.
| Fields | |
|---|---|
uptime_check_ips[] |
The returned list of IP addresses (including region and location) that the checkers run from. |
next_page_token |
This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented |
MutationRecord
Describes a change made to a configuration.
| Fields | |
|---|---|
mutate_time |
When the change occurred. |
mutated_by |
The email address of the user making the change. |
NotificationChannel
A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.
| Fields | |
|---|---|
type |
The type of the notification channel. This field matches the value of the |
name |
The full REST resource name for this channel. The format is: The |
display_name |
An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. |
description |
An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. |
labels |
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the |
user_labels |
User-supplied key/value data that does not need to conform to the corresponding The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. |
verification_status |
Indicates whether this channel has been verified or not. On a If the value is If the channel is neither This field cannot be modified using a standard |
enabled |
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. |
VerificationStatus
Indicates whether the channel has been verified or not. It is illegal to specify this field in a CreateNotificationChannelUpdateNotificationChannel
| Enums | |
|---|---|
VERIFICATION_STATUS_UNSPECIFIED |
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function). |
UNVERIFIED |
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process. |
VERIFIED |
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel. |
NotificationChannelDescriptor
A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.
| Fields | |
|---|---|
name |
The full REST resource name for this descriptor. The format is: In the above, |
type |
The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique. |
display_name |
A human-readable name for the notification channel type. This form of the name is suitable for a user interface. |
description |
A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. |
labels[] |
The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. |
launch_stage |
The product launch stage for channels of this type. |
Point
A single data point in a time series.
| Fields | |
|---|---|
interval |
The time interval to which the data point applies. For |
value |
The value of the data point. |
QueryError
An error associated with a query in the time series query language format.
| Fields | |
|---|---|
locator |
The location of the time series query language text that this error applies to. |
message |
The error message. |
QueryErrorList
This is an error detail intended to be used with INVALID_ARGUMENT errors.
| Fields | |
|---|---|
errors[] |
Errors in parsing the time series query language text. The number of errors in the response may be limited. |
error_summary |
A summary of all the errors. |
QueryTimeSeriesRequest
The QueryTimeSeries request.
| Fields | |
|---|---|
name |
Required. The project on which to execute the request. The format is: |
query |
Required. The query in the monitoring query language format. The default time zone is in UTC. |
page_size |
A positive number that is the maximum number of time_series_data to return. |
page_token |
If this field is not empty then it must contain the |
QueryTimeSeriesResponse
The QueryTimeSeries response.
| Fields | |
|---|---|
time_series_descriptor |
The descriptor for the time series data. |
time_series_data[] |
The time series data. |
next_page_token |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
partial_errors[] |
Query execution errors that may have caused the time series data returned to be incomplete. The available data will be available in the response. |
Range
Range of numerical values, inclusive of min and exclusive of max. If the open range "< range.max" is desired, set range.min = -infinity. If the open range ">= range.min" is desired, set range.max = infinity.
| Fields | |
|---|---|
min |
Range minimum. |
max |
Range maximum. |
RequestBasedSli
Service Level Indicators for which atomic units of service are counted directly.
| Fields | ||
|---|---|---|
Union field method. The means to compute a ratio of good_service to total_service. method can be only one of the following: |
||
good_total_ratio |
|
|
distribution_cut |
|
|
SendNotificationChannelVerificationCodeRequest
The SendNotificationChannelVerificationCode request.
| Fields | |
|---|---|
name |
Required. The notification channel to which to send a verification code. Authorization requires the following IAM permission on the specified resource
|
Service
A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.
| Fields | ||
|---|---|---|
name |
Resource name for this Service. The format is: |
|
display_name |
Name used for UI elements listing this Service. |
|
telemetry |
Configuration for how to query telemetry on a Service. |
|
Union field identifier. REQUIRED. Service-identifying atoms specifying the underlying service. identifier can be only one of the following: |
||
custom |
Custom service type. |
|
app_engine |
Type used for App Engine services. |
|
cloud_endpoints |
Type used for Cloud Endpoints services. |
|
cluster_istio |
Type used for Istio services that live in a Kubernetes cluster. |
|
mesh_istio |
Type used for Istio services scoped to an Istio mesh. |
|
AppEngine
App Engine service. Learn more at https://cloud.google.com/appengine.
| Fields | |
|---|---|
module_id |
The ID of the App Engine module underlying this service. Corresponds to the |
CloudEndpoints
Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.
| Fields | |
|---|---|
service |
The name of the Cloud Endpoints service underlying this service. Corresponds to the |
ClusterIstio
Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io.
| Fields | |
|---|---|
location |
The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the |
cluster_name |
The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the |
service_namespace |
The namespace of the Istio service underlying this service. Corresponds to the |
service_name |
The name of the Istio service underlying this service. Corresponds to the |
Custom
Custom view of service telemetry. Currently a place-holder pending final design.
MeshIstio
Istio service scoped to an Istio mesh
| Fields | |
|---|---|
mesh_uid |
Identifier for the mesh in which this Istio service is defined. Corresponds to the |
service_namespace |
The namespace of the Istio service underlying this service. Corresponds to the |
service_name |
The name of the Istio service underlying this service. Corresponds to the |
Telemetry
Configuration for how to query telemetry on a Service.
| Fields | |
|---|---|
resource_name |
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
ServiceLevelIndicator
A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service /
total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries.
| Fields | ||
|---|---|---|
Union field type. Service level indicators can be grouped by whether the "unit" of service being measured is based on counts of good requests or on counts of good time windows type can be only one of the following: |
||
basic_sli |
Basic SLI on a well-known service type. |
|
request_based |
Request-based SLIs |
|
windows_based |
Windows-based SLIs |
|
ServiceLevelObjective
A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."
| Fields | ||
|---|---|---|
name |
Resource name for this |
|
display_name |
Name used for UI elements listing this SLO. |
|
service_level_indicator |
The definition of good service, used to measure and calculate the quality of the |
|
goal |
The fraction of service that must be good in order for this objective to be met. |
|
Union field period. The time period over which the objective will be evaluated. period can be only one of the following: |
||
rolling_period |
A rolling time period, semantically "in the past |
|
calendar_period |
A calendar period, semantically "since the start of the current |
|
View
ServiceLevelObjective.View determines what form of ServiceLevelObjective is returned from GetServiceLevelObjective, ListServiceLevelObjectives, and ListServiceLevelObjectiveVersions RPCs.
| Enums | |
|---|---|
VIEW_UNSPECIFIED |
Same as FULL. |
FULL |
Return the embedded ServiceLevelIndicator in the form in which it was defined. If it was defined using a BasicSli, return that BasicSli. |
EXPLICIT |
For ServiceLevelIndicators using BasicSli articulation, instead return the ServiceLevelIndicator with its mode of computation fully spelled out as a RequestBasedSli. For ServiceLevelIndicators using RequestBasedSli or WindowsBasedSli, return the ServiceLevelIndicator as it was provided. |
SpanContext
The context of a span, attached to [Exemplars][google.api.Distribution.Exemplars] in Distribution values during aggregation.
It contains the name of a span with format:
projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
| Fields | |
|---|---|
span_name |
The resource name of the span. The format is:
|
TextLocator
A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.
For example, suppose the request field text contains:
text: "The quick brown fox jumps over the lazy dog."
Then the locator:
source: "text" start_position { line: 1 column: 17 } end_position { line: 1 column: 19 }
refers to the part of the text: "fox".
| Fields | |
|---|---|
source |
The source of the text. The source may be a field in the request, in which case its format is the format of the google.rpc.BadRequest.FieldViolation.field field in https://cloud.google.com/apis/design/errors#error_details. It may also be be a source other than the request field (e.g. a macro definition referenced in the text of the query), in which case this is the name of the source (e.g. the macro name). |
start_position |
The position of the first byte within the text. |
end_position |
The position of the last byte within the text. |
nested_locator |
If |
nesting_reason |
When |
Position
The position of a byte within the text.
| Fields | |
|---|---|
line |
The line, starting with 1, where the byte is positioned. |
column |
The column within the line, starting with 1, where the byte is positioned. This is a byte index even though the text is UTF-8. |
TimeInterval
A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time.
For
GAUGEmetrics, thestartTimevalue is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only forGAUGEmetrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval.For
DELTAmetrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. ForDELTAmetrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.For
CUMULATIVEmetrics, the start time and end time must specify a a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval.The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.
| Fields | |
|---|---|
end_time |
Required. The end of the time interval. |
start_time |
Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. |
TimeSeries
A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
| Fields | |
|---|---|
metric |
The associated metric. A fully-specified metric used to identify the time series. |
resource |
The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. |
metadata |
Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. |
metric_kind |
The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either |
value_type |
The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the |
points[] |
The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be |
unit |
The units in which the metric value is reported. It is only applicable if the |
TimeSeriesData
Represents the values of a time series associated with a TimeSeriesDescriptor.
| Fields | |
|---|---|
label_values[] |
The values of the labels in the time series identifier, given in the same order as the |
point_data[] |
The points in the time series. |
PointData
A point's value columns and time interval. Each point has one or more point values corresponding to the entries in point_descriptors field in the TimeSeriesDescriptor associated with this object.
| Fields | |
|---|---|
values[] |
The values that make up the point. |
time_interval |
The time interval associated with the point. |
TimeSeriesDescriptor
A descriptor for the labels and points in a time series.
| Fields | |
|---|---|
label_descriptors[] |
Descriptors for the labels. |
point_descriptors[] |
Descriptors for the point data value columns. |
ValueDescriptor
A descriptor for the value columns in a data point.
| Fields | |
|---|---|
key |
The value key. |
value_type |
The value type. |
metric_kind |
The value stream kind. |
unit |
The unit in which |
TimeSeriesRatio
A TimeSeriesRatio specifies two TimeSeries to use for computing the good_service / total_service ratio. The specified TimeSeries must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind =
DELTA or MetricKind = CUMULATIVE. The TimeSeriesRatio must specify exactly two of good, bad, and total, and the relationship good_service +
bad_service = total_service will be assumed.
| Fields | |
|---|---|
good_service_filter |
A monitoring filter specifying a |
bad_service_filter |
A monitoring filter specifying a |
total_service_filter |
A monitoring filter specifying a |
TypedValue
A single strongly-typed value.
| Fields | ||
|---|---|---|
Union field value. The typed value field. value can be only one of the following: |
||
bool_value |
A Boolean value: |
|
int64_value |
A 64-bit integer. Its range is approximately ±9.2x1018. |
|
double_value |
A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. |
|
string_value |
A variable-length string value. |
|
distribution_value |
A distribution value. |
|
UpdateAlertPolicyRequest
The protocol for the UpdateAlertPolicy request.
| Fields | |
|---|---|
update_mask |
Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy ( Examples of valid field masks include If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:
|
alert_policy |
Required. The updated alerting policy or the updated values for the fields listed in Authorization requires the following IAM permission on the specified resource
|
UpdateGroupRequest
The UpdateGroup request.
| Fields | |
|---|---|
group |
Required. The new definition of the group. All fields of the existing group, excepting |
validate_only |
If true, validate this request but do not update the existing group. |
UpdateNotificationChannelRequest
The UpdateNotificationChannel request.
| Fields | |
|---|---|
update_mask |
The fields to update. |
notification_channel |
Required. A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the |
UpdateServiceLevelObjectiveRequest
The UpdateServiceLevelObjective request.
| Fields | |
|---|---|
service_level_objective |
Required. The |
update_mask |
A set of field paths defining which fields to use for the update. |
UpdateServiceRequest
The UpdateService request.
| Fields | |
|---|---|
service |
Required. The |
update_mask |
A set of field paths defining which fields to use for the update. |
UpdateUptimeCheckConfigRequest
The protocol for the UpdateUptimeCheckConfig request.
| Fields | |
|---|---|
update_mask |
Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. |
uptime_check_config |
Required. If an The following fields can be updated: Authorization requires the following IAM permission on the specified resource
|
UptimeCheckConfig
This message configures which resources and services to monitor for availability.
| 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. |
display_name |
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. |
content_matchers[] |
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 |
selected_regions[] |
|