rails-log-viewer 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f71d55ec4d0b129b9518234958e3f60529331578
-  data.tar.gz: 75d1e75904723e63cbe5d64a45f7f0eff4d0906c
+  metadata.gz: 015081caae2bb08228b885ceb1f25a575a9aab45
+  data.tar.gz: 78a5dbdcf4a8b13cf4bcbb15624c57749d5e03c0
 SHA512:
-  metadata.gz: 4f42bf40d716406ffbdfd67bd85f64a5bf2da524b61bd722e5951404df5308dc1336b27358d38b777e2fab78c14ed782a8bcd3b36c44c3be153eacb504d77bff
-  data.tar.gz: e179836cde88125f870083d5fd74137218863cabe450fe05ef881f85280c2045a8dc48396bb04e9462347e8a6651f367bc8bbc2fd57926aab7f7c6929a688754
+  metadata.gz: 2e951eeedb486b34817730631bbafa8ae4d02b8b653789757a610278aab585794c028181d4dbe5d381dcd754cc6206eca034632401e34c0c88074bcb0bb505af
+  data.tar.gz: 9c1c12463a5e69222678b262867af9ae9b02c4689e00ed5061ba6b85524f7e27678d6b5ce92f193b3509ddbf9f968357546efa733b5fb24df99d46168b4b187b

data/README.md

@@ -1,24 +1,49 @@
-# Log::Parser
+# Rails Log viewer
 
-TODO: Write a gem description
+With the help of logstash, elasticsearch, kibana and lograge, it is now realy easy to view log of a rails app locally.
 
-## Installation
+This solution has the adventage that it doesn't require any remote server to run.
 
-Add this line to your application's Gemfile:
+What it does is to fetch the remote logs to your locale machine and start logstash with kibana if needed
 
-    gem 'log-parser'
+![Your awsome logs](https://raw.githubusercontent.com/collaide/rails-log-viewer/master/logstash.jpg)
 
-And then execute:
+## Installation
 
-    $ bundle
+Install the gem:
 
-Or install it yourself as:
+    $ gem install rails-log-viewer
+    
+Install logstash:
 
-    $ gem install log-parser
+1. Download the latest logstash
+2. uncompress the archive
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Configure
+
+First, start to configure the gem, run:
+
+     $ fetch-log config
+     
+And provide the required informations. By now, you need to setup a ssh publickey to access to your remote machine. The password option is not working. Then, run:
+
+    $ read-log config
+    
+And provide your logstash executable (usually under: `logstash-1.x.x/bin/logstash`)
+
+Now you can run logstash: ` read-log ` and then fetch the log: ` fetch-log `. Each times the logs has changed and you want to read it, run. ` fetch-log `.
+
+Go to ` localhost:9292 ` to view your logs !
+
+When you are done, run: ` read-log quit `
+
+If you delete the log file to the server and want to parse it from the beginning, run: `read-log reset`
+
+Every created files by this gem are under `$HOME/.log-parser`. Config files are .config for server access and .config-read for logstash executable
+
+To configure lograge go to his github repo. Otherwise is a good idea to read the logstash doc!
 
 ## Contributing
 

data/bin/read-log

@@ -34,14 +34,14 @@ input {
 filter {
  if [fields][ip] {
     geoip {
-         source => "[fields][ip]"
-         target => "geoip"
-         add_field => [ "[geoip][coordinates]", "%{[geoip][longitude]}" ]
-         add_field => [ "[geoip][coordinates]", "%{[geoip][latitude]}"  ]
-    }
-    mutate {
-      convert => [ "[geoip][coordinates]", "float" ]
-    }
+       source => "[@fields][ip]"
+       target => "geoip"
+       add_field => [ "[geoip][coordinates]", "%{[geoip][longitude]}" ]
+       add_field => [ "[geoip][coordinates]", "%{[geoip][latitude]}"  ]
+  }
+  mutate {
+    convert => [ "[geoip][coordinates]", "float" ]
+  }
   }
 }
 

data/lib/log/parser/version.rb

@@ -1,5 +1,5 @@
 module Log
   module Parser
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-log-viewer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - leo
@@ -88,6 +88,7 @@ files:
 - lib/log/parser.rb
 - lib/log/parser/version.rb
 - log-parser.gemspec
+- logstash.jpg
 - rails logs
 homepage: ''
 licenses: