diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b04a8c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1f525be --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +--- +language: ruby +cache: bundler +rvm: + - 2.7.0 +before_install: gem install bundler -v 2.1.2 diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..e50a5ad --- /dev/null +++ b/Gemfile @@ -0,0 +1,9 @@ +source "https://rubygems.org" + +gemspec + +gem "rake", "~> 12.0" +gem "rspec", "~> 3.0" +gem 'sniffer', git: 'https://github.com/dsalahutdinov/sniffer', branch: 'feature/middleware' +gem 'byebug' +gem 'faraday' diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..2575cf2 --- /dev/null +++ b/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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0614ae --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Yabeda::Http + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yabeda/http`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'yabeda-http' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install yabeda-http + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/yabeda-http. + + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b7e9ed5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..7e86574 --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +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__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/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 diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..73fcfcc --- /dev/null +++ b/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: diff --git a/lib/yabeda/http.rb b/lib/yabeda/http.rb new file mode 100644 index 0000000..cb27a13 --- /dev/null +++ b/lib/yabeda/http.rb @@ -0,0 +1,27 @@ +require "yabeda/http/version" +require 'yabeda/http/sniffer' +require "yabeda" +require 'sniffer' + +require 'byebug' +module Yabeda + module Http + Yabeda.configure do + group :http + + counter :requests_total, + comment: "A counter of the total number of external HTTP requests.", + tags: %i[host] + + ::Sniffer.config do |c| + c.enabled = true + c.middleware do |chain| + chain.add(Yabeda::Http::Sniffer) + end + end + end + + class Error < StandardError; end + # Your code goes here... + end +end diff --git a/lib/yabeda/http/sniffer.rb b/lib/yabeda/http/sniffer.rb new file mode 100644 index 0000000..2ac0126 --- /dev/null +++ b/lib/yabeda/http/sniffer.rb @@ -0,0 +1,14 @@ +module Yabeda + module Http + class Sniffer + def call(data_item) + Yabeda.http_requests_total.increment( + host: data_item.request.host, + port: data_item.request.port, + method: data_item.request.method, + query: data_item.request.query + ) + end + end + end +end diff --git a/lib/yabeda/http/version.rb b/lib/yabeda/http/version.rb new file mode 100644 index 0000000..feb403f --- /dev/null +++ b/lib/yabeda/http/version.rb @@ -0,0 +1,5 @@ +module Yabeda + module Http + VERSION = "0.1.0" + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..407ffa9 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require "bundler/setup" +require "yabeda/http" + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = ".rspec_status" + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end diff --git a/spec/yabeda/http_spec.rb b/spec/yabeda/http_spec.rb new file mode 100644 index 0000000..8dc4308 --- /dev/null +++ b/spec/yabeda/http_spec.rb @@ -0,0 +1,9 @@ +RSpec.describe Yabeda::Http do + it "has a version number" do + expect(Yabeda::Http::VERSION).not_to be nil + end + + it "does something useful" do + expect(false).to eq(true) + end +end diff --git a/yabeda-http.gemspec b/yabeda-http.gemspec new file mode 100644 index 0000000..57dfc17 --- /dev/null +++ b/yabeda-http.gemspec @@ -0,0 +1,27 @@ +require_relative 'lib/yabeda/http/version' + +Gem::Specification.new do |spec| + spec.name = "yabeda-http" + spec.version = Yabeda::Http::VERSION + spec.authors = ["Dmitry Salahutdinov"] + spec.email = ["dsalahutdinov@gmail.com"] + + spec.summary = %q{Monitoring of external services http/https calls} + spec.description = %q{Extends Yabeda metrics to collect external calls} + spec.homepage = "https://github.com/yabeda-rb/yabeda-http" + 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" + + 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_runtime_dependency "yabeda" + spec.add_runtime_dependency "sniffer" +end