nginxtop 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06769fe40c9c272f91056f96f40b0da3b2ea6cb6
+  data.tar.gz: 74f4f583dbee58710692a2bc2ec3717e0c227980
+SHA512:
+  metadata.gz: e221640f46a3da378f682236fa57c1af593649a3e642f781e203fce3719bf02103a96bda6830dd46fb70797d9739046ecf4172d9841afd422d15c78c7e07e83c
+  data.tar.gz: df3b5beb90954cbe734030170bf6d8182912e6e1ec47b0f39f55c61ef5a907dcda0fb8e764073684e8fe25fa4886d7194644f7a362da4bce0e7013d22f4f8c23

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ashish Bista
+
+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,41 @@
+# Nginxtop
+
+NGINX live log parsing and monitoring tool.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nginxtop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nginxtop
+
+## Usage
+
+Run `nginxtop`.
+
+For more options:
+
+`nginxtop --help`
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashishbista/nginxtop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/nginxtop

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nginxtop"
+require 'optparse'
+
+options = {file: '/var/log/nginx/access.log', no_watch: false}
+
+parser = OptionParser.new do|opts|
+	opts.banner = "Usage: nginxtop [options]"
+	opts.on('-f', '--file file', 'NGINX log file') do |name|
+		options[:file] = file
+	end
+
+	opts.on('-n', '--no-watch', "Don't watch log forever") do
+		options[:no_watch] = true
+	end
+
+	opts.on('-h', '--help', 'Displays help') do
+		puts opts
+		exit
+	end
+end
+
+parser.parse!
+
+NginxTop::Listener.new(options).listen
+

data/lib/nginxtop.rb

@@ -0,0 +1,26 @@
+require "nginxtop/version"
+require "nginxtop/listener"
+require "nginxtop/output"
+require "nginxtop/parser"
+require "nginxtop/request"
+require "nginxtop/printer"
+require 'io/console'
+
+module NginxTop
+  REQUESTS = []
+
+  def self.count(status)
+    REQUESTS.select{ |r| r.status_verb == status }.count
+  end
+
+  def self.bar(status)
+    n = (IO.console.winsize.last * 0.25 * (( 100 * count(status)/REQUESTS.count))/100).to_i rescue 0
+    "|" * n
+  end
+
+  def self.uptime
+    time_diff = Time.now - Listener::START_TIME
+    Time.at(time_diff.to_i.abs).utc.strftime "%H:%M:%S"
+  end
+
+end

data/lib/nginxtop/listener.rb

@@ -0,0 +1,51 @@
+module NginxTop
+  class Listener
+
+    START_TIME = Time.now
+
+    def initialize(options)
+      @log_file = options[:file]
+      @no_watch = options[:no_watch]
+      install_signal_handlers
+    end
+
+    def listen
+
+      File.readlines(@log_file).each do |line|
+        Parser.new.parse(line.chomp)
+      end
+
+      Output.create
+
+      file = File.open(@log_file)
+      file.seek(0,IO::SEEK_END)
+      thread1 = Thread.new do
+        loop do
+          select([file])
+          line = file.gets
+          Parser.new.parse(line.chomp) if line
+        end
+      end
+
+      thread2 = Thread.new do
+        loop do
+          sleep 1
+          Output.create
+        end
+      end
+      unless @no_watch
+        thread1.join
+        thread2.join
+      end
+
+    end
+
+    def install_signal_handlers
+      Signal.trap('INT') do
+        puts 'Caught interrupt! Stopping parsing...'
+        exit 130
+      end
+    end
+
+  end
+end

data/lib/nginxtop/output.rb

@@ -0,0 +1,25 @@
+require 'pry'
+module NginxTop
+  class Output
+    def self.create
+
+      output = Printer.stream
+
+      output << sprintf("%31s \n", Printer.bold(Printer.white("NGINX TOP")))
+
+      output << sprintf(" %5s %s %-50s %s %d \t %20s %s\n", Printer.cyan("2XX"), Printer.white("["), Printer.green(NginxTop.bar(:success)), Printer.white("]"), NginxTop.count(:success), Printer.cyan("Running for:"), Printer.white(NginxTop.uptime))
+      output << sprintf(" %5s %s %-50s %s %d \t %20s %d\n", Printer.cyan("3XX"), Printer.white("["), Printer.gray(NginxTop.bar(:redirection)), Printer.white("]"), NginxTop.count(:redirection), Printer.cyan("Total requests:"), NginxTop::REQUESTS.count)
+      output << sprintf(" %5s %s %-50s %s %d\n", Printer.cyan("4XX"), Printer.white("["), Printer.yellow(NginxTop.bar(:client_error)), Printer.white("]"), NginxTop.count(:client_error))
+      output << sprintf(" %5s %s %-50s %s %d\n", Printer.cyan("5XX"), Printer.white("["), Printer.red(NginxTop.bar(:server_error)), Printer.white("]"), NginxTop.count(:server_error))
+
+      output << sprintf("\n%31s \n", Printer.bold(Printer.white("TOP PAGES")))
+
+      NginxTop::REQUESTS.group_by(&:path).sort_by(&:count)[0..15].each do |r|
+        output << sprintf(" %-58s %s\n", Printer.light_gray(r.first), Printer.white(r.last.count))
+      end
+
+      puts output
+
+    end
+  end
+end

