mongo_request_logger 0.1.0

data/spec/query_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'mongo_request_logger/search_terms'
+
+include MongoRequestLogger
+
+describe SearchTerms do
+  it "should search for paths by default" do
+    SearchTerms.new("/test/path").path.should == "/test/path"
+  end
+
+  it "should search for paths by default" do
+    SearchTerms.new("/test/path/").path.should == "/test/path/"
+  end
+
+  it "should default to a nil path" do
+    SearchTerms.new("").path.should == nil
+  end
+
+  it "should parse simple single parameters" do
+    SearchTerms.new("tag:rack").parts.should == {'tag' => "rack"}
+  end
+
+  it "should parse complex single parameters" do
+    SearchTerms.new("tag:rack,mobile:stf").parts.should == {'tag' => "rack,mobile:stf"}
+  end
+
+  it "should parse single parameter with path" do
+    terms = SearchTerms.new("/test/path tag:rack,mobile:stf")
+    terms.parts.should == {'tag' => "rack,mobile:stf"}
+    terms.path.should == '/test/path'
+  end
+
+  it "should parse multiple parameters" do
+    SearchTerms.new("tag:rack user:315").parts.should == {'tag' => "rack", 'user' => '315'}
+  end
+
+  it "should use additional text as search text" do
+    terms = SearchTerms.new("/test/path This is a test query")
+    terms.path.should == '/test/path'
+    terms.search.should == 'This is a test query'
+  end
+
+  it "should parse parameters before search text" do
+    terms = SearchTerms.new("tag:rack This is a test query")
+    terms.path.should == nil
+    terms.parts.should == {'tag' => "rack"}
+    terms.search.should == 'This is a test query'
+  end
+
+  it "should parse parameters after search text" do
+    terms = SearchTerms.new("/test/path This is a test query tag:rack")
+    terms.path.should == '/test/path'
+    terms.parts.should == {'tag' => "rack"}
+    terms.search.should == 'This is a test query'
+  end
+
+  it "should ignore characters inside quotes" do
+    terms = SearchTerms.new("/test/path \"This is a test:query\"")
+    terms.path.should == '/test/path'
+    terms.parts.should == {}
+    terms.search.should == 'This is a test:query'
+  end
+
+  it "should parse regular expressions" do
+    terms = SearchTerms.new("/test/path /This\\sis.a:test/")
+    terms.path.should == '/test/path'
+    terms.parts.should == {}
+    terms.search_regex.should == "This\\sis.a:test"
+  end
+
+  it "should parse regular expressions with parameters" do
+    terms = SearchTerms.new("/test/path /This\\sis.a:test/ tag:rack")
+    terms.path.should == '/test/path'
+    terms.parts.should == {'tag' => 'rack'}
+    terms.search_regex.should == "This\\sis.a:test"
+  end
+
+
+
+end

data/spec/railtie_spec.rb

@@ -0,0 +1,21 @@
+require 'rails'
+require 'spec_helper'
+require 'mongo_request_logger/railtie'
+
+class TestApp < Rails::Application
+  config.root = File.join(__FILE__, '../testapp')
+end
+
+describe 'railtie' do
+  it "should load the Railtie" do
+    # For now, we mostly test that no errors are raised
+    MongoRequestLogger::Railtie.should be
+    MongoRequestLogger::Railtie.setup TestApp
+
+    File.exist?(Rails.root.join('log/test.log')).should == true
+  end
+
+  after do
+    FileUtils.rm_f(Rails.root.join('log/test.log'))
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,111 @@
+shared_examples "log" do
+
+
+  it "should log without a request" do
+    logger = MongoRequestLogger::Logger.new @adapter, @file
+    logger.info "Test message"
+    logger.error "Test error"
+    logger.close
+    lines = File.open(@file).readlines
+    lines.last.should match /Test error/
+  end
+
+  it "should log requests" do
+    logger = MongoRequestLogger::Logger.new @adapter, @file
+    options = {test_option: "Test value", args: {"one" => "Value"}}
+    logger.log_request(options) do
+      logger.add_metadata value: "Test"
+      logger.tag "test1"
+      logger.tag "test2", "test3"
+
+      logger.info "Test message"
+      logger.error "Test error"
+    end
+    log = @adapter.collection.find.first
+    log.should be
+
+    log['test_option'].should == "Test value"
+    log['args'].should == {"one" => "Value"}
+    log['value'].should == "Test"
+    log['tags'].should == %w(test1 test2 test3)
+    log['runtime'].should be
+    log['timestamp'].should be
+    log['pid'].should be
+    messages = log['messages']
+    messages[0].should match /INFO.*Test message/
+    messages[1].should match /ERROR.*Test error/
+  end
+
+  it "should log exceptions" do
+    class MyError < StandardError; end
+    logger = MongoRequestLogger::Logger.new @adapter, @file
+    options = {test_option: "Test value", args: {"one" => "Value"}}
+    logger.log_request(options) do
+      logger.info "Test message"
+      begin
+        raise MyError, "Test error"
+      rescue => e
+        logger.exception e
+      end
+    end
+    log = @adapter.collection.find.first
+    log.should be
+
+    messages = log['messages']
+    messages[0].should match /INFO.*Test message/
+    messages[1].should match /ERROR.*Test error.*\n.*shared_examples\.rb/
+  end
+
+  it "should log raised errors" do
+    class MyError < StandardError; end
+
+    logger = MongoRequestLogger::Logger.new @adapter, @file
+    options = {test_option: "Test value", args: {"one" => "Value"}}
+    block = ->{
+      logger.log_request do
+        logger.info "Test message"
+        raise MyError, "This is a test"
+      end
+    }
+
+    block.should raise_error(MyError)
+
+    log = @adapter.collection.find.first
+    log.should be
+
+    log['runtime'].should be
+    log['timestamp'].should be
+    log['exception'].should == {"class"=>"MyError", "message"=>"This is a test"}
+    messages = log['messages']
+    messages[0].should match /INFO.*Test message/
+    messages[1].should match /ERROR.*MyError.*This is a test.*\n.*shared_examples\.rb/
+  end
+
+  it "should log SystemStackErrors" do
+    def infinite_recursion n=0
+      infinite_recursion(n+1)
+    end
+
+    logger = MongoRequestLogger::Logger.new @adapter, @file
+    block = ->{
+      logger.log_request do
+        begin
+          infinite_recursion
+        rescue => e
+          logger.exception e
+          raise e
+        end
+      end
+    }
+
+    block.should raise_error(SystemStackError)
+
+    log = @adapter.collection.find.first
+    log.should be
+
+    log['exception'].should == {"class"=>"SystemStackError", "message"=>"stack level too deep"}
+    messages = log['messages']
+    messages[0].should match /ERROR.*SystemStackError.*stack level too deep/
+    puts messages
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'rails'
+Rails.backtrace_cleaner.remove_silencers!
+ENV["RAILS_ENV"] = 'test'
+
+# Require all files, so they show up in coverage
+Dir['lib/**/*.rb'].each do |file|
+  path = /lib\/(.*)\.rb/.match(file)[1]
+  require path
+end

data/spec/testapp/config/logger.yml

@@ -0,0 +1,6 @@
+test:
+  host: localhost
+  database: request_logger_test
+  username: request_logger_test
+  password: test_password
+  capsize: 1024

data/views/layout.erb

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title><%= @title %></title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    <!-- Le styles -->
+    <link href="<%= url('/css/bootstrap.css') %>" rel="stylesheet">
+    <style>
+        body {
+            padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */
+        }
+    </style>
+    <link href="<%= url('/css/bootstrap-responsive.css') %>" rel="stylesheet">
+
+    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+
+    <![endif]-->
+</head>
+
+<body>
+
+<div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+        <div class="container">
+            <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+            </a>
+            <a class="brand" href="<%= url('/') %>">Log Viewer</a>
+            <!--<div class="nav-collapse">-->
+                <!--<ul class="nav">-->
+                    <!--<li class="active"><a href="/">Home</a></li>-->
+                    <!--<li><a href="#about">About</a></li>-->
+                    <!--<li><a href="#contact">Contact</a></li>-->
+                <!--</ul>-->
+            <!--</div>-->
+        </div>
+    </div>
+</div>
+
+<div class="container">
+
+    <%=  yield %>
+
+</div> <!-- /container -->
+
+<!-- Le javascript
+================================================== -->
+<!-- Placed at the end of the document so the pages load faster -->
+<script src="<%= url('/js/jquery-1.7.2.min.js') %>"></script>
+<script src="<%= url('/js/bootstrap.js') %>"></script>
+
+</body>
+</html>

data/views/log_page.erb

@@ -0,0 +1,22 @@
+
+<h4>Request</h4>
+<table class="table table-striped table-bordered table-condensed">
+    <tr><td>Path</td><td><%=h @log.path %></td></tr>
+    <tr><td>Time</td><td><%=h @log.time %></td></tr>
+    <tr><td>Response</td><td><%=h @log.response %></td></tr>
+    <% if @log.exception %><tr><td>Error</td><td><%=h @log.exception %></td></tr><% end %>
+    <tr><td>Tags</td><td><%=h @log.tags.join(' ') %></td></tr>
+    <% if @log.args %><tr><td>Args</td><td><%=h @log.args %></td></tr><% end %>
+    <% if @log.params %><tr><td>Params</td><td><%=h @log.params %></td></tr><% end %>
+    <%  @log.extra(%w(_id path timestamp response exception messages tags args)).each do |key, value| %>
+        <tr><td><%= key %></td><td><%=h value.to_s.truncate(150) %></td></tr>
+    <% end %>
+</table>
+
+<h4>Messages</h4>
+<pre>
+<% @log.messages.each do |message| %>
+<%=h message %>
+
+<% end %>
+</pre>

data/views/logs.erb

@@ -0,0 +1,76 @@
+<div class="well form-search">
+    <input type="text" class="input-xxlarge search-query" id="search_text" name="q" />
+    <button class="btn search_button" id="search_button">Search</button>
+    <button class="btn" id="refresh_button"><i class="icon-refresh"></i></button>
+    <button class="btn" id="help_button"><i class="icon-question-sign"></i></button>
+</div>
+
+<div id="errors">
+</div>
+
+<div id="help" style="display: none;">
+    <h4>Examples</h4>
+    <table class="table table-bordered">
+        <tbody>
+        <tr><td>Search by path prefix</td><td><code>/the/path</code></td></tr>
+        <tr><td>Search by exact path</td><td><code>/the/path$</code></td></tr>
+        <tr><td>Search by tag</td><td><code>tag:rack</code></td></tr>
+        <tr><td>Pages with errors</td><td><code>error:1</code></td></tr>
+        <tr><td>HTTP 200</td><td><code>response:200</code></td></tr>
+        <tr><td>Search by object ID</td><td><code>id:12345</code></td></tr>
+        <tr><td>Search by user ID</td><td><code>user:12345</code></td></tr>
+        <tr><td>Filter by keyword</td><td><code>/the/path keyword</code></td></tr>
+        <tr><td>Filter by multiple keywords</td><td><code>/the/path "multiple keywords"</code></td></tr>
+        <tr><td>Filter by regular expression</td><td><code>/the/path /the regex/</code></td></tr>
+        <tr><td>Filter by regular expression</td><td><code>/the/path /the regex/</code></td></tr>
+        <tr><td>Combination of the above</td><td><code>/the/path error:1 tag:rack "some keywords"</code></td></tr>
+        </tbody>
+    </table>
+</div>
+<br />
+
+<table class="table table-striped" id="search_results">
+  <thead>
+    <tr>
+      <th>Time</th>
+      <th style="max-width: 150px;">Path</th>
+      <th style="max-width: 200px;">Referer</th>
+      <th>User</th>
+      <th>IP</th>
+      <th>Location</th>
+      <th>Response</th>
+      <th>User Agent</th>
+      <th>Runtime</th>
+      <th>Details</th>
+    </tr>
+  </thead>
+  <tbody>
+  </tbody>
+    <tfoot>
+    <tr>
+        <td colspan="7">
+            <button class="btn" id="more_button">Show more results</button>
+        </td>
+    </tr>
+    </tfoot>
+</table>
+
+<!--%= will_paginate @pagination %-->
+
+
+
+<pre id="search_query"></pre>
+
+<script type="text/javascript">
+    var log_base_url = "<%= url("/") %>";
+</script>
+<script src="<%= url('/js/logs.js') %>"></script>
+
+<style type="text/css">
+    /*.table tbody tr.log-row td:hover {*/
+        /*cursor: pointer;*/
+    /*}*/
+
+    /*.table-row { display: table-row; }*/
+    /*.table-cell { display: table-cell; }*/
+</style>