google-cloud-logging 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43b8c5db09219ded373243da0ca00c843a9fc621
-  data.tar.gz: 1f7283f517b86783fa2411b7a03f93020762851f
+  metadata.gz: 055747223efbea95c51a675309d4d35050ab8b18
+  data.tar.gz: 7255d083b277697741232f86fa4b08c89cbe5989
 SHA512:
-  metadata.gz: cd23872d6e35733f0bdf08775bf74922c1be1263dff90af212be364a5a763b58b9a1b41ab3d77bbcdecfeee6b339057deebcbdec66ef8fdfb3033dd2d484ab02
-  data.tar.gz: 3fbbb4a987dd9f3012d1917bdcbe09d7f808fb15d815fd3b3c932e92f6bba78a70435766288cab945d912ce37697b507d70985601add2afeb6bd1ab0fd982e37
+  metadata.gz: 32e392f48a2abe8ec52428f56157ce9a2fee76ef0483ea33f2bb17c9cd1c957b1d595af3fb503d6130727b6c135e2debb72472007eb1f82a82ab287041a0a65b
+  data.tar.gz: 55f318c0491a69100b394c1de617b67335f7a5e270edde3e5956d27dbf056f9507cb0642e9735c7659d8e457f8b91c9c7c254acb3a19f266cc9699889a245503

data/README.md

@@ -8,17 +8,32 @@
 
 ## Quick Start
 
+Install the gem directly:
+
 ```sh
 $ gem install google-cloud-logging
 ```
 
-## Authentication
+Or install through Bundler:
+
+1. Add the `google-cloud-logging` gem to your Gemfile:
+
+```ruby
+gem "google-cloud-logging"
+```
+
+2. Use Bundler to install the gem:
+
+```sh
+$ bundle install
+```
 
-This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.
+Alternatively, check out the [`stackdriver`](../stackdriver) gem that includes 
+the `google-cloud-logging` gem.
 
-Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
+## Logging using client library
 
-## Example
+You can directly read or write log entries through the client library:
 
 ```ruby
 require "google/cloud/logging"
@@ -44,48 +59,102 @@ entry.resource.labels[:version_id] = "20150925t173233"
 logging.write_entries entry
 ```
 
-## Rails Integration
+## Using Stackdriver Logging in frameworks
+
+The `google-cloud-logging` library provides framework integration for popular 
+Rack-based frameworks, such as Ruby on Rails and Sinatra, which sets the default 
+Rack logger to an instance of the Stackdriver Logging logger.
+
+### With Ruby on Rails
 
-This library also provides a built in Railtie for Ruby on Rails integration. When enabled, it sets an instance of Google::Cloud::Logging::Logger as the default Rails logger. Then all consequent log entries will be submitted to the Stackdriver Logging service.
+You can load the Railtie that comes with the library into your Ruby 
+on Rails application by explicitly requiring it during the application startup:
 
-To do this, simply add this line to config/application.rb:
 ```ruby
+# In config/application.rb
 require "google/cloud/logging/rails"
 ```
