$ git log --pretty=format:'%h %s (%cs)%d' v0.20.1 --
19af4a5 raindrops 0.20.1 (2023-02-25)
(tag: v0.20.1)
10d5fb2 Fix off by one error in test (2023-02-24)
a5902f2 Fix queue stats for sockets with SO_REUSEPORT (2023-02-24)
2fa3153 raindrops 0.20.0 (2021-12-06)
(tag: v0.20.0)
b73beee doc: update with IMAP(S) URLs and improve descriptions (2021-11-30)
18ee38a Allow Raindrops objects to be backed by a file (2021-11-26)
00fb3c8 raindrops 0.19.2 (2021-05-25)
(tag: v0.19.2)
1c49146 pkg.mk: remove index.html and created.rid from homepage (2021-05-25)
eef7d03 doc: use Tor v3 .onion URLs (2021-05-25)
436ab38 mark ListenStats in C ext for GC.compact (2021-05-25)
...
$ git cat-file blob v0.20.1:README
= raindrops - real-time stats for preforking Rack servers
raindrops is a real-time stats toolkit to show statistics for Rack HTTP
servers. It is designed for preforking servers such as unicorn, but
should support any Rack HTTP server on platforms supporting POSIX shared
memory. It may also be used as a generic scoreboard for sharing atomic
counters across multiple processes.
== 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.
* TCP_Info reporting may be used to check stat for every accepted client
on TCP servers
Users of older Linux kernels need to ensure that the the "inet_diag"
and "tcp_diag" kernel modules are loaded as they do not autoload correctly
== Install
We recommend GCC 4+ (or compatible) to support the __sync builtins
(__sync_{add,sub}_and_fetch()):
https://gcc.gnu.org/onlinedocs/gcc/_005f_005fsync-Builtins.html
For non-GCC 4+ users, we also support compilation with the libatomic_ops
package starting with Raindrops 0.4.0:
https://github.com/ivmai/libatomic_ops
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
== Usage
See Raindrops::Middleware and Raindrops::LastDataRecv documentation for
use Rack servers. The entire library is fully-documented and we are
responsive on the publicly archived mailbox
(mailto:raindrops-public@yhbt.net) if you have any questions or comments.
== Development
You can get the latest source via git from the following locations:
https://yhbt.net/raindrops.git
http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/raindrops.git
http://repo.or.cz/w/raindrops.git (gitweb mirror)
Snapshots and tarballs are available.
Inline patches (from "git format-patch") to the mailbox 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.
raindrops is licensed under the LGPL-2.1+
== Contact
All feedback (bug reports, user/development discussion, patches, pull
requests) go to the publicly archived mailbox:
mailto:raindrops-public@yhbt.net
Mail archives are available over HTTP(S), IMAP(S) and NNTP(S):
* https://yhbt.net/raindrops-public/
* http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/raindrops-public/
* imaps://yhbt.net/inbox.comp.lang.ruby.raindrops.0
* imap://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.raindrops.0
* nntps://news.public-inbox.org/inbox.comp.lang.ruby.raindrops
* nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.raindrops
Since archives are public, scrub sensitive information and
use anonymity tools such as Tor or Mixmaster if you deem necessary.
# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master README: update with extra disclaimer (2024-04-04)
aggregate-pmq aggregate/pmq: avoid File#stat allocation (2017-03-18)
freebsd define Raindrops::TCP hash for TCP states (2017-03-17)
gc-next linux_inet_diag: improve compatibility with newer GCs (2013-06-16)
# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
--format='%(refname:short) %(subject) (%(creatordate:short))'
v0.20.1 raindrops 0.20.1 (2023-02-25) tar.gz
v0.20.0 raindrops 0.20.0 (2021-12-06) tar.gz
v0.19.2 raindrops 0.19.2 (2021-05-25) tar.gz
v0.19.1 raindrops 0.19.1 (2020-01-08) tar.gz
v0.19.0 raindrops 0.19.0 - Rack 2.x middleware compatibility (2017-08-09) tar.gz
v0.18.0 raindrops 0.18.0 (2017-03-23) tar.gz
v0.17.0 raindrops 0.17.0 - rack 2.x updates (2016-07-31) tar.gz
v0.16.0 raindrops 0.16.0 - minor fixes and workarounds (2016-02-29) tar.gz
v0.15.0 raindrops 0.15.0 - non-glibc compat fix on Linux (2015-07-22) tar.gz
v0.14.0 raindrops 0.14.0 - misc doc updates (2015-06-25) tar.gz
...
# associated public inboxes:
# (number on the left is used for dev purposes)
http://yhbt.net/raindrops-public
git clone http://yhbt.net/raindrops.git