google-cloud-logging 0.20.0

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

@@ -0,0 +1,172 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/logging/metric/list"
+
+module Google
+  module Cloud
+    module Logging
+      ##
+      # # Metric
+      #
+      # A logs-based [Google Cloud
+      # Monitoring](https://cloud.google.com/monitoring/docs) metric. A metric
+      # is a measured value that can be used to assess a system. The basis of a
+      # logs-based metric is the collection of log entries that match a logs
+      # filter.
+      #
+      # @see https://cloud.google.com/logging/docs/view/logs_based_metrics
+      #   Logs-based Metrics
+      # @see https://cloud.google.com/monitoring/docs Google Cloud Monitoring
+      #
+      # @example
+      #   require "google/cloud"
+      #
+      #   gcloud = Google::Cloud.new
+      #   logging = gcloud.logging
+      #   metric = logging.create_metric "errors", "severity>=ERROR"
+      #
+      class Metric
+        ##
+        # @private The gRPC Service object.
+        attr_accessor :service
+
+        ##
+        # @private The gRPC Google::Logging::V2::LogMetric object.
+        attr_accessor :grpc
+
+        ##
+        # @private Create an empty Metric object.
+        def initialize
+          @service = nil
+          @grpc = Google::Logging::V2::LogMetric.new
+        end
+
+        ##
+        # The client-assigned metric identifier. Metric identifiers are limited
+        # to 1000 characters and can include only the following characters:
+        # `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The
+        # forward-slash character (`/`) denotes a hierarchy of name pieces, and
+        # it cannot be the first character of the name.
+        def name
+          grpc.name
+        end
+
+        ##
+        # The description of this metric, which is used in documentation.
+        def description
+          grpc.description
+        end
+
+        ##
+        # Updates the description of this metric, which is used in
+        # documentation.
+        def description= description
+          grpc.description = description
+        end
+
+        ##
+        # An [advanced logs
+        # filter](https://cloud.google.com/logging/docs/view/advanced_filters).
+        def filter
+          grpc.filter
+        end
+
+        ##
+        # Updates the [advanced logs
+        # filter](https://cloud.google.com/logging/docs/view/advanced_filters).
+        def filter= filter
+          grpc.filter = filter
+        end
+
+        ##
+        # Updates the logs-based metric.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.metric "severe_errors"
+        #   metric.filter = "logName:syslog AND severity>=ERROR"
+        #   metric.save
+        #
+        def save
+          ensure_service!
+          @grpc = service.update_metric name, description, filter
+          true
+        end
+
+        ##
+        # Reloads the logs-based metric with current data from the Logging
+        # service.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.metric "severe_errors"
+        #   metric.filter = "Unwanted value"
+        #   metric.reload!
+        #   metric.filter #=> "logName:syslog"
+        #
+        def reload!
+          ensure_service!
+          @grpc = service.get_metric name
+          true
+        end
+        alias_method :refresh!, :reload!
+
+        ##
+        # Permanently deletes the logs-based metric.
+        #
+        # @return [Boolean] Returns `true` if the metric was deleted.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.metric "severe_errors"
+        #   metric.delete
+        #
+        def delete
+          ensure_service!
+          service.delete_metric name
+          true
+        end
+
+        ##
+        # @private New Metric from a gRPC object.
+        def self.from_grpc grpc, service
+          new.tap do |m|
+            m.grpc = grpc
+            m.service = service
+          end
+        end
+
+        protected
+
+        ##
+        # @private Raise an error unless an active connection to the service is
+        # available.
+        def ensure_service!
+          fail "Must have active connection to service" unless service
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/logging/metric/list.rb

@@ -0,0 +1,175 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "delegate"
+
+module Google
+  module Cloud
+    module Logging
+      class Metric
+        ##
+        # Metric::List is a special case Array with additional values.
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more records that match
+          # the request and this value should be passed to continue.
+          attr_accessor :token
+
+          ##
+          # @private Create a new Metric::List with an array of Metric
+          # instances.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of metrics.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #
+          #   metrics = logging.metrics
+          #   if metrics.next?
+          #     next_metrics = metrics.next
+          #   end
+          #
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of metrics.
+          #
+          # @return [Sink::List]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #
+          #   metrics = dataset.metrics
+          #   if metrics.next?
+          #     next_metrics = metrics.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            grpc = @service.list_metrics token: token, max: @max
+            self.class.from_grpc grpc, @service
+          end
+
+          ##
+          # Retrieves all metrics by repeatedly loading {#next} until {#next?}
+          # returns `false`. Calls the given block once for each metric, which
+          # is passed as the parameter.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method may make several API calls until all metrics are
+          # retrieved. Be sure to use as narrow a search criteria as possible.
+          # Please use with caution.
+          #
+          # @param [Integer] request_limit The upper limit of API requests to
+          #   make to load all metrics. Default is no limit.
+          # @yield [metric] The block for accessing each metric.
+          # @yieldparam [Metric] metric The metric object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each metric by passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   metrics = logging.metrics
+          #
+          #   metrics.all do |metric|
+          #     puts "#{metric.name}: #{metric.filter}"
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   metrics = logging.metrics
+          #
+          #   all_names = metrics.all.map do |metric|
+          #     metric.name
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   metrics = logging.metrics
+          #
+          #   metrics.all(request_limit: 10) do |metric|
+          #     puts "#{metric.name}: #{metric.filter}"
+          #   end
+          #
+          def all request_limit: nil
+            request_limit = request_limit.to_i if request_limit
+            unless block_given?
+              return enum_for(:all, request_limit: request_limit)
+            end
+            results = self
+            loop do
+              results.each { |r| yield r }
+              if request_limit
+                request_limit -= 1
+                break if request_limit < 0
+              end
+              break unless results.next?
+              results = results.next
+            end
+          end
+
+          ##
+          # @private New Metric::List from a
+          # Google::Logging::V2::ListLogMetricsResponse object.
+          def self.from_grpc grpc_list, service, max = nil
+            metrics = new(Array(grpc_list.metrics).map do |grpc_metric|
+              Metric.from_grpc grpc_metric, service
+            end)
+            token = grpc_list.next_page_token
+            token = nil if token == ""
+            metrics.instance_variable_set "@token", token
+            metrics.instance_variable_set "@service", service
+            metrics.instance_variable_set "@max", max
+            metrics
+          end
+
+          protected
+
+          ##
+          # @private Raise an error unless an active connection to the service
+          # is available.
+          def ensure_service!
+            fail "Must have active connection to service" unless @service
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,650 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/errors"
+require "google/cloud/core/gce"
+require "google/cloud/logging/service"
+require "google/cloud/logging/credentials"
+require "google/cloud/logging/entry"
+require "google/cloud/logging/resource_descriptor"
+require "google/cloud/logging/sink"
+require "google/cloud/logging/metric"
+require "google/cloud/logging/logger"
+
+module Google
+  module Cloud
+    module Logging
+      ##
+      # # Project
+      #
+      # Projects are top-level containers in Google Cloud Platform. They store
+      # information about billing and authorized users, and they control access
+      # to Stackdriver Logging resources. Each project has a friendly name and a
+      # unique ID. Projects can be created only in the [Google Developers
+      # Console](https://console.developers.google.com). See
+      # {Google::Cloud#logging}.
+      #
+      # @example
+      #   require "google/cloud"
+      #
+      #   gcloud = Google::Cloud.new
+      #   logging = gcloud.logging
+      #   entries = logging.entries
+      #
+      # See Google::Cloud#logging
+      class Project
+        ##
+        # @private The gRPC Service object.
+        attr_accessor :service
+
+        ##
+        # @private Creates a new Connection instance.
+        def initialize service
+          @service = service
+        end
+
+        ##
+        # The ID of the current project.
+        #
+        # @return [String] the Google Cloud project ID
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new "my-project", "/path/to/keyfile.json"
+        #   logging = gcloud.logging
+        #
+        #   logging.project #=> "my-project"
+        #
+        def project
+          service.project
+        end
+
+        ##
+        # @private Default project.
+        def self.default_project
+          ENV["LOGGING_PROJECT"] ||
+            ENV["GOOGLE_CLOUD_PROJECT"] ||
+            ENV["GCLOUD_PROJECT"] ||
+            Google::Cloud::Core::GCE.project_id
+        end
+
+        ##
+        # Lists log entries. Use this method to retrieve log entries from Cloud
+        # Logging.
+        #
+        # @param [String, Array] projects One or more project IDs or project
+        #   numbers from which to retrieve log entries. If `nil`, the ID of the
+        #   receiving project instance will be used.
+        # @param [String] filter An [advanced logs
+        #   filter](https://cloud.google.com/logging/docs/view/advanced_filters).
+        #   The filter is compared against all log entries in the projects
+        #   specified by `projects`. Only entries that match the filter are
+        #   retrieved. An empty filter matches all log entries.
+        # @param [String] order How the results should be sorted. Presently, the
+        #   only permitted values are "timestamp" (default) and "timestamp
+        #   desc".
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of entries to return.
+        #
+        # @return [Array<Google::Cloud::Logging::Entry>] (See
+        #   {Google::Cloud::Logging::Entry::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   entries = logging.entries
+        #   entries.each do |e|
+        #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
+        #   end
+        #
+        # @example You can use a filter to narrow results to a single log.
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   entries = logging.entries filter: "log:syslog"
+        #   entries.each do |e|
+        #     puts "[#{e.timestamp}] #{e.payload.inspect}"
+        #   end
+        #
+        # @example You can also order the results by timestamp.
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   entries = logging.entries order: "timestamp desc"
+        #   entries.each do |e|
+        #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
+        #   end
+        #
+        # @example Retrieve all log entries: (See {Entry::List#all})
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   entries = logging.entries
+        #
+        #   entries.all do |e|
+        #     puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
+        #   end
+        #
+        def entries projects: nil, filter: nil, order: nil, token: nil, max: nil
+          ensure_service!
+          list_grpc = service.list_entries projects: projects, filter: filter,
+                                           order: order, token: token, max: max
+          Entry::List.from_grpc list_grpc, service,
+                                projects: projects, max: max,
+                                filter: filter, order: order
+        end
+        alias_method :find_entries, :entries
+
+        ##
+        # Creates an new Entry instance that may be populated and written to the
+        # Stackdriver Logging service. The {Entry#resource} attribute is
+        # pre-populated with a new {Google::Cloud::Logging::Resource} instance.
+        # Equivalent to calling `Google::Cloud::Logging::Entry.new`.
+        #
+        # @param [String] log_name The resource name of the log to which this
+        #   log entry belongs. See also {Entry#log_name=}.
+        # @param [Resource] resource The monitored resource associated with this
+        #   log entry. See also {Entry#resource}.
+        # @param [Time] timestamp The time the event described by the log entry
+        #   occurred. If omitted, Stackdriver Logging will use the time the log
+        #   entry is written. See also {Entry#timestamp}.
+        # @param [Symbol] severity The severity level of the log entry. The
+        #   default value is `DEFAULT`. See also {Entry#severity}.
+        # @param [String] insert_id A unique ID for the log entry. If you
+        #   provide this field, the logging service considers other log entries
+        #   in the same log with the same ID as duplicates which can be removed.
+        #   If omitted, Stackdriver Logging will generate a unique ID for this
+        #   log entry. See also {Entry#insert_id}.
+        # @param [Hash{Symbol,String => String}] labels A hash of user-defined
+        #   `key:value` pairs that provide additional information about the log
+        #   entry. See also {Entry#labels=}.
+        # @param [String, Hash] payload The log entry payload, represented as
+        #   either a string, a hash (JSON), or a hash (protocol buffer). See
+        #   also {Entry#payload}.
+        #
+        # @return [Google::Cloud::Logging::Entry] a new Entry instance
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #
+        #   entry = logging.entry severity: :INFO, payload: "Job started."
+        #
+        #   logging.write_entries entry
+        #
+        def entry log_name: nil, resource: nil, timestamp: nil, severity: nil,
+                  insert_id: nil, labels: nil, payload: nil
+          e = Entry.new
+          e.log_name = log_name if log_name
+          e.resource = resource if resource
+          e.timestamp = timestamp if timestamp
+          e.severity = severity if severity
+          e.insert_id = insert_id if insert_id
+          e.labels = labels if labels
+          e.payload = payload if payload
+          e
+        end
+        alias_method :new_entry, :entry
+
+        ##
+        # Writes log entries to the Stackdriver Logging service.
+        #
+        # 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.
+        #
+        # @param [Google::Cloud::Logging::Entry,
+        #   Array<Google::Cloud::Logging::Entry>] entries One or more entry
+        #   objects to write. The log entries must have values for all required
+        #   fields.
+        # @param [String] log_name A default log ID for those log entries in
+        #   `entries` that do not specify their own `log_name`. See also
+        #   {Entry#log_name=}.
+        # @param [Resource] resource A default monitored resource for those log
+        #   entries in entries that do not specify their own resource. See also
+        #   {Entry#resource}.
+        # @param [Hash{Symbol,String => String}] labels User-defined `key:value`
+        #   items that are added to the `labels` field of each log entry in
+        #   `entries`, except when a log entry specifies its own `key:value`
+        #   item with the same key. See also {Entry#labels=}.
+        #
+        # @return [Boolean] Returns `true` if the entries were written.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #
+        #   entry = logging.entry payload: "Job started.",
+        #                         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
+        #
+        # @example Optionally pass log name, resource, and labels for entries.
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #
+        #   entry1 = logging.entry payload: "Job started."
+        #   entry2 = logging.entry 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
+        #
+        def write_entries entries, log_name: nil, resource: nil, labels: nil
+          ensure_service!
+          service.write_entries Array(entries).map(&:to_grpc),
+                                log_name: log_name, resource: resource,
+                                labels: labels
+          true
+        end
+
+        ##
+        # Creates a logger instance that is API-compatible with Ruby's standard
+        # library [Logger](http://ruby-doc.org/stdlib/libdoc/logger/rdoc).
+        #
+        # @param [String] log_name A log resource name to be associated with the
+        #   written log entries.
+        # @param [Google::Cloud::Logging::Resource] resource The monitored
+        #   resource to be associated with written log entries.
+        # @param [Hash] labels A set of user-defined data to be associated with
+        #   written log entries.
+        #
+        # @return [Google::Cloud::Logging::Logger] a Logger object that can be
+        #   used in place of a ruby standard library logger object.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #
+        #   resource = logging.resource "gae_app",
+        #                               module_id: "1",
+        #                               version_id: "20150925t173233"
+        #
+        #   logger = logging.logger "my_app_log", resource, env: :production
+        #   logger.info "Job started."
+        #
+        def logger log_name, resource, labels = {}
+          Logger.new self, log_name, resource, labels
+        end
+
+        ##
+        # Deletes a log and all its log entries. The log will reappear if it
+        # receives new entries.
+        #
+        # @param [String] name The name of the log, which may be the full path
+        #   including the project ID (`projects/<project-id>/logs/<log-id>`), or
+        #   just the short name (`<log-id>`), in which case the beginning of the
+        #   path will be automatically prepended, using the ID of the current
+        #   project.
+        #
+        # @return [Boolean] Returns `true` if the log and all its log entries
+        #   were deleted.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   logging.delete_log "my_app_log"
+        #
+        def delete_log name
+          ensure_service!
+          service.delete_log name
+          true
+        end
+
+        ##
+        # Retrieves the list of monitored resource descriptors that are used by
+        # Stackdriver Logging.
+        #
+        # @see https://cloud.google.com/logging/docs/api/introduction_v2#monitored_resources
+        #   Monitored Resources
+        #
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of resource descriptors to return.
+        #
+        # @return [Array<Google::Cloud::Logging::ResourceDescriptor>] (See
+        #   {Google::Cloud::Logging::ResourceDescriptor::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   resource_descriptors = logging.resource_descriptors
+        #   resource_descriptors.each do |rd|
+        #     label_keys = rd.labels.map(&:key).join(", ")
+        #     puts "#{rd.type} (#{label_keys})"
+        #   end
+        #
+        # @example Pagination:
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   resource_descriptors = logging.resource_descriptors
+        #
+        #   resource_descriptors.all do |rd|
+        #     puts rd.type
+        #   end
+        #
+        def resource_descriptors token: nil, max: nil
+          ensure_service!
+          list_grpc = service.list_resource_descriptors token: token, max: max
+          ResourceDescriptor::List.from_grpc list_grpc, service, max
+        end
+        alias_method :find_resource_descriptors, :resource_descriptors
+
+        ##
+        # Creates a new monitored resource instance.
+        #
+        # @return [Google::Cloud::Logging::Resource]
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #
+        #   resource = logging.resource "gae_app",
+        #                               "module_id" => "1",
+        #                               "version_id" => "20150925t173233"
+        #
+        def resource type, labels = {}
+          Resource.new.tap do |r|
+            r.type = type
+            r.labels = labels
+          end
+        end
+        alias_method :new_resource, :resource
+
+        ##
+        # Retrieves the list of sinks belonging to the project.
+        #
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of sinks to return.
+        #
+        # @return [Array<Google::Cloud::Logging::Sink>] (See
+        #   {Google::Cloud::Logging::Sink::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sinks = logging.sinks
+        #   sinks.each do |s|
+        #     puts "#{s.name}: #{s.filter} -> #{s.destination}"
+        #   end
+        #
+        # @example Retrieve all sinks: (See {Sink::List#all})
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sinks = logging.sinks
+        #
+        #   sinks.all do |s|
+        #     puts "#{s.name}: #{s.filter} -> #{s.destination}"
+        #   end
+        #
+        def sinks token: nil, max: nil
+          ensure_service!
+          list_grpc = service.list_sinks token: token, max: max
+          Sink::List.from_grpc list_grpc, service, max
+        end
+        alias_method :find_sinks, :sinks
+
+        ##
+        # Creates a new project sink. When you create a sink, only new log
+        # entries that match the sink's filter are exported. Stackdriver Logging
+        # does not send previously-ingested log entries to the sink's
+        # destination.
+        #
+        # Before creating the sink, ensure that you have granted
+        # `cloud-logs@google.com` permission to write logs to the destination.
+        # See [Permissions for writing exported
+        # logs](https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs).
+        #
+        # @see https://cloud.google.com/logging/docs/api/tasks/exporting-logs
+        #   Exporting Logs With Sinks
+        # @see https://cloud.google.com/logging/docs/api/introduction_v2#kinds_of_log_sinks
+        #   Kinds of log sinks (API V2)
+        # @see https://cloud.google.com/logging/docs/api/#sinks Sinks (API V1)
+        # @see https://cloud.google.com/logging/docs/export/configure_export#setting_product_name_short_permissions_for_writing_exported_logs
+        #   Permissions for writing exported logs
+        #
+        # @param [String] name The client-assigned sink identifier. Sink
+        #   identifiers are limited to 1000 characters and can include only the
+        #   following characters: `A-Z`, `a-z`, `0-9`, and the special
+        #   characters `_-.`.
+        # @param [String] destination The resource name of the export
+        #   destination. See [About
+        #   sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs#about_sinks)
+        #   for examples.
+        # @param [String, nil] filter An [advanced logs
+        #  filter](https://cloud.google.com/logging/docs/view/advanced_filters)
+        #  that defines the log entries to be exported. The filter must be
+        #  consistent with the log entry format designed by the `version`
+        #  parameter, regardless of the format of the log entry that was
+        #  originally written to Stackdriver Logging.
+        # @param [Symbol] version The log entry version used when exporting log
+        #   entries from this sink. This version does not have to correspond to
+        #   the version of the log entry when it was written to Stackdriver
+        #   Logging. Accepted values are `:unspecified`, `:v2`, and `:v1`.
+        #   Version 2 is currently the preferred format. An unspecified version
+        #   format currently defaults to V2 in the service. The default value is
+        #   `:unspecified`.
+        #
+        # @return [Google::Cloud::Logging::Sink] a project sink
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   storage = gcloud.storage
+        #
+        #   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}"
+        #
+        #   sink = logging.create_sink "my-sink",
+        #                              "storage.googleapis.com/#{bucket.id}"
+        #
+        def create_sink name, destination, filter: nil, version: :unspecified
+          version = Sink.resolve_version version
+          ensure_service!
+          grpc = service.create_sink name, destination, filter, version
+          Sink.from_grpc grpc, service
+        end
+        alias_method :new_sink, :create_sink
+
+        ##
+        # Retrieves a sink by name.
+        #
+        # @param [String] sink_name Name of a sink.
+        #
+        # @return [Google::Cloud::Logging::Sink, nil] Returns `nil` if the sink
+        #   does not exist.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sink = logging.sink "existing-sink"
+        #
+        # @example By default `nil` will be returned if the sink does not exist.
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sink = logging.sink "non-existing-sink" #=> nil
+        #
+        def sink sink_name
+          ensure_service!
+          grpc = service.get_sink sink_name
+          Sink.from_grpc grpc, service
+        rescue Google::Cloud::NotFoundError
+          nil
+        end
+        alias_method :get_sink, :sink
+        alias_method :find_sink, :sink
+
+        ##
+        # Retrieves the list of metrics belonging to the project.
+        #
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of metrics to return.
+        #
+        # @return [Array<Google::Cloud::Logging::Metric>] (See
+        #   {Google::Cloud::Logging::Metric::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metrics = logging.metrics
+        #   metrics.each do |m|
+        #     puts "#{m.name}: #{m.filter}"
+        #   end
+        #
+        # @example Retrieve all metrics: (See {Metric::List#all})
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metrics = logging.metrics
+        #
+        #   metrics.all do |m|
+        #     puts "#{m.name}: #{m.filter}"
+        #   end
+        #
+        def metrics token: nil, max: nil
+          ensure_service!
+          grpc = service.list_metrics token: token, max: max
+          Metric::List.from_grpc grpc, service, max
+        end
+        alias_method :find_metrics, :metrics
+
+        ##
+        # Creates a new logs-based metric for Google Cloud Monitoring.
+        #
+        # @see https://cloud.google.com/logging/docs/view/logs_based_metrics
+        #   Logs-based Metrics
+        # @see https://cloud.google.com/monitoring/docs Google Cloud Monitoring
+        #
+        # @param [String] name The client-assigned metric identifier. Metric
+        #   identifiers are limited to 1000 characters and can include only the
+        #   following characters: `A-Z`, `a-z`, `0-9`, and the special
+        #   characters `_-.,+!*',()%/\`. The forward-slash character (`/`)
+        #   denotes a hierarchy of name pieces, and it cannot be the first
+        #   character of the name.
+        # @param [String] filter An [advanced logs
+        #   filter](https://cloud.google.com/logging/docs/view/advanced_filters).
+        # @param [String, nil] description A description of this metric, which
+        #   is used in documentation.
+        #
+        # @return [Google::Cloud::Logging::Metric]
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.create_metric "errors", "severity>=ERROR"
+        #
+        def create_metric name, filter, description: nil
+          ensure_service!
+          grpc = service.create_metric name, filter, description
+          Metric.from_grpc grpc, service
+        end
+        alias_method :new_metric, :create_metric
+
+        ##
+        # Retrieves metric by name.
+        #
+        # @param [String] name Name of a metric.
+        #
+        # @return [Google::Cloud::Logging::Metric, nil] Returns `nil` if metric
+        #   does not exist.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.metric "existing_metric"
+        #
+        # @example By default `nil` will be returned if metric does not exist.
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   metric = logging.metric "non_existing_metric" #=> nil
+        #
+        def metric name
+          ensure_service!
+          grpc = service.get_metric name
+          Metric.from_grpc grpc, service
+        rescue Google::Cloud::NotFoundError
+          nil
+        end
+        alias_method :get_metric, :metric
+        alias_method :find_metric, :metric
+
+        protected
+
+        ##
+        # @private Raise an error unless an active connection to the service is
+        # available.
+        def ensure_service!
+          fail "Must have active connection to service" unless service
+        end
+      end
+    end
+  end
+end