data/lib/nginxtop/parser.rb

@@ -0,0 +1,7 @@
+module NginxTop
+  class Parser
+    def parse(log)
+      NginxTop::REQUESTS << Request.new(log)
+    end
+  end
+end

data/lib/nginxtop/printer.rb

@@ -0,0 +1,29 @@
+module NginxTop
+  class Printer
+    COLORS = {
+      red: "\e[31m",
+      yellow: "\e[33m",
+      blue: "\e[34m",
+      green: "\e[32m",
+      white: "\e[97m",
+      bold: "\e[1m",
+      dim: "\e[2m",
+      gray: "\e[90m",
+      cyan: "\e[36m",
+      light_green: "\e[92m",
+      light_gray: "\e[37m"
+    }
+
+    class << self
+      def stream
+        sprintf "\033c"
+      end
+
+      COLORS.each_pair do |k, v|
+        define_method k do |str|
+          v + str.to_s + "\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/nginxtop/request.rb

@@ -0,0 +1,29 @@
+module NginxTop
+  class Request
+    REGEX = /((?-mix:(?-mix:(?:(?:[a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*(?:[A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]))|(?-mix:(?-mix:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?-mix:(?-mix:(?:[0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4})|(?-mix:(?:(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)::(?:(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?))|(?-mix:(?:(?:[0-9A-Fa-f]{1,4}:){6})(?-mix:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))|(?-mix:(?:(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)::(?:(?:[0-9A-Fa-f]{1,4}:)*)(?-mix:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))))))\ ([\w-]+)\ (\/\S*|-)\ \[((?-mix:(?-mix:\d{2}\/(?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\/\d{4}:\d{2}:\d{2}:\d{2}\ (?:[+-]\d{4}|[A-Z]{3,4}))|(?-mix:\d{2}\/(?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\/\d{4}\ \d{2}:\d{2}:\d{2})))?\]\ "([A-Z]+) (\S+) HTTP\/(\d+(?:\.\d+)*)"\ (\d{3})\ (\d+|-)/
+
+    DIRECTIVES = [:remote_host, :remote_logname, :user, :timestamp, :http_method, :path, :http_version, :http_status, :bytes_sent]
+    attr_accessor *DIRECTIVES
+    def initialize(log)
+      @log = log
+      log.scan(REGEX).flatten.each_with_index do |value, index|
+        instance_variable_set "@#{DIRECTIVES[index]}".to_sym, value
+      end
+    end
+
+    def status_verb
+      status = http_status.to_i
+      if status.between?(200, 299)
+        :success
+      elsif status.between?(300, 399)
+        :redirection
+      elsif status.between?(400, 499)
+        :client_error
+      elsif status.between?(500, 599)
+        :server_error
+      else
+        :unknown
+      end
+    end
+  end
+end

data/lib/nginxtop/version.rb

@@ -0,0 +1,3 @@
+module NginxTop
+  VERSION = "0.1.1"
+end

data/nginxtop.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nginxtop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nginxtop"
+  spec.version       = NginxTop::VERSION
+  spec.authors       = ["Ashish Bista"]
+  spec.email         = ["b@ashishbista.com"]
+
+  spec.summary       = %q{NGIN Top: NGINX Access Log Parser and Monitoring Tool.}
+  spec.description   = %q{Parse and monitor NGINX incoming requests based on its access log.}
+  spec.homepage      = "https://github.com/ashishbista/nginxtop"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: nginxtop
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ashish Bista
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Parse and monitor NGINX incoming requests based on its access log.
+email:
+- b@ashishbista.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nginxtop
+- dev/null
+- lib/nginxtop.rb
+- lib/nginxtop/listener.rb
+- lib/nginxtop/output.rb
+- lib/nginxtop/parser.rb
+- lib/nginxtop/printer.rb
+- lib/nginxtop/request.rb
+- lib/nginxtop/version.rb
+- nginxtop.gemspec
+homepage: https://github.com/ashishbista/nginxtop
+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.1
+signing_key: 
+specification_version: 4
+summary: 'NGIN Top: NGINX Access Log Parser and Monitoring Tool.'
+test_files: []