pghero_logs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 737e31fc4c3ab01eeb5ba8e881283a98518334bc
+  data.tar.gz: 66220410a913aa2788e9d6f25dcf19d73b81ed22
+SHA512:
+  metadata.gz: 2eeeb1110a97f6b176f1ad42f1a6372a311f0c77752a6d927e72df19fa560197652778f581d8ce2892a108c8328339228bc3e163fee25a043eea2750a73ddd60
+  data.tar.gz: 204f704794d2632e47f7fe89aea94a77685b014b9cb8d8b3d7422b6b9ec1ba7394cfcf9897ab35c6ee0efd8282ccfce372b71fc994cc1f1a778ec4076ec23ab3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+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,66 @@
+# PgHero Logs
+
+Slow query log parser for Postgres
+
+```sh
+Total    Avg  Count  Query
+(min)   (ms)
+   20   4381    283  SELECT DISTINCT "orders"."id" AS t0_r0, "orders"
+    7   3574    120  SELECT "visits".* FROM "visits" WHERE ("visits".
+    4  12621     20  SELECT DISTINCT "order_deliveries"."id" AS t0_r0
+```
+
+## Install
+
+```sh
+gem install pghero_logs
+```
+
+It can take 10 minutes or more to compile the [query parser](https://pganalyze.com/blog/parse-postgresql-queries-in-ruby.html) :clock2:
+
+Tell Postgres to log slow queries in `postgresql.conf`
+
+```conf
+log_min_duration_statement = 20 # ms
+```
+
+Analyze the logs
+
+```sh
+cat /usr/local/var/postgres/server.log | pghero_logs
+```
+
+## Amazon RDS
+
+First, download the logs. Create an IAM user with the policy below
+
+```sh
+{
+  "Statement": [
+    {
+      "Sid": "Stmt1410669817271",
+      "Action": [
+        "rds:DescribeDBLogFiles",
+        "rds:DownloadDBLogFilePortion"
+      ],
+      "Effect": "Allow",
+      "Resource": "*"
+    }
+  ]
+}
+```
+
+And run
+
+```sh
+export AWS_ACCESS_KEY_ID=test123
+export AWS_SECRET_ACCESS_KEY=secret123
+export AWS_DB_INSTANCE_IDENTIFIER=production
+pghero_logs download
+```
+
+Once logs are downloaded, run
+
+```sh
+cat logs/postgresql.log.* | pghero_logs
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/pghero_logs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "pghero_logs"
+PgHeroLogs.run(ARGV[0])

data/lib/pghero_logs.rb

@@ -0,0 +1,102 @@
+require "pghero_logs/version"
+require "pg_query"
+require "aws-sdk"
+
+module PgHeroLogs
+  class << self
+    REGEX = /duration: (\d+\.\d+) ms  execute <unnamed>: (.+)?/i
+
+    def run(command)
+      case command
+      when nil
+        parse
+      when "download"
+        download
+      else
+        abort "Unknown command: #{command}"
+      end
+    end
+
+    protected
+
+    def download
+      Dir.mkdir("logs") if !Dir.exists?("logs")
+
+      db_instance_identifier = ENV["AWS_DB_INSTANCE_IDENTIFIER"]
+      rds = AWS::RDS.new(access_key_id: ENV["AWS_ACCESS_KEY_ID"], secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"])
+      resp = rds.client.describe_db_log_files(db_instance_identifier: db_instance_identifier)
+      files = resp[:describe_db_log_files].map{|f| f[:log_file_name] }
+      files.each do |log_file_name|
+        local_file_name = log_file_name.sub("error", "logs")
+        if File.exists?(local_file_name)
+          puts "EXISTS #{local_file_name}"
+        else
+          data = ""
+          marker = nil
+          begin
+            options = {
+              db_instance_identifier: db_instance_identifier,
+              log_file_name: log_file_name
+            }
+            options.merge!(marker: marker) if marker
+            resp = rds.client.download_db_log_file_portion(options)
+            data << resp[:log_file_data].to_s
+          end while resp[:additional_data_pending] && (marker = resp[:marker])
+          File.open(local_file_name, "w") { |file| file.write(data) }
+          puts "DOWNLOADED #{local_file_name}"
+        end
+      end
+    end
+
+    def parse
+      active_entry = ""
+      $stdin.each_line do |line|
+        if line.include?(":  ")
+          if active_entry
+            parse_entry(active_entry)
+          end
+          active_entry = ""
+        end
+        active_entry << line
+      end
+      parse_entry(active_entry)
+
+      queries = self.queries.sort_by{|q, i| -i[:total_time] }[0...20]
+
+      puts "Slowest Queries\n\n"
+      puts "Total    Avg  Count  Query"
+      puts "(min)   (ms)"
+      queries.each do |query, info|
+        puts "%5d  %5d  %5d  %s" % [info[:total_time] / 60000, info[:total_time] / info[:count], info[:count], query[0...60]]
+      end
+
+      puts "\nFull Queries\n\n"
+      queries.each_with_index do |(query, info), i|
+        puts "#{i + 1}. #{info[:sample]}"
+        puts
+      end
+    end
+
+    def parse_entry(active_entry)
+      if (matches = active_entry.match(REGEX))
+        begin
+          query = PgQuery.normalize(squish(matches[2].gsub(/\/\*.+/, ""))).gsub(/\?(, \?)+/, "?")
+          queries[query][:count] += 1
+          queries[query][:total_time] += matches[1].to_f
+          queries[query][:sample] = squish(matches[2])
+        rescue PgQuery::ParseError
+          # do nothing
+        end
+      end
+    end
+
+    def queries
+      @queries ||= Hash.new {|hash, key| hash[key] = {count: 0, total_time: 0} }
+    end
+
+    def squish(str)
+      str.gsub(/\A[[:space:]]+/, '').gsub(/[[:space:]]+\z/, '').gsub(/[[:space:]]+/, ' ')
+    end
+
+  end
+end

data/lib/pghero_logs/version.rb

@@ -0,0 +1,3 @@
+module PgheroLogs
+  VERSION = "0.0.1"
+end

data/pghero_logs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pghero_logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pghero_logs"
+  spec.version       = PgheroLogs::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Slow query log parser for Postgres}
+  spec.description   = %q{Slow query log parser for Postgres}
+  spec.homepage      = "https://github.com/ankane/pghero_logs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg_query"
+  spec.add_dependency "aws-sdk"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: pghero_logs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  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: aws-sdk
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Slow query log parser for Postgres
+email:
+- andrew@chartkick.com
+executables:
+- pghero_logs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pghero_logs
+- lib/pghero_logs.rb
+- lib/pghero_logs/version.rb
+- pghero_logs.gemspec
+homepage: https://github.com/ankane/pghero_logs
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Slow query log parser for Postgres
+test_files: []
+has_rdoc: