streamlog 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTk1NzM4M2VkZDg4YTFkM2NjNzk2NGVjNGZhOTRhNTI4NTQ3OGNjMg==
+  data.tar.gz: !binary |-
+    Mzk4NmVhODNmMDNiNDQ5MzcxOGY0Zjc4MWFjYTk4ZTA0ZTI1MzFiNw==
+SHA512:
+  metadata.gz: !binary |-
+    MGY0NmFiNmQ5NWFhNzliNmM4ZDgyMTRhZjE3NzJiYTAwZWFkOWM4Njc3NDgw
+    NTM2N2FjZDYxODQ5NjIxZDE1NGVhZTVmZjA2Y2M3OWUyNzZkYzM2M2I3NDY1
+    ZDFjMTExZjhjYWQxMzY5MzYxMzQ3YzAxOTdjNTllYzJhZDczN2E=
+  data.tar.gz: !binary |-
+    OWRmOTY4NmQ3YjUyZDg2MjVmNWY2ZTc4M2MzOWZlMmM4ODRiNzQxMTkyZWUz
+    YjM0NmE5MDUzYTkxMDE5OWQ2MDEzMjBkMDVhMTcwOWE3ZWI3YjBmZWM0ZWQ5
+    ZmZkNmI4Mzg3YjQwNDhlNGY1YWQ2YjM2MTNjOTdmNjJiNzZmOTE=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Salman Siddiqui
+
+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,47 @@
+# Streamlog
+
+Streamlog is a Rails Mountable Engine. It streams rails application log to the browser. It is an alternative to [Browserlog](https://coveralls.io/r/dieb/browserlog).
+Browserlog is based on polling while streamlog streams the log.
+
+## Installation
+
+Simply add it to your `Gemfile`
+
+```ruby
+gem 'streamlog'
+```
+
+And then mount this rails engine on `config/routes.rb`
+
+```ruby
+Rails.application.routes.draw do  
+  mount Streamlog::Engine => '/streamlog'  
+end
+```
+
+This will make the log available at ``domain/streamlog``. Make sure to authenticate this route.
+
+### Using your app layout
+
+Create ``streamlog.rb`` in ``config/initializers``, and add the following line in it.
+
+```ruby
+Streamlog.engine_layout = false
+```
+
+Then add the following line in your layout ``head`` tag
+
+```ruby
+<% yield :head %>
+```
+
+This will use your application layout to load streamlog view.
+
+## Note
+
+You will need to install passenger with nginx/apache on your local machine to achieve concurrency and be able to test streamlog.
+[GoRails](https://gorails.com/deploy/ubuntu/14.04) is a guide to setup Passenger with nginx.
+
+## Supported Rails Version
+
+* Rails >= 4.1

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Streamlog'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/streamlog/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require_tree .

data/app/assets/javascripts/streamlog/logs.js

@@ -0,0 +1,34 @@
+$(document).ready(function () {
+    var autoScroll = true;
+
+    function startAutoScroll() {
+        $("#streamlog-resume").addClass('streamlog-hidden');
+        autoScroll = true;
+    }
+
+    function stopAutoScroll() {
+        $("#streamlog-resume").removeClass('streamlog-hidden');
+        autoScroll = false;
+    }
+
+    function scrollToBottom() {
+        window.scrollTo(0, document.body.scrollHeight);
+    }
+
+    var source = new EventSource('/streamlog/stream');
+
+    source.addEventListener('message', function (e) {
+        $("<p>" + JSON.parse(e.data) + "</p>").insertBefore(".streamlog-cursor");
+        if (autoScroll)
+            scrollToBottom();
+    });
+
+    $("#streamlog-resume").click(scrollToBottom);
+
+    window.onscroll = function () {
+        if ($(window).scrollTop() + $(window).height() == $(document).height())
+            startAutoScroll();
+        else
+            stopAutoScroll();
+    };
+});

data/app/assets/stylesheets/streamlog/application.css

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ */

data/app/assets/stylesheets/streamlog/logs.css

@@ -0,0 +1,130 @@
+.streamlog {
+    min-width: 500px;
+    min-height: 430px;
+    background: #272822;
+    border-radius: 5px;
+    overflow: hidden;
+    font-size: 13px;
+}
+
+.streamlog-body {
+    font-family: Andale Mono, monospace;
+    padding: 10px;
+}
+
+.streamlog-body p {
+    color: #fff;
+    padding: 1px 0;
+}
+
+@keyframes blink {
+    0% {
+        background: rgba(225, 225, 225, 100);
+    }
+    100% {
+        background: rgba(225, 225, 225, 0);
+    }
+}
+
+@-webkit-keyframes blink {
+    0% {
+        background: rgba(225, 225, 225, 100);
+    }
+    100% {
+        background: rgba(225, 225, 225, 0);
+    }
+}
+
+@-moz-keyframes blink {
+    0% {
+        background: rgba(225, 225, 225, 100);
+    }
+    100% {
+        background: rgba(225, 225, 225, 0);
+    }
+}
+
+.streamlog-cursor {
+    background: #63de00;
+    display: inline-block;
+    width: 11px;
+    height: 19px;
+    margin-bottom: -3px;
+    -webkit-animation-name: blink;
+    -webkit-animation-duration: 1.2s;
+    -webkit-animation-iteration-count: infinite;
+    -moz-animation-name: blink;
+    -moz-animation-duration: 1.2s;
+    -moz-animation-iteration-count: infinite;
+}
+
+.streamlog-hidden {
+    display: none !important;
+    visibility: hidden !important;
+}
+
+#streamlog-resume {
+    position: fixed;
+    right: 40px;
+    bottom: 40px;
+}
+
+.log-method {
+    color: #C285FF;
+}
+
+.log-path {
+    color: #85D6FF;
+}
+
+.log-ip {
+    color: #585856;
+}
+
+.log-date {
+    color: #585856;
+}
+
+.log-controller {
+    color: #FF0066;
+}
+
+.log-action {
+    color: #FF0066;
+}
+
+.log-format {
+    color: #C285FF;
+}
+
+.log-template-name {
+    color: #FFFF66;
+}
+
+.log-layout-name {
+    color: #C285FF;
+}
+
+.log-rendering-time {
+    color: #85D6FF;
+}
+
+.log-model-load {
+    color: #da564a;
+}
+
+.log-sql-query {
+    color: #585856;
+}
+
+.log-total-time {
+    color: #85D6FF;
+}
+
+.log-status.success {
+    color: #33D633;
+}
+
+.log-status.error {
+    color: red;
+}

data/app/controllers/streamlog/application_controller.rb

@@ -0,0 +1,4 @@
+module Streamlog
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/streamlog/logs_controller.rb

@@ -0,0 +1,28 @@
+require_dependency 'streamlog/application_controller'
+
+module Streamlog
+  class LogsController < ApplicationController
+    include ActionController::Live
+    layout 'application' unless Streamlog.engine_layout
+
+    def index
+    end
+
+    def stream
+      response.headers['Content-Type'] = 'text/event-stream'
+
+      sse = Streamlog::SSE.new(response.stream)
+      colorizer = Streamlog::LogColorize.new
+
+      begin
+        File::Tail::Logfile.tail(Rails.root.join('log', Rails.env+'.log').to_s, backward: 1) do |line|
+          sse.write colorizer.colorize_line line
+        end
+      rescue IOError
+        # When the client disconnects, we'll get an IOError on write
+      ensure
+        sse.close
+      end
+    end
+  end
+end

data/app/helpers/streamlog/application_helper.rb

@@ -0,0 +1,4 @@
+module Streamlog
+  module ApplicationHelper
+  end
+end

data/app/helpers/streamlog/logs_helper.rb

@@ -0,0 +1,4 @@
+module Streamlog
+  module LogsHelper
+  end
+end

data/app/views/layouts/streamlog/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Streamlog</title>
+  <%= stylesheet_link_tag 'streamlog/application', media: 'all' %>
+  <%= javascript_include_tag 'streamlog/application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/streamlog/logs/index.html.erb

@@ -0,0 +1,11 @@
+<%= h content_for(:title, 'Server Logs') %>
+<% content_for :head do %>
+    <%= javascript_include_tag 'streamlog/application' %>
+    <%= stylesheet_link_tag 'streamlog/application' %>
+<% end %>
+<div class="streamlog">
+  <div class="streamlog-body">
+    <div class="streamlog-cursor"></div>
+  </div>
+</div>
+<button class="streamlog-hidden" id="streamlog-resume">Resume</button>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Streamlog::Engine.routes.draw do
+  get '/' => 'logs#index'
+  get '/stream' => 'logs#stream'
+end

data/lib/streamlog.rb

@@ -0,0 +1,9 @@
+require 'streamlog/engine'
+
+module Streamlog
+  autoload :SSE, 'streamlog/sse'
+  autoload :LogColorize, 'streamlog/log_colorize'
+
+  mattr_accessor :engine_layout
+  @@engine_layout = true
+end

data/lib/streamlog/content_length_with_exclusions.rb

@@ -0,0 +1,17 @@
+module Rack
+  class ContentLengthWithExclusions < ContentLength
+    def initialize(app, options = {})
+      @app = app
+
+      @exclude = options[:exclude]
+    end
+
+    def call(env)
+      if @exclude && @exclude.call(env)
+        @app.call(env)
+      else
+        super(env)
+      end
+    end
+  end
+end

data/lib/streamlog/engine.rb

@@ -0,0 +1,13 @@
+require 'streamlog/content_length_with_exclusions'
+
+module Streamlog
+  class Engine < ::Rails::Engine
+    isolate_namespace Streamlog
+
+    config.middleware.use Rack::ContentLengthWithExclusions, exclude: proc { |env|
+      env['PATH_INFO'] == 'streamlog/stream'
+    }
+    config.preload_frameworks = true
+    config.allow_concurrency = true
+  end
+end

data/lib/streamlog/log_colorize.rb

@@ -0,0 +1,97 @@
+module Streamlog
+  class LogColorize
+    REXP_REQUEST    = /^Started (?<method>\w+) "(?<path>[\w\/\?\&\=\.]+)" for (?<ip>[\d\.]+) at (?<date>[\w:\-\+\s]+)$/
+    REXP_CONTROLLER = /^Processing by (?<controller>[\w\:]+)#(?<action>\w+) as (?<format>[\w\/\-\.]+)$/
+    REXP_RENDER     = /^\s*Rendered (?<path>.*\/)(?<template_name>\w+\.html\.\w+) \((?<rendering_time>[\d+\.]+ms)\)$/
+    REXP_RENDER_WITHIN = /^\s*Rendered (?<path>.*\/)(?<template_name>\w+\.html\.\w+) within (?<layout_name>[\w\d\/]+) ?\((?<rendering_time>[\d+\.]+ms)\)$/
+    REXP_COMPLETE   = /^Completed (?<status>\d+\s\w+) in (?<total_time>[\d+\.]+ms) (?<last_bit>.*)$/
+    REXP_SQL_QUERY  = /^\s*(?<model_load>[\w:]+ Load) \((?<rendering_time>[\d+\.]+ms)\) \s*(?<sql_query>.*)$/
+
+    def colorize_line(line)
+      line = strip_ansi_colors(line)
+      line = colorize(line)
+    rescue => e
+      puts "Could not colorize: #{e.message}"
+      line
+    end
+
+    private
+
+    def strip_ansi_colors(line)
+      line.gsub(/\e\[(\d+)m/, '')
+    end
+
+    def colorize(line)
+      case line
+        when REXP_REQUEST       then colorize_request(line)
+        when REXP_CONTROLLER    then colorize_controller(line)
+        when REXP_RENDER        then colorize_render(line)
+        when REXP_RENDER_WITHIN then colorize_render_within(line)
+        when REXP_COMPLETE      then colorize_complete(line)
+        when REXP_SQL_QUERY     then colorize_sql_query(line)
+        else line
+      end
+    end
+
+    def span(item, classname)
+      "<span class='#{classname}'>#{item}</span>"
+    end
+
+    def space
+      '&nbsp;&nbsp;'
+    end
+
+    def colorize_request(line)
+      data = regex_parse(line.match(REXP_REQUEST))
+      method = span(data[:method], 'log-method')
+      path = span(data[:path], 'log-path')
+      ip = span(data[:ip], 'log-ip')
+      date = span(data[:date], 'log-date')
+      "Started #{method} \"#{path}\" for #{ip} at #{date}"
+    end
+
+    def colorize_controller(line)
+      data = regex_parse(line.match(REXP_CONTROLLER))
+      controller = span(data[:controller], 'log-controller')
+      action = span(data[:action], 'log-action')
+      format = span(data[:format], 'log-format')
+      "Processing by #{controller}##{action} as #{format}"
+    end
+
+    def colorize_render(line)
+      data = regex_parse(line.match(REXP_RENDER))
+      path = data[:path]
+      template_name = span(data[:template_name], 'log-template-name')
+      rendering_time = span(data[:rendering_time], 'log-rendering-time')
+      "#{space}Rendered #{path}#{template_name} (#{rendering_time})"
+    end
+
+    def colorize_render_within(line)
+      data = regex_parse(line.match(REXP_RENDER_WITHIN))
+      path = data[:path]
+      layout_name = span(data[:layout_name], 'log-layout-name')
+      template_name = span(data[:template_name], 'log-template-name')
+      rendering_time = span(data[:rendering_time], 'log-rendering-time')
+      "#{space}Rendered #{path}#{template_name} within #{layout_name} (#{rendering_time})"
+    end
+
+    def colorize_sql_query(line)
+      data = regex_parse(line.match(REXP_SQL_QUERY))
+      model_load = span(data[:model_load], 'log-model-load')
+      rendering_time = span(data[:rendering_time], 'log-rendering-time')
+      sql_query = data[:sql_query]
+      "#{space}#{model_load} (#{rendering_time}) #{sql_query}"
+    end
+
+    def colorize_complete(line)
+      data = regex_parse(line.match(REXP_COMPLETE))
+      status = span(data[:status], data[:status] =~ /^2/ ? 'log-status success' : 'log-status failure')
+      total_time = span(data[:total_time], 'log-total-time')
+      "Completed #{status} in #{total_time} #{data[:last_bit]}"
+    end
+
+    def regex_parse(match)
+      Hash[match.names.collect { |k| k.to_sym }.zip(match.captures)]
+    end
+  end
+end