google-cloud-monitoring-v3 0.3.0 → 0.4.0

data/proto_docs/google/monitoring/v3/alert_service.rb

@@ -29,10 +29,11 @@ module Google
         #         projects/[PROJECT_ID_OR_NUMBER]
         #
         #     Note that this field names the parent container in which the alerting
-        #     policy will be written, not the name of the created policy. 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
-        #     `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
+        #     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 `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
         #     container.
         # @!attribute [rw] alert_policy
         #   @return [::Google::Cloud::Monitoring::V3::AlertPolicy]
@@ -104,6 +105,10 @@ module Google
         #     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 `page_token` in the next call to this method.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     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
         class ListAlertPoliciesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/monitoring/v3/common.rb

@@ -44,28 +44,34 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # 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. In no case can the end time be earlier than the start
-        # time.
+        # 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`](/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.
         #
-        # * For a `GAUGE` metric, the `startTime` value is technically optional; if
+        # * 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.
+        #   measurements. The end time of a new interval must be at least a
+        #   millisecond after the end time of the previous interval.
         #
-        # * For `DELTA` and `CUMULATIVE` metrics, the start time must be earlier
-        #   than the end time.
+        # * 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.
         #
-        # * In all cases, the start time of the next interval must be
-        #   at least a millisecond after the end time of the previous interval.
-        #   Because the interval is closed, if the start time of a new interval
-        #   is the same as the end time of the previous interval, data written
-        #   at the new start time could overwrite data written at the previous
-        #   end time.
+        # * For `CUMULATIVE` metrics, 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.
         # @!attribute [rw] end_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Required. The end of the time interval.
@@ -113,10 +119,13 @@ module Google
         #     time. This will be done before the per-series aligner can be applied to
         #     the data.
         #
-        #     The value must be at least 60 seconds. If a per-series aligner other than
-        #     `ALIGN_NONE` is specified, this field is required or an error is returned.
-        #     If no per-series aligner is specified, or the aligner `ALIGN_NONE` is
-        #     specified, then this field is ignored.
+        #     The value must be at least 60 seconds. If a per-series
+        #     aligner other than `ALIGN_NONE` is specified, this field is required or an
+        #     error is returned. If no per-series aligner is specified, or the aligner
+        #     `ALIGN_NONE` is specified, then this field is ignored.
+        #
+        #     The maximum value of the `alignment_period` is 104 weeks (2 years) for
+        #     charts, and 90,000 seconds (25 hours) for alerting policies.
         # @!attribute [rw] per_series_aligner
         #   @return [::Google::Cloud::Monitoring::V3::Aggregation::Aligner]
         #     An `Aligner` describes how to bring the data points in a single

data/proto_docs/google/monitoring/v3/dropped_labels.rb

@@ -21,16 +21,17 @@ module Google
   module Cloud
     module Monitoring
       module V3
-        # A set of (label, value) pairs which were dropped during aggregation, attached
-        # to google.api.Distribution.Exemplars in google.api.Distribution values during
-        # aggregation.
+        # 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.
         #
-        # These values are used in combination with the label values that remain on the
-        # aggregated Distribution timeseries to construct the full label set for the
-        # exemplar values.  The resulting full label set may be used to identify the
-        # specific task/job/instance (for example) which may be contributing to a
-        # long-tail, while allowing the storage savings of only storing aggregated
-        # distribution values for a large group.
+        # 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

data/proto_docs/google/monitoring/v3/metric.rb

@@ -56,8 +56,8 @@ module Google
         # @!attribute [rw] metadata
         #   @return [::Google::Api::MonitoredResourceMetadata]
         #     Output only. The associated monitored resource metadata. When reading a
-        #     a timeseries, this field will include metadata labels that are explicitly
-        #     named in the reduction. When creating a timeseries, this field is ignored.
+        #     time series, this field will include metadata labels that are explicitly
+        #     named in the reduction. When creating a time series, this field is ignored.
         # @!attribute [rw] metric_kind
         #   @return [::Google::Api::MetricDescriptor::MetricKind]
         #     The metric kind of the time series. When listing time series, this metric