-Then the library can be configured through this set of Rails parameters in config/environments/*.rb:
+
+If you're using the `stackdriver` gem, it automatically loads the Railtie into 
+your application when it starts.
+
+You'll be able to use Stackdriver logger through the standard Rails logger:
+
 ```ruby
-# Sharing authentication parameters
-config.google_cloud.project_id = "gcp-project-id"
-config.google_cloud.keyfile = "/path/to/gcp/secret.json"
-# Or more specificly for Logging
-config.google_cloud.logging.project_id = "gcp-project-id"
-config.google_cloud.logging.keyfile = "/path/to/gcp/sercret.json"
-
-# Explicitly enable or disable Logging
-config.google_cloud.use_logging = true
-
-# Set Stackdriver Logging log name
-config.google_cloud.logging.log_name = "my-app-log"
-
-# Override default monitored resource if needed. E.g. used on AWS
-config.google_cloud.logging.monitored_resource.type = "aws_ec2_instance"
-config.google_cloud.logging.monitored_resource.labels.instance_id = "ec2-instance-id"
-config.google_cloud.logging.monitored_resource.labels.aws_account = "AWS account number"
+Rails.logger.info "Hello World"
+# Or just...
+logger.warn "Hola Mundo"
 ```
-Alternatively, check out [stackdriver](../stackdriver) gem, which includes this Railtie by default.
 
-## Rack Integration
+### With other Rack-based frameworks
+
+Other Rack-based applications can use the Rack Middleware to replace the Rack 
+logger with the Stackdriver Logging logger:
 
-Other Rack base framework can also directly leverage the built-in Middleware.
 ```ruby
 require "google/cloud/logging"
+use Google::Cloud::Logging::Middleware
+```
 
-logging = Google::Cloud::Logging.new
-resource = Google::Cloud::Logging::Middleware.build_monitored_resource
-logger = logging.logger "my-log-name",
-                        resource
-use Google::Cloud::Logging::Middleware, logger: logger
+Once the Rack logger is set, some Rack-based frameworks, such as Ruby on Rails 
+and Sinatra, automatically initialize the default application logger to use the 
+Rack logger:
+
+```ruby
+logger.info "Hello World"
+logger.warn "Hola Mundo"
+logger.error "Bonjour Monde"
+```
+
+For other frameworks, consult the documentations on how to utilize the Rack 
+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 
+list of possible configuration options.
+
+## Authentication
+
+This library uses Service Account credentials to connect to Google Cloud 
+services. When running on Compute Engine the credentials will be discovered 
+automatically. When running on other environments the Service Account 
+credentials can be specified by providing in several ways.
+
+If you're using Ruby on Rails and the library's Rails integration feature, you 
+can provide the authentication parameters through the Rails configuration 
+interface:
+ 
+```ruby
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Shared parameters
+  config.google_cloud.project_id = "your-project-id"
+  config.google_cloud.keyfile = "/path/to/key.json"
+  # Stackdriver Logging specific parameters
+  config.google_cloud.logging.project_id = "your-project-id"
+  config.google_cloud.logging.keyfile    = "/path/to/key.json"
+end
 ```
+Other Rack-based applications that are loading the Rack Middleware directly can 
+use the configration interface:
+
+```ruby
+require "google/cloud/logging"
+Google::Cloud.configure do |config|
+  # Shared parameters
+  config.project_id = "your-project-id"
+  config.keyfile = "/path/to/key.json"
+  # Or Stackdriver logging specific parameters
+  config.logging.project_id = "your-project-id"
+  config.logging.keyfile = "/path/to/key.json"
+end
+```
+
+See the [Authentication 
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/guides/authentication).
+for more ways to authenticate the client library.
 
 ## Supported Ruby Versions
 

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Logging
-      VERSION = "1.2.2"
+      VERSION = "1.2.3"
     end
   end
 end

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

@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :log_name, :string, 12
     optional :resource, :message, 8, "google.api.MonitoredResource"
     optional :timestamp, :message, 9, "google.protobuf.Timestamp"
+    optional :receive_timestamp, :message, 24, "google.protobuf.Timestamp"
     optional :severity, :enum, 10, "google.logging.type.LogSeverity"
     optional :insert_id, :string, 4
     optional :http_request, :message, 7, "google.logging.type.HttpRequest"

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

@@ -5,6 +5,7 @@ require 'google/protobuf'
 
 require 'google/api/annotations_pb'
 require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.logging.v2.LogSink" do
@@ -13,6 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :filter, :string, 5
     optional :output_version_format, :enum, 6, "google.logging.v2.LogSink.VersionFormat"
     optional :writer_identity, :string, 8
+    optional :include_children, :bool, 9
     optional :start_time, :message, 10, "google.protobuf.Timestamp"
     optional :end_time, :message, 11, "google.protobuf.Timestamp"
   end
@@ -46,6 +48,36 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.logging.v2.DeleteSinkRequest" do
     optional :sink_name, :string, 1
   end
+  add_message "google.logging.v2.LogExclusion" do
+    optional :name, :string, 1
+    optional :description, :string, 2
+    optional :filter, :string, 3
+    optional :disabled, :bool, 4
+  end
+  add_message "google.logging.v2.ListExclusionsRequest" do
+    optional :parent, :string, 1
+    optional :page_token, :string, 2
+    optional :page_size, :int32, 3
+  end
+  add_message "google.logging.v2.ListExclusionsResponse" do
+    repeated :exclusions, :message, 1, "google.logging.v2.LogExclusion"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.logging.v2.GetExclusionRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.logging.v2.CreateExclusionRequest" do
+    optional :parent, :string, 1
+    optional :exclusion, :message, 2, "google.logging.v2.LogExclusion"
+  end
+  add_message "google.logging.v2.UpdateExclusionRequest" do
+    optional :name, :string, 1
+    optional :exclusion, :message, 2, "google.logging.v2.LogExclusion"
+    optional :update_mask, :message, 3, "google.protobuf.FieldMask"
+  end
+  add_message "google.logging.v2.DeleteExclusionRequest" do
+    optional :name, :string, 1
+  end
 end
 
 module Google
@@ -59,6 +91,13 @@ module Google
       CreateSinkRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.CreateSinkRequest").msgclass
       UpdateSinkRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.UpdateSinkRequest").msgclass
       DeleteSinkRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.DeleteSinkRequest").msgclass
+      LogExclusion = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.LogExclusion").msgclass
+      ListExclusionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListExclusionsRequest").msgclass
+      ListExclusionsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListExclusionsResponse").msgclass
+      GetExclusionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.GetExclusionRequest").msgclass
+      CreateExclusionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.CreateExclusionRequest").msgclass
+      UpdateExclusionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.UpdateExclusionRequest").msgclass
+      DeleteExclusionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.DeleteExclusionRequest").msgclass
     end
   end
 end

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

@@ -43,18 +43,27 @@ module Google
           # `writer_identity` is not permitted to write to the destination.  A sink can
           # export log entries only from the resource owning the sink.
           rpc :CreateSink, CreateSinkRequest, LogSink
-          # Updates a sink. If the named sink doesn't exist, then this method is
-          # identical to
-          # [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create).
-          # If the named sink does exist, then this method replaces the following
-          # fields in the existing sink with values from the new sink: `destination`,
-          # `filter`, `output_version_format`, `start_time`, and `end_time`.
-          # The updated filter might also have a new `writer_identity`; see the
+          # Updates a sink.  This method replaces the following fields in the existing
+          # sink with values from the new sink: `destination`, `filter`,
+          # `output_version_format`, `start_time`, and `end_time`.
+          # The updated sink might also have a new `writer_identity`; see the
           # `unique_writer_identity` field.
           rpc :UpdateSink, UpdateSinkRequest, LogSink
           # Deletes a sink. If the sink has a unique `writer_identity`, then that
           # service account is also deleted.
           rpc :DeleteSink, DeleteSinkRequest, Google::Protobuf::Empty
+          # Lists all the exclusions in a parent resource.
+          rpc :ListExclusions, ListExclusionsRequest, ListExclusionsResponse
+          # Gets the description of an exclusion.
+          rpc :GetExclusion, GetExclusionRequest, LogExclusion
+          # Creates a new exclusion in a specified parent resource.
+          # Only log entries belonging to that resource can be excluded.
+          # You can have up to 10 exclusions in a resource.
+          rpc :CreateExclusion, CreateExclusionRequest, LogExclusion
+          # Changes one or more properties of an existing exclusion.
+          rpc :UpdateExclusion, UpdateExclusionRequest, LogExclusion
+          # Deletes an exclusion.
+          rpc :DeleteExclusion, DeleteExclusionRequest, Google::Protobuf::Empty
         end
 
         Stub = Service.rpc_stub_class

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

@@ -7,11 +7,16 @@ require 'google/api/annotations_pb'
 require 'google/api/distribution_pb'
 require 'google/api/metric_pb'
 require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.logging.v2.LogMetric" do
     optional :name, :string, 1
     optional :description, :string, 2
     optional :filter, :string, 3
+    optional :metric_descriptor, :message, 5, "google.api.MetricDescriptor"
+    optional :value_extractor, :string, 6
+    map :label_extractors, :string, :string, 7
+    optional :bucket_options, :message, 8, "google.api.Distribution.BucketOptions"
     optional :version, :enum, 4, "google.logging.v2.LogMetric.ApiVersion"
   end
   add_enum "google.logging.v2.LogMetric.ApiVersion" do

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

@@ -23,6 +23,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "google.logging.v2.WriteLogEntriesResponse" do
   end
+  add_message "google.logging.v2.WriteLogEntriesPartialErrors" do
+    map :log_entry_errors, :int32, :message, 1, "google.rpc.Status"
+  end
   add_message "google.logging.v2.ListLogEntriesRequest" do
     repeated :project_ids, :string, 1
     repeated :resource_names, :string, 8
@@ -60,6 +63,7 @@ module Google
       DeleteLogRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.DeleteLogRequest").msgclass
       WriteLogEntriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesRequest").msgclass
       WriteLogEntriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesResponse").msgclass
+      WriteLogEntriesPartialErrors = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesPartialErrors").msgclass
       ListLogEntriesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogEntriesRequest").msgclass
       ListLogEntriesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogEntriesResponse").msgclass
       ListMonitoredResourceDescriptorsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListMonitoredResourceDescriptorsRequest").msgclass

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

@@ -37,7 +37,13 @@ module Google
           # Log entries written shortly before the delete operation might not be
           # deleted.
           rpc :DeleteLog, DeleteLogRequest, Google::Protobuf::Empty
-          # Writes log entries to Stackdriver Logging.
+          # ## Log entry resources
+          #
+          # Writes log entries to Stackdriver Logging. This API method is the
+          # only way to send log entries to Stackdriver Logging. This method
+          # is used, directly or indirectly, by the Stackdriver Logging agent
+          # (fluentd) and all logging libraries configured to use Stackdriver
+          # Logging.
           rpc :WriteLogEntries, WriteLogEntriesRequest, WriteLogEntriesResponse
           # Lists log entries.  Use this method to retrieve log entries from
           # Stackdriver Logging.  For ways to export log entries, see

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core