loggie 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7f44eb361050e8b8c4146d150a7d06154d50ba4
+  data.tar.gz: 79640e4eddf1f7509f3318175d146b5be8181665
+SHA512:
+  metadata.gz: b2c2b6ed794cbc2d75d2febc1a71fe70a0c4f2687100e2031f58731e4cab9408c296b00bd9a302dc5b277da9a78e5eeee3696d65a9e15f02fa3a8b3c3a1673c8
+  data.tar.gz: cfea02fe7b240be9dba042ef639cde88cc4f89b8929c158e94b8451a692fcb8f627463d82bf4319c90bbe17dadd886f2e0d5914a42f0bdaedf1144b879b208f4

data/.env.example

@@ -0,0 +1,13 @@
+# from https://logentries.com/app/<app>#/user-account/apikey
+READ_TOKEN=key
+
+# A comma separated list of log file ids
+LOG_FILES=e20bd6af, c83c7cd7, 6fb426fd, 776dfea9
+
+# Depending on the size of the underlying dataset of the complexity of the query,
+# a request may not yield a value straight away. In this case this gem will request
+# the results up until this retry count
+MAX_RETRY=50
+
+# Internal logging level. default: info
+LOG_LEVEL=info

data/.env.test

@@ -0,0 +1,12 @@
+READ_TOKEN=bf3b4d32
+
+# A comma separated list of log file ids
+LOG_FILES=e20bd6af,c83c7cd7,6fb426fd,776dfea9
+
+# Depending on the size of the underlying dataset of the complexity of the query,
+# a request may not yield a value straight away. In this case this gem will request
+# the results up until this retry count
+MAX_RETRY=50
+
+# LOG_LEVEL=info
+LOG_LEVEL=debug

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+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 loggie.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ian Vaughan
+
+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,55 @@
+# Loggie
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loggie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loggie
+
+## Usage
+
+```ruby
+Loggie.search(query: "foobar")
+  => {:timestamp=>Sun, 08 Jan 2017 01:00:58 +0000,
+  :message=>
+  { "remote_addr"=>"11.11.36.72",
+    "version"=>"HTTP/1.1",
+    "host"=>"host.com",
+    "x_forwared_for"=>"11.11.11.11",
+    ...
+
+```
+
+Or, use from the command line with:
+
+`loggie foobar`
+
+## 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/IanVaughan/loggie.
+
+1. Fork it ( https://github.com/IanVaughan/loggie/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "loggie"
+
+require 'dotenv'
+Dotenv.load
+
+require "pry"
+Pry.start

data/bin/loggie

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# Enables search from the console
+
+require "bundler/setup"
+
+require 'dotenv'
+Dotenv.load
+
+require 'loggie'
+puts Loggie.search query: ARGV[0]

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/loggie.rb

@@ -0,0 +1,18 @@
+require 'active_support/all'
+Time.zone = 'Europe/London'
+
+require "loggie/version"
+require "loggie/logging"
+
+require "loggie/extract"
+require "loggie/request"
+
+require "loggie/logentries/search"
+require "loggie/logentries/retry"
+require "loggie/logentries/response"
+
+module Loggie
+  def self.search(query:, from: 1.week.ago, to: Time.zone.now)
+    Logentries::Search.new(query: query, from: from, to: to).call
+  end
+end

data/lib/loggie/extract.rb

@@ -0,0 +1,94 @@
+module Loggie
+  class Extract
+    # Extracts the payload from the response into a more manageable hash.
+    # 1. Converts the JSON into a Hash
+    # 2. Strips any empty
+    # 3. Updates the timestamp from unix to DateTime
+    # 4. Removes fields that are not interesting
+    # The full log can contain many fields, most are not that great, so are excluded by default
+    #
+    # Full response hash includes :
+    #  "remote_addr"=>"11.11.11.161",
+    #  "request_method"=>"GET",
+    #  "path_info"=>"/foo/user",
+    #  "query_string"=>"device_id=00000000-0000-0000-0000-000000000000",
+    #  "version"=>"HTTP/1.1",
+    #  "host"=>"server.com",
+    #  "origin"=>nil,
+    #  "connection"=>nil,
+    #  "proxy_connection"=>nil,
+    #  "referer"=>nil,
+    #  "x_forwared_for"=>"11.111.232.161",
+    #  "x_forwared_proto"=>"https",
+    #  "x_forwared_port"=>"443",
+    #  "accept"=>"*/*",
+    #  "accept_encoding"=>"gzip, deflate",
+    #  "accept_language"=>"en-gb",
+    #  "content_length"=>nil,
+    #  "content_type"=>nil,
+    #  "agent"=>"version",
+    #  "user_agent"=>"app",
+    #  "authorization"=>"bearer token",
+    #  "api_version"=>"20161115",
+    #  "response_status"=>200,
+    #  "response_header"=>{"Content-Type"=>"application/json", "Content-Length"=>"819"},
+    #  "response_body" ....
+    #  "request_params" ....
+    #  "duration"
+
+    DEFAULT_FIELDS_INCLUDED = [
+      "request_method", "path_info", "query_string", "agent", "authorization", "response_body", "request_params"
+    ]
+
+    def initialize
+      @keep_fields = DEFAULT_FIELDS_INCLUDED
+    end
+
+    ##
+    # @param [Array] results hash from the request
+    def call(results)
+      return if results.nil?
+
+      results.map do |result|
+        formatted_message = format(result["message"])
+        next if formatted_message.empty?
+
+        {
+          timestamp: formatted_date(result["timestamp"]),
+          message: formatted_message
+        }
+      end.compact
+    end
+
+    private
+
+    attr_reader :keep_fields
+
+    def formatted_date(timestamp)
+      Time.at(timestamp / 1000).to_datetime
+    end
+
+    def format(m)
+      m = remove_rails_timestamp(m)
+      m = safe_parse(m)
+      m = remove_empty_fields(m)
+      m.except(*keep_fields)
+    end
+
+    def remove_rails_timestamp(message)
+      message.sub(/.*-- : /, '')
+    end
+
+    def safe_parse(message, save: true)
+      begin
+        JSON.parse message
+      rescue JSON::ParserError
+        {}
+      end
+    end
+
+    def remove_empty_fields(m)
+      m.compact.reject { |m| m.empty? }
+    end
+  end
+end

data/lib/loggie/logentries/response.rb

@@ -0,0 +1,31 @@
+module Loggie
+  module Logentries
+    class Response
+      attr_reader :logs, :progress, :links, :id, :leql, :events
+
+      def initialize(response)
+        data = JSON.parse response.read_body
+
+        @logs = data["logs"]
+        @links = data["links"]
+        @leql = data["leql"]
+
+        if data.key?("events") # 200
+          @events = data["events"]
+        else # 202 for a query that successfully started but has not yet finished
+          @progress = data["progress"]
+          @id = data["id"]
+        end
+      end
+
+      def next_url
+        # res.fetch("links", [{}]).first.dig("href").gsub(/\?$/, '')
+        links.first["href"]
+      end
+
+      def events?
+        !@events.nil?
+      end
+    end
+  end
+end

data/lib/loggie/logentries/retry.rb

@@ -0,0 +1,44 @@
+module Loggie
+  module Logentries
+    # Allows a block to be retried a number of times up until MAX_RETRY
+    # Each retry will sleep RETRY_DELAY_SECONDS before requesting
+    # It checks the response and extracts the polling URI for progress
+    class Retry
+      include Logging
+      MAX_RETRY = ENV.fetch('MAX_RETRY', 5).to_i
+      RETRY_DELAY_SECONDS = ENV.fetch('RETRY_DELAY_SECONDS', 0.2).to_f
+      MAX_RETRY_DELEY_SECONDS = 20 # max 20 seconds, or it will expire
+
+      def call(url, method, options, &block)
+        # TODO: ensure retry_count is reset or if that matters
+        @retry_count ||= 0
+        response = block.call(url, method, options)
+        logger.debug "#{self.class} retry:#{@retry_count}, response:#{response.body}"
+
+        if response.code.to_i > 203
+          log_and_raise "Failed request with:#{response.message}"
+        end
+
+        res = Response.new response
+        return res.events if res.events?
+        logger.info "Logentries returned progress:#{res.progress}"
+
+        @retry_count += 1
+        if @retry_count > MAX_RETRY
+          log_and_raise "Retry count of #{MAX_RETRY} reached"
+        end
+
+        sleep RETRY_DELAY_SECONDS
+
+        self.call(res.next_url, :get, nil, &block)
+      end
+
+      private
+
+      def log_and_raise(message)
+        logger.error message
+        raise message
+      end
+    end
+  end
+end

data/lib/loggie/logentries/search.rb

@@ -0,0 +1,61 @@
+module Loggie
+  module Logentries
+    # Main entry point to query a specific log source
+    class Search
+      include Logging
+      BASE_URI = "https://rest.logentries.com"
+      QUERY_PATH = "query/logs"
+      LOG_FILES = ENV['LOG_FILES']
+
+      ##
+      # @param [String] query: to perform
+      # @param [DateTime] from: query from date
+      # @param [DateTime] to: query to date
+      # @param [Array] log_files: list of log id files to search. default ENV['LOG_FILES']
+      #
+      def initialize(query: nil, from: nil, to: nil, log_files: nil)
+        @query, @from, @to = query, from, to
+        @log_files = log_files || log_files_from_env
+        @extract = Extract.new
+        @request = Request.new(retry_mechanism: Retry.new)
+      end
+
+      def call(query: nil, from: nil, to: nil, log_files: nil)
+        options = parsed_post_params(query || @query, from || @from, to || @to, log_files || @log_files)
+        logger.debug "#{self.class} options:#{options}, url:#{url}"
+
+        extract.call(request.call(url, method: :post, options: options))
+      end
+
+      private
+
+      attr_reader :extract, :request
+
+      def url
+        [BASE_URI, QUERY_PATH].join('/')
+      end
+
+      # https://docs.logentries.com/docs/post-query
+      def parsed_post_params(query, from, to, log_keys)
+        {
+          logs: log_keys,
+          leql: {
+            during: {
+              from: convert(from),
+              to: convert(to)
+            },
+            statement: "where(#{query})"
+          }
+        }
+      end
+
+      def convert(time)
+        (time.to_f * 1000).floor
+      end
+
+      def log_files_from_env
+        LOG_FILES&.split(",")
+      end
+    end
+  end
+end

data/lib/loggie/logging.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+module Logging
+  LOG_LEVEL = ENV.fetch('LOG_LEVEL', :warn).to_sym
+
+  class << self
+    def logger
+      @logger ||= ::Logger.new(STDOUT).tap { |l| l.level = LOG_LEVEL }
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+
+  def self.included(base)
+    class << base
+      def logger
+        Logging.logger
+      end
+    end
+  end
+
+  def logger
+    Logging.logger
+  end
+end

data/lib/loggie/request.rb

@@ -0,0 +1,53 @@
+require 'uri'
+require 'net/http'
+
+module Loggie
+  # Makes external HTTP request, with a retry mechanism for
+  # polling long running queries on remote server
+  class Request
+    include Logging
+    READ_TOKEN = ENV['READ_TOKEN']
+
+    def initialize(retry_mechanism: )
+      @retry_mechanism = retry_mechanism || Retry.new
+    end
+
+    def call(url, method: :get, options: nil)
+      retry_mechanism.call(url, method, options) do |url, method, options|
+        request(url, method: method, options: options)
+      end
+    end
+
+    private
+
+    attr_reader :retry_mechanism
+
+    def request(url, method:, options: nil)
+      encoded_options = URI.encode_www_form(options) if options
+
+      url = if method == :get
+              URI([url, encoded_options].compact.join("?"))
+            else
+              URI(url)
+            end
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = if method == :get
+                  Net::HTTP::Get.new(url)
+                else
+                  Net::HTTP::Post.new(url)
+                end
+      request["x-api-key"] = READ_TOKEN
+
+      if method == :post
+        request["content-type"] = 'application/json'
+        request.body = options.to_json
+      end
+
+      http.request(request)
+    end
+  end
+end

data/lib/loggie/version.rb

@@ -0,0 +1,3 @@
+module Loggie
+  VERSION = "0.0.2"
+end

data/loggie.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loggie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "loggie"
+  spec.version       = Loggie::VERSION
+  spec.authors       = ["Ian Vaughan"]
+  spec.email         = ["github@ianvaughan.co.uk"]
+
+  spec.summary       = %q{Enables search of log files}
+  spec.description   = %q{Searches remote log files via API}
+  spec.homepage      = "https://github.com/IanVaughan/loggie"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   << "loggie"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv", "~> 2.1"
+  spec.add_dependency "activesupport", "~> 5.0"
+
+  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"
+  spec.add_development_dependency "timecop", "~> 0.7"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: loggie
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ian Vaughan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: Searches remote log files via API
+email:
+- github@ianvaughan.co.uk
+executables:
+- loggie
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".env.test"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/loggie
+- bin/setup
+- lib/loggie.rb
+- lib/loggie/extract.rb
+- lib/loggie/logentries/response.rb
+- lib/loggie/logentries/retry.rb
+- lib/loggie/logentries/search.rb
+- lib/loggie/logging.rb
+- lib/loggie/request.rb
+- lib/loggie/version.rb
+- loggie.gemspec
+homepage: https://github.com/IanVaughan/loggie
+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
+signing_key: 
+specification_version: 4
+summary: Enables search of log files
+test_files: []
+has_rdoc: