google_cloud_logging_extension 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44415cf20a26f3450f298d5071b7817126c693f0f2d43f2157124306d2169e06
+  data.tar.gz: 0be5fd106d23db06709a09ac284d5d1733c9fbcb04b6a0be23acc8a3a666fded
+SHA512:
+  metadata.gz: 85350a0b3b8e487c8c516584cde20941fa9efe259c4df4e29b4d41638fb2d0e3d37dfdd7d40451bee0e0a5a265047003ecac1377c16f43a4a3e3dbdb388ed5c6
+  data.tar.gz: 1e42ab6bc5547c0d5cb2e1e0a5e58db9fc10f89766a3a4b12ee684b648989bc821c5638fdb009471bd3a8520dde0c5675d12ec47d08599c2a56c0f6a51891aeb

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_cloud_logging_extension.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+group :development, :test do
+  gem 'solargraph', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    google_cloud_logging_extension (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.13.6-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    solargraph (0.45.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.10)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  google_cloud_logging_extension!
+  rake (~> 13.0)
+  solargraph
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ishotihadus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# GoogleCloudLoggingExtension
+
+Extension of google-cloud-logging gem.
+
+This extension provides `Google::Cloud::Logging.create` method.
+
+This gem also converts exceptions into json payload.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add google_cloud_logging_extension
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install google_cloud_logging_extension
+
+## Usage
+
+### Use default extension
+
+```ruby
+require 'google_cloud_logging_extension'
+
+logger = Google::Cloud::Logging.create('test')
+# logger = Google::Cloud::Logging.create('test', 'gce_project', hoge: 'fuga')
+
+logger.info('hoge')
+
+begin
+  5 / 0
+rescue
+  logger.error($!)
+end
+```
+
+### Use roda plugin
+
+```ruby
+require 'google_cloud_logging_extension/roda_plugin'
+
+class App < Roda
+  plugin :google_cloud_logging, log_name: 'name', labels: { hoge: 'fuga' }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ishotihadus/google_cloud_logging_extension.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/google_cloud_logging_extension.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/google_cloud_logging_extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'google_cloud_logging_extension'
+  spec.version = GoogleCloudLoggingExtension::VERSION
+  spec.authors = ['Ishotihadus']
+  spec.email = ['hanachan.pao@gmail.com']
+
+  spec.summary = 'Extension of google-cloud-logging-gem'
+  spec.description = 'Extension of google-cloud-logging-gem.'
+  spec.homepage = 'https://github.com/ishotihadus/google_cloud_logging_extension'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ishotihadus/google_cloud_logging_extension'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f)}
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Google
+  module Cloud
+    module Logging
+      def self.create(log_name, resource_type = 'gce_project', **labels)
+        logging = Google::Cloud::Logging.new
+        writer = logging.async_writer(max_queue_size: 1000)
+        resource = logging.resource(resource_type)
+        if labels.key?(:level)
+          level = labels[:level]
+          labels.delete(:level)
+        end
+        logger = Google::Cloud::Logging::Logger.new(writer, log_name, resource, labels)
+        logger.level = level if level
+        logger
+      end
+
+      class Entry
+        # @param [Exception] exception
+        def create_exception_payload(exception)
+          {
+            class: exception.class.name,
+            message: exception.message,
+            backtrace: exception.backtrace,
+            cause: exception.cause.is_a?(Exception) ? create_exception_payload(exception.cause) : exception
+          }
+        end
+
+        def payload=(payload)
+          @payload = case payload
+                     when Exception
+                       create_exception_payload(payload)
+                     else
+                       payload
+                     end
+        end
+      end
+    end
+  end
+end

data/lib/google_cloud_logging_extension/roda_plugin.rb

@@ -0,0 +1,127 @@
+# frozen-string-literal: true
+
+require 'google/cloud/logging'
+
+module Google
+  module Cloud
+    module Logging
+      class Logger
+        def write_entry_with_http_request(severity, message, http_request)
+          entry = Entry.new.tap do |e|
+            e.timestamp = Time.now
+            e.severity = gcloud_severity severity
+            e.payload = message
+          end
+          entry.instance_variable_set(:@http_request, http_request)
+
+          actual_log_name = log_name
+          info = request_info
+          if info
+            actual_log_name = info.log_name || actual_log_name
+            entry.trace = "projects/#{@project}/traces/#{info.trace_id}" unless info.trace_id.nil? || @project.nil?
+            entry.trace_sampled = info.trace_sampled if entry.trace_sampled.nil?
+          end
+
+          writer.write_entries entry, log_name: actual_log_name, resource:, labels: entry_labels(info)
+        end
+      end
+
+      class Entry
+        class HttpRequest
+          attr_accessor :server_ip, :latency, :protocol
+
+          def to_grpc
+            return nil if empty?
+
+            Google::Cloud::Logging::Type::HttpRequest.new(
+              request_method: request_method.to_s,
+              request_url: url.to_s,
+              request_size: size.to_i,
+              status: status.to_i,
+              response_size: response_size.to_i,
+              user_agent: user_agent.to_s,
+              remote_ip: remote_ip.to_s,
+              referer: referer.to_s,
+              server_ip: server_ip.to_s,
+              latency:,
+              protocol: protocol.to_s,
+              cache_hit: !(!cache_hit),
+              cache_validated_with_origin_server: !(!validated)
+            )
+          end
+        end
+      end
+    end
+  end
+end
+
+class Roda
+  module RodaPlugins
+    module GoogleCloudLogging
+      def self.configure(app, opts = {})
+        if opts[:writer].nil? && opts[:resource].nil?
+          logging = Google::Cloud::Logging.new
+          opts[:writer] = logging.async_writer(max_queue_size: opts[:max_queue_size] || 1000)
+          opts[:resource] = logging.resource(opts[:resource_id] || 'gce_project')
+        end
+        opts[:log_name] ||= 'roda'
+        logger = Google::Cloud::Logging::Logger.new(opts[:writer], opts[:log_name], opts[:resource], opts[:labels])
+        logger.level = opts[:level] if opts[:level]
+        app.opts[:google_cloud_logger] = logger
+      end
+
+      module InstanceMethods
+        def cloud_logging_set_payload(key, value)
+          @google_cloud_logging_custom_payload ||= {}
+          @google_cloud_logging_custom_payload[key] = value
+        end
+
+        def cloud_logging_set_severity(value)
+          @google_cloud_logging_severity = value
+        end
+
+        private
+
+        def _roda_before_00__google_cloud_logging
+          return unless Process.const_defined?(:CLOCK_MONOTONIC_RAW)
+
+          @google_cloud_logging_clock = Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
+        end
+
+        def _roda_after_99__google_cloud_logging(res)
+          server_ip = "#{env['SERVER_NAME']}:#{env['SERVER_PORT']}"
+          latency = @google_cloud_logging_clock &&
+                    (Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW) - @google_cloud_logging_clock)
+          latency_fraction = latency - latency.to_i
+
+          latency_duration = Google::Protobuf::Duration.new(seconds: latency.to_i,
+                                                            nanos: (latency_fraction * 1000 * 1000 * 1000).to_i)
+
+          http_request = Google::Cloud::Logging::Entry::HttpRequest.new
+          http_request.request_method = env['REQUEST_METHOD']
+          http_request.url = "#{env['rack.url_scheme']}://#{env['HTTP_HOST'] || server_ip}#{env['REQUEST_URI']}"
+          http_request.status = res[0]
+          http_request.user_agent = env['HTTP_USER_AGENT']
+          http_request.remote_ip = env['HTTP_X_REAL_IP'] || env['REMOTE_ADDR']
+          http_request.server_ip = server_ip
+          http_request.referer = env['HTTP_REFERER']
+          http_request.latency = latency_duration
+          http_request.protocol = env['SERVER_PROTOCOL']
+
+          severity = @google_cloud_logging_severity || (res[0] >= 500 ? ::Logger::ERROR : ::Logger::INFO)
+
+          message = "#{env['REQUEST_METHOD']} #{env['REQUEST_URI']} #{env['SERVER_PROTOCOL']}"
+
+          payload = { message: }
+          payload.merge!(@google_cloud_logging_custom_payload) if @google_cloud_logging_custom_payload
+
+          opts[:google_cloud_logger]&.write_entry_with_http_request(severity, payload, http_request)
+        rescue StandardError
+          # pass
+        end
+      end
+    end
+
+    register_plugin(:google_cloud_logging, GoogleCloudLogging)
+  end
+end

data/lib/google_cloud_logging_extension/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GoogleCloudLoggingExtension
+  VERSION = '0.1.0'
+end

data/lib/google_cloud_logging_extension.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'google_cloud_logging_extension/google/cloud/logging'
+require_relative 'google_cloud_logging_extension/version'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: google_cloud_logging_extension
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ishotihadus
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-01 00:00:00.000000000 Z
+dependencies: []
+description: Extension of google-cloud-logging-gem.
+email:
+- hanachan.pao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- google_cloud_logging_extension.gemspec
+- lib/google_cloud_logging_extension.rb
+- lib/google_cloud_logging_extension/google/cloud/logging.rb
+- lib/google_cloud_logging_extension/roda_plugin.rb
+- lib/google_cloud_logging_extension/version.rb
+homepage: https://github.com/ishotihadus/google_cloud_logging_extension
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ishotihadus/google_cloud_logging_extension
+  source_code_uri: https://github.com/ishotihadus/google_cloud_logging_extension
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Extension of google-cloud-logging-gem
+test_files: []