google-cloud-logging 1.5.4 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c186c4f38de2474a1a806259d215e3613ccea28d09011b3ad7b9c08421aae52f
-  data.tar.gz: d17ddc92fd9783853bb4efb7edba4be0aaa6bea9f45bb8d04147a17f6f8c191e
+  metadata.gz: 5cabe641ea9b231603ff1ec5dd90876723acbb111fa200a293fd661ef2cb9c1d
+  data.tar.gz: 4b828ba6797ba1465a594deca80e4eff19f8d020a1471057b46a521df787a13b
 SHA512:
-  metadata.gz: 5e8c71b129fa26d8f3061fee8e7f66dca3942467cf844f650d47322f586d18c9a381251f7afd05767f22b87b81538182a8ae6cc82aa4003e98e0e7feee7d8ca6
-  data.tar.gz: e13b593778894c9df313fb513ef9c16496961243342ac36523a12d98192fc65a82c5bfa740e5ec597d304805cf829eb39452f386d1900d0a30ee28e813aa60a8
+  metadata.gz: dcea1515ca1c9ec282d9db850646bc2279db32c59b6214d84a8656e9605ded07f0213f57f3e4884170fb43b5486110425f890cfff32da30604f6f342f524352a
+  data.tar.gz: 0f1f1586220415cd0ce7aa654f07dc779a5efebb22fbf79bbac1bea942c49a35dac0d814d7a20a21341fecc411108d467be41a5fd15cfcc99ed5aa08ad3996df

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History
 
+### 1.5.5 / 2018-09-20
+
+* Make Logger thread-safe.
+* Update Logging generated files.
+  * Add Metric's MetricDescriptorMetadata.
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+* Fix circular require warning.
+
 ### 1.5.4 / 2018-09-12
 
 * Add missing documentation files to package.

data/INSTRUMENTATION.md

@@ -16,7 +16,7 @@ if you want to run on a non Google Cloud environment or you want to customize
 the default behavior.
 
 See the 
-[Configuration Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+[Configuration Guide](https://googleapis.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
 for full configuration parameters.
 
 ## Using instrumentation with Ruby on Rails

data/LOGGING.md

@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
 that you set may be a Ruby stdlib
 [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
-[`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
 that will write logs to [Stackdriver
 Logging](https://cloud.google.com/logging/). See
 [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)

data/lib/google-cloud-logging.rb

@@ -20,7 +20,7 @@
 
 
 gem "google-cloud-core"
-require "google/cloud"
+require "google/cloud" unless defined? Google::Cloud.new
 require "google/cloud/config"
 require "googleauth"
 

data/lib/google/cloud/logging.rb

@@ -138,7 +138,7 @@ module Google
       #   Rack environment.
       #
       # See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
+      # Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
       # for full configuration parameters.
       #
       # @return [Google::Cloud::Config] The configuration object

data/lib/google/cloud/logging/logger.rb

@@ -14,6 +14,8 @@
 
 
 require "logger"
+require "monitor"
+require "thread"
 
 module Google
   module Cloud
@@ -51,6 +53,8 @@ module Google
       #   logger.info payload
       #
       class Logger
+        include MonitorMixin
+
         ##
         # A RequestInfo represents data about the request being handled by the
         # current thread. It is used to configure logs coming from that thread.
@@ -121,7 +125,9 @@ module Google
         # @deprecated Use request_info
         #
         def trace_ids
-          @request_info.inject({}) { |r, (k, v)| r[k] = v.trace_id }
+          synchronize do
+            @request_info_map.inject({}) { |r, (k, v)| r[k] = v.trace_id }
+          end
         end
 
         ##
@@ -166,7 +172,7 @@ module Google
           @resource = resource
           @labels = labels || {}
           @level = 0 # DEBUG is the default behavior
-          @request_info = {}
+          @request_info_map = {}
           @closed = false
           # Unused, but present for API compatibility
           @formatter = ::Logger::Formatter.new
@@ -176,6 +182,8 @@ module Google
           # The writer is usually a Project or AsyncWriter.
           logging = @writer.respond_to?(:logging) ? @writer.logging : @writer
           @project = logging.project if logging.respond_to? :project
+
+          super() # to init MonitorMixin
         end
 
         ##
@@ -302,6 +310,8 @@ module Google
         #   called when the logger is configured to show them.
         #
         def add severity, message = nil, progname = nil
+          return if @closed
+
           severity = derive_severity(severity) || ::Logger::UNKNOWN
           return true if severity < @level
 
@@ -430,7 +440,7 @@ module Google
         # @deprecated Use add_request_info
         #
         def add_trace_id trace_id
-          add_request_id trace_id: trace_id
+          add_request_info trace_id: trace_id
         end
 
         ##
@@ -448,17 +458,17 @@ module Google
         # @param [Hash, nil] env The request's Rack environment or `nil` if not
         #     available.
         #
-        def add_request_info info: nil,
-                             env: nil,
-                             trace_id: nil,
-                             log_name: nil
+        def add_request_info info: nil, env: nil, trace_id: nil, log_name: nil
           info ||= RequestInfo.new trace_id, log_name, env
-          @request_info[current_thread_id] = info
 
-          # Start removing old entries if hash gets too large.
-          # This should never happen, because middleware should automatically
-          # remove entries when a request is finished
-          @request_info.shift while @request_info.size > 10_000
+          synchronize do
+            @request_info_map[current_thread_id] = info
+
+            # Start removing old entries if hash gets too large.
+            # This should never happen, because middleware should automatically
+            # remove entries when a request is finished
+            @request_info_map.shift while @request_info_map.size > 10_000
+          end
 
           info
         end
@@ -470,7 +480,7 @@ module Google
         #     or `nil` if there is no data set.
         #
         def request_info
-          @request_info[current_thread_id]
+          synchronize { @request_info_map[current_thread_id] }
         end
 
         ##
@@ -479,7 +489,7 @@ module Google
         # @return [RequestInfo] The info that's being deleted
         #
         def delete_request_info
-          @request_info.delete current_thread_id
+          synchronize { @request_info_map.delete current_thread_id }
         end
 
         ##
@@ -552,14 +562,13 @@ module Google
 
           writer.write_entries entry, log_name: actual_log_name,
                                       resource: resource,
-                                      labels: entry_labels
+                                      labels: entry_labels(info)
         end
 
         ##
         # @private generate the labels hash for a log entry.
-        def entry_labels
+        def entry_labels info
           merged_labels = {}
-          info = request_info
 
           if info && !info.trace_id.nil?
             merged_labels["traceId"] = info.trace_id
@@ -568,7 +577,7 @@ module Google
             end
           end
 
-          request_env = info && request_info.env || {}
+          request_env = info && info.env || {}
 
           compute_labels(request_env).merge(merged_labels)
         end

data/lib/google/cloud/logging/middleware.rb

@@ -45,7 +45,7 @@ module Google
         #   specified, a default logger with be used.
         # @param [Hash] kwargs Hash of configuration settings. Used for
         #   backward API compatibility. See the [Configuration
-        #   Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
+        #   Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
         #   for the prefered way to set configuration parameters.
         #
         # @return [Google::Cloud::Logging::Middleware] A new

data/lib/google/cloud/logging/rails.rb

@@ -37,7 +37,7 @@ module Google
       # before the `Rails::Rack::Logger Middleware`, which allows it to set the
       # `env['rack.logger']` in place of Rails's default logger.
       # See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
+      # Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
       # on how to configure the Railtie and Middleware.
       #
       class Railtie < ::Rails::Railtie

data/lib/google/cloud/logging/v2/config_service_v2_client.rb

@@ -351,7 +351,7 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
           #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
           #
-          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -380,7 +380,7 @@ module Google
 
           # Creates a sink that exports specified log entries to a destination.  The
           # export of newly-ingested log entries begins immediately, unless the sink's
-          # +writer_identity+ is not permitted to write to the destination.  A sink can
+          # `writer_identity` is not permitted to write to the destination.  A sink can
           # export log entries only from the resource owning the sink.
           #
           # @param parent [String]
@@ -391,24 +391,24 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]"
           #       "folders/[FOLDER_ID]"
           #
-          #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
+          #   Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
           # @param sink [Google::Logging::V2::LogSink | Hash]
-          #   Required. The new sink, whose +name+ parameter is a sink identifier that
+          #   Required. The new sink, whose `name` parameter is a sink identifier that
           #   is not already in use.
           #   A hash of the same form as `Google::Logging::V2::LogSink`
           #   can also be provided.
           # @param unique_writer_identity [true, false]
-          #   Optional. Determines the kind of IAM identity returned as +writer_identity+
+          #   Optional. Determines the kind of IAM identity returned as `writer_identity`
           #   in the new sink.  If this value is omitted or set to false, and if the
-          #   sink's parent is a project, then the value returned as +writer_identity+ is
+          #   sink's parent is a project, then the value returned as `writer_identity` is
           #   the same group or service account used by Stackdriver Logging before the
           #   addition of writer identities to this API. The sink's destination must be
           #   in the same project as the sink itself.
           #
           #   If this field is set to true, or if the sink is owned by a non-project
-          #   resource such as an organization, then the value of +writer_identity+ will
+          #   resource such as an organization, then the value of `writer_identity` will
           #   be a unique service account used only for exports from the new sink.  For
-          #   more information, see +writer_identity+ in {Google::Logging::V2::LogSink LogSink}.
+          #   more information, see `writer_identity` in {Google::Logging::V2::LogSink LogSink}.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -423,7 +423,7 @@ module Google
           #   config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
           #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +sink+:
+          #   # TODO: Initialize `sink`:
           #   sink = {}
           #   response = config_service_v2_client.create_sink(formatted_parent, sink)
 
@@ -443,9 +443,9 @@ module Google
           end
 
           # Updates a sink.  This method replaces the following fields in the existing
-          # sink with values from the new sink: +destination+, and +filter+.
-          # The updated sink might also have a new +writer_identity+; see the
-          # +unique_writer_identity+ field.
+          # sink with values from the new sink: `destination`, and `filter`.
+          # The updated sink might also have a new `writer_identity`; see the
+          # `unique_writer_identity` field.
           #
           # @param sink_name [String]
           #   Required. The full resource name of the sink to update, including the
@@ -456,29 +456,29 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
           #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
           #
-          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
           # @param sink [Google::Logging::V2::LogSink | Hash]
           #   Required. The updated sink, whose name is the same identifier that appears
-          #   as part of +sink_name+.
+          #   as part of `sink_name`.
           #   A hash of the same form as `Google::Logging::V2::LogSink`
           #   can also be provided.
           # @param unique_writer_identity [true, false]
           #   Optional. See
           #   [sinks.create](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create)
           #   for a description of this field.  When updating a sink, the effect of this
-          #   field on the value of +writer_identity+ in the updated sink depends on both
+          #   field on the value of `writer_identity` in the updated sink depends on both
           #   the old and new values of this field:
           #
           #   * If the old and new values of this field are both false or both true,
-          #     then there is no change to the sink's +writer_identity+.
+          #     then there is no change to the sink's `writer_identity`.
           #   * If the old value is false and the new value is true, then
-          #     +writer_identity+ is changed to a unique service account.
+          #     `writer_identity` is changed to a unique service account.
           #   * It is an error if the old value is true and the new value is
           #     set to false or defaulted to false.
           # @param update_mask [Google::Protobuf::FieldMask | Hash]
-          #   Optional. Field mask that specifies the fields in +sink+ that need
+          #   Optional. Field mask that specifies the fields in `sink` that need
           #   an update. A sink field will be overwritten if, and only if, it is
-          #   in the update mask.  +name+ and output only fields cannot be updated.
+          #   in the update mask.  `name` and output only fields cannot be updated.
           #
           #   An empty updateMask is temporarily treated as using the following mask
           #   for backwards compatibility purposes:
@@ -486,10 +486,10 @@ module Google
           #   At some point in the future, behavior will be removed and specifying an
           #   empty updateMask will be an error.
           #
-          #   For a detailed +FieldMask+ definition, see
+          #   For a detailed `FieldMask` definition, see
           #   https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
           #
-          #   Example: +updateMask=filter+.
+          #   Example: `updateMask=filter`.
           #   A hash of the same form as `Google::Protobuf::FieldMask`
           #   can also be provided.
           # @param options [Google::Gax::CallOptions]
@@ -506,7 +506,7 @@ module Google
           #   config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
           #   formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
           #
-          #   # TODO: Initialize +sink+:
+          #   # TODO: Initialize `sink`:
           #   sink = {}
           #   response = config_service_v2_client.update_sink(formatted_sink_name, sink)
 
@@ -527,7 +527,7 @@ module Google
             @update_sink.call(req, options, &block)
           end
 
-          # Deletes a sink. If the sink has a unique +writer_identity+, then that
+          # Deletes a sink. If the sink has a unique `writer_identity`, then that
           # service account is also deleted.
           #
           # @param sink_name [String]
@@ -539,7 +539,7 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
           #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
           #
-          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -635,7 +635,7 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
           #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
           #
-          #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
+          #   Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -674,9 +674,9 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]"
           #       "folders/[FOLDER_ID]"
           #
-          #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
+          #   Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
           # @param exclusion [Google::Logging::V2::LogExclusion | Hash]
-          #   Required. The new exclusion, whose +name+ parameter is an exclusion name
+          #   Required. The new exclusion, whose `name` parameter is an exclusion name
           #   that is not already used in the parent resource.
           #   A hash of the same form as `Google::Logging::V2::LogExclusion`
           #   can also be provided.
@@ -694,7 +694,7 @@ module Google
           #   config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
           #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
           #
-          #   # TODO: Initialize +exclusion+:
+          #   # TODO: Initialize `exclusion`:
           #   exclusion = {}
           #   response = config_service_v2_client.create_exclusion(formatted_parent, exclusion)
 
@@ -721,20 +721,20 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
           #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
           #
-          #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
+          #   Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
           # @param exclusion [Google::Logging::V2::LogExclusion | Hash]
           #   Required. New values for the existing exclusion. Only the fields specified
-          #   in +update_mask+ are relevant.
+          #   in `update_mask` are relevant.
           #   A hash of the same form as `Google::Logging::V2::LogExclusion`
           #   can also be provided.
           # @param update_mask [Google::Protobuf::FieldMask | Hash]
           #   Required. A nonempty list of fields to change in the existing exclusion.
           #   New values for the fields are taken from the corresponding fields in the
           #   {Google::Logging::V2::LogExclusion LogExclusion} included in this request. Fields not mentioned in
-          #   +update_mask+ are not changed and are ignored in the request.
+          #   `update_mask` are not changed and are ignored in the request.
           #
           #   For example, to change the filter and description of an exclusion,
-          #   specify an +update_mask+ of +"filter,description"+.
+          #   specify an `update_mask` of `"filter,description"`.
           #   A hash of the same form as `Google::Protobuf::FieldMask`
           #   can also be provided.
           # @param options [Google::Gax::CallOptions]
@@ -751,10 +751,10 @@ module Google
           #   config_service_v2_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
           #   formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
           #
-          #   # TODO: Initialize +exclusion+:
+          #   # TODO: Initialize `exclusion`:
           #   exclusion = {}
           #
-          #   # TODO: Initialize +update_mask+:
+          #   # TODO: Initialize `update_mask`:
           #   update_mask = {}
           #   response = config_service_v2_client.update_exclusion(formatted_name, exclusion, update_mask)
 
@@ -783,7 +783,7 @@ module Google
           #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
           #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
           #
-          #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
+          #   Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.

data/lib/google/cloud/logging/v2/doc/google/api/distribution.rb

@@ -29,13 +29,13 @@ module Google
     #
     # Although it is not forbidden, it is generally a bad idea to include
     # non-finite values (infinities or NaNs) in the population of values, as this
-    # will render the +mean+ and +sum_of_squared_deviation+ fields meaningless.
+    # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
     # @!attribute [rw] count
     #   @return [Integer]
     #     The number of values in the population. Must be non-negative.
     # @!attribute [rw] mean
     #   @return [Float]
-    #     The arithmetic mean of the values in the population. If +count+ is zero
+    #     The arithmetic mean of the values in the population. If `count` is zero
     #     then this field must be zero.
     # @!attribute [rw] sum_of_squared_deviation
     #   @return [Float]
@@ -47,26 +47,26 @@ module Google
     #     Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
     #     describes Welford's method for accumulating this sum in one pass.
     #
-    #     If +count+ is zero then this field must be zero.
+    #     If `count` is zero then this field must be zero.
     # @!attribute [rw] range
     #   @return [Google::Api::Distribution::Range]
     #     If specified, contains the range of the population values. The field
-    #     must not be present if the +count+ is zero.
+    #     must not be present if the `count` is zero.
     # @!attribute [rw] bucket_options
     #   @return [Google::Api::Distribution::BucketOptions]
     #     Defines the histogram bucket boundaries.
     # @!attribute [rw] bucket_counts
     #   @return [Array<Integer>]
-    #     If +bucket_options+ is given, then the sum of the values in +bucket_counts+
-    #     must equal the value in +count+.  If +bucket_options+ is not given, no
-    #     +bucket_counts+ fields may be given.
+    #     If `bucket_options` is given, then the sum of the values in `bucket_counts`
+    #     must equal the value in `count`.  If `bucket_options` is not given, no
+    #     `bucket_counts` fields may be given.
     #
     #     Bucket counts are given in order under the numbering scheme described
     #     above (the underflow bucket has number 0; the finite buckets, if any,
     #     have numbers 1 through N-2; the overflow bucket has number N-1).
     #
-    #     The size of +bucket_counts+ must be no greater than N as defined in
-    #     +bucket_options+.
+    #     The size of `bucket_counts` must be no greater than N as defined in
+    #     `bucket_options`.
     #
     #     Any suffix of trailing zero bucket_count fields may be omitted.
     class Distribution
@@ -80,9 +80,9 @@ module Google
       class Range; end
 
       # A Distribution may optionally contain a histogram of the values in the
-      # population.  The histogram is given in +bucket_counts+ as counts of values
+      # population.  The histogram is given in `bucket_counts` as counts of values
       # that fall into one of a sequence of non-overlapping buckets.  The sequence
-      # of buckets is described by +bucket_options+.
+      # of buckets is described by `bucket_options`.
       #
       # A bucket specifies an inclusive lower bound and exclusive upper bound for
       # the values that are counted for that bucket.  The upper bound of a bucket
@@ -97,11 +97,11 @@ module Google
       # +infinity.  The finite buckets are so-called because both bounds are
       # finite.
       #
-      # +BucketOptions+ describes bucket boundaries in one of three ways.  Two
+      # `BucketOptions` describes bucket boundaries in one of three ways.  Two
       # describe the boundaries by giving parameters for a formula to generate
       # boundaries and one gives the bucket boundaries explicitly.
       #
-      # If +bucket_boundaries+ is not given, then no +bucket_counts+ may be given.
+      # If `bucket_boundaries` is not given, then no `bucket_counts` may be given.
       # @!attribute [rw] linear_buckets
       #   @return [Google::Api::Distribution::BucketOptions::Linear]
       #     The linear bucket.
@@ -116,8 +116,8 @@ module Google
         # overflow and underflow).  Each bucket represents a constant absolute
         # uncertainty on the specific value in the bucket.
         #
-        # Defines +num_finite_buckets + 2+ (= N) buckets with these boundaries for
-        # bucket +i+:
+        # Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for
+        # bucket `i`:
         #
         #    Upper bound (0 <= i < N-1):     offset + (width * i).
         #    Lower bound (1 <= i < N):       offset + (width * (i - 1)).
@@ -136,7 +136,7 @@ module Google
         # the value of the lower bound.  Each bucket represents a constant relative
         # uncertainty on a specific value in the bucket.
         #
-        # Defines +num_finite_buckets + 2+ (= N) buckets with these boundaries for
+        # Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for
         # bucket i:
         #
         #    Upper bound (0 <= i < N-1):     scale * (growth_factor ^ i).
@@ -154,13 +154,13 @@ module Google
 
         # A set of buckets with arbitrary widths.
         #
-        # Defines +size(bounds) + 1+ (= N) buckets with these boundaries for
+        # Defines `size(bounds) + 1` (= N) buckets with these boundaries for
         # bucket i:
         #
         #    Upper bound (0 <= i < N-1):     bounds[i]
         #    Lower bound (1 <= i < N);       bounds[i - 1]
         #
-        # There must be at least one element in +bounds+.  If +bounds+ has only one
+        # There must be at least one element in `bounds`.  If `bounds` has only one
         # element, there are no finite buckets, and that single element is the
         # common boundary of the overflow and underflow buckets.
         # @!attribute [rw] bounds