Permalink
Browse files

Add README and LICENSE.

  • Loading branch information...
1 parent be97554 commit 5f10fe4ed712aeabdfc5b9fb28663097f9a6bab0 @watsonian committed Sep 4, 2012
Showing with 46 additions and 0 deletions.
  1. +20 −0 LICENSE
  2. +26 −0 README.md
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joel Watson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,26 @@
+# MemWatcher
+
+![](https://img.skitch.com/20120904-ei2851g3ij73e7mqp7m95q8f8s.jpg)
+
+This is a small Sinatra app that's designed to run on a server that you want
+to monitor memory usage on. You configure a memory threshold and every time
+the `/memcheck` page is hit the memory usage on the server is checked. If it
+exceeds the specified amount, it records the running processes and the memory
+usage at that time. Subsequent memory checks won't be recorded unless they
+exceed the last highest memory usage seen. The max seen memory is reset after
+a configurable number of times.
+
+## Configuration
+
+The following configuration options are available via environment variables:
+
+* `MEMWATCHER_MEMORY_THRESHOLD` - The memory threshold to record a process
+ listing if exceeded. Defaults to 50MB.
+* `MEMWATCHER_MAX_CHECKS` - The number of checks before the max seen memory
+ usage is reset. Dfaults to 6.
+* `MEMWATCHER_LOGS_TO_KEEP` - The number of log files to keep. Defaults to 25.
+* `MEMWATCHER_LOG_DIR` - The location to store the logs. Defaults to `log/procs`.
+
+## Copyright
+
+Copyright (c) 2012 Joel Watson. See LICENSE for details.

0 comments on commit 5f10fe4

Please sign in to comment.