@@ -87,12 +87,17 @@ module Google
         #     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 `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+        # @!attribute [rw] unit
+        #   @return [::String]
+        #     The units in which the metric value is reported. It is only applicable
+        #     if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
+        #     defines the representation of the stored metric values.
         class TimeSeries
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A descriptor for the labels and points in a timeseries.
+        # A descriptor for the labels and points in a time series.
         # @!attribute [rw] label_descriptors
         #   @return [::Array<::Google::Api::LabelDescriptor>]
         #     Descriptors for the labels.
@@ -113,6 +118,12 @@ module Google
           # @!attribute [rw] metric_kind
           #   @return [::Google::Api::MetricDescriptor::MetricKind]
           #     The value stream kind.
+          # @!attribute [rw] unit
+          #   @return [::String]
+          #     The unit in which `time_series` point values are reported. `unit`
+          #     follows the UCUM format for units as seen in
+          #     https://unitsofmeasure.org/ucum.html.
+          #     `unit` is only valid if `value_type` is INTEGER, DOUBLE, DISTRIBUTION.
           class ValueDescriptor
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/monitoring/v3/metric_service.rb

@@ -167,9 +167,12 @@ module Google
         # The `ListTimeSeries` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The project on which to execute the request. The format is:
+        #     Required. The project, organization or folder on which to execute the request. The
+        #     format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]
+        #         organizations/[ORGANIZATION_ID]
+        #         folders/[FOLDER_ID]
         # @!attribute [rw] filter
         #   @return [::String]
         #     Required. A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
@@ -191,6 +194,10 @@ module Google
         #
         #     By default (if no `aggregation` is explicitly specified), the raw time
         #     series data is returned.
+        # @!attribute [rw] secondary_aggregation
+        #   @return [::Google::Cloud::Monitoring::V3::Aggregation]
+        #     Apply a second aggregation after `aggregation` is applied. May only be
+        #     specified if `aggregation` is specified.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     Unsupported: must be left blank. The points in each time series are
@@ -239,6 +246,14 @@ module Google
         #   @return [::Array<::Google::Rpc::Status>]
         #     Query execution errors that may have caused the time series data returned
         #     to be incomplete.
+        # @!attribute [rw] unit
+        #   @return [::String]
+        #     The unit in which all `time_series` point values are reported. `unit`
+        #     follows the UCUM format for units as seen in
+        #     https://unitsofmeasure.org/ucum.html.
+        #     If different `time_series` have different units (for example, because they
+        #     come from different metric types, or a unit is absent), then `unit` will be
+        #     "\\{not_a_unit}".
         class ListTimeSeriesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -311,8 +326,9 @@ module Google
         #         projects/[PROJECT_ID_OR_NUMBER]
         # @!attribute [rw] query
         #   @return [::String]
-        #     Required. The query in the monitoring query language format. The default
-        #     time zone is in UTC.
+        #     Required. The query in the [Monitoring Query
+        #     Language](https://cloud.google.com/monitoring/mql/reference) format.
+        #     The default time zone is in UTC.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     A positive number that is the maximum number of time_series_data to return.

data/proto_docs/google/monitoring/v3/notification.rb

@@ -33,7 +33,10 @@ module Google
         #     In the above, `[TYPE]` is the value of the `type` field.
         # @!attribute [rw] type
         #   @return [::String]
-        #     The type of notification channel, such as "email", "sms", etc.
+        #     The type of notification channel, such as "email" and "sms". To view the
+        #     full list of channels, see
+        #     [Channel
+        #     descriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd).
         #     Notification channel types are globally unique.
         # @!attribute [rw] display_name
         #   @return [::String]
@@ -134,6 +137,12 @@ module Google
         #     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.
+        # @!attribute [rw] creation_record
+        #   @return [::Google::Cloud::Monitoring::V3::MutationRecord]
+        #     Record of the creation of this channel.
+        # @!attribute [rw] mutation_records
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::MutationRecord>]
+        #     Records of the modification of this channel.
         class NotificationChannel
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/monitoring/v3/notification_service.rb

