yabeda-gruf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 825cbd87d9e02b2eb8197d8e50411689d52bcb74817642bc354359759b80a34b
+  data.tar.gz: 30f0c2b0080898575b86c4d8087371c911765055654c25e3f91769570f8abb12
+SHA512:
+  metadata.gz: 373830ae75d21f3803ebd457e3394b15f323b737e739f8ffb6b88ec540e1371094d336e60621711f95ae800bcd23e72329ed72ea2900f7786e62cfdc2628779e
+  data.tar.gz: 7e64ebb48767fc6ed40d8d1e0fa6873cb5d3378a95080d201cdfb1dcf6dce906dbbd514b44ce636ab8b15605261c5c2d13717bb0f2c8354055ffc5be0531d9bf

data/.gitignore

@@ -0,0 +1,59 @@
+
+# Created by https://www.gitignore.io/api/ruby
+# Edit at https://www.gitignore.io/?templates=ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+---
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - "Gemfile"
+    - "spec/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yabeda-gruf.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-byebug', platform: :mri
+
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    yabeda-gruf (1.0.0)
+      gruf
+      yabeda
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    dry-initializer (2.5.0)
+    google-protobuf (3.6.1)
+    googleapis-common-protos-types (1.0.2)
+      google-protobuf (~> 3.0)
+    grpc (1.17.0)
+      google-protobuf (~> 3.1)
+      googleapis-common-protos-types (~> 1.0.0)
+    grpc-tools (1.17.0)
+    gruf (2.5.1)
+      activesupport
+      concurrent-ruby
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      slop (~> 4.6)
+    i18n (1.2.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.57.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.24.0)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.9.0)
+    slop (4.6.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    yabeda (0.1.2)
+      concurrent-ruby
+      dry-initializer
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  yabeda-gruf!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Boostcom
+
+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,36 @@
+# Yabeda::Gruf
+
+Metrics for gruf.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-gruf'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add `Yabeda::Gruf::ServerInterceptor` in gruf configuration.
+Preferably at the beginning of interceptor chain.
+
+```ruby
+Gruf.configure do |c|
+  c.interceptors.use(Yabeda::Gruf::ServerInterceptor)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/Boostcom/yabeda-gruf.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yabeda/gruf'
+
+# 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/lib/yabeda/gruf/server_interceptor.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Gruf
+    class ServerInterceptor < ::Gruf::Interceptors::ServerInterceptor
+      def call # rubocop:disable Metrics/MethodLength
+        response = nil
+        error = nil
+
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        begin
+          response = yield
+        rescue StandardError => e
+          error = e
+        end
+
+        stop_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        l = labels(response, error)
+
+        Yabeda.gruf_served_requests_total.increment(l)
+        Yabeda.gruf_served_request_duration.measure(l, stop_time - start_time)
+
+        raise error if error
+        response
+      end
+
+      private
+
+      def labels(_response, error)
+        {
+          grpcService: request.service_key,
+          grpcMethod: request.method_key,
+          grpcStatus: error ? error.class.name : 'GRPC::Ok',
+          status: status_code(error)
+        }
+      end
+
+      def status_code(error)
+        return '0' unless error
+        return 'error' unless error.respond_to?(:code)
+
+        error.code.to_s
+      end
+    end
+  end
+end

data/lib/yabeda/gruf/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Gruf
+    VERSION = '1.0.0'
+  end
+end

data/lib/yabeda/gruf.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'yabeda/gruf/version'
+require 'yabeda'
+require 'gruf'
+
+require 'yabeda/gruf/server_interceptor'
+
+module Yabeda
+  module Gruf
+    LONG_RUNNING_REQUEST_BUCKETS = [
+      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard
+      30, 60, 120, 300, 600, # Sometimes requests may be really long-running
+    ].freeze
+
+    class << self
+      def install!
+        configure_yabeda!
+      end
+
+      private
+
+      def configure_yabeda!
+        Yabeda.configure do
+          group :gruf
+
+          # server
+          counter   :served_requests_total, comment: 'A counter of the total number of gRPC requests processed.'
+          histogram :served_request_duration, unit: :seconds, buckets: LONG_RUNNING_REQUEST_BUCKETS,
+                                              comment: 'A histogram of the response latency.'
+        end
+      end
+    end
+  end
+end
+
+Yabeda::Gruf.install!

data/yabeda-gruf.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yabeda/gruf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yabeda-gruf'
+  spec.version       = Yabeda::Gruf::VERSION
+  spec.authors       = ['kruczjak']
+  spec.email         = ['jakub.kruczek@boostcom.no']
+
+  spec.summary       = 'Yabeda exporter for gruf'
+  spec.description   = 'Yabeda exporter for gruf gRPC server'
+  spec.homepage      = 'https://boostcom.no'
+  spec.license       = 'MIT'
+
+  # 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 { |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_dependency 'gruf'
+  spec.add_dependency 'yabeda'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-gruf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kruczjak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gruf
+  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'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Yabeda exporter for gruf gRPC server
+email:
+- jakub.kruczek@boostcom.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/gruf.rb
+- lib/yabeda/gruf/server_interceptor.rb
+- lib/yabeda/gruf/version.rb
+- yabeda-gruf.gemspec
+homepage: https://boostcom.no
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Yabeda exporter for gruf
+test_files: []