From 1413b13ee1741183772b57481d5f9a99c9bdc129 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Fri, 12 Apr 2024 11:04:29 -0700 Subject: [PATCH] docs: Various updates PiperOrigin-RevId: 624233552 --- google/monitoring/v3/alert.proto | 7 +- google/monitoring/v3/common.proto | 78 ++++++++------ google/monitoring/v3/dropped_labels.proto | 2 +- google/monitoring/v3/group.proto | 2 +- google/monitoring/v3/group_service.proto | 36 ++++--- google/monitoring/v3/metric.proto | 2 +- google/monitoring/v3/metric_service.proto | 114 ++++++++++++--------- google/monitoring/v3/monitoring.yaml | 24 +---- google/monitoring/v3/mutation_record.proto | 2 +- google/monitoring/v3/query_service.proto | 11 +- google/monitoring/v3/service_service.proto | 85 ++++++++------- google/monitoring/v3/span_context.proto | 2 +- 12 files changed, 194 insertions(+), 171 deletions(-) diff --git a/google/monitoring/v3/alert.proto b/google/monitoring/v3/alert.proto index 8dafe88a235a5..8603859de847b 100644 --- a/google/monitoring/v3/alert.proto +++ b/google/monitoring/v3/alert.proto @@ -46,8 +46,8 @@ message AlertPolicy { pattern: "*" }; - // A content string and a MIME type that describes the content string's - // format. + // Documentation that is included in the notifications and incidents + // pertaining to this policy. message Documentation { // The body of the documentation, interpreted according to `mime_type`. // The content may not exceed 8,192 Unicode characters and may not exceed @@ -228,7 +228,8 @@ message AlertPolicy { Trigger trigger = 7; // A condition control that determines how metric-threshold conditions - // are evaluated when data stops arriving. + // are evaluated when data stops arriving. To use this control, the value + // of the `duration` field must be greater than or equal to 60 seconds. EvaluationMissingData evaluation_missing_data = 11; } diff --git a/google/monitoring/v3/common.proto b/google/monitoring/v3/common.proto index 62a189b81b83a..b5c728a0cda07 100644 --- a/google/monitoring/v3/common.proto +++ b/google/monitoring/v3/common.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -51,34 +51,44 @@ message TypedValue { } } -// 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`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future. +// Describes a time interval: // -// * For `GAUGE` metrics, the `startTime` value 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 for `GAUGE` metrics, 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 `DELTA` metrics, the start time and end time must specify a -// non-zero interval, with subsequent points specifying contiguous and -// non-overlapping intervals. For `DELTA` metrics, the start time of -// the next interval must be at least a millisecond after the end time -// of the previous interval. -// -// * For `CUMULATIVE` metrics, the start time and end time must specify 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. +// * Reads: A half-open time interval. It includes the end time but +// excludes the start time: `(startTime, endTime]`. The start time +// must be specified, must be earlier than the end time, and should be +// no older than the data retention period for the metric. +// * Writes: 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`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) +// of the metric value. The end time must not be earlier than the start +// time, and the end time must not be more than 25 hours in the past or more +// than five minutes in the future. +// * For `GAUGE` metrics, the `startTime` value 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 for `GAUGE` metrics, 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 `DELTA` metrics, the start time and end time must specify a +// non-zero interval, with subsequent points specifying contiguous and +// non-overlapping intervals. For `DELTA` metrics, the start time of +// the next interval must be at least a millisecond after the end time +// of the previous interval. +// * For `CUMULATIVE` metrics, the start time and end time must specify 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. message TimeInterval { // Required. The end of the time interval. google.protobuf.Timestamp end_time = 2; @@ -461,7 +471,7 @@ enum ComparisonType { COMPARISON_NE = 6; } -// The tier of service for a Workspace. Please see the +// The tier of service for a Metrics Scope. Please see the // [service tiers // documentation](https://cloud.google.com/monitoring/workspaces/tiers) for more // details. @@ -472,17 +482,17 @@ enum ServiceTier { // been provided explicitly. SERVICE_TIER_UNSPECIFIED = 0; - // The Stackdriver Basic tier, a free tier of service that provides basic + // The Cloud Monitoring Basic tier, a free tier of service that provides basic // features, a moderate allotment of logs, and access to built-in metrics. // A number of features are not available in this tier. For more details, // see [the service tiers // documentation](https://cloud.google.com/monitoring/workspaces/tiers). SERVICE_TIER_BASIC = 1; - // The Stackdriver Premium tier, a higher, more expensive tier of service - // that provides access to all Stackdriver features, lets you use Stackdriver - // with AWS accounts, and has a larger allotments for logs and metrics. For - // more details, see [the service tiers + // The Cloud Monitoring Premium tier, a higher, more expensive tier of service + // that provides access to all Cloud Monitoring features, lets you use Cloud + // Monitoring with AWS accounts, and has a larger allotments for logs and + // metrics. For more details, see [the service tiers // documentation](https://cloud.google.com/monitoring/workspaces/tiers). SERVICE_TIER_PREMIUM = 2; } diff --git a/google/monitoring/v3/dropped_labels.proto b/google/monitoring/v3/dropped_labels.proto index 6c176698afc41..104b7f783ed80 100644 --- a/google/monitoring/v3/dropped_labels.proto +++ b/google/monitoring/v3/dropped_labels.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/google/monitoring/v3/group.proto b/google/monitoring/v3/group.proto index ee7a3004c7808..3f7259bb25c0b 100644 --- a/google/monitoring/v3/group.proto +++ b/google/monitoring/v3/group.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/google/monitoring/v3/group_service.proto b/google/monitoring/v3/group_service.proto index ebe1bd9d14626..344e13d4509f9 100644 --- a/google/monitoring/v3/group_service.proto +++ b/google/monitoring/v3/group_service.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -96,7 +96,8 @@ service GroupService { } // Lists the monitored resources that are members of a group. - rpc ListGroupMembers(ListGroupMembersRequest) returns (ListGroupMembersResponse) { + rpc ListGroupMembers(ListGroupMembersRequest) + returns (ListGroupMembersResponse) { option (google.api.http) = { get: "/v3/{name=projects/*/groups/*}/members" }; @@ -106,8 +107,9 @@ service GroupService { // The `ListGroup` request. message ListGroupsRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) - // whose groups are to be listed. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) whose + // groups are to be listed. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 7 [ @@ -128,8 +130,8 @@ message ListGroupsRequest { // Returns groups whose `parent_name` field contains the group // name. If no groups have this parent, the results are empty. string children_of_group = 2 [(google.api.resource_reference) = { - type: "monitoring.googleapis.com/Group" - }]; + type: "monitoring.googleapis.com/Group" + }]; // A group name. The format is: // @@ -140,8 +142,8 @@ message ListGroupsRequest { // ending with the most distant ancestor. If the specified group has no // immediate parent, the results are empty. string ancestors_of_group = 3 [(google.api.resource_reference) = { - type: "monitoring.googleapis.com/Group" - }]; + type: "monitoring.googleapis.com/Group" + }]; // A group name. The format is: // @@ -151,8 +153,8 @@ message ListGroupsRequest { // the results returned by the `children_of_group` filter, and includes // children-of-children, and so forth. string descendants_of_group = 4 [(google.api.resource_reference) = { - type: "monitoring.googleapis.com/Group" - }]; + type: "monitoring.googleapis.com/Group" + }]; } // A positive number that is the maximum number of results to return. @@ -190,8 +192,9 @@ message GetGroupRequest { // The `CreateGroup` request. message CreateGroupRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in - // which to create the group. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) in which + // to create the group. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 4 [ @@ -201,8 +204,8 @@ message CreateGroupRequest { } ]; - // Required. A group definition. It is an error to define the `name` field because - // the system assigns the name. + // Required. A group definition. It is an error to define the `name` field + // because the system assigns the name. Group group = 2 [(google.api.field_behavior) = REQUIRED]; // If true, validate this request but do not create the group. @@ -211,8 +214,9 @@ message CreateGroupRequest { // The `UpdateGroup` request. message UpdateGroupRequest { - // Required. The new definition of the group. All fields of the existing group, - // excepting `name`, are replaced with the corresponding fields of this group. + // Required. The new definition of the group. All fields of the existing + // group, excepting `name`, are replaced with the corresponding fields of this + // group. Group group = 2 [(google.api.field_behavior) = REQUIRED]; // If true, validate this request but do not update the existing group. diff --git a/google/monitoring/v3/metric.proto b/google/monitoring/v3/metric.proto index ba55255be6bc9..682cb561ecd78 100644 --- a/google/monitoring/v3/metric.proto +++ b/google/monitoring/v3/metric.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/google/monitoring/v3/metric_service.proto b/google/monitoring/v3/metric_service.proto index edea2b532513a..c067ad9be2487 100644 --- a/google/monitoring/v3/metric_service.proto +++ b/google/monitoring/v3/metric_service.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -72,32 +72,36 @@ service MetricService { "https://www.googleapis.com/auth/monitoring.read," "https://www.googleapis.com/auth/monitoring.write"; - // Lists monitored resource descriptors that match a filter. This method does not require a Workspace. - rpc ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest) returns (ListMonitoredResourceDescriptorsResponse) { + // Lists monitored resource descriptors that match a filter. + rpc ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest) + returns (ListMonitoredResourceDescriptorsResponse) { option (google.api.http) = { get: "/v3/{name=projects/*}/monitoredResourceDescriptors" }; option (google.api.method_signature) = "name"; } - // Gets a single monitored resource descriptor. This method does not require a Workspace. - rpc GetMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest) returns (google.api.MonitoredResourceDescriptor) { + // Gets a single monitored resource descriptor. + rpc GetMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest) + returns (google.api.MonitoredResourceDescriptor) { option (google.api.http) = { get: "/v3/{name=projects/*/monitoredResourceDescriptors/**}" }; option (google.api.method_signature) = "name"; } - // Lists metric descriptors that match a filter. This method does not require a Workspace. - rpc ListMetricDescriptors(ListMetricDescriptorsRequest) returns (ListMetricDescriptorsResponse) { + // Lists metric descriptors that match a filter. + rpc ListMetricDescriptors(ListMetricDescriptorsRequest) + returns (ListMetricDescriptorsResponse) { option (google.api.http) = { get: "/v3/{name=projects/*}/metricDescriptors" }; option (google.api.method_signature) = "name"; } - // Gets a single metric descriptor. This method does not require a Workspace. - rpc GetMetricDescriptor(GetMetricDescriptorRequest) returns (google.api.MetricDescriptor) { + // Gets a single metric descriptor. + rpc GetMetricDescriptor(GetMetricDescriptorRequest) + returns (google.api.MetricDescriptor) { option (google.api.http) = { get: "/v3/{name=projects/*/metricDescriptors/**}" }; @@ -105,11 +109,13 @@ service MetricService { } // Creates a new metric descriptor. - // The creation is executed asynchronously and callers may check the returned - // operation to track its progress. + // The creation is executed asynchronously. // User-created metric descriptors define // [custom metrics](https://cloud.google.com/monitoring/custom-metrics). - rpc CreateMetricDescriptor(CreateMetricDescriptorRequest) returns (google.api.MetricDescriptor) { + // The metric descriptor is updated if it already exists, + // except that metric labels are never removed. + rpc CreateMetricDescriptor(CreateMetricDescriptorRequest) + returns (google.api.MetricDescriptor) { option (google.api.http) = { post: "/v3/{name=projects/*}/metricDescriptors" body: "metric_descriptor" @@ -120,23 +126,20 @@ service MetricService { // Deletes a metric descriptor. Only user-created // [custom metrics](https://cloud.google.com/monitoring/custom-metrics) can be // deleted. - rpc DeleteMetricDescriptor(DeleteMetricDescriptorRequest) returns (google.protobuf.Empty) { + rpc DeleteMetricDescriptor(DeleteMetricDescriptorRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v3/{name=projects/*/metricDescriptors/**}" }; option (google.api.method_signature) = "name"; } - // Lists time series that match a filter. This method does not require a Workspace. + // Lists time series that match a filter. rpc ListTimeSeries(ListTimeSeriesRequest) returns (ListTimeSeriesResponse) { option (google.api.http) = { get: "/v3/{name=projects/*}/timeSeries" - additional_bindings { - get: "/v3/{name=organizations/*}/timeSeries" - } - additional_bindings { - get: "/v3/{name=folders/*}/timeSeries" - } + additional_bindings { get: "/v3/{name=organizations/*}/timeSeries" } + additional_bindings { get: "/v3/{name=folders/*}/timeSeries" } }; option (google.api.method_signature) = "name,filter,interval,view"; } @@ -145,7 +148,11 @@ service MetricService { // 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. - rpc CreateTimeSeries(CreateTimeSeriesRequest) returns (google.protobuf.Empty) { + // This method does not support + // [resource locations constraint of an organization + // policy](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy). + rpc CreateTimeSeries(CreateTimeSeriesRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v3/{name=projects/*}/timeSeries" body: "*" @@ -162,7 +169,8 @@ service MetricService { // This method is only for use by Google Cloud services. Use // [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries] // instead. - rpc CreateServiceTimeSeries(CreateTimeSeriesRequest) returns (google.protobuf.Empty) { + rpc CreateServiceTimeSeries(CreateTimeSeriesRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v3/{name=projects/*}/timeSeries:createService" body: "*" @@ -173,8 +181,9 @@ service MetricService { // The `ListMonitoredResourceDescriptors` request. message ListMonitoredResourceDescriptorsRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - // which to execute the request. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which + // to execute the request. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 5 [ @@ -231,8 +240,9 @@ message GetMonitoredResourceDescriptorRequest { // The `ListMetricDescriptors` request. message ListMetricDescriptorsRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - // which to execute the request. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which + // to execute the request. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 5 [ @@ -252,7 +262,9 @@ message ListMetricDescriptorsRequest { // metric.type = starts_with("custom.googleapis.com/") string filter = 2; - // A positive number that is the maximum number of results to return. + // A positive number that is the maximum number of results to return. The + // default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is + // submitted, will instead return a maximum of 10,000 results. int32 page_size = 3; // If this field is not empty then it must contain the `nextPageToken` value @@ -275,7 +287,8 @@ message ListMetricDescriptorsResponse { // The `GetMetricDescriptor` request. message GetMetricDescriptorRequest { - // Required. The metric descriptor on which to execute the request. The format is: + // Required. The metric descriptor on which to execute the request. The format + // is: // // projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] // @@ -291,8 +304,9 @@ message GetMetricDescriptorRequest { // The `CreateMetricDescriptor` request. message CreateMetricDescriptorRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - // which to execute the request. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which + // to execute the request. The format is: // 4 // projects/[PROJECT_ID_OR_NUMBER] string name = 3 [ @@ -302,14 +316,16 @@ message CreateMetricDescriptorRequest { } ]; - // Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics) - // descriptor. - google.api.MetricDescriptor metric_descriptor = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The new [custom + // metric](https://cloud.google.com/monitoring/custom-metrics) descriptor. + google.api.MetricDescriptor metric_descriptor = 2 + [(google.api.field_behavior) = REQUIRED]; } // The `DeleteMetricDescriptor` request. message DeleteMetricDescriptorRequest { - // Required. The metric descriptor on which to execute the request. The format is: + // Required. The metric descriptor on which to execute the request. The format + // is: // // projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] // @@ -325,7 +341,7 @@ message DeleteMetricDescriptorRequest { // The `ListTimeSeries` request. message ListTimeSeriesRequest { - // Controls which fields are returned by `ListTimeSeries`. + // Controls which fields are returned by `ListTimeSeries*`. enum TimeSeriesView { // Returns the identity of the metric(s), the time series, // and the time series data. @@ -336,7 +352,8 @@ message ListTimeSeriesRequest { HEADERS = 1; } - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name), + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name), // organization or folder on which to execute the request. The format is: // // projects/[PROJECT_ID_OR_NUMBER] @@ -349,18 +366,19 @@ message ListTimeSeriesRequest { } ]; - // Required. A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters) - // 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: + // Required. A [monitoring + // filter](https://cloud.google.com/monitoring/api/v3/filters) 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: // // metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND // metric.labels.instance_name = "my-instance-name" string filter = 2 [(google.api.field_behavior) = REQUIRED]; - // 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. + // 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. TimeInterval interval = 4 [(google.api.field_behavior) = REQUIRED]; // Specifies the alignment of data points in individual time series as @@ -419,8 +437,9 @@ message ListTimeSeriesResponse { // The `CreateTimeSeries` request. message CreateTimeSeriesRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - // which to execute the request. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which + // to execute the request. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 3 [ @@ -472,8 +491,9 @@ message CreateTimeSeriesSummary { // The `QueryTimeSeries` request. message QueryTimeSeriesRequest { - // Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on - // which to execute the request. The format is: + // Required. The + // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which + // to execute the request. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string name = 1 [(google.api.field_behavior) = REQUIRED]; diff --git a/google/monitoring/v3/monitoring.yaml b/google/monitoring/v3/monitoring.yaml index fe3ee5592ae83..9e94026cda066 100644 --- a/google/monitoring/v3/monitoring.yaml +++ b/google/monitoring/v3/monitoring.yaml @@ -4,6 +4,7 @@ name: monitoring.googleapis.com title: Cloud Monitoring API apis: +- name: google.longrunning.Operations - name: google.monitoring.v3.AlertPolicyService - name: google.monitoring.v3.GroupService - name: google.monitoring.v3.MetricService @@ -20,29 +21,6 @@ types: documentation: summary: Manages your Cloud Monitoring data and configurations. -backend: - rules: - - selector: 'google.monitoring.v3.AlertPolicyService.*' - deadline: 30.0 - - selector: 'google.monitoring.v3.GroupService.*' - deadline: 30.0 - - selector: google.monitoring.v3.GroupService.UpdateGroup - deadline: 180.0 - - selector: 'google.monitoring.v3.MetricService.*' - deadline: 30.0 - - selector: google.monitoring.v3.MetricService.CreateServiceTimeSeries - deadline: 12.0 - - selector: google.monitoring.v3.MetricService.CreateTimeSeries - deadline: 12.0 - - selector: google.monitoring.v3.MetricService.ListTimeSeries - deadline: 90.0 - - selector: 'google.monitoring.v3.NotificationChannelService.*' - deadline: 30.0 - - selector: google.monitoring.v3.QueryService.QueryTimeSeries - deadline: 90.0 - - selector: 'google.monitoring.v3.SnoozeService.*' - deadline: 30.0 - authentication: rules: - selector: google.longrunning.Operations.GetOperation diff --git a/google/monitoring/v3/mutation_record.proto b/google/monitoring/v3/mutation_record.proto index bfad65ff4ec7b..7753517d40b24 100644 --- a/google/monitoring/v3/mutation_record.proto +++ b/google/monitoring/v3/mutation_record.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/google/monitoring/v3/query_service.proto b/google/monitoring/v3/query_service.proto index 5d45124d6ab44..1e75953d84e9c 100644 --- a/google/monitoring/v3/query_service.proto +++ b/google/monitoring/v3/query_service.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -17,8 +17,8 @@ syntax = "proto3"; package google.monitoring.v3; import "google/api/annotations.proto"; -import "google/monitoring/v3/metric_service.proto"; import "google/api/client.proto"; +import "google/monitoring/v3/metric_service.proto"; option csharp_namespace = "Google.Cloud.Monitoring.V3"; option go_package = "cloud.google.com/go/monitoring/apiv3/v2/monitoringpb;monitoringpb"; @@ -28,7 +28,7 @@ option java_package = "com.google.monitoring.v3"; option php_namespace = "Google\\Cloud\\Monitoring\\V3"; option ruby_package = "Google::Cloud::Monitoring::V3"; -// The QueryService API is used to manage time series data in Stackdriver +// The QueryService API is used to manage time series data in Cloud // Monitoring. Time series data is a collection of data points that describes // the time-varying values of a metric. service QueryService { @@ -38,8 +38,9 @@ service QueryService { "https://www.googleapis.com/auth/monitoring," "https://www.googleapis.com/auth/monitoring.read"; - // Queries time series using Monitoring Query Language. This method does not require a Workspace. - rpc QueryTimeSeries(QueryTimeSeriesRequest) returns (QueryTimeSeriesResponse) { + // Queries time series using Monitoring Query Language. + rpc QueryTimeSeries(QueryTimeSeriesRequest) + returns (QueryTimeSeriesResponse) { option (google.api.http) = { post: "/v3/{name=projects/*}/timeSeries:query" body: "*" diff --git a/google/monitoring/v3/service_service.proto b/google/monitoring/v3/service_service.proto index bc55a48ff55f6..0a9d317d782be 100644 --- a/google/monitoring/v3/service_service.proto +++ b/google/monitoring/v3/service_service.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -33,9 +33,9 @@ option php_namespace = "Google\\Cloud\\Monitoring\\V3"; option ruby_package = "Google::Cloud::Monitoring::V3"; // 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. +// managing and querying aspects of a Metrics Scope's services. These include +// the `Service`'s monitored resources, its Service-Level Objectives, and a +// taxonomy of categorized Health Metrics. service ServiceMonitoringService { option (google.api.default_host) = "monitoring.googleapis.com"; option (google.api.oauth_scopes) = @@ -60,7 +60,7 @@ service ServiceMonitoringService { option (google.api.method_signature) = "name"; } - // List `Service`s for this workspace. + // List `Service`s for this Metrics Scope. rpc ListServices(ListServicesRequest) returns (ListServicesResponse) { option (google.api.http) = { get: "/v3/{parent=*/*}/services" @@ -86,7 +86,8 @@ service ServiceMonitoringService { } // Create a `ServiceLevelObjective` for the given `Service`. - rpc CreateServiceLevelObjective(CreateServiceLevelObjectiveRequest) returns (ServiceLevelObjective) { + rpc CreateServiceLevelObjective(CreateServiceLevelObjectiveRequest) + returns (ServiceLevelObjective) { option (google.api.http) = { post: "/v3/{parent=*/*/services/*}/serviceLevelObjectives" body: "service_level_objective" @@ -95,7 +96,8 @@ service ServiceMonitoringService { } // Get a `ServiceLevelObjective` by name. - rpc GetServiceLevelObjective(GetServiceLevelObjectiveRequest) returns (ServiceLevelObjective) { + rpc GetServiceLevelObjective(GetServiceLevelObjectiveRequest) + returns (ServiceLevelObjective) { option (google.api.http) = { get: "/v3/{name=*/*/services/*/serviceLevelObjectives/*}" }; @@ -103,7 +105,8 @@ service ServiceMonitoringService { } // List the `ServiceLevelObjective`s for the given `Service`. - rpc ListServiceLevelObjectives(ListServiceLevelObjectivesRequest) returns (ListServiceLevelObjectivesResponse) { + rpc ListServiceLevelObjectives(ListServiceLevelObjectivesRequest) + returns (ListServiceLevelObjectivesResponse) { option (google.api.http) = { get: "/v3/{parent=*/*/services/*}/serviceLevelObjectives" }; @@ -111,7 +114,8 @@ service ServiceMonitoringService { } // Update the given `ServiceLevelObjective`. - rpc UpdateServiceLevelObjective(UpdateServiceLevelObjectiveRequest) returns (ServiceLevelObjective) { + rpc UpdateServiceLevelObjective(UpdateServiceLevelObjectiveRequest) + returns (ServiceLevelObjective) { option (google.api.http) = { patch: "/v3/{service_level_objective.name=*/*/services/*/serviceLevelObjectives/*}" body: "service_level_objective" @@ -120,7 +124,8 @@ service ServiceMonitoringService { } // Delete the given `ServiceLevelObjective`. - rpc DeleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest) returns (google.protobuf.Empty) { + rpc DeleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v3/{name=*/*/services/*/serviceLevelObjectives/*}" }; @@ -130,8 +135,9 @@ service ServiceMonitoringService { // The `CreateService` request. message CreateServiceRequest { - // Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of - // the parent workspace. The format is: + // Required. Resource + // [name](https://cloud.google.com/monitoring/api/v3#project_name) of the + // parent Metrics Scope. The format is: // // projects/[PROJECT_ID_OR_NUMBER] string parent = 1 [ @@ -164,9 +170,9 @@ message GetServiceRequest { // The `ListServices` request. message ListServicesRequest { - // Required. Resource name of the parent containing the listed services, either a - // [project](https://cloud.google.com/monitoring/api/v3#project_name) or a - // Monitoring Workspace. The formats are: + // Required. Resource name of the parent containing the listed services, + // either a [project](https://cloud.google.com/monitoring/api/v3#project_name) + // or a Monitoring Metrics Scope. The formats are: // // projects/[PROJECT_ID_OR_NUMBER] // workspaces/[HOST_PROJECT_ID_OR_NUMBER] @@ -177,25 +183,24 @@ message ListServicesRequest { } ]; - // A filter specifying what `Service`s to return. The filter currently - // supports the following fields: + // A filter specifying what `Service`s to return. The filter supports + // filtering on a particular service-identifier type or one of its attributes. // - // - `identifier_case` - // - `app_engine.module_id` - // - `cloud_endpoints.service` (reserved for future use) - // - `mesh_istio.mesh_uid` - // - `mesh_istio.service_namespace` - // - `mesh_istio.service_name` - // - `cluster_istio.location` (deprecated) - // - `cluster_istio.cluster_name` (deprecated) - // - `cluster_istio.service_namespace` (deprecated) - // - `cluster_istio.service_name` (deprecated) + // To filter on a particular service-identifier type, the `identifier_case` + // refers to which option in the `identifier` field is populated. For example, + // the filter `identifier_case = "CUSTOM"` would match all services with a + // value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", + // "MESH_ISTIO", and the other options listed at + // https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service // - // `identifier_case` refers to which option in the identifier oneof is - // populated. For example, the filter `identifier_case = "CUSTOM"` would match - // all services with a value for the `custom` field. Valid options are - // "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) - // and "CLOUD_ENDPOINTS" (reserved for future use). + // To filter on an attribute of a service-identifier type, apply the filter + // name by using the snake case of the service-identifier type and the + // attribute of that service-identifier type, and join the two with a period. + // For example, to filter by the `meshUid` field of the `MeshIstio` + // service-identifier type, you must filter on `mesh_istio.mesh_uid = + // "123"` to match all services with mesh UID "123". Service-identifier types + // and their attributes are described at + // https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service string filter = 2; // A non-negative number that is the maximum number of results to return. @@ -256,18 +261,20 @@ message CreateServiceLevelObjectiveRequest { // Optional. The ServiceLevelObjective id to use for this // ServiceLevelObjective. If omitted, an id will be generated instead. Must - // match the pattern `[a-z0-9\-]+` + // match the pattern `^[a-zA-Z0-9-_:.]+$` string service_level_objective_id = 3; // Required. The `ServiceLevelObjective` to create. // The provided `name` will be respected if no `ServiceLevelObjective` exists // with this name. - ServiceLevelObjective service_level_objective = 2 [(google.api.field_behavior) = REQUIRED]; + ServiceLevelObjective service_level_objective = 2 + [(google.api.field_behavior) = REQUIRED]; } // The `GetServiceLevelObjective` request. message GetServiceLevelObjectiveRequest { - // Required. Resource name of the `ServiceLevelObjective` to get. The format is: + // Required. Resource name of the `ServiceLevelObjective` to get. The format + // is: // // projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] string name = 1 [ @@ -287,7 +294,7 @@ message GetServiceLevelObjectiveRequest { // The `ListServiceLevelObjectives` request. message ListServiceLevelObjectivesRequest { // Required. Resource name of the parent containing the listed SLOs, either a - // project or a Monitoring Workspace. The formats are: + // project or a Monitoring Metrics Scope. The formats are: // // projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] // workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/- @@ -332,7 +339,8 @@ message ListServiceLevelObjectivesResponse { message UpdateServiceLevelObjectiveRequest { // Required. The `ServiceLevelObjective` to draw updates from. // The given `name` specifies the resource to update. - ServiceLevelObjective service_level_objective = 1 [(google.api.field_behavior) = REQUIRED]; + ServiceLevelObjective service_level_objective = 1 + [(google.api.field_behavior) = REQUIRED]; // A set of field paths defining which fields to use for the update. google.protobuf.FieldMask update_mask = 2; @@ -340,7 +348,8 @@ message UpdateServiceLevelObjectiveRequest { // The `DeleteServiceLevelObjective` request. message DeleteServiceLevelObjectiveRequest { - // Required. Resource name of the `ServiceLevelObjective` to delete. The format is: + // Required. Resource name of the `ServiceLevelObjective` to delete. The + // format is: // // projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] string name = 1 [ diff --git a/google/monitoring/v3/span_context.proto b/google/monitoring/v3/span_context.proto index 2488e5dadb2eb..da02a138a1b64 100644 --- a/google/monitoring/v3/span_context.proto +++ b/google/monitoring/v3/span_context.proto @@ -1,4 +1,4 @@ -// Copyright 2021 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License.