Skip to content

Commit

Permalink
Hey it's a readme!
Browse files Browse the repository at this point in the history
  • Loading branch information
schmichael committed Aug 15, 2011
1 parent f87ba42 commit 01c6bb6
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
===
Wat
===

Mmstats is a way to expose and read (slurpstats.py) diagnostic/statistical
values for applications.

-----
Goals
-----

* Separate publishing/writing library from consuming/reading tools
* Platform/language independent (a Java writer can be read by a Python tool)
* Predictable performance impact for writers via:
** No locks (1 writer per thread)
** No syscalls
** All in userspace
** Reading has no impact on writers
* Optional persistent (writer can sync anytime)
* 1-way (Publish/consume only; mmstats are not management extensions)

=====
Usage
=====

-------------------
Testing/Development
-------------------

# Run your favorite Python test runner (py.test or nosetests)
# Run slurptests.py
# Clean /tmp/mmstats-* files up

0 comments on commit 01c6bb6

Please sign in to comment.