Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Deprecate HouseMD

  • Loading branch information...
commit 7383aea43bd36caab5964a19445d5a2591fc82d2 1 parent 6ddf882
@zhongl zhongl authored
Showing with 3 additions and 116 deletions.
  1. +3 −116 README.md
View
119 README.md
@@ -1,118 +1,5 @@
-[中文使用指南](https://github.com/zhongl/HouseMD/wiki/UserGuideCN)
+# Sorry guys, HouseMD may not be updated any more except merging PR.
-HouseMD is a interactive command-line tool for dianosing Java process in runtime.
-It's inspiration came from [BTrace](http://kenai.com/projects/btrace), but more easier to use and more safer.
+# I highly recommend [Grey anatomy](https://github.com/oldmanpushcart/greys-anatomy) If you are looking for a tool like HouseMD.
-# Features
-
-- Display loaded classes information
- - name
- - source file(.class or .jar)
- - classloaders
-- Display invocation trace summary
- - method full name and sign
- - class loader of method declaring class
- - total invoked times
- - avg elapse millis
- - self instance
-- Output invocation detail
- - timestamp
- - elapse millis
- - call thread
- - this object
- - class name
- - method name
- - arguments
- - result or exception
-- Output invocation stack trace
-- Display object field value
-- Display enviroment variable
-- Auto-completion by typing `Tab`
-- navigate command history by up and down, and support `Ctrl + R` for searching
-- Awesome features you can provide by forking me
-
-[Test cases](https://github.com/zhongl/HouseMD/blob/master/src/test/scala/com/github/zhongl/housemd) would show more specification details.
-
-# Getting started
-
-## Pre-requirement
-
-- JDK 6
-- [sbt](https://github.com/harrah/xsbt)
-
-## Install from [jenv](https://github.com/linux-china/jenv)
-
-- install [jenv](https://github.com/linux-china/jenv)
-- execute command line: `$ jenv install housemd`
-
-> Caution: Windows are not supported yet.
-
-
-# How to use
-
-
- > housemd -h
-
-A help infomation shows up like:
-
- Usage: housemd [OPTIONS] pid
- a runtime diagnosis tool of JVM.
- Options:
- -h, --help
- show help infomation of this command.
- -p, --port=[INT]
- set console local socket server port number.
- default: 54321
- Parameters:
- pid
- id of process to be diagnosing.
-
-
-Suppost your target pid is `1234` (you can use `jps` or `ps` get it), and then input:
-
- > ./housemd 1234
-
-After seen prompt `housemd>`, input `help` then you get help infomation like this:
-
- housemd> help
-
- quit terminate the process.
- help display this infomation.
- trace display or output infomation of method invocaton.
- loaded display loaded classes information.
- env display system env.
- inspect display fields of a class.
-
-You can also input `help loaded` and get help infomation of `loaded` as blow:
-
- housemd> help loaded
- Usage: loaded [OPTIONS] name
- display loaded classes information.
- Options:
- -h, --classloader-hierarchies
- display classloader hierarchies of loaded class.
- Parameters:
- name
- class name without package name.
-
-# More about commands
-
-[Click here](https://github.com/zhongl/housemd/wiki/usecases) to see the use cases.
-
-# Build from code
-
- $ git clone https://github.com/zhongl/HouseMD.git housemd
- $ cd housemd
- $ sbt proguard
-
-A runnable jar named `housemd_x.x.x-x.x.x.min.jar` should be generated blow `target/scala-x.x.x/`
-
-
-## Run it
-
- $ java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar housemd_x.x.x-x.x.x.min.jar [OPTIONS] <pid>
-
-> Caution: In Mac OSX, the `-Xbootclasspath` is no needed.
-> You can created launch script as a shortcut.
-
-Having fun!
+[README moved here.](https://github.com/CSUG/HouseMD/wiki/readme)
Please sign in to comment.
Something went wrong with that request. Please try again.