git.iko.soy/distributed-process
on master help sign in
Document the use of built-in trace flags
fc0a1ccTim Watson
src/Control/Distributed/Process/Debug.hs+13
@@ -78,6 +78,19 @@
78-- This is checked for /any/ non-empty value. If set, all internal traces are
78-- This is checked for /any/ non-empty value. If set, all internal traces are
79-- written to the GHC eventlog.
79-- written to the GHC eventlog.
80--
80--
81+-- By default, the built in tracers will ignore all trace events! In order to
82+-- enable tracing the incoming 'MxEvent' stream, the @DISTRIBUTED_PROCESS_TRACE_FLAGS@
83+-- environment variable accepts the following flags, which enable tracing specific
84+-- event types:
85+--
86+-- p = trace the spawning of new processes
87+-- d = trace the death of processes
88+-- n = trace registration of names (i.e., named processes)
89+-- u = trace un-registration of names (i.e., named processes)
90+-- s = trace the sending of messages to other processes
91+-- r = trace the receipt of messages from other processes
92+-- l = trace node up/down events
93+--
81-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
94-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
82-- because the trace file option only supports trace output from a single node
95-- because the trace file option only supports trace output from a single node
83-- (so as to avoid interleaving), a file trace configured for the master node
96-- (so as to avoid interleaving), a file trace configured for the master node