@@ -147,6 +147,10 @@ module Google
         #     the request. Use the value in the `page_token` field in a
         #     subsequent request to fetch the next set of results. If empty,
         #     all results have been returned.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     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
         class ListNotificationChannelsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/monitoring/v3/service.rb

@@ -49,6 +49,11 @@ module Google
         # @!attribute [rw] mesh_istio
         #   @return [::Google::Cloud::Monitoring::V3::Service::MeshIstio]
         #     Type used for Istio services scoped to an Istio mesh.
+        # @!attribute [rw] istio_canonical_service
+        #   @return [::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService]
+        #     Type used for canonical services scoped to an Istio mesh.
+        #     Metrics for Istio are
+        #     [documented here](https://istio.io/latest/docs/reference/config/metrics/)
         # @!attribute [rw] telemetry
         #   @return [::Google::Cloud::Monitoring::V3::Service::Telemetry]
         #     Configuration for how to query telemetry on a Service.
@@ -86,7 +91,8 @@ module Google
           end
 
           # Istio service scoped to a single Kubernetes cluster. Learn more at
-          # http://istio.io.
+          # https://istio.io. Clusters running OSS Istio will have their services
+          # ingested as this type.
           # @!attribute [rw] location
           #   @return [::String]
           #     The location of the Kubernetes cluster in which this Istio service is
@@ -110,7 +116,8 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Istio service scoped to an Istio mesh
+          # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8
+          # will have their services ingested as this type.
           # @!attribute [rw] mesh_uid
           #   @return [::String]
           #     Identifier for the mesh in which this Istio service is defined.
@@ -128,6 +135,30 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >=
+          # 1.6.8 will have their services ingested as this type.
+          # @!attribute [rw] mesh_uid
+          #   @return [::String]
+          #     Identifier for the Istio mesh in which this canonical service is defined.
+          #     Corresponds to the `mesh_uid` metric label in
+          #     [Istio metrics](https://cloud.google.com/monitoring/api/metrics_istio).
+          # @!attribute [rw] canonical_service_namespace
+          #   @return [::String]
+          #     The namespace of the canonical service underlying this service.
+          #     Corresponds to the `destination_canonical_service_namespace` metric
+          #     label in [Istio
+          #     metrics](https://cloud.google.com/monitoring/api/metrics_istio).
+          # @!attribute [rw] canonical_service
+          #   @return [::String]
+          #     The name of the canonical service underlying this service.
+          #     Corresponds to the `destination_canonical_service_name` metric label in
+          #     label in [Istio
+          #     metrics](https://cloud.google.com/monitoring/api/metrics_istio).
+          class IstioCanonicalService
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Configuration for how to query telemetry on a Service.
           # @!attribute [rw] resource_name
           #   @return [::String]

data/proto_docs/google/monitoring/v3/service_service.rb

@@ -65,16 +65,20 @@ module Google
         #
         #         - `identifier_case`
         #         - `app_engine.module_id`
-        #         - `cloud_endpoints.service`
-        #         - `cluster_istio.location`
-        #         - `cluster_istio.cluster_name`
-        #         - `cluster_istio.service_namespace`
-        #         - `cluster_istio.service_name`
+        #         - `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)
         #
         #     `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", "CLOUD_ENDPOINTS", and "CLUSTER_ISTIO".
+        #     "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated)
+        #     and "CLOUD_ENDPOINTS" (reserved for future use).
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     A non-negative number that is the maximum number of results to return.

data/proto_docs/google/monitoring/v3/uptime.rb

@@ -86,6 +86,9 @@ module Google
         #
         #          projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
         #
+        #     `[PROJECT_ID_OR_NUMBER]` is the Workspace host project associated with the
+        #     Uptime check.
+        #
         #     This field should be omitted when creating the Uptime check configuration;
         #     on create, the resource name is assigned by the server and included in the
         #     response.
@@ -172,7 +175,8 @@ module Google
           # Information involved in an HTTP/HTTPS Uptime check request.
           # @!attribute [rw] request_method
           #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
-          #     The HTTP request method to use for the check.
+          #     The HTTP request method to use for the check. If set to
+          #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
           # @!attribute [rw] use_ssl
           #   @return [::Boolean]
           #     If `true`, use HTTPS instead of HTTP to run the check.
