google-cloud-logging-v2 0.5.1 → 0.5.5

data/proto_docs/google/api/metric.rb

@@ -28,11 +28,12 @@ module Google
     # @!attribute [rw] type
     #   @return [::String]
     #     The metric type, including its DNS name prefix. The type is not
-    #     URL-encoded.  All user-defined custom metric types have the DNS name
-    #     `custom.googleapis.com`.  Metric types should use a natural hierarchical
-    #     grouping. For example:
+    #     URL-encoded. All user-defined metric types have the DNS name
+    #     `custom.googleapis.com` or `external.googleapis.com`. Metric types should
+    #     use a natural hierarchical grouping. For example:
     #
     #         "custom.googleapis.com/invoice/paid/amount"
+    #         "external.googleapis.com/prometheus/up"
     #         "appengine.googleapis.com/http/server/response_latencies"
     # @!attribute [rw] labels
     #   @return [::Array<::Google::Api::LabelDescriptor>]
@@ -52,10 +53,28 @@ module Google
     #     Some combinations of `metric_kind` and `value_type` might not be supported.
     # @!attribute [rw] unit
     #   @return [::String]
-    #     The unit in which the metric value is reported. It is only applicable
-    #     if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
-    #     supported units are a subset of [The Unified Code for Units of
-    #     Measure](http://unitsofmeasure.org/ucum.html) standard:
+    #     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.
+    #
+    #     Different systems might scale the values to be more easily displayed (so a
+    #     value of `0.02kBy` _might_ be displayed as `20By`, and a value of
+    #     `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
+    #     `kBy`, then the value of the metric is always in thousands of bytes, no
+    #     matter how it might be displayed.
+    #
+    #     If you want a custom metric to record the exact number of CPU-seconds used
+    #     by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
+    #     `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
+    #     CPU-seconds, then the value is written as `12005`.
+    #
+    #     Alternatively, if you want a custom metric to record data in a more
+    #     granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
+    #     `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
+    #     or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
+    #
+    #     The supported units are a subset of [The Unified Code for Units of
+    #     Measure](https://unitsofmeasure.org/ucum.html) standard:
     #
     #     **Basic units (UNIT)**
     #
@@ -65,36 +84,44 @@ module Google
     #     * `min`   minute
     #     * `h`     hour
     #     * `d`     day
+    #     * `1`     dimensionless
     #
     #     **Prefixes (PREFIX)**
     #
-    #     * `k`     kilo    (10**3)
-    #     * `M`     mega    (10**6)
-    #     * `G`     giga    (10**9)
-    #     * `T`     tera    (10**12)
-    #     * `P`     peta    (10**15)
-    #     * `E`     exa     (10**18)
-    #     * `Z`     zetta   (10**21)
-    #     * `Y`     yotta   (10**24)
-    #     * `m`     milli   (10**-3)
-    #     * `u`     micro   (10**-6)
-    #     * `n`     nano    (10**-9)
-    #     * `p`     pico    (10**-12)
-    #     * `f`     femto   (10**-15)
-    #     * `a`     atto    (10**-18)
-    #     * `z`     zepto   (10**-21)
-    #     * `y`     yocto   (10**-24)
-    #     * `Ki`    kibi    (2**10)
-    #     * `Mi`    mebi    (2**20)
-    #     * `Gi`    gibi    (2**30)
-    #     * `Ti`    tebi    (2**40)
+    #     * `k`     kilo    (10^3)
+    #     * `M`     mega    (10^6)
+    #     * `G`     giga    (10^9)
+    #     * `T`     tera    (10^12)
+    #     * `P`     peta    (10^15)
+    #     * `E`     exa     (10^18)
+    #     * `Z`     zetta   (10^21)
+    #     * `Y`     yotta   (10^24)
+    #
+    #     * `m`     milli   (10^-3)
+    #     * `u`     micro   (10^-6)
+    #     * `n`     nano    (10^-9)
+    #     * `p`     pico    (10^-12)
+    #     * `f`     femto   (10^-15)
+    #     * `a`     atto    (10^-18)
+    #     * `z`     zepto   (10^-21)
+    #     * `y`     yocto   (10^-24)
+    #
+    #     * `Ki`    kibi    (2^10)
+    #     * `Mi`    mebi    (2^20)
+    #     * `Gi`    gibi    (2^30)
+    #     * `Ti`    tebi    (2^40)
+    #     * `Pi`    pebi    (2^50)
     #
     #     **Grammar**
     #
     #     The grammar also includes these connectors:
     #
-    #     * `/`    division (as an infix operator, e.g. `1/s`).
-    #     * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
+    #     * `/`    division or ratio (as an infix operator). For examples,
+    #              `kBy/{email}` or `MiBy/10ms` (although you should almost never
+    #              have `/s` in a metric `unit`; rates should always be computed at
+    #              query time from the underlying cumulative or delta value).
+    #     * `.`    multiplication or composition (as an infix operator). For
+    #              examples, `GBy.d` or `k{watt}.h`.
     #
     #     The grammar for a unit is as follows:
     #
@@ -109,14 +136,25 @@ module Google
     #
     #     Notes:
     #
-    #     * `Annotation` is just a comment if it follows a `UNIT` and is
-    #        equivalent to `1` if it is used alone. For examples,
-    #        `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
+    #     * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
+    #        is used alone, then the unit is equivalent to `1`. For examples,
+    #        `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
     #     * `NAME` is a sequence of non-blank printable ASCII characters not
-    #        containing '\\{' or '}'.
-    #     * `1` represents dimensionless value 1, such as in `1/s`.
-    #     * `%` represents dimensionless value 1/100, and annotates values giving
-    #        a percentage.
+    #        containing `{` or `}`.
+    #     * `1` represents a unitary [dimensionless
+    #        unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
+    #        as in `1/s`. It is typically used when none of the basic units are
+    #        appropriate. For example, "new users per day" can be represented as
+    #        `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
+    #        users). Alternatively, "thousands of page views per day" would be
+    #        represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
+    #        value of `5.3` would mean "5300 page views per day").
+    #     * `%` represents dimensionless value of 1/100, and annotates values giving
+    #        a percentage (so the metric values are typically in the range of 0..100,
+    #        and a metric value `3` means "3 percent").
+    #     * `10^2.%` indicates a metric contains a ratio, typically in the range
+    #        0..1, that will be multiplied by 100 and displayed as a percentage
+    #        (so a metric value `0.03` means "3 percent").
     # @!attribute [rw] description
     #   @return [::String]
     #     A detailed description of the metric, which can be used in documentation.
@@ -126,11 +164,46 @@ module Google
     #     Use sentence case without an ending period, for example "Request count".
     #     This field is optional but it is recommended to be set for any metrics
     #     associated with user-visible concepts, such as Quota.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Api::MetricDescriptor::MetricDescriptorMetadata]
+    #     Optional. Metadata which can be used to guide usage of the metric.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Optional. The launch stage of the metric definition.
+    # @!attribute [rw] monitored_resource_types
+    #   @return [::Array<::String>]
+    #     Read-only. If present, then a [time
+    #     series][google.monitoring.v3.TimeSeries], which is identified partially by
+    #     a metric type and a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor}, that is associated
+    #     with this metric type can only be associated with one of the monitored
+    #     resource types listed here.
     class MetricDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
 
+      # Additional annotations that can be used to guide the usage of a metric.
+      # @!attribute [rw] launch_stage
+      #   @return [::Google::Api::LaunchStage]
+      #     Deprecated. Must use the {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} instead.
+      # @!attribute [rw] sample_period
+      #   @return [::Google::Protobuf::Duration]
+      #     The sampling period of metric data points. For metrics which are written
+      #     periodically, consecutive data points are stored at this time interval,
+      #     excluding data loss due to errors. Metrics with a higher granularity have
+      #     a smaller sampling period.
+      # @!attribute [rw] ingest_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     The delay of data points caused by ingestion. Data points older than this
+      #     age are guaranteed to be ingested and available to be read, excluding
+      #     data loss due to errors.
+      class MetricDescriptorMetadata
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
       # The kind of measurement. It describes how the data is reported.
+      # For information on setting the start time and end time based on
+      # the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
       module MetricKind
         # Do not use this default value.
         METRIC_KIND_UNSPECIFIED = 0

data/proto_docs/google/api/monitored_resource.rb

@@ -40,7 +40,6 @@ module Google
     #   @return [::String]
     #     Required. The monitored resource type. For example, the type
     #     `"cloudsql_database"` represents databases in Google Cloud SQL.
-    #     The maximum length of this value is 256 characters.
     # @!attribute [rw] display_name
     #   @return [::String]
     #     Optional. A concise name for the monitored resource type that might be
@@ -56,6 +55,9 @@ module Google
     #     Required. A set of labels used to describe instances of this monitored
     #     resource type. For example, an individual Google Cloud SQL database is
     #     identified by values for the labels `"database_id"` and `"zone"`.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Optional. The launch stage of the monitored resource definition.
     class MonitoredResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -101,15 +103,14 @@ module Google
     # Auxiliary metadata for a {::Google::Api::MonitoredResource MonitoredResource} object.
     # {::Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
     # uniquely identify a monitored resource instance. There is some other useful
-    # auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
-    # pipeline to extract metadata for cloud resources of all types , and stores
+    # auxiliary metadata. Monitoring and Logging use an ingestion
+    # pipeline to extract metadata for cloud resources of all types, and store
     # the metadata in this message.
     # @!attribute [rw] system_labels
     #   @return [::Google::Protobuf::Struct]
     #     Output only. Values for predefined system metadata labels.
-    #     System labels are a kind of metadata extracted by Google Stackdriver.
-    #     Stackdriver determines what system labels are useful and how to obtain
-    #     their values. Some examples: "machine_image", "vpc", "subnet_id",
+    #     System labels are a kind of metadata extracted by Google, including
+    #     "machine_image", "vpc", "subnet_id",
     #     "security_group", "name", etc.
     #     System label values can be only strings, Boolean values, or a list of
     #     strings. For example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging-v2
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -185,8 +185,6 @@ files:
 - lib/google/cloud/logging/v2/metrics_service/credentials.rb
 - lib/google/cloud/logging/v2/metrics_service/paths.rb
 - lib/google/cloud/logging/v2/version.rb
-- lib/google/logging/type/http_request_pb.rb
-- lib/google/logging/type/log_severity_pb.rb
 - lib/google/logging/v2/log_entry_pb.rb
 - lib/google/logging/v2/logging_config_pb.rb
 - lib/google/logging/v2/logging_config_services_pb.rb
@@ -198,6 +196,7 @@ files:
 - proto_docs/google/api/distribution.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/label.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/metric.rb
 - proto_docs/google/api/monitored_resource.rb
 - proto_docs/google/api/resource.rb

data/lib/google/logging/type/http_request_pb.rb

@@ -1,38 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: google/logging/type/http_request.proto
-
-require 'google/protobuf'
-
-require 'google/protobuf/duration_pb'
-require 'google/api/annotations_pb'
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/logging/type/http_request.proto", :syntax => :proto3) do
-    add_message "google.logging.type.HttpRequest" do
-      optional :request_method, :string, 1
-      optional :request_url, :string, 2
-      optional :request_size, :int64, 3
-      optional :status, :int32, 4
-      optional :response_size, :int64, 5
-      optional :user_agent, :string, 6
-      optional :remote_ip, :string, 7
-      optional :server_ip, :string, 13
-      optional :referer, :string, 8
-      optional :latency, :message, 14, "google.protobuf.Duration"
-      optional :cache_lookup, :bool, 11
-      optional :cache_hit, :bool, 9
-      optional :cache_validated_with_origin_server, :bool, 10
-      optional :cache_fill_bytes, :int64, 12
-      optional :protocol, :string, 15
-    end
-  end
-end
-
-module Google
-  module Cloud
-    module Logging
-      module Type
-        HttpRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.type.HttpRequest").msgclass
-      end
-    end
-  end
-end

data/lib/google/logging/type/log_severity_pb.rb

@@ -1,31 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: google/logging/type/log_severity.proto
-
-require 'google/protobuf'
-
-require 'google/api/annotations_pb'
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/logging/type/log_severity.proto", :syntax => :proto3) do
-    add_enum "google.logging.type.LogSeverity" do
-      value :DEFAULT, 0
-      value :DEBUG, 100
-      value :INFO, 200
-      value :NOTICE, 300
-      value :WARNING, 400
-      value :ERROR, 500
-      value :CRITICAL, 600
-      value :ALERT, 700
-      value :EMERGENCY, 800
-    end
-  end
-end
-
-module Google
-  module Cloud
-    module Logging
-      module Type
-        LogSeverity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.type.LogSeverity").enummodule
-      end
-    end
-  end
-end