grpc_access_logging_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a68e9f69eb2185dd62fa4a09fce523451b64b51e1bc235ab10412ebe2ee1e8f
+  data.tar.gz: 8940b1bd83aea87e84b43c9a7bbd82246529cfcefbc291bb93b4dffc0ae007ea
+SHA512:
+  metadata.gz: 2ab3910b015437b573ccfde6adc105b303286435eefad110246327469abcbd2c36ec9880ca37af7fbddbd9f244d026db086d1ab39a554a0b52c7ab4807148b96
+  data.tar.gz: 365573f561f728423a95f13656c5d5a392f000e68ede2b460819a03093506c3f4e0f75fe8d00c3a04ab2a442c910b4eb79841c234aa0d7f7bbeeceb117fe0d40

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_access_logging_interceptor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    grpc_access_logging_interceptor (0.0.1)
+      grpc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    google-protobuf (3.10.0-universal-darwin)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    grpc (1.24.0)
+      google-protobuf (~> 3.8)
+      googleapis-common-protos-types (~> 1.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    timecop (0.9.1)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  google-protobuf
+  grpc_access_logging_interceptor!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rspec
+  timecop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nao Minami
+
+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,81 @@
+# GrpcAccessLoggingInterceptor
+An interceptor for access logging with gRPC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc_access_logging_interceptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc_access_logging_interceptor
+
+## Usage
+Please set a `GrpcAccessLoggingInterceptor` as an interceptor of your gRPC application.
+
+```ruby
+require 'grpc'
+require 'grpc_access_logging_interceptor'
+
+server = GRPC::RpcServer.new(
+  interceptors: [
+    GrpcAccessLoggingInterceptor.new,
+  ]
+)
+server.handle(MyHandler.new)
+server.run_till_terminated_or_interrupted(['SIGINT'])
+```
+
+With this setting, the following access logs will be printed.
+
+```console
+I, [2019-03-15T00:00:00.000000 #30034]  INFO -- : {"remote_addr":"127.0.0.1","accessed_at":"2019-03-15 00:00:00.000000","params":"{\"value\":\"World\"}","user_agent":"grpc-node/1.19.0 grpc-c/7.0.0 (linux; chttp2; gold)","grpc_method":"/test.Test/HelloRpc","grpc_metadata":"{\"user-agent\":\"grpc-node/1.19.0 grpc-c/7.0.0 (linux; chttp2; gold)\"}","grpc_status_code":0,"response_time_ms":0.0}
+```
+
+### The information in the access log
+
+You can get information for the following fields.
+
+| Field Name | Meaning |
+| -- | -- |
+| accessed_at | The time that the request was received  |
+| grpc_metadata | [gRPC's metadata](https://grpc.io/docs/guides/concepts/#metadata) |
+| grpc_method | A path string (cf. [gRPC over HTTP2](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md)) |
+| grpc_status_code | [Status codes in gRPC](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md) |
+| params | Request parameter in JSON |
+| remote_addr |  IP address of a client (e.g. `"127.0.0.1"`) |
+| response_time_ms | Response time (ms) |
+| user_agent | User agent (e.g. `"grpc_health_probe grpc-go/1.17.0"`) |
+
+### Custom Logger
+
+You can use your custom logger.
+
+```ruby
+server = GRPC::RpcServer.new(
+  interceptors: [
+    GrpcAccessLoggingInterceptor.new(logger: YourCustomLogger.new),
+  ]
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/south37/grpc_access_logging_interceptor.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_access_logging_interceptor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grpc_access_logging_interceptor.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grpc_access_logging_interceptor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_access_logging_interceptor"
+  spec.version       = GrpcAccessLoggingInterceptor::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{An interceptor for access logging with gRPC.}
+  spec.description   = %q{An interceptor for access logging with gRPC.}
+  spec.homepage      = "https://github.com/south37/grpc_access_logging_interceptor"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/south37/grpc_access_logging_interceptor"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "google-protobuf"
+  spec.add_development_dependency "timecop"
+  spec.add_dependency "grpc"
+end

data/lib/grpc_access_logging_interceptor.rb

@@ -0,0 +1,10 @@
+require "grpc_access_logging_interceptor/version"
+require "grpc_access_logging_interceptor/server_interceptor"
+
+module GrpcAccessLoggingInterceptor
+  class << self
+    def new(options = {})
+      ServerInterceptor.new(**options)
+    end
+  end
+end

data/lib/grpc_access_logging_interceptor/default_logger.rb

@@ -0,0 +1,16 @@
+require "json"
+require "logger"
+
+module GrpcAccessLoggingInterceptor
+  class DefaultLogger
+    # @param [#info] logger
+    def initialize(logger: Logger.new($stdout))
+      @logger = logger
+    end
+
+    # @param [Hash] hash
+    def log(data)
+      @logger.info(data.to_json)
+    end
+  end
+end

data/lib/grpc_access_logging_interceptor/server_interceptor.rb

@@ -0,0 +1,122 @@
+require "grpc"
+require "grpc_access_logging_interceptor/default_logger"
+
+module GrpcAccessLoggingInterceptor
+  class ServerInterceptor < GRPC::ServerInterceptor
+    USER_AGENT_KEY = "user-agent"
+
+    # @param [#log] logger
+    # @param [#filter, nil] params_filter
+    # @param [#call, nil] custom_data_provider
+    def initialize(logger: DefaultLogger.new, params_filter: nil, custom_data_provider: nil)
+      @logger               = logger
+      @params_filter        = params_filter
+      @custom_data_provider = custom_data_provider
+    end
+
+    ##
+    # Intercept a unary request response call.
+    #
+    # @param [Object] request
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    #
+    def request_response(request:, call:, method:)
+      accessed_at = Time.now
+
+      data = {
+        remote_addr:   remote_addr(call.peer),
+        accessed_at:   accessed_at.utc.strftime('%Y-%m-%d %H:%M:%S.%6N'),
+        params:        filter(request.to_h).to_json,
+        user_agent:    call.metadata[USER_AGENT_KEY],
+        grpc_method:   grpc_method(method),
+        grpc_metadata: call.metadata.to_json,
+      }
+      data.merge!(custom_data(request: request, call: call, method: method))
+
+      yield
+
+      data[:grpc_status_code] = 0  # OK
+    rescue StandardError => e
+      data[:grpc_status_code] = grpc_status_code(e)
+      raise e
+    ensure
+      data[:response_time_ms] = response_time_ms(accessed_at)
+      log(data)
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+  private
+
+    # @param [Object] peer
+    # @return [String, nil]
+    def remote_addr(peer)
+      # Usually peer is a string such as "ipv4:127.0.0.1:63634"
+      if peer.is_a?(String) && peer[0..4] == 'ipv4:'
+        peer.split(':')[1]
+      else
+        nil
+      end
+    end
+
+    # @param [Method] method
+    # @return [String]
+    def grpc_method(method)
+      # We use path, which is represented as "/" Service-Name "/" {method name}
+      # e.g. /google.pubsub.v2.PublisherService/CreateTopic.
+      # cf. https://github.com/grpc/grpc/blob/v1.24.0/doc/PROTOCOL-HTTP2.md
+      "/#{method.owner.service_name}/#{camelize(method.name.to_s)}"
+    end
+
+    # @param [String] term
+    # @return [String]
+    def camelize(term)
+      term.split("_").map(&:capitalize).join
+    end
+
+    # @param [Hash] params
+    # @return [Hash]
+    def filter(params)
+      if @params_filter
+        @params_filter.filter(params)
+      else
+        params
+      end
+    end
+
+    # @param [Object] request
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    # @return [Hash]
+    def custom_data(request:, call:, method:)
+      if @custom_data_provider
+        @custom_data_provider.call(request, call, method)
+      else
+        {}
+      end
+    end
+
+    # @param [StandardError] e
+    # @return [Integer] represents the grpc status code
+    def grpc_status_code(e)
+      case e
+      when GRPC::BadStatus
+        e.code
+      else
+        2  # GRPC::Unknown
+      end
+    end
+
+    # @param [Time] from
+    # @return [Integer]
+    def response_time_ms(from)
+      (Time.now - from) * 1000
+    end
+
+    # @param [Hash] data
+    def log(data)
+      @logger.log(data)
+    end
+  end
+end

data/lib/grpc_access_logging_interceptor/version.rb

@@ -0,0 +1,3 @@
+module GrpcAccessLoggingInterceptor
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: grpc_access_logging_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An interceptor for access logging with gRPC.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grpc_access_logging_interceptor.gemspec
+- lib/grpc_access_logging_interceptor.rb
+- lib/grpc_access_logging_interceptor/default_logger.rb
+- lib/grpc_access_logging_interceptor/server_interceptor.rb
+- lib/grpc_access_logging_interceptor/version.rb
+homepage: https://github.com/south37/grpc_access_logging_interceptor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/south37/grpc_access_logging_interceptor
+  source_code_uri: https://github.com/south37/grpc_access_logging_interceptor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An interceptor for access logging with gRPC.
+test_files: []