yabeda-http_requests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01bace4735a867891820dd93841a8644b1f3937e0d51680cc7179ba508bea8d3
+  data.tar.gz: 4bea13b8f7843f97673dbaaf529b27f16de4fce6d548271e3dbd70e64a4142cd
+SHA512:
+  metadata.gz: d9d17867e1a4c0a2405526c0f5f8e0f6a715bf2256781128e58f0a6b894a80772350138537ac6260770554204798b913684853edaa9cee5049e9123b36e66c8e
+  data.tar.gz: 48df8e0f9ac3f1d5715464ec3756dd4fb9989412abae0407e489a4dc2ade86436eb33eb6df814971d40db8abd67e2a41fc198e181b4c6ec7062b8e3fe1998dce

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Style/Documentation:
+  Exclude:
+    - 'example/**/*'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'byebug'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+
+gem 'faraday'
+gem 'sniffer', '>= 0.4.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,83 @@
+<a href="https://amplifr.com/?utm_source=yabeda-http_requests">
+  <img width="100" height="140" align="right"
+    alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
+</a>
+
+# Yabeda::HttpRequests
+
+Built-in metrics for external services HTTP calls! This gem is a Part of the [yabeda](https://github.com/yabeda-rb/yabeda) suite.
+
+## Metrics
+
+Works as the Puma plugin and provides following metrics:
+ - `http_request_total` - the number of external HTTP request attempts (by host, port, method)
+ - `http_response_total` - the number of made external HTTP requeusts (by host, port, method, status)
+ - `http_response_duuration` - the histogram of response duration (by host, port, method, status)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-http_requests'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yabeda-http_requests
+
+## Usage
+
+After plugin the gem, you just have to set up metrics exporting with [yabeda-prometheus](https://github.com/yabeda-rb/yabeda-prometheus) gem.
+
+The metrics page will look like this:
+
+```
+# TYPE http_requests_total_count counter
+# HELP http_requests_total_count A counter of the total number of external HTTP requests.
+http_request_total{host="twitter.com",port="443",method="GET",query="/dsalahutdinov1"} 149.0
+http_request_total{host="dev.to",port="443",method="GET",query="/amplifr"} 145.0
+...
+```
+
+To simple set up Grafana, try the [sample dashboard](https://github.com/yabeda-rb/yabeda-http_requests/blob/master/example/grafana/provisioning/dashboards/yabeda-http_requests.json).
+
+## Sample application
+
+Sample application aims to show how Ruby web-application, this gem and Prometheus/Grafana work togather.
+Get into `example` directory and run docker compose:
+
+```sh
+$ cd example
+$ docker-compose up
+```
+
+After docker image builds and all the services get up, you can browse application endpoints:
+ - Ruby web-application runs on [http://localhost:9292/](http://localhost:9292/). Everytime you request page, it schedules random web-scrapping job into sidekiq.
+ - Sidekiq exposes prometheus metrics on [http://localhost:9394/metrics](http://localhost:9394/metrics). This endpoint is scrapped by prometheus exporter every 5 seconds.
+ - Grafana runs on [http://localhost:3000/](http://localhost:3000/). Use `admin/foobar` as login and password to get in. Grafana already has specific dashboard with data visualisation.
+
+Follow the [yabeda-external-http-requests](http://localhost:3000/d/OGd-oEXWz/yabeda-external-http-requests?orgId=1&refresh=5s) dashboard in Grafana.
+Finally, after a couple of minutes when data collected you will see the following:
+![Monitor external HTTP calls with Grafana](docs/http_requests_rate_by_host.png)
+
+## Development with Docker
+
+Get local development environment working and tests running is very easy with docker-compose:
+```bash
+docker-compose run app bundle
+docker-compose run app bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-http_requests.
+
+
+## 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,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yabeda/http'
+
+# 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/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.4'
+
+services:
+  app:
+    image: ruby:latest
+    environment:
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_CONFIG=/app/.bundle/config
+    command: bash
+    working_dir: /app
+    volumes:
+      - .:/app:cached
+      - bundler_data:/bundle
+    tmpfs:
+      - /tmp
+
+volumes:
+  bundler_data:

data/lib/yabeda/http_requests.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'yabeda/http_requests/version'
+require 'yabeda/http_requests/sniffer'
+require 'yabeda'
+require 'sniffer'
+
+module Yabeda
+  # Common module
+  module HttpRequests
+    Yabeda.configure do
+      group :http
+
+      LONG_RUNNING_REQUEST_BUCKETS = [
+        0.5, 1, 2.5, 5, 10, 25, 50, 100, 250, 500, 1000, # standard
+        30_000, 60_000, 120_000, 300_000, 600_000 # slow queries
+      ].freeze
+
+      counter :request_total,
+              comment: 'A counter of the total number of external HTTP \
+                         requests.',
+              tags: %i[host port method]
+      counter :response_total,
+              comment: 'A counter of the total number of external HTTP \
+                         responses.',
+              tags: %i[host port method status]
+
+      histogram :response_duration, tags: %i[host port method status],
+                                    unit: :milliseconds,
+                                    buckets: LONG_RUNNING_REQUEST_BUCKETS,
+                                    comment: "A histogram of the response \
+                                               duration (milliseconds)."
+
+      ::Sniffer.config do |c|
+        c.enabled = true
+        c.middleware do |chain|
+          chain.add(Yabeda::HttpRequests::Sniffer)
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/http_requests/sniffer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module HttpRequests
+    # Middleware for sniffer gem
+    class Sniffer
+      def request(data_item)
+        Yabeda.http_request_total.increment(
+          host: data_item.request.host,
+          port: data_item.request.port,
+          method: data_item.request.method
+        )
+      end
+
+      def response(data_item)
+        log_http_response_total(data_item)
+        log_http_response_duration(data_item)
+      end
+
+      private
+
+      def log_http_response_total(data_item)
+        Yabeda.http_response_total.increment(
+          host: data_item.request.host,
+          port: data_item.request.port,
+          method: data_item.request.method,
+          status: data_item.response.status
+        )
+      end
+
+      def log_http_response_duration(data_item)
+        labels = {
+          host: data_item.request.host,
+          port: data_item.request.port,
+          method: data_item.request.method,
+          status: data_item.response.status
+        }
+
+        Yabeda.http_response_duration.measure(
+          labels, duration_in_milliseconds(data_item)
+        )
+      end
+
+      def duration_in_milliseconds(data_item)
+        seconds = data_item.response&.timing
+        return nil if seconds.nil?
+
+        (seconds * 1000).round
+      end
+    end
+  end
+end

data/lib/yabeda/http_requests/version.rb

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

data/yabeda-http_requests.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/yabeda/http_requests/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yabeda-http_requests'
+  spec.version       = Yabeda::HttpRequests::VERSION
+  spec.authors       = ['Dmitry Salahutdinov']
+  spec.email         = ['dsalahutdinov@gmail.com']
+
+  spec.summary       = 'Monitoring of external services HTTP/HTTPS calls'
+  spec.description   = 'Extends Yabeda metrics to collect external calls'
+  spec.homepage      = 'https://github.com/yabeda-rb/yabeda-http_requests'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yabeda-rb/yabeda-http_requests'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|example|docs)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'sniffer'
+  spec.add_runtime_dependency 'yabeda'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-http_requests
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Salahutdinov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sniffer
+  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'
+description: Extends Yabeda metrics to collect external calls
+email:
+- dsalahutdinov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/yabeda/http_requests.rb
+- lib/yabeda/http_requests/sniffer.rb
+- lib/yabeda/http_requests/version.rb
+- yabeda-http_requests.gemspec
+homepage: https://github.com/yabeda-rb/yabeda-http_requests
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yabeda-rb/yabeda-http_requests
+  source_code_uri: https://github.com/yabeda-rb/yabeda-http_requests
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Monitoring of external services HTTP/HTTPS calls
+test_files: []