Allow optionally configuring git-annex with -fEKG to enable awesome remote monitoring interfaceat http://localhost:4242/

3 files changed, 20 insertions, 0 deletions

diff --git a/doc/ekg.mdwn b/doc/ekg.mdwn
new file mode 100644
index 000000000..3bbea8614
--- /dev/null
+++ b/doc/ekg.mdwn
@@ -0,0 +1,14 @@
+You can `cabal configure -fEKG` to build a git-annex that includes
+the EKG remote monitoring interface.
+
+To access the EKG control panel, go to
+<http://localhost:4242/> while a git-annex command is running.
+
+This EKG build is mostly useful for debugging resource usage problems.
+
+[[!img ekg.png caption="git-annex webapp startup, and assistant startup scan"]]
+
+Note that since only one process can open port 4242 at a time, running
+more than one git-annex process with EKG support at the same time can
+result in some "resource busy (Address already in use)" messages -- but
+git-annex will continue to work.
diff --git a/doc/ekg/ekg.png b/doc/ekg/ekg.png
new file mode 100644
index 000000000..a8d16a2d8
--- /dev/null
+++ b/doc/ekg/ekg.png
diff --git a/doc/install/cabal.mdwn b/doc/install/cabal.mdwn
index 4eac597f1..3270dd0f9 100644
--- a/doc/install/cabal.mdwn
+++ b/doc/install/cabal.mdwn
@@ -50,3 +50,9 @@ you want, and use cabal as follows inside its source tree:
 	cabal configure
 	cabal build
 	cabal install --bindir=$HOME/bin
+
+## EKG
+
+When building with cabal, you can optionally enable the 
+[[EKG monitoring interface|ekg]]. This is great for debugging resource
+usage problems.