@@ -195,7 +199,7 @@ module Google
           #     defaults to empty.
           # @!attribute [rw] mask_headers
           #   @return [::Boolean]
-          #     Boolean specifiying whether to encrypt the header information.
+          #     Boolean specifying whether to encrypt the header information.
           #     Encryption should be specified for any headers related to authentication
           #     that you do not wish to be seen when retrieving the configuration. The
           #     server will be responsible for encrypting the headers.
@@ -213,7 +217,14 @@ module Google
           #     The maximum number of headers allowed is 100.
           # @!attribute [rw] content_type
           #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType]
-          #     The content type to use for the check.
+          #     The content type header to use for the check. The following
+          #     configurations result in errors:
+          #     1. Content type is specified in both the `headers` field and the
+          #     `content_type` field.
+          #     2. Request method is `GET` and `content_type` is not `TYPE_UNSPECIFIED`
+          #     3. Request method is `POST` and `content_type` is `TYPE_UNSPECIFIED`.
+          #     4. Request method is `POST` and a "Content-Type" header is provided via
+          #     `headers` field. The `content_type` field should be used instead.
           # @!attribute [rw] validate_ssl
           #   @return [::Boolean]
           #     Boolean specifying whether to include SSL certificate validation as a
@@ -222,11 +233,14 @@ module Google
           #     setting `validate_ssl` to `true` has no effect.
           # @!attribute [rw] body
           #   @return [::String]
-          #     The request body associated with the HTTP request. If `content_type` is
-          #     `URL_ENCODED`, the body passed in must be URL-encoded. Users can provide
-          #     a `Content-Length` header via the `headers` field or the API will do
-          #     so. The maximum byte size is 1 megabyte. Note: As with all `bytes` fields
-          #     JSON representations are base64 encoded.
+          #     The request body associated with the HTTP POST request. If `content_type`
+          #     is `URL_ENCODED`, the body passed in must be URL-encoded. Users can
+          #     provide a `Content-Length` header via the `headers` field or the API will
+          #     do so. If the `request_method` is `GET` and `body` is not empty, the API
+          #     will return an error. The maximum byte size is 1 megabyte. Note: As with
+          #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
+          #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
+          #     "Zm9vJTI1M0RiYXI=".
           class HttpCheck
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -267,12 +281,9 @@ module Google
               POST = 2
             end
 
-            # Header options corresponding to the Content-Type of the body in HTTP
-            # requests. Note that a `Content-Type` header cannot be present in the
-            # `headers` field if this field is specified.
+            # Header options corresponding to the content type of a HTTP request body.
             module ContentType
-              # No content type specified. If the request method is POST, an
-              # unspecified content type results in a check creation rejection.
+              # No content type specified.
               TYPE_UNSPECIFIED = 0
 
               # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-v3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,9 @@ files:
 - lib/google/cloud/monitoring/v3/notification_channel_service/client.rb
 - lib/google/cloud/monitoring/v3/notification_channel_service/credentials.rb
 - lib/google/cloud/monitoring/v3/notification_channel_service/paths.rb
+- lib/google/cloud/monitoring/v3/query_service.rb
+- lib/google/cloud/monitoring/v3/query_service/client.rb
+- lib/google/cloud/monitoring/v3/query_service/credentials.rb
 - lib/google/cloud/monitoring/v3/service_monitoring_service.rb
 - lib/google/cloud/monitoring/v3/service_monitoring_service/client.rb
 - lib/google/cloud/monitoring/v3/service_monitoring_service/credentials.rb
@@ -206,6 +209,8 @@ files:
 - lib/google/monitoring/v3/notification_pb.rb
 - lib/google/monitoring/v3/notification_service_pb.rb
 - lib/google/monitoring/v3/notification_service_services_pb.rb
+- lib/google/monitoring/v3/query_service_pb.rb
+- lib/google/monitoring/v3/query_service_services_pb.rb
 - lib/google/monitoring/v3/service_pb.rb
 - lib/google/monitoring/v3/service_service_pb.rb
 - lib/google/monitoring/v3/service_service_services_pb.rb