log_stats 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f874fbbcc589b39b6cd4b7146fa8f32bd4a57f1
+  data.tar.gz: a9b0fab518d53e1bfe2718d3d2986277fc1a394b
+SHA512:
+  metadata.gz: b420cce2a9ffc8001403ba1213db7681a43ef56eeb00a1549f259165d61ac30722f09ccc4642838b05cb6b6d137366afed954f245aa8f97411b61f2c034f5727
+  data.tar.gz: 1727b1363af36c20fdd66b4e4ac30e6d2c866d26430a1a0526ea10b278c922d0e496f9dc0a2b3bbd0c2d241659770298899ccba01d1730bce735fd52536cf5ec

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Marklund
+
+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,35 @@
+# Log Stats
+
+A rubygem for extracting response time and error stats based on log files such as
+the Heroku router log. Example usage with Heroku addon papertrail:
+
+```
+gem install papertrail
+PAPERTRAIL_API_TOKEN=... papertrail --min-time "yesterday 22:00" --max-time "yesterday 22:30" > tmp/papertrail.log
+gem install log_stats
+log_stats /tmp/papertrail.log
+```
+
+To download longer timeperiods, like a whole day, download and gunzip a Papertrail log archive file.
+
+Example Heroku success log line:
+
+```
+768004272804798492	2017-02-14T03:41:49	2017-02-14T03:41:49Z	505641143	cmore-web-prod	54.144.85.82	Local3	Info	heroku/router	at=info method=GET path="/filmer/med/glenn-erland-tosterud" host=www.cmore.se request_id=29cb0a66-23f9-4ef4-999a-65f8de089208 fwd="216.244.66.238,23.54.19.54" dyno=web.5 connect=0ms service=210ms status=200 bytes=52867
+```
+ Example Heroku error log line:
+
+```
+768277650920906757	2017-02-14T21:48:07	2017-02-14T21:48:08Z	505641143	cmore-web-prod	54.196.126.116	Local3	Info	heroku/router	at=error code=H12 desc="Request timeout" method=GET path="/serie/74763-alvinnn-og-gjengen-tv-serien/sesong-1/episode-2/3282212-alvinnn-og-gjengen-tv-serien-forelsket-i-rektor-norsk-tale" host=www.cmore.no request_id=f5c2921a-3974-4522-8fdf-d9bfff8b1db9 fwd="163.172.66.89,80.239.216.108" dyno=web.5 connect=0ms service=30001ms status=503 bytes=0
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Resources:
+
+* Heroku Logging: https://devcenter.heroku.com/articles/logging
+* Heroku Error Codes: https://devcenter.heroku.com/articles/error-codes
+* Papertrail archives: https://papertrailapp.com/account/archives
+* Papertrail archive download: http://help.papertrailapp.com/kb/how-it-works/permanent-log-archives/#downloading-multiple-archives

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/log_stats

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'log_stats'
+require "log_stats/config"
+
+log_file_data = ARGF.read
+config = LogStats::Config.default_config.merge(LogStats::Config.env_config)
+LogStats.run(log_file_data, config)

data/lib/log_stats/config.rb

@@ -0,0 +1,55 @@
+module LogStats
+  module Config
+    def self.default_config
+      {
+        events: {
+          requests: {
+            # NOTE: matches Heroku router lines. Also matches Papertrails slightly modified lines.
+            line_pattern: /\s(heroku\/router)|(heroku\[router\]:)\s/,
+            fields: [
+              {
+                name: :time,
+                parse: Proc.new { |line| line[/\b20\d\d-\d\d-\d\dT\d\d:\d\d:\d\d/] }
+              },
+              {name: :method},
+              {name: :host},
+              {name: :path},
+              {name: :status, numeric: true},
+              {name: :code, optional: true},
+              {name: :service, numeric: true}
+            ],
+            top_list_limit: 100,
+            apdex: {tolerating: 500, frustrated: 2000},
+            apdex_goal: 0.9,
+          }
+        },
+        verbose: true,
+        stats_format: "text"
+      }
+    end
+
+    def self.env_config
+      default_config.keys.reduce({}) do |acc, key|
+        value = env_value(key)
+        if !value.nil?
+          acc[key] = value
+        end
+        acc
+      end
+    end
+
+    def self.env_value(key)
+      env_key = key.to_s.upcase
+      value = ENV[env_key]
+      if !value.nil? && boolean?(default_config[key]) 
+        ['1', true, 'true', 't', 'TRUE'].include?(value)
+      else
+        value
+      end
+    end
+
+    def self.boolean?(value)
+      !!value == value
+    end
+  end
+end

data/lib/log_stats/line_parser.rb

@@ -0,0 +1,52 @@
+module LogStats
+  module LineParser
+    def self.parse(log_data, config)
+      data = {}
+      log_data.split("\n").each do |line_string|
+        config[:events].each do |event, event_config|
+          if event_config[:line_pattern] =~ line_string
+            data[event] ||= []
+            data[event].push(parse_line(line_string, event_config))
+          end
+        end
+      end
+      data
+    end
+
+    def self.strip_quotes(value)
+      if value && value.start_with?('"')
+        value[1..-2]
+      else
+        value
+      end
+    end
+
+    def self.parse_numeric(value)
+      value[/\d+/].to_i
+    end
+
+    def self.parse_field(field, line_string, event_config)
+      if field[:parse]
+        value = field[:parse].call(line_string)
+      else
+        value = /\b#{field[:name]}=(\S+)/.match(line_string).to_a[1]
+        value = strip_quotes(value)
+        value = parse_numeric(value) if field[:numeric]
+      end
+      puts "Parsing failed field=#{field} line=#{line_string}" unless (value || field[:optional])
+      value
+    rescue Exception => e
+      puts "Parsing failed field=#{field} line=#{line_string}: #{e.message}"
+      nil
+    end
+
+    def self.parse_line(line_string, event_config)
+      event_config[:fields].reduce({}) do |acc, field|
+        if value = parse_field(field, line_string, event_config)
+          acc[field[:name]] = value
+        end
+        acc
+      end
+    end
+  end
+end

data/lib/log_stats/logger.rb

@@ -0,0 +1,11 @@
+module LogStats
+  class Logger
+    def initialize(verbose)
+      @verbose = verbose
+    end
+
+    def info(message)
+      puts(message) if @verbose
+    end
+  end
+end

data/lib/log_stats/requests/kpi.rb

@@ -0,0 +1,48 @@
+module LogStats
+  module Requests
+    module KPI
+      PRECISION = 5
+
+      def self.calculate(requests, stats)
+        {
+          request_count: requests.size,
+          response_time_avg: avg(:service, requests),
+          response_time_95p: percentile(:service, 0.95, requests),
+          apdex: avg(Stats.method(:apdex_metric), stats),
+          error_rate: rate(method(:error?), requests),
+          timeout_rate: rate(method(:timeout?), requests)
+        }
+      end
+
+      def self.rate(predicate, requests)
+        (count(predicate, requests).to_f/requests.size).round(PRECISION)
+      end
+
+      def self.count(predicate, requests)
+        requests.select(&predicate).size
+      end
+
+      def self.avg(metric, requests)
+        sum = requests.reduce(0) do |acc, request|
+          value = metric.respond_to?(:call) ? metric.call(request) : request[metric]
+          acc + value
+        end
+        (sum/requests.size.to_f).round(PRECISION)
+      end
+
+      def self.percentile(field, percentile, requests)
+        index = (requests.size*percentile).round - 1
+        request = requests.sort_by { |request| request[field] }[index]
+        request && request[field]
+      end
+
+      def self.error?(request)
+        Stats.error_status?(request[:status])
+      end
+
+      def self.timeout?(request)
+        request[:code] == "H12"
+      end
+    end
+  end
+end

data/lib/log_stats/requests/stats.rb

@@ -0,0 +1,89 @@
+module LogStats
+  module Requests
+    module Stats
+      def self.stats(requests, event_config)
+        requests.reduce({}) do |acc, request|
+          id = (request[:method] == "GET" ? '' : "#{request[:method]} ") + [request[:host], request[:path]].join('')
+          acc[id] ||= {
+            id: id,
+            method: request[:method],
+            path: request[:path],
+            count: 0,
+            success_count: 0,
+            error_count: 0,
+            timeout_count: 0,
+            code_count: Hash.new(0),
+            satisfied_count: 0,
+            tolerating_count: 0,
+            frustrated_count: 0,
+            service: 0
+          }
+          acc[id][:count] += 1
+          if error_status?(request[:status])
+            acc[id][:error_count] += 1
+            acc[id][:frustrated_count] += 1
+          else
+            acc[id][:success_count] += 1
+            if request[:service] <= event_config[:apdex][:tolerating]
+              acc[id][:satisfied_count] += 1
+            elsif request[:service] <= event_config[:apdex][:frustrated]
+              acc[id][:tolerating_count] += 1
+            else
+              acc[id][:frustrated_count] += 1
+            end
+          end
+          if request[:code]
+            acc[id][:code_count][request[:code]] += 1
+          end
+          if request[:code] == "H12"
+            acc[id][:timeout_count] += 1
+          end
+          acc[id][:service] += request[:service]
+          acc
+        end.values
+      end
+
+      def self.error_status?(status)
+        status / 100 == 5
+      end
+
+      def self.requests_by_duration(requests)
+        requests.sort_by { |request| -request[:service].to_i }
+      end
+
+      def self.duration_metric(stat)
+        stat[:service].to_f/stat[:count]
+      end
+
+      def self.error_rate_metric(stat)
+        stat[:error_count].to_f/stat[:count]
+      end
+
+      def self.timeout_metric(stat)
+        stat[:timeout_count]
+      end
+
+      def self.popularity_metric(stat)
+        stat[:count]
+      end
+
+      def self.apdex_metric(stat)
+        (stat[:satisfied_count] + stat[:tolerating_count].to_f/2)/stat[:count]
+      end
+
+      def self.stats_by_metric(stats, metric, direction = 1)
+        stats.sort do |stat1, stat2|
+          metric1 = -1 * direction * metric.call(stat1)
+          metric2 = -1 * direction * metric.call(stat2)
+          if metric1 == metric2
+            0
+          elsif metric1.nil? || metric2.nil?
+            metric1.nil? ? -1 : 1
+          else
+            metric1 > metric2 ? 1 : -1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/log_stats/requests/text_output.rb

@@ -0,0 +1,87 @@
+module LogStats
+  module Requests
+    module TextOutput
+      def self.print(data, event_config)
+        print_heading("KPIs")
+        print_kpi(data[:kpi])
+
+        print_heading("STATUS CODES")
+        print_percentages(data[:requests_count], data[:requests_by_status])
+
+        print_heading("HEROKU ERROR CODES")
+        print_percentages(data[:requests_count], data[:requests_by_code])
+
+        top_list_options = {
+          direction: 1,
+          limit: event_config[:top_list_limit],
+          apdex_goal: event_config[:apdex_goal]
+        }
+
+        print_heading("POPULARITY TOP LIST")
+        print_top_list(data[:stats], Stats.method(:popularity_metric), top_list_options)
+
+        print_heading("APDEX TOP LIST")
+        print_top_list(data[:stats], Stats.method(:apdex_metric), top_list_options.merge(direction: -1))
+
+        print_heading("DURATION TOP LIST")
+        print_top_list(data[:stats], Stats.method(:duration_metric), top_list_options)
+
+        print_heading("ERROR RATE TOP LIST")
+        print_top_list(data[:stats], Stats.method(:error_rate_metric), top_list_options)
+
+        print_heading("TIMEOUT TOP LIST")
+        print_top_list(data[:stats], Stats.method(:timeout_metric), top_list_options)
+
+        data[:requests_by_status].each do |status, requests|
+          print_heading("REQUESTS - STATUS #{status}")
+          Stats.requests_by_duration(requests).each do |request|
+            print_request(request)
+          end
+        end
+      end
+
+      def self.print_request(request)
+        parts = [(request[:method] == "GET" ? nil : request[:method]),
+                  request[:path],
+                  request[:service],
+                  request[:code]
+                ].compact
+        if parts.size > 1
+          puts parts.join(" ")
+        end
+      end
+
+      def self.print_percentages(total_lines_count, grouped_lines)
+        grouped_lines.select { |key, _| !key.nil? }.each do |key, lines|
+          percent = (lines.size.to_f*100/total_lines_count).round(4)
+          puts "#{key} #{percent}%"
+        end
+      end
+
+      def self.print_top_list(stats, metric, options = {})
+        Stats.stats_by_metric(stats, metric, options[:direction])[0, options[:limit]].each do |stat|
+          apdex = Stats.apdex_metric(stat).round(2)
+          puts [stat[:id],
+                metric.call(stat),
+                "count=#{stat[:count]}",
+                "apdex=#{apdex}",
+                (apdex >= options[:apdex_goal] ? "OK" : "SLOW")
+               ].join(' ')
+        end
+      end
+
+      def self.print_heading(heading)
+        puts "\n-----------------------------------------------------------"
+        puts heading
+        puts "-----------------------------------------------------------\n\n"
+      end
+
+
+      def self.print_kpi(kpi)
+        kpi.each do |key, value|
+          puts "#{key}: #{value}"
+        end
+      end
+    end
+  end
+end

data/lib/log_stats/version.rb

@@ -0,0 +1,3 @@
+module LogStats
+  VERSION = "0.3.0"
+end

data/lib/log_stats.rb

@@ -0,0 +1,46 @@
+require "json"
+require "log_stats/version"
+require "log_stats/line_parser"
+require "log_stats/logger"
+require "log_stats/requests/stats"
+require "log_stats/requests/kpi"
+require "log_stats/requests/text_output"
+
+module LogStats
+  def self.run(log_data, config)
+    data = get_data(log_data, config)
+    if config[:stats_format] == "text" && request_config = config[:events][:requests]
+      Requests::TextOutput.print(data[:requests], request_config)
+    end
+    if config[:stats_format] == "json"
+      puts JSON.generate(data)
+    end
+    data
+  end
+
+  def self.get_data(log_data, config)
+    logger = Logger.new(config[:verbose])
+    logger.info("\nParsing request lines...")
+    data = LineParser.parse(log_data, config)
+    result = {}
+    if requests = data[:requests]
+      requests_count = requests.size
+      requests_config = config[:events][:requests]
+      logger.info("\nNumber of request lines: #{requests_count}")
+      logger.info("Start time: #{requests[0][:time]}")
+      logger.info("End time: #{requests[-1][:time]}")
+
+      logger.info("\nCalculating request stats...")
+      stats = Requests::Stats.stats(requests, requests_config)
+      result[:requests] = {
+        requests_count: requests_count,
+        requests: requests,
+        stats: stats,
+        requests_by_status: requests.group_by { |request| request[:status] },
+        requests_by_code: requests.group_by { |request| request[:code] },
+        kpi: Requests::KPI.calculate(requests, stats)
+      }
+    end
+    result
+  end
+end

data/log_stats.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_stats"
+  spec.version       = LogStats::VERSION
+  spec.authors       = ["Peter Marklund"]
+  spec.email         = ["peter@marklunds.com"]
+
+  spec.summary       = %q{Extract request statistics from Heroku logs}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/peter/log_stats"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: log_stats
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Peter Marklund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ''
+email:
+- peter@marklunds.com
+executables:
+- log_stats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/log_stats
+- lib/log_stats.rb
+- lib/log_stats/config.rb
+- lib/log_stats/line_parser.rb
+- lib/log_stats/logger.rb
+- lib/log_stats/requests/kpi.rb
+- lib/log_stats/requests/stats.rb
+- lib/log_stats/requests/text_output.rb
+- lib/log_stats/version.rb
+- log_stats.gemspec
+homepage: https://github.com/peter/log_stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Extract request statistics from Heroku logs
+test_files: []
+has_rdoc: