mtr_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 304645e0f0ea1e14c5b92a04df71c554e3a07c8c
+  data.tar.gz: ae6d78847eb58cf4ccbb1d3da9e985dc52f4edb9
+SHA512:
+  metadata.gz: 8772708194ec209e674115ea90cd5f0b926336113172a7ffb0db3c56122a5583cc44901c75bcd61ea0835f3000129d7f3d377cff23fe35efff19f5e5f180cb38
+  data.tar.gz: '09c8ed845b0051030e05c38c42f3cc8f27075b27aea8061f48746570d081dbb13baf073de1d358a64c9d47fd39b5159f188ca8b8f443aee649467c5ea87166bd'

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at igor@renderedtext.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mtr_monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Šarčević
+
+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 @@
+# MtrMonitor
+
+Generates a MTR report, uploads the report to S3, and finally parses the report
+and collects statsd metrics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mtr_monitor'
+```
+
+## Generate an MTR report
+
+``` ruby
+name   = "google"
+domain = "google.com"
+
+s3_bucket             = "my-private-bucket-name" # change this
+aws_access_key_id     = "<KEY>"
+aws_secret_access_key = "<KEY>"
+
+report = MtrMonitor::Report.new(name,
+                                domain,
+                                s3_bucket,
+                                aws_access_key_id,
+                                aws_secret_access_key)
+
+report.generate
+report.submit_metrics
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mtr_monitor"
+
+# 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/mtr_monitor.rb

@@ -0,0 +1,78 @@
+require "mtr_monitor/version"
+
+module MtrMonitor
+  #
+  # Runs a mtr trace toward a domain and saves the report
+  # to /var/log/mtr/<domain>_timestamp.log , uploads to s3 and reports metrics to statsd.
+  #
+  class Report
+
+    def initialize(name, domain, s3_bucket, aws_access_key_id, aws_secret_access_key)
+      @name = name
+      @domain = domain
+      @s3_bucket = s3_bucket
+      @aws_access_key_id = aws_access_key_id
+      @aws_secret_access_key = aws_secret_access_key
+
+      @log_name  = "#{@name}/#{Time.now.strftime("%Y-%m-%d")}/#{@host_ip_address}/#{Time.now.strftime("%H-%M")}.log"
+      @log_path  = "/var/log/mtr/#{@log_name.gsub("/", "-")}"
+      @s3_path   = "s3://#{@s3_bucket}/#{@log_name}"
+    end
+
+    def generate
+      puts "Local Path : #{@log_path}"
+      puts "S3 Path    : #{@s3_path}"
+
+      `sudo mkdir -p /var/log/mtr`
+      `sudo sh -c 'mtr --report #{@domain} > #{@log_path}'`
+      `AWS_ACCESS_KEY_ID='#{@aws_access_key_id}' AWS_SECRET_ACCESS_KEY='#{@aws_secret_access_key}' aws s3 cp #{@log_path} #{@s3_path}`
+    end
+
+    def submit_metrics
+      report = `sudo cat #{@log_path}`
+
+      Mtr.parse(report).each do |hop|
+        hop_name = hop.name.gsub(".", "-").gsub("?", "q")
+        tags = [`hostname`.strip, @name, hop_name]
+
+        Watchman.submit("network.mtr.loss", hop.loss, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.snt", hop.snt, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.last", hop.last, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.avg", hop.avg, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.best", hop.best, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.worst", hop.worst, :gauge, :tags => tags)
+        Watchman.submit("network.mtr.std_dev", hop.std_dev, :gauge, :tags => tags)
+      end
+    end
+
+    def self.parse(report)
+      report.split("\n").map { |line| Hop.parse(line) }.compact
+    end
+
+    def host_ip_address
+      `/sbin/ip -o -4 addr list eth0 | awk '{print $4}' | cut -d/ -f1`.strip.gsub(".", "-")
+    end
+  end
+
+  class Hop
+    def self.parse(line)
+      return unless line =~ /\|--/
+
+      new(*line.split(" ")[1..-1])
+    end
+
+    attr_reader :name, :loss, :snt, :last, :avg, :best, :worst, :std_dev
+
+    def initialize(name, loss, snt, last, avg, best, worst, std_dev)
+      @name    = name
+      @loss    = loss.to_f
+      @snt     = snt.to_i
+      @last    = last.to_f
+      @avg     = avg.to_f
+      @best    = best.to_f
+      @worst   = worst.to_f
+      @std_dev = std_dev.to_f
+    end
+  end
+
+end

data/lib/mtr_monitor/version.rb

@@ -0,0 +1,3 @@
+module MtrMonitor
+  VERSION = "0.1.0"
+end

data/mtr_monitor.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mtr_monitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mtr_monitor"
+  spec.version       = MtrMonitor::VERSION
+  spec.authors       = ["RenderedText DevOps Team"]
+  spec.email         = ["devops@renderedtext.com"]
+
+  spec.summary       = %q{Generate, parse, and collect MTR reports}
+  spec.homepage      = "https://github.com/renderedtext/mtr-monitor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: mtr_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RenderedText DevOps Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-20 00:00:00.000000000 Z
+dependencies:
+- !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: 
+email:
+- devops@renderedtext.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mtr_monitor.rb
+- lib/mtr_monitor/version.rb
+- mtr_monitor.gemspec
+homepage: https://github.com/renderedtext/mtr-monitor
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Generate, parse, and collect MTR reports
+test_files: []