README

   1 = raindrops - real-time stats for preforking Rack servers
   2
   3 raindrops is a real-time stats toolkit to show statistics for Rack HTTP
   4 servers.  It is designed for preforking servers such as unicorn, but
   5 should support any Rack HTTP server on platforms supporting POSIX shared
   6 memory.  It may also be used as a generic scoreboard for sharing atomic
   7 counters across multiple processes.
   8
   9 == Features
  10
  11 * counters are shared across all forked children and lock-free
  12
  13 * counters are kept on separate cache lines to reduce contention under SMP
  14
  15 * may expose server statistics as a Rack Middleware endpoint
  16   (default: "/_raindrops")
  17
  18 * middleware displays the number of actively processing and writing
  19   clients from a single request regardless of which worker process
  20   it hits.
  21
  22 == Linux-only Extra Features!
  23
  24 * Middleware response includes extra stats for bound TCP and
  25   Unix domain sockets (configurable, it can include stats from
  26   other TCP or UNIX domain socket servers).
  27
  28 * TCP socket stats use efficient inet_diag facilities via netlink
  29   instead of parsing /proc/net/tcp to minimize overhead.
  30   This was fun to discover and write.
  31
  32 * TCP_Info reporting may be used to check stat for every accepted client
  33   on TCP servers
  34
  35 Users of older Linux kernels need to ensure that the the "inet_diag"
  36 and "tcp_diag" kernel modules are loaded as they do not autoload correctly
  37
  38 == Install
  39
  40 We recommend GCC 4+ (or compatible) to support the __sync builtins
  41 (__sync_{add,sub}_and_fetch()):
  42
  43 https://gcc.gnu.org/onlinedocs/gcc/_005f_005fsync-Builtins.html
  44
  45 For non-GCC 4+ users, we also support compilation with the libatomic_ops
  46 package starting with Raindrops 0.4.0:
  47
  48 https://github.com/ivmai/libatomic_ops
  49
  50 If you're using a packaged Ruby distribution, make sure you have a C
  51 compiler and the matching Ruby development libraries and headers.
  52
  53 If you use RubyGems:
  54
  55     gem install raindrops
  56
  57 == Usage
  58
  59 See Raindrops::Middleware and Raindrops::LastDataRecv documentation for
  60 use Rack servers.  The entire library is fully-documented and we are
  61 responsive on the publicly archived mailbox
  62 (mailto:raindrops-public@yhbt.net) if you have any questions or comments.
  63
  64 == Development
  65
  66 You can get the latest source via git from the following locations:
  67
  68   https://yhbt.net/raindrops.git
  69   http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/raindrops.git
  70   http://repo.or.cz/w/raindrops.git (gitweb mirror)
  71
  72 Snapshots and tarballs are available.
  73
  74 Inline patches (from "git format-patch") to the mailbox are
  75 preferred because they allow code review and comments in the reply to
  76 the patch.
  77
  78 We will adhere to mostly the same conventions for patch submissions as
  79 git itself.  See the Documentation/SubmittingPatches document
  80 distributed with git on on patch submission guidelines to follow.  Just
  81 don't email the git mailing list or maintainer with raindrops patches.
  82
  83 raindrops is licensed under the LGPL-2.1+
  84
  85 == Contact
  86
  87 All feedback (bug reports, user/development discussion, patches, pull
  88 requests) go to the publicly archived mailbox:
  89 mailto:raindrops-public@yhbt.net
  90
  91 Mail archives are available over HTTP(S), IMAP(S) and NNTP(S):
  92
  93 * https://yhbt.net/raindrops-public/
  94 * http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/raindrops-public/
  95 * imaps://yhbt.net/inbox.comp.lang.ruby.raindrops.0
  96 * imap://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.raindrops.0
  97 * nntps://news.public-inbox.org/inbox.comp.lang.ruby.raindrops
  98 * nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.lang.ruby.raindrops
  99
 100 Since archives are public, scrub sensitive information and
 101 use anonymity tools such as Tor or Mixmaster if you deem necessary.
 102
 103 There is NO WARRANTY whatsoever if anything goes wrong and
 104 no commercial support will ever be provided by the amateur maintainer.
 105 raindrops hackers are NOT responsible for your supply chain security:
 106 read and understand it yourself or get someone you trust to audit it.
 107 Malicious commits and releases will be made if under duress.  The only
 108 defense you'll ever have is from reviewing the source code.
 109
 110 No user or contributor will ever be expected to sacrifice their own
 111 security by running JavaScript or revealing any personal information.