Skip to content

Commit

Permalink
rename project and add README
Browse files Browse the repository at this point in the history
  • Loading branch information
josqu4red committed Apr 10, 2013
1 parent 7c921f9 commit 88746b5
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 4 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# varnishops

varnishops is a tool for analyzing and categorizing traffic on your varnish servers in realtime.

It gathers the output of varnishncsa and create statistics such as request rate, output bandwidth or hitratio.

URLs from varnishncsa are categorized using custom regular expressions, based on your assets' paths and classification (example provided in **ext/**)

varnishops is written in Ruby (tested with MRI 1.9.3) and depends only on varnishncsa.

## Setup

* git clone https://github.com/Fotolia/varnishops
OR
* gem install varnishops


By default, all URLs will be categorized as "other", and statistics will be computed based on the global varnish traffic

Categories can be added by defining filters (ruby regexps). See example file in **ext/**.

## Credits

varnishops is heavily inspired by [mctop](http://github.com/etsy/mctop) from Etsy's folks.
File renamed without changes.
8 changes: 4 additions & 4 deletions varnishhit.gemspec → varnishops.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

Gem::Specification.new do |gem|
gem.name = "varnishhit"
gem.name = "varnishops"
gem.version = "0.0.1"
gem.authors = ["Jonathan Amiez"]
gem.email = ["[email protected]"]
gem.description = %q{varnishhit - a realtime varnish log analyzer}
gem.summary = %q{varnishhit - an interactive terminal app for analyzing varnish activity with hitratio, request number and request rate per type of files}
gem.homepage = "https://github.com/Fotolia/varnishhit"
gem.description = %q{varnishops - a realtime varnish log analyzer}
gem.summary = %q{varnishops - an interactive terminal app for analyzing varnish activity with hitratio, bandwidth and request rate per type of files}
gem.homepage = "https://github.com/Fotolia/varnishops"

gem.files = `git ls-files`.split($/)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
Expand Down

0 comments on commit 88746b5

Please sign in to comment.