google-cloud-monitoring-v3 0.16.0 → 0.17.0

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

@@ -28,7 +28,7 @@ module Google
         # operational aspects of the service are accessible.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name for this Service. The format is:
+        #     Identifier. Resource name for this Service. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
         # @!attribute [rw] display_name
@@ -54,6 +54,24 @@ module Google
         #     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] cloud_run
+        #   @return [::Google::Cloud::Monitoring::V3::Service::CloudRun]
+        #     Type used for Cloud Run services.
+        # @!attribute [rw] gke_namespace
+        #   @return [::Google::Cloud::Monitoring::V3::Service::GkeNamespace]
+        #     Type used for GKE Namespaces.
+        # @!attribute [rw] gke_workload
+        #   @return [::Google::Cloud::Monitoring::V3::Service::GkeWorkload]
+        #     Type used for GKE Workloads.
+        # @!attribute [rw] gke_service
+        #   @return [::Google::Cloud::Monitoring::V3::Service::GkeService]
+        #     Type used for GKE Services (the Kubernetes concept of a service).
+        # @!attribute [rw] basic_service
+        #   @return [::Google::Cloud::Monitoring::V3::Service::BasicService]
+        #     Message that contains the service type and service labels of this service
+        #     if it is a basic service.
+        #     Documentation and examples
+        #     [here](https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
         # @!attribute [rw] telemetry
         #   @return [::Google::Cloud::Monitoring::V3::Service::Telemetry]
         #     Configuration for how to query telemetry on a Service.
@@ -69,8 +87,9 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Custom view of service telemetry. Currently a place-holder pending final
-          # design.
+          # Use a custom service to designate a service that you want to monitor
+          # when none of the other service types (like App Engine, Cloud Run, or
+          # a GKE type) matches your intended service.
           class Custom
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -80,8 +99,8 @@ module Google
           # @!attribute [rw] module_id
           #   @return [::String]
           #     The ID of the App Engine module underlying this service. Corresponds to
-          #     the `module_id` resource label in the `gae_app` monitored resource:
-          #     https://cloud.google.com/monitoring/api/resources#tag_gae_app
+          #     the `module_id` resource label in the [`gae_app` monitored
+          #     resource](https://cloud.google.com/monitoring/api/resources#tag_gae_app).
           class AppEngine
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -91,8 +110,8 @@ module Google
           # @!attribute [rw] service
           #   @return [::String]
           #     The name of the Cloud Endpoints service underlying this service.
-          #     Corresponds to the `service` resource label in the `api` monitored
-          #     resource: https://cloud.google.com/monitoring/api/resources#tag_api
+          #     Corresponds to the `service` resource label in the [`api` monitored
+          #     resource](https://cloud.google.com/monitoring/api/resources#tag_api).
           class CloudEndpoints
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -167,6 +186,129 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Cloud Run service. Learn more at https://cloud.google.com/run.
+          # @!attribute [rw] service_name
+          #   @return [::String]
+          #     The name of the Cloud Run service. Corresponds to the `service_name`
+          #     resource label in the [`cloud_run_revision` monitored
+          #     resource](https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     The location the service is run. Corresponds to the `location`
+          #     resource label in the [`cloud_run_revision` monitored
+          #     resource](https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).
+          class CloudRun
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # GKE Namespace. The field names correspond to the resource metadata labels
+          # on monitored resources that fall under a namespace (for example,
+          # `k8s_container` or `k8s_pod`).
+          # @!attribute [r] project_id
+          #   @return [::String]
+          #     Output only. The project this resource lives in. For legacy services
+          #     migrated from the `Custom` type, this may be a distinct project from the
+          #     one parenting the service itself.
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     The location of the parent cluster. This may be a zone or region.
+          # @!attribute [rw] cluster_name
+          #   @return [::String]
+          #     The name of the parent cluster.
+          # @!attribute [rw] namespace_name
+          #   @return [::String]
+          #     The name of this namespace.
+          class GkeNamespace
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond
+          # to the metadata labels on monitored resources that fall under a workload
+          # (for example, `k8s_container` or `k8s_pod`).
+          # @!attribute [r] project_id
+          #   @return [::String]
+          #     Output only. The project this resource lives in. For legacy services
+          #     migrated from the `Custom` type, this may be a distinct project from the
+          #     one parenting the service itself.
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     The location of the parent cluster. This may be a zone or region.
+          # @!attribute [rw] cluster_name
+          #   @return [::String]
+          #     The name of the parent cluster.
+          # @!attribute [rw] namespace_name
+          #   @return [::String]
+          #     The name of the parent namespace.
+          # @!attribute [rw] top_level_controller_type
+          #   @return [::String]
+          #     The type of this workload (for example, "Deployment" or "DaemonSet")
+          # @!attribute [rw] top_level_controller_name
+          #   @return [::String]
+          #     The name of this workload.
+          class GkeWorkload
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # GKE Service. The "service" here represents a
+          # [Kubernetes service
+          # object](https://kubernetes.io/docs/concepts/services-networking/service).
+          # The field names correspond to the resource labels on [`k8s_service`
+          # monitored
+          # resources](https://cloud.google.com/monitoring/api/resources#tag_k8s_service).
+          # @!attribute [r] project_id
+          #   @return [::String]
+          #     Output only. The project this resource lives in. For legacy services
+          #     migrated from the `Custom` type, this may be a distinct project from the
+          #     one parenting the service itself.
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     The location of the parent cluster. This may be a zone or region.
+          # @!attribute [rw] cluster_name
+          #   @return [::String]
+          #     The name of the parent cluster.
+          # @!attribute [rw] namespace_name
+          #   @return [::String]
+          #     The name of the parent namespace.
+          # @!attribute [rw] service_name
+          #   @return [::String]
+          #     The name of this service.
+          class GkeService
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A well-known service type, defined by its service type and service labels.
+          # Documentation and examples
+          # [here](https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
+          # @!attribute [rw] service_type
+          #   @return [::String]
+          #     The type of service that this basic service defines, e.g.
+          #     APP_ENGINE service type.
+          #     Documentation and valid values
+          #     [here](https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
+          # @!attribute [rw] service_labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Labels that specify the resource that emits the monitoring data which
+          #     is used for SLO reporting of this `Service`.
+          #     Documentation and valid values for given service types
+          #     [here](https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
+          class BasicService
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class ServiceLabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Configuration for how to query telemetry on a Service.
           # @!attribute [rw] resource_name
           #   @return [::String]
@@ -195,7 +337,7 @@ module Google
         # "99.5% of requests in each calendar month return successfully."
         # @!attribute [rw] name
         #   @return [::String]
-        #     Resource name for this `ServiceLevelObjective`. The format is:
+        #     Identifier. Resource name for this `ServiceLevelObjective`. The format is:
         #
         #         projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
         # @!attribute [rw] display_name

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

@@ -24,8 +24,9 @@ module Google
         # The `CreateService` request.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     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]
         # @!attribute [rw] service_id
@@ -54,33 +55,32 @@ module Google
         # The `ListServices` request.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     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]
         # @!attribute [rw] filter
         #   @return [::String]
-        #     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
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     A non-negative number that is the maximum number of results to return.
@@ -143,7 +143,7 @@ module Google
         #   @return [::String]
         #     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-_:.]+$`
         # @!attribute [rw] service_level_objective
         #   @return [::Google::Cloud::Monitoring::V3::ServiceLevelObjective]
         #     Required. The `ServiceLevelObjective` to create.
@@ -157,7 +157,8 @@ module Google
         # The `GetServiceLevelObjective` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     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]
         # @!attribute [rw] view
@@ -175,7 +176,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     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/-
@@ -232,7 +233,8 @@ module Google
         # The `DeleteServiceLevelObjective` request.
         # @!attribute [rw] name
         #   @return [::String]
-        #     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]
         class DeleteServiceLevelObjectiveRequest

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

@@ -79,11 +79,38 @@ module Google
           end
         end
 
+        # Describes a Synthetic Monitor to be invoked by Uptime.
+        # @!attribute [rw] cloud_function_v2
+        #   @return [::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget::CloudFunctionV2Target]
+        #     Target a Synthetic Monitor GCFv2 instance.
+        class SyntheticMonitorTarget
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A Synthetic Monitor deployed to a Cloud Functions V2 instance.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Fully qualified GCFv2 resource name
+          #     i.e. `projects/{project}/locations/{location}/functions/{function}`
+          #     Required.
+          # @!attribute [r] cloud_run_revision
+          #   @return [::Google::Api::MonitoredResource]
+          #     Output only. The `cloud_run_revision` Monitored Resource associated with
+          #     the GCFv2. The Synthetic Monitor execution results (metrics, logs, and
+          #     spans) are reported against this Monitored Resource. This field is output
+          #     only.
+          class CloudFunctionV2Target
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # This message configures which resources and services to monitor for
         # availability.
         # @!attribute [rw] name
         #   @return [::String]
-        #     A unique resource name for this Uptime check configuration. The format is:
+        #     Identifier. A unique resource name for this Uptime check configuration. The
+        #     format is:
         #
         #          projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
         #
@@ -115,6 +142,9 @@ module Google
         # @!attribute [rw] resource_group
         #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup]
         #     The group resource associated with the configuration.
+        # @!attribute [rw] synthetic_monitor
+        #   @return [::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget]
+        #     Specifies a Synthetic Monitor to invoke.
         # @!attribute [rw] http_check
         #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck]
         #     Contains information needed to make an HTTP or HTTPS check.
@@ -226,6 +256,7 @@ module Google
           #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
           #     The authentication information. Optional when creating an HTTP check;
           #     defaults to empty.
+          #     Do not set both `auth_method` and `auth_info`.
           # @!attribute [rw] mask_headers
           #   @return [::Boolean]
           #     Boolean specifying whether to encrypt the header information.
@@ -287,6 +318,11 @@ module Google
           # @!attribute [rw] ping_config
           #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig]
           #     Contains information needed to add pings to an HTTP check.
+          # @!attribute [rw] service_agent_authentication
+          #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication]
+          #     If specified, Uptime will generate and attach an OIDC JWT token for the
+          #     Monitoring service agent service account as an `Authorization` header
+          #     in the HTTP request when probing.
           class HttpCheck
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -343,6 +379,28 @@ module Google
               end
             end
 
+            # Contains information needed for generating an
+            # [OpenID Connect
+            # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+            # The OIDC token will be generated for the Monitoring service agent service
+            # account.
+            # @!attribute [rw] type
+            #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
+            #     Type of authentication.
+            class ServiceAgentAuthentication
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Type of authentication.
+              module ServiceAgentAuthenticationType
+                # Default value, will result in OIDC Authentication.
+                SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0
+
+                # OIDC Authentication
+                OIDC_TOKEN = 1
+              end
+            end
+
             # @!attribute [rw] key
             #   @return [::String]
             # @!attribute [rw] value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-v3
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common