aboutsummaryrefslogtreecommitdiff
path: root/doc/ekg.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-11-06 16:33:45 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-11-06 16:33:45 -0400
commitc86c3dd1d1d18747d42dfafcbaa4d5e87f41892b (patch)
treefbd70ee78127b4291f391e91eb6050744a99f5f2 /doc/ekg.mdwn
parente040b23aa1754ca4e210a79969ca5b146c1120f0 (diff)
Allow optionally configuring git-annex with -fEKG to enable awesome remote monitoring interfaceat http://localhost:4242/
Diffstat (limited to 'doc/ekg.mdwn')
-rw-r--r--doc/ekg.mdwn14
1 files changed, 14 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.