descriptionreal-time stats for preforking Rack servers
homepage URLhttp://raindrops.bogomips.org/
repository URLgit://bogomips.org/raindrops.git
ownerraindrops@bogomips.org
last changeMon, 29 Feb 2016 12:22:55 +0000 (29 12:22 +0000)
last refreshFri, 27 May 2016 16:57:00 +0000 (27 18:57 +0200)
content tags
add:
readme
= raindrops - real-time stats for preforking Rack servers

Raindrops is a real time stats package to show statistics for Rack HTTP
servers.  It is designed for preforking servers such as Rainbows! and
Unicorn, but should support any Rack HTTP server under Ruby 1.9, 1.8 and
possibly Rubinius (untested) on platforms supporting POSIX shared memory
and compiled with GCC (for atomic builtins).

Raindrops includes a Struct-like Raindrops::Struct class that may be used
standalone to create atomic counters shared across any number of forked
processes under SMP.

== Features

* counters are shared across all forked children and lock-free

* counters are kept on separate cache lines to reduce contention under SMP

* may expose server statistics as a Rack Middleware endpoint
  (default: "/_raindrops")

* middleware displays the number of actively processing and writing
  clients from a single request regardless of which worker process
  it hits.

== Linux-only Extra Features!

* Middleware response includes extra stats for bound TCP and
  Unix domain sockets (configurable, it can include stats from
  other TCP or UNIX domain socket servers).

* TCP socket stats use efficient inet_diag facilities via netlink
  instead of parsing /proc/net/tcp to minimize overhead.
  This was fun to discover and write.

== Install

raindrops requires GCC 4.x (or compatible) or later to support the
atomic builtins (__sync_{add,sub}_and_fetch()).  Atomic operations on
other compilers may be supported if there is demand.

If you're using a packaged Ruby distribution, make sure you have a C
compiler and the matching Ruby development libraries and headers.

If you use RubyGems:

    gem install raindrops

Otherwise grab the latest tarball from:

http://raindrops.bogomips.org/files/

Unpack it, and run "ruby setup.rb"

== Usage (Rainbows!/Unicorn preload_app=false)

If you're using preload_app=false (the default) in your Rainbows!/Unicorn
config file, you'll need to create the global Stats object before
forking.

        require 'raindrops'
        $stats ||= Raindrops::Middleware::Stats.new

In your Rack config.ru:

        use Raindrops::Middleware, :stats => $stats

== Usage (Rainbows!/Unicorn preload_app=true)

If you're using preload_app=true in your Rainbows!/Unicorn
config file, just add the middleware to your stack:

In your Rack config.ru:

        use Raindrops::Middleware

== Usage (Linux-extras)

To get bound listener statistics under Linux, you need to specify the
listener names for your server.  You can even include listen sockets for
*other* servers on the same machine.  This can be handy for monitoring
your nginx proxy as well.

In your Rack config.ru, just pass the :listeners argument as an array of
strings (along with any other arguments).  You can specify any
combination of TCP or Unix domain socket names:

        use Raindrops::Middleware, :listeners => %w(0.0.0.0:80 /tmp/.sock)

See the tests/ and examples/ directory for more examples

== Development

You can get the latest source via git from the following locations:

  git://bogomips.org/raindrops.git
  git://repo.or.cz/raindrops.git (mirror)

You may browse the code from the web and download the latest snapshot
tarballs here:

* http://bogomips.org/cgit/raindrops.git (cgit)
* http://repo.or.cz/w/raindrops.git (gitweb)

Inline patches (from "git format-patch") to the mailing list are
preferred because they allow code review and comments in the reply to
the patch.

We will adhere to mostly the same conventions for patch submissions as
git itself.  See the Documentation/SubmittingPatches document
distributed with git on on patch submission guidelines to follow.  Just
don't email the git mailing list or maintainer with raindrops patches.

== Contact

All feedback (bug reports, user/development discussion, patches, pull
requests) go to the mailing list: mailto:raindrops-public@bogomips.org
shortlog
2016-02-29 Eric Wongraindrops 0.16.0 - minor fixes and workaroundsmasterv0.16.0
2016-02-25 Eric Wongbuild: use '--local' domain for dev gem install
2016-02-25 Eric Wonglinux: tcp_listener_stats drops "true" placeholders
2016-02-24 Eric WongREADME: remove indentation from URLs in RDoc
2016-02-24 Eric Wongdoc: update URLs and references
2016-02-24 Eric Wongmiddleware: minor bytecode size reduction
2016-02-24 Eric Wongadd .gitattributes for Ruby method detection
2016-02-23 Eric Wonglinux: remove Pathname stdlib dependency
2016-02-23 Eric Wonglinux: workaround Ruby 2.3 change
2016-02-02 Eric Wongremove optimizations which made sense for older rubies
2015-08-29 Eric Wonggemspec: avoid circular dependency on unicorn
2015-07-22 Eric Wongraindrops 0.15.0 - non-glibc compat fix on Linuxv0.15.0
2015-07-14 Eric Wongcheck for the existence of linux/tcp.h
2015-06-25 Eric Wongraindrops 0.14.0 - misc doc updatesv0.14.0
2015-01-14 Eric Wonglinux_inet_diag: fix Wshorten-64-to-32 warnings
2015-01-14 Eric WongTODO: add item for unix_diag and udp_diag
...
tags
2 months ago v0.16.0 raindrops 0.16.0 - minor fixes...
10 months ago v0.15.0 raindrops 0.15.0 - non-glibc compat...
11 months ago v0.14.0 raindrops 0.14.0 - misc doc updates
2 years ago v0.13.0 raindrops 0.13.0 several minor...
2 years ago v0.12.0 raindrops 0.12.0 - compatibility...
3 years ago v0.11.0 raindrops 0.11.0 - minor fixes...
3 years ago v0.10.0 raindrops 0.10.0 - minor feature...
4 years ago v0.9.0 raindrops 0.9.0 - minor middleware...
4 years ago v0.8.1 raindrops 0.8.1 - compatibility...
4 years ago v0.8.0 raindrops 0.8.0 - watcher updates
4 years ago v0.7.0 raindrops 0.7.0 - FreeBSD fix,...
5 years ago v0.6.1 raindrops 0.6.1 - fix build on...
5 years ago v0.6.0 raindrops 0.6.0 - polishing up...
5 years ago v0.5.0 raindrops 0.5.0 - more Linux extras!
5 years ago v0.4.1 raindrops 0.4.1 - more portability!
5 years ago v0.4.0 raindrops 0.4.0 - flowing into...
...
heads
2 months ago master
2 years ago gc-next