RubyGems - google-cloud-logging - Versions diffs - 1.5.2 → 1.5.3 - Mend

google-cloud-logging 1.5.2 → 1.5.3

Files changed (37) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165648d3671f94bbce1dd44a66d3970f76aef3227a867efc8700844c8baf8535
-  data.tar.gz: 2864cce34c49c550cff3e842f824db2155daa15cd83c9c4789f8aa3e778fc3b6
+  metadata.gz: c8b7a06296878a5094bc4de7d45d87b988297de5cec70e212c17b55639f07485
+  data.tar.gz: '090cc3fe558e01f326240b6c7ba23cc9607e480454f39be71ec0da9844cefa0e'
 SHA512:
-  metadata.gz: '08d0ec06b1240642fe5e1090480787df1da41550b20f15de77a920cc894fbb8e68bebcfe7d9bca190d5ad6a5c03be9d9de56a6802fe04ee44d4e3f1588bfd206'
-  data.tar.gz: 51ec296ada17157804749f371d364a88f5ea7e61091dd00d4d58c2bbc34551160c9638d20125d8b164a737873239f659714c19386badfe291254d78027ed9c81
+  metadata.gz: fda5da167d780b2ad5dd119037291730e935927b57da558266168db82f587665608fc0e1df14b983dd8f87ac0d217b790a810ab037edaba2497b7558bdd19305
+  data.tar.gz: bb7324f057ca44e027fcaf532360b66e5ec25a377ff32ae20f88accae7f0b2097117f61c626d966dac18e67998b9fe95ef8a55f8fe817a38fa248e842c17fa03

data/.yardopts CHANGED

@@ -3,7 +3,16 @@
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet
+--main OVERVIEW.md
 ./lib/**/*.rb
 -
-README.md
+OVERVIEW.md
+AUTHENTICATION.md
+INSTRUMENTATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/README.md CHANGED

@@ -2,7 +2,7 @@
 [Stackdriver Logging](https://cloud.google.com/logging/) ([docs](https://cloud.google.com/logging/docs/)) allows you to store, search, analyze, monitor, and alert on log data and events from Google Cloud Platform and Amazon Web Services (AWS). It supports ingestion of any custom log data from any source. Stackdriver Logging is a fully-managed service that performs at scale and can ingest application and system log data from thousands of VMs. Even better, you can analyze all that log data in real-time.
-- [google-cloud-logging API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest)
+- [google-cloud-logging API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest)
 - [google-cloud-logging on RubyGems](https://rubygems.org/gems/google-cloud-logging)
 - [Stackdriver Logging documentation](https://cloud.google.com/logging/docs/)
@@ -112,7 +112,7 @@ logger.
 ### Configuring the framework integration
 You can customize the behavior of the Stackdriver Logging framework integration
-for Ruby. See the [configuration guide](../stackdriver/configuration.md) for a
+for Ruby. See the [configuration guide](../stackdriver/CONFIGURATION.md) for a
 list of possible configuration options.
 ## Authentication
@@ -153,12 +153,12 @@ end
 ```
 See the [Authentication
-Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/file.AUTHENTICATION).
 for more ways to authenticate the client library.
 ## Enabling Logging
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger 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) 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) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger 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) 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) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 Configuring a Ruby stdlib logger:
@@ -183,9 +183,9 @@ end
 This library is supported on Ruby 2.3+.
 Google provides official support for Ruby versions that are actively supported
-by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.3
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
+security maintenance, and not end of life. Currently, this means Ruby 2.3 and
+later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
@@ -197,15 +197,24 @@ This library follows [Semantic Versioning](http://semver.org/).
 Contributions to this library are always welcome and highly encouraged.
-See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
+See the [Contributing
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/file.CONTRIBUTING)
+for more information on how to get started.
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
+Please note that this project is released with a Contributor Code of Conduct. By
+participating in this project you agree to abide by its terms. See [Code of
+Conduct](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/file.CODE_OF_CONDUCT)
+for more information.
 ## License
-This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+This library is licensed under Apache 2.0. Full license text is available in
+[LICENSE](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/file.LICENSE).
 ## Support
-Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
-Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
+Please [report bugs at the project on
+Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
+hesitate to [ask
+questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
+about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-cloud-logging.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 ##
 # This file is here to be autorequired by bundler, so that the
 # Google::Cloud.logging and Google::Cloud#logging methods can be available, but
@@ -29,8 +30,8 @@ module Google
     # Creates a new object for connecting to the Stackdriver Logging service.
     # Each call creates a new connection.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
@@ -75,8 +76,8 @@ module Google
     # Creates a new object for connecting to the Stackdriver Logging service.
     # Each call creates a new connection.
     #
-    # For more information on connecting to Google Cloud see the [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    # For more information on connecting to Google Cloud see the
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String] project_id Project identifier for the Stackdriver Logging
     #   service you are connecting to. If not present, the default project for

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

@@ -29,358 +29,15 @@ module Google
     # programmatic control over your projects' logs. You can use the Stackdriver
     # Logging API to:
     #
-    # * [Read and filter log entries](#listing-log-entries)
-    # * [Export your log entries](#exporting-log-entries) to Cloud Storage,
-    #   BigQuery, or Cloud Pub/Sub
-    # * [Create logs-based metrics](#creating-logs-based-metrics) for use in
-    #   Cloud Monitoring
-    # * [Write log entries](#writing-log-entries)
+    # * Read and filter log entries
+    # * Export your log entries to Cloud Storage, BigQuery, or Cloud Pub/Sub
+    # * Create logs-based metrics for use in Cloud Monitoring
+    # * Write log entries
     #
     # For general information about Stackdriver Logging, read [Stackdriver
     # Logging Documentation](https://cloud.google.com/logging/docs/).
     #
-    # The goal of google-cloud is to provide an API that is comfortable to
-    # Rubyists. Your authentication credentials are detected automatically in
-    # Google Cloud Platform environments such as Google Compute Engine, Google
-    # App Engine and Google Kubernetes Engine. In other environments you can
-    # configure authentication easily, either directly in your code or via
-    # environment variables. Read more about the options for connecting in the
-    # [Authentication
-    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
-    #
-    # If you just want to write your application's logs to the Stackdriver
-    # Logging service, you may find it easiest to use the [Stackdriver Logging
-    # Instrumentation](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/instrumentation)
-    # or the [Ruby Logger
-    # implementation](#creating-a-ruby-logger-implementation) provided by this
-    # library. Otherwise, read on to learn more about the Logging API.
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying
-    # [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The
-    # logger 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)
-    # 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)
-    # and the gRPC
-    # [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
-    # for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```x
-    #
-    # ## Listing log entries
-    #
-    # Stackdriver Logging gathers log entries from many services, including
-    # Google App Engine and Google Compute Engine. (See the [List of Log
-    # Types](https://cloud.google.com/logging/docs/view/logs_index).) In
-    # addition, you can write your own log entries to the service.
-    #
-    # {Google::Cloud::Logging::Project#entries} returns the
-    # {Google::Cloud::Logging::Entry} records belonging to your project:
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # entries = logging.entries
-    # entries.each do |e|
-    #   puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
-    # end
-    # ```
-    #
-    # You can narrow the results to a single log using an [advanced logs
-    # filter](https://cloud.google.com/logging/docs/view/advanced_filters). A
-    # log is a named collection of entries. Logs can be produced by Google Cloud
-    # Platform services, by third-party services, or by your applications. For
-    # example, the log `compute.googleapis.com/activity_log` is produced by
-    # Google Compute Engine. Logs are simply referenced by name in google-cloud.
-    # There is no `Log` type in google-cloud or `Log` resource in the
-    # Stackdriver Logging API.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # entries = logging.entries filter: "logName:syslog"
-    # entries.each do |e|
-    #   puts "[#{e.timestamp}] #{e.payload.inspect}"
-    # end
-    # ```
-    #
-    # You can also order the log entries by `timestamp`.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # entries = logging.entries order: "timestamp desc"
-    # entries.each do |e|
-    #   puts "[#{e.timestamp}] #{e.log_name}"
-    # end
-    # ```
-    #
-    # ## Exporting log entries
-    #
-    # Stackdriver Logging lets you export log entries to destinations including
-    # Google Cloud Storage buckets (for long term log storage), Google BigQuery
-    # datasets (for log analysis), and Google Pub/Sub (for streaming to other
-    # applications).
-    #
-    # ### Creating sinks
-    #
-    # A {Google::Cloud::Logging::Sink} is an object that lets you to specify a
-    # set of log entries to export.
-    #
-    # In addition to the name of the sink and the export destination,
-    # {Google::Cloud::Logging::Project#create_sink} accepts an [advanced logs
-    # filter](https://cloud.google.com/logging/docs/view/advanced_filters) to
-    # narrow the collection.
-    #
-    # Before creating the sink, ensure that you have granted
-    # `cloud-logs@google.com` permission to write logs to the destination. See
-    # [Exporting Logs
-    # (V2)](https://cloud.google.com/logging/docs/export/configure_export_v2).
-    #
-    # ```ruby
-    # require "google/cloud/storage"
-    # require "google/cloud/logging"
-    #
-    # storage = Google::Cloud::Storage.new
-    #
-    # bucket = storage.create_bucket "my-logs-bucket"
-    #
-    # # Grant owner permission to Stackdriver Logging service
-    # email = "cloud-logs@google.com"
-    # bucket.acl.add_owner "group-#{email}"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # sink = logging.create_sink "my-sink",
-    #                            "storage.googleapis.com/#{bucket.id}"
-    # ```
-    #
-    # When you create a sink, only new log entries are exported. Stackdriver
-    # Logging does not send previously-ingested log entries to the sink's
-    # destination.
-    #
-    # ### Listing sinks
-    #
-    # You can also list the sinks belonging to your project with
-    # {Google::Cloud::Logging::Project#sinks}.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # sinks = logging.sinks
-    # sinks.each do |s|
-    #   puts "#{s.name}: #{s.filter} -> #{s.destination}"
-    # end
-    # ```
-    #
-    # ## Creating logs-based metrics
-    #
-    # You can use log entries in your project as the basis for [Google Cloud
-    # Monitoring](https://cloud.google.com/monitoring/docs) metrics. These
-    # metrics can then be used to produce Cloud Monitoring reports and alerts.
-    #
-    # ### Creating metrics
-    #
-    # A metric is a measured value that can be used to assess a system. Use
-    # {Google::Cloud::Logging::Project#create_metric} to configure a
-    # {Google::Cloud::Logging::Metric} based on a collection of log entries
-    # matching an [advanced logs
-    # filter](https://cloud.google.com/logging/docs/view/advanced_filters).
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # metric = logging.create_metric "errors", "severity>=ERROR"
-    # ```
-    #
-    # ### Listing metrics
-    #
-    # You can also list the metrics belonging to your project with
-    # {Google::Cloud::Logging::Project#metrics}.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # metrics = logging.metrics
-    # metrics.each do |m|
-    #   puts "#{m.name}: #{m.filter}"
-    # end
-    # ```
-    #
-    # ## Writing log entries
-    #
-    # An {Google::Cloud::Logging::Entry} is composed of metadata and a payload.
-    # The payload is traditionally a message string, but in Stackdriver Logging
-    # it can also be a JSON or protocol buffer object. A single log can have
-    # entries with different payload types. In addition to the payload, your
-    # argument(s) to {Google::Cloud::Logging::Project#write_entries} must also
-    # contain a log name and a resource.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # entry = logging.entry
-    # entry.payload = "Job started."
-    # entry.log_name = "my_app_log"
-    # entry.resource.type = "gae_app"
-    # entry.resource.labels[:module_id] = "1"
-    # entry.resource.labels[:version_id] = "20150925t173233"
-    #
-    # logging.write_entries entry
-    # ```
-    #
-    # To write a JSON payload to the log, simply pass a hash argument:
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # entry = logging.entry
-    # entry.payload = { "stats" => { "a" => 8, "b" => 12.5} }
-    # entry.log_name = "my_app_log"
-    # entry.resource.type = "gae_app"
-    # entry.resource.labels[:module_id] = "1"
-    # entry.resource.labels[:version_id] = "20150925t173233"
-    #
-    # logging.write_entries entry
-    # ```
-    #
-    # If you write a collection of log entries, you can provide the log name,
-    # resource, and/or labels hash to be used for all of the entries, and omit
-    # these values from the individual entries.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # entry1 = logging.entry
-    # entry1.payload = "Job started."
-    # entry2 = logging.entry
-    # entry2.payload = "Job completed."
-    # labels = { job_size: "large", job_code: "red" }
-    #
-    # resource = logging.resource "gae_app",
-    #                             "module_id" => "1",
-    #                             "version_id" => "20150925t173233"
-    #
-    # logging.write_entries [entry1, entry2],
-    #                       log_name: "my_app_log",
-    #                       resource: resource,
-    #                       labels: labels
-    # ```
-    #
-    # Normally, writing log entries is done synchronously; the call to
-    # {Google::Cloud::Logging::Project#write_entries} will block until it has
-    # either completed transmitting the data or encountered an error. To "fire
-    # and forget" without blocking, use {Google::Cloud::Logging::AsyncWriter};
-    # it spins up a background thread that writes log entries in batches. Calls
-    # to {Google::Cloud::Logging::AsyncWriter#write_entries} simply add entries
-    # to its work queue and return immediately.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    # async = logging.async_writer
-    #
-    # entry1 = logging.entry
-    # entry1.payload = "Job started."
-    # entry2 = logging.entry
-    # entry2.payload = "Job completed."
-    # labels = { job_size: "large", job_code: "red" }
-    #
-    # resource = logging.resource "gae_app",
-    #                             "module_id" => "1",
-    #                             "version_id" => "20150925t173233"
-    #
-    # async.write_entries [entry1, entry2],
-    #                     log_name: "my_app_log",
-    #                     resource: resource,
-    #                     labels: labels,
-    #                     partial_success: true
-    # ```
-    #
-    # ### Creating a Ruby Logger implementation
-    #
-    # If your environment requires a logger instance that is API-compatible with
-    # Ruby's standard library
-    # [Logger](http://ruby-doc.org/stdlib/libdoc/logger/rdoc), you can use
-    # {Google::Cloud::Logging::Project#logger} to create one.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # resource = logging.resource "gae_app",
-    #                             module_id: "1",
-    #                             version_id: "20150925t173233"
-    #
-    # logger = logging.logger "my_app_log", resource, env: :production
-    # logger.info "Job started."
-    # ```
-    #
-    # By default, the logger instance writes log entries asynchronously in a
-    # background thread using an {Google::Cloud::Logging::AsyncWriter}. If you
-    # want to customize or disable asynchronous writing, you may call the
-    # Logger constructor directly.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new
-    #
-    # resource = logging.resource "gae_app",
-    #                             module_id: "1",
-    #                             version_id: "20150925t173233"
-    #
-    # logger = Google::Cloud::Logging::Logger.new logging,
-    #                                             "my_app_log",
-    #                                             resource,
-    #                                             {env: :production}
-    # logger.info "Log entry written synchronously."
-    # ```
-    #
-    # ## Configuring timeout
-    #
-    # You can configure the request `timeout` value in seconds.
-    #
-    # ```ruby
-    # require "google/cloud/logging"
-    #
-    # logging = Google::Cloud::Logging.new timeout: 120
-    # ```
+    # See {file:OVERVIEW.md Stackdriver Logging Overview}.
     #
     module Logging
       ##
@@ -388,8 +45,7 @@ module Google
       # Each call creates a new connection.
       #
       # For more information on connecting to Google Cloud see the
-      # [Authentication
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      # {file:AUTHENTICATION.md Authentication Guide}.
       #
       # @param [String] project_id Project identifier for the Stackdriver
       #   Logging service you are connecting to. If not present, the default
@@ -482,7 +138,7 @@ module Google
       #   Rack environment.
       #
       # See the [Configuration
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/stackdriver/guides/instrumentation_configuration)
+      # Guide](https://googlecloudplatform.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 CHANGED

@@ -64,7 +64,7 @@ module Google
         RequestInfo = ::Struct.new :trace_id, :log_name, :env
         ##
-        # The Google Cloud writer object that calls to {#write_entries} are made
+        # The Google Cloud writer object that calls to `#write_entries` are made
         # on. Either an AsyncWriter or Project object.
         attr_reader :writer
@@ -131,7 +131,7 @@ module Google
         #   entries. Generally, to create a logger that blocks on transmitting
         #   log entries, pass the Project; otherwise, to create a logger that
         #   transmits log entries in the background, pass an AsyncWriter. You
-        #   may also pass any other object that responds to #write_entries.
+        #   may also pass any other object that responds to `#write_entries`.
         # @param [String] log_name A log resource name to be associated with the
         #   written log entries.
         # @param [Google::Cloud::Logging::Resource] resource The monitored

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

@@ -43,9 +43,9 @@ module Google
         #   to track Stackdriver request trace ID. It also properly sets
         #   env["rack.logger"] to this assigned logger for accessing. If not
         #   specified, a default logger with be used.
-        # @param [Hash] *kwargs Hash of configuration settings. Used for
+        # @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/guides/instrumentation_configuration)
+        #   Guide](https://googlecloudplatform.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 CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 require "google/cloud/logging"
 module Google
@@ -36,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/guides/instrumentation_configuration)
+      # Guide](https://googlecloudplatform.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.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 require "google/cloud/logging/v2/config_service_v2_client"
 require "google/cloud/logging/v2/logging_service_v2_client"
 require "google/cloud/logging/v2/metrics_service_v2_client"

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

@@ -19,6 +19,7 @@
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
 require "json"
 require "pathname"
@@ -37,6 +38,7 @@ module Google
         # @!attribute [r] config_service_v2_stub
         #   @return [Google::Logging::V2::ConfigServiceV2::Stub]
         class ConfigServiceV2Client
+          # @private
           attr_reader :config_service_v2_stub
           # The default address of the service.

data/lib/google/cloud/logging/v2/credentials.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 require "googleauth"
 module Google

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

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Api
     # Distribution contains summary statistics for a population of values and,

data/lib/google/cloud/logging/v2/doc/google/api/label.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Api
     # A description of a label.

data/lib/google/cloud/logging/v2/doc/google/api/metric.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Api
     # Defines a metric type and its schema. Once a metric descriptor is created,
@@ -106,7 +107,7 @@ module Google
     #
     #     * +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+.
+    #       +\\{requests}/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+.

data/lib/google/cloud/logging/v2/doc/google/api/monitored_resource.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Api
     # An object that describes the schema of a {Google::Api::MonitoredResource MonitoredResource} object using a
@@ -26,11 +27,11 @@ module Google
     # @!attribute [rw] name
     #   @return [String]
     #     Optional. The resource name of the monitored resource descriptor:
-    #     +"projects/{project_id}/monitoredResourceDescriptors/{type}"+ where
-    #     {type} is the value of the +type+ field in this object and
-    #     {project_id} is a project ID that provides API-specific context for
+    #     +"projects/\\{project_id}/monitoredResourceDescriptors/\\{type}"+ where
+    #     \\{type} is the value of the +type+ field in this object and
+    #     \\{project_id} is a project ID that provides API-specific context for
     #     accessing the type.  APIs that do not use project information can use the
-    #     resource name format +"monitoredResourceDescriptors/{type}"+.
+    #     resource name format +"monitoredResourceDescriptors/\\{type}"+.
     # @!attribute [rw] type
     #   @return [String]
     #     Required. The monitored resource type. For example, the type

data/lib/google/cloud/logging/v2/doc/google/logging/type/http_request.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Logging
     module Type

data/lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Logging
     module V2

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Logging
     module V2

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Logging
     module V2

data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Logging
     module V2

data/lib/google/cloud/logging/v2/doc/google/protobuf/any.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # +Any+ contains an arbitrary serialized protocol buffer message along with a
@@ -95,17 +96,18 @@ module Google
     #     }
     # @!attribute [rw] type_url
     #   @return [String]
-    #     A URL/resource name whose content describes the type of the
-    #     serialized protocol buffer message.
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     +path/google.protobuf.Duration+). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
     #
-    #     For URLs which use the scheme +http+, +https+, or no scheme, the
-    #     following restrictions and interpretations apply:
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme +http+, +https+, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
     #
     #     * If no scheme is provided, +https+ is assumed.
-    #     * The last segment of the URL's path must represent the fully
-    #       qualified name of the type (as in +path/google.protobuf.Duration+).
-    #       The name should be in a canonical form (e.g., leading "." is
-    #       not accepted).
     #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
     #       value in binary format, or produce an error.
     #     * Applications are allowed to cache lookup results based on the
@@ -114,6 +116,10 @@ module Google
     #       on changes to types. (Use versioned type names to manage
     #       breaking changes.)
     #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
     #     Schemes other than +http+, +https+ (or the empty scheme) might be
     #     used with implementation specific semantics.
     # @!attribute [rw] value

data/lib/google/cloud/logging/v2/doc/google/protobuf/duration.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # A Duration represents a signed, fixed-length span of time represented

data/lib/google/cloud/logging/v2/doc/google/protobuf/empty.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # A generic empty message that you can re-use to avoid defining duplicated

data/lib/google/cloud/logging/v2/doc/google/protobuf/field_mask.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # +FieldMask+ represents a set of symbolic field paths, for example:
@@ -215,6 +216,12 @@ module Google
     #
     # Note that oneof type names ("test_oneof" in this case) cannot be used in
     # paths.
+    #
+    # == Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
     # @!attribute [rw] paths
     #   @return [Array<String>]
     #     The set of field mask paths.

data/lib/google/cloud/logging/v2/doc/google/protobuf/struct.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # +Struct+ represents a structured data value, consisting of fields

data/lib/google/cloud/logging/v2/doc/google/protobuf/timestamp.rb CHANGED

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 module Google
   module Protobuf
     # A Timestamp represents a point in time independent of any time zone
@@ -72,12 +73,14 @@ module Google
     #
     # In JSON format, the Timestamp type is encoded as a string in the
     # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
-    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
-    # where {year} is always expressed using four digits while {month}, {day},
-    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
     # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
     # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
-    # is required, though only UTC (as indicated by "Z") is presently supported.
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
     #
     # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
     # 01:30 UTC on January 15, 2017.
@@ -88,8 +91,8 @@ module Google
     # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
     # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
-    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
-    # to obtain a formatter capable of generating timestamps in this format.
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]
     #     Represents seconds of UTC time since Unix epoch

data/lib/google/cloud/logging/v2/logging_service_v2_client.rb CHANGED

@@ -19,6 +19,7 @@
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
 require "json"
 require "pathname"
@@ -36,6 +37,7 @@ module Google
         # @!attribute [r] logging_service_v2_stub
         #   @return [Google::Logging::V2::LoggingServiceV2::Stub]
         class LoggingServiceV2Client
+          # @private
           attr_reader :logging_service_v2_stub
           # The default address of the service.

data/lib/google/cloud/logging/v2/metrics_service_v2_client.rb CHANGED

@@ -19,6 +19,7 @@
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
 require "json"
 require "pathname"
@@ -36,6 +37,7 @@ module Google
         # @!attribute [r] metrics_service_v2_stub
         #   @return [Google::Logging::V2::MetricsServiceV2::Stub]
         class MetricsServiceV2Client
+          # @private
           attr_reader :metrics_service_v2_stub
           # The default address of the service.

data/lib/google/cloud/logging/version.rb CHANGED

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Logging
-      VERSION = "1.5.2".freeze
+      VERSION = "1.5.3".freeze
     end
   end
 end

data/lib/google/logging/v2/log_entry_pb.rb CHANGED

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/log_entry.proto
 require 'google/protobuf'
 require 'google/api/annotations_pb'

data/lib/google/logging/v2/logging_config_pb.rb CHANGED

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging_config.proto
 require 'google/protobuf'
 require 'google/api/annotations_pb'

data/lib/google/logging/v2/logging_config_services_pb.rb CHANGED

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 require 'grpc'
 require 'google/logging/v2/logging_config_pb'

data/lib/google/logging/v2/logging_metrics_pb.rb CHANGED

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging_metrics.proto
 require 'google/protobuf'
 require 'google/api/annotations_pb'

data/lib/google/logging/v2/logging_metrics_services_pb.rb CHANGED

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 require 'grpc'
 require 'google/logging/v2/logging_metrics_pb'

data/lib/google/logging/v2/logging_pb.rb CHANGED

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging.proto
 require 'google/protobuf'
 require 'google/api/annotations_pb'

data/lib/google/logging/v2/logging_services_pb.rb CHANGED

@@ -16,6 +16,7 @@
 # limitations under the License.
 #
 require 'grpc'
 require 'google/logging/v2/logging_pb'

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -197,16 +197,16 @@ dependencies:
   name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement