google-cloud-logging 0.20.0

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

@@ -0,0 +1,230 @@
+# 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/sink/list"
+
+module Google
+  module Cloud
+    module Logging
+      ##
+      # # Sink
+      #
+      # Used to export log entries outside Stackdriver Logging. When you create
+      # a sink, new log entries 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).
+      #
+      # You can retrieve an existing sink with {Project#sink}.
+      #
+      # @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
+      #
+      # @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}"
+      #
+      class Sink
+        ##
+        # @private The gRPC Service object.
+        attr_accessor :service
+
+        ##
+        # @private The Google API Client object.
+        attr_accessor :grpc
+
+        ##
+        # @private Create an empty Sink object.
+        def initialize
+          @service = nil
+          @grpc = Google::Logging::V2::LogSink.new
+        end
+
+        ##
+        # 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 `_-.`.
+        def name
+          @grpc.name
+        end
+
+        ##
+        # The export destination. See [Exporting Logs With
+        # Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
+        def destination
+          @grpc.destination
+        end
+
+        ##
+        # Updates the export destination. See [Exporting Logs With
+        # Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
+        def destination= destination
+          @grpc.destination = destination
+        end
+
+        ##
+        # 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.
+        def filter
+          @grpc.filter
+        end
+
+        ##
+        # Updates the [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.
+        def filter= filter
+          @grpc.filter = filter
+        end
+
+        ##
+        # 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.
+        def version
+          @grpc.output_version_format
+        end
+
+        ##
+        # Updates 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 `:VERSION_FORMAT_UNSPECIFIED`, `:V2`, and `:V1`.
+        def version= version
+          @grpc.output_version_format = self.class.resolve_version(version)
+        end
+
+        ##
+        # Helper to determine if the sink's version is
+        # `VERSION_FORMAT_UNSPECIFIED`.
+        def unspecified?
+          !(v1? || v2?)
+        end
+
+        ##
+        # Helper to determine if the sink's version is `V2`.
+        def v2?
+          version == :V2
+        end
+
+        ##
+        # Helper to determine if the sink's version is `V1`.
+        def v1?
+          version == :V1
+        end
+
+        ##
+        # Updates the logs-based sink.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sink = logging.sink "severe_errors"
+        #   sink.filter = "logName:syslog AND severity>=ERROR"
+        #   sink.save
+        #
+        def save
+          ensure_service!
+          @grpc = service.update_sink name, destination, filter, version
+        end
+
+        ##
+        # Reloads the logs-based sink with current data from the Logging
+        # service.
+        def reload!
+          ensure_service!
+          @grpc = service.get_sink name
+        end
+        alias_method :refresh!, :reload!
+
+        ##
+        # Permanently deletes the logs-based sink.
+        #
+        # @return [Boolean] Returns `true` if the sink was deleted.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   logging = gcloud.logging
+        #   sink = logging.sink "severe_errors"
+        #   sink.delete
+        #
+        def delete
+          ensure_service!
+          service.delete_sink name
+          true
+        end
+
+        ##
+        # @private New Sink from a Google::Logging::V2::LogSink object.
+        def self.from_grpc grpc, service
+          new.tap do |f|
+            f.grpc = grpc
+            f.service = service
+          end
+        end
+
+        ##
+        # @private Convert a version value to the gRPC enum value.
+        def self.resolve_version version
+          ver = version.to_s.upcase.to_sym
+          ver = Google::Logging::V2::LogSink::VersionFormat.resolve ver
+          return ver if ver
+          Google::Logging::V2::LogSink::VersionFormat:: \
+            VERSION_FORMAT_UNSPECIFIED
+        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/sink/list.rb

@@ -0,0 +1,173 @@
+# 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 Sink
+        ##
+        # Sink::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 Sink::List with an array of Sink instances.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of sinks.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #
+          #   sinks = logging.sinks
+          #   if sinks.next?
+          #     next_sinks = sinks.next
+          #   end
+          #
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of sinks.
+          #
+          # @return [Sink::List]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #
+          #   sinks = dataset.sinks
+          #   if sinks.next?
+          #     next_sinks = sinks.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            list_grpc = @service.list_sinks token: token, max: @max
+            self.class.from_grpc list_grpc, @service
+          end
+
+          ##
+          # Retrieves all sinks by repeatedly loading {#next} until {#next?}
+          # returns `false`. Calls the given block once for each sink, which is
+          # passed as the parameter.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method may make several API calls until all sinks 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 sinks. Default is no limit.
+          # @yield [sink] The block for accessing each sink.
+          # @yieldparam [Sink] sink The sink object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each sink by passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   sinks = logging.sinks
+          #
+          #   sinks.all do |sink|
+          #     puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   sinks = logging.sinks
+          #
+          #   all_names = sinks.all.map do |sink|
+          #     sink.name
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   logging = gcloud.logging
+          #   sinks = logging.sinks
+          #
+          #   sinks.all(request_limit: 10) do |sink|
+          #     puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
+          #   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 Sink::List from a
+          # Google::Logging::V2::ListSinksResponse object.
+          def self.from_grpc grpc_list, service, max = nil
+            sinks = new(Array(grpc_list.sinks).map do |grpc|
+              Sink.from_grpc grpc, service
+            end)
+            token = grpc_list.next_page_token
+            token = nil if token == ""
+            sinks.instance_variable_set "@token", token
+            sinks.instance_variable_set "@service", service
+            sinks.instance_variable_set "@max", max
+            sinks
+          end
+
+          protected
+
+          ##
+          # Raise an error unless an active service is available.
+          def ensure_service!
+            fail "Must have active service" unless @service
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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/v2/config_service_v2_api"
+require "google/cloud/logging/v2/logging_service_v2_api"
+require "google/cloud/logging/v2/metrics_service_v2_api"

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

@@ -0,0 +1,331 @@
+# 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/logging/v2/logging_config.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+require "google/logging/v2/logging_config_services_pb"
+
+module Google
+  module Cloud
+    module Logging
+      module V2
+        # Service for configuring sinks used to export log entries outside Stackdriver
+        # Logging.
+        #
+        # @!attribute [r] stub
+        #   @return [Google::Logging::V2::ConfigServiceV2::Stub]
+        class ConfigServiceV2Api
+          attr_reader :stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "logging.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze
+
+          DEFAULT_TIMEOUT = 30
+
+          PAGE_DESCRIPTORS = {
+            "list_sinks" => Google::Gax::PageDescriptor.new(
+              "page_token",
+              "next_page_token",
+              "sinks")
+          }.freeze
+
+          private_constant :PAGE_DESCRIPTORS
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/cloud-platform.read-only",
+            "https://www.googleapis.com/auth/logging.admin",
+            "https://www.googleapis.com/auth/logging.read",
+            "https://www.googleapis.com/auth/logging.write"
+          ].freeze
+
+          PARENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}"
+          )
+
+          private_constant :PARENT_PATH_TEMPLATE
+
+          SINK_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/sinks/{sink}"
+          )
+
+          private_constant :SINK_PATH_TEMPLATE
+
+          # Returns a fully-qualified parent resource name string.
+          # @param project [String]
+          # @return [String]
+          def self.parent_path project
+            PARENT_PATH_TEMPLATE.render(
+              :"project" => project
+            )
+          end
+
+          # Returns a fully-qualified sink resource name string.
+          # @param project [String]
+          # @param sink [String]
+          # @return [String]
+          def self.sink_path project, sink
+            SINK_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"sink" => sink
+            )
+          end
+
+          # Parses the project from a parent resource.
+          # @param parent_name [String]
+          # @return [String]
+          def self.match_project_from_parent_name parent_name
+            PARENT_PATH_TEMPLATE.match(parent_name)["project"]
+          end
+
+          # Parses the project from a sink resource.
+          # @param sink_name [String]
+          # @return [String]
+          def self.match_project_from_sink_name sink_name
+            SINK_PATH_TEMPLATE.match(sink_name)["project"]
+          end
+
+          # Parses the sink from a sink resource.
+          # @param sink_name [String]
+          # @return [String]
+          def self.match_sink_from_sink_name sink_name
+            SINK_PATH_TEMPLATE.match(sink_name)["sink"]
+          end
+
+          # @param service_path [String]
+          #   The domain name of the API remote host.
+          # @param port [Integer]
+          #   The port on which to connect to the remote host.
+          # @param channel [Channel]
+          #   A Channel object through which to make calls.
+          # @param chan_creds [Grpc::ChannelCredentials]
+          #   A ChannelCredentials for the setting up the RPC client.
+          # @param client_config[Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          # @param app_name [String]
+          #   The codename of the calling service.
+          # @param app_version [String]
+          #   The version of the calling service.
+          def initialize \
+              service_path: SERVICE_ADDRESS,
+              port: DEFAULT_SERVICE_PORT,
+              channel: nil,
+              chan_creds: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              app_name: "gax",
+              app_version: Google::Gax::VERSION
+            google_api_client = "#{app_name}/#{app_version} " \
+              "#{CODE_GEN_NAME_VERSION} ruby/#{RUBY_VERSION}".freeze
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "config_service_v2_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.logging.v2.ConfigServiceV2",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                page_descriptors: PAGE_DESCRIPTORS,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+            @stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              scopes: scopes,
+              &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
+            )
+
+            @list_sinks = Google::Gax.create_api_call(
+              @stub.method(:list_sinks),
+              defaults["list_sinks"]
+            )
+            @get_sink = Google::Gax.create_api_call(
+              @stub.method(:get_sink),
+              defaults["get_sink"]
+            )
+            @create_sink = Google::Gax.create_api_call(
+              @stub.method(:create_sink),
+              defaults["create_sink"]
+            )
+            @update_sink = Google::Gax.create_api_call(
+              @stub.method(:update_sink),
+              defaults["update_sink"]
+            )
+            @delete_sink = Google::Gax.create_api_call(
+              @stub.method(:delete_sink),
+              defaults["delete_sink"]
+            )
+          end
+
+          # Service calls
+
+          # Lists sinks.
+          #
+          # @param parent [String]
+          #   Required. The resource name containing the sinks.
+          #   Example: +"projects/my-logging-project"+.
+          # @param page_size [Integer]
+          #   The maximum number of resources contained in the underlying API
+          #   response. If page streaming is performed per-resource, this
+          #   parameter does not affect the return value. If page streaming is
+          #   performed per-page, this determines the maximum number of
+          #   resources in a page.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>]
+          #   An enumerable of Google::Logging::V2::LogSink instances.
+          #   See Google::Gax::PagedEnumerable documentation for other
+          #   operations such as per-page iteration or access to the response
+          #   object.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def list_sinks \
+              parent,
+              page_size: nil,
+              options: nil
+            req = Google::Logging::V2::ListSinksRequest.new(
+              parent: parent
+            )
+            req.page_size = page_size unless page_size.nil?
+            @list_sinks.call(req, options)
+          end
+
+          # Gets a sink.
+          #
+          # @param sink_name [String]
+          #   The resource name of the sink to return.
+          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogSink]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def get_sink \
+              sink_name,
+              options: nil
+            req = Google::Logging::V2::GetSinkRequest.new(
+              sink_name: sink_name
+            )
+            @get_sink.call(req, options)
+          end
+
+          # Creates a sink.
+          #
+          # @param parent [String]
+          #   The resource in which to create the sink.
+          #   Example: +"projects/my-project-id"+.
+          #
+          #   The new sink must be provided in the request.
+          # @param sink [Google::Logging::V2::LogSink]
+          #   The new sink, which must not have an identifier that already
+          #   exists.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogSink]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def create_sink \
+              parent,
+              sink,
+              options: nil
+            req = Google::Logging::V2::CreateSinkRequest.new(
+              parent: parent,
+              sink: sink
+            )
+            @create_sink.call(req, options)
+          end
+
+          # Creates or updates a sink.
+          #
+          # @param sink_name [String]
+          #   The resource name of the sink to update.
+          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #
+          #   The updated sink must be provided in the request and have the
+          #   same name that is specified in +sinkName+.  If the sink does not
+          #   exist, it is created.
+          # @param sink [Google::Logging::V2::LogSink]
+          #   The updated sink, whose name must be the same as the sink
+          #   identifier in +sinkName+.  If +sinkName+ does not exist, then
+          #   this method creates a new sink.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogSink]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def update_sink \
+              sink_name,
+              sink,
+              options: nil
+            req = Google::Logging::V2::UpdateSinkRequest.new(
+              sink_name: sink_name,
+              sink: sink
+            )
+            @update_sink.call(req, options)
+          end
+
+          # Deletes a sink.
+          #
+          # @param sink_name [String]
+          #   The resource name of the sink to delete.
+          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def delete_sink \
+              sink_name,
+              options: nil
+            req = Google::Logging::V2::DeleteSinkRequest.new(
+              sink_name: sink_name
+            )
+            @delete_sink.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end