marketplace-2014/Management_and_Monitoring.html

21 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>5&nbsp;Management and Monitoring</title><link rel="stylesheet" type="text/css" href="scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="racket.css" title="default"/><link rel="stylesheet" type="text/css" href="manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="manual-racket.css" title="default"/><script type="text/javascript" src="scribble-common.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="scribble-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,&quot;tocview_0&quot;);">&#9660;</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x">Marketplace:<span class="mywbr"> &nbsp;</span> Network-<wbr></wbr>Aware Programming</a></td></tr></table></div><div class="tocviewsublisttop" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1&nbsp;</td><td><a href="Concepts.html" class="tocviewlink" data-pltdoc="x">Concepts</a></td></tr><tr><td align="right">2&nbsp;</td><td><a href="high-level-interface.html" class="tocviewlink" data-pltdoc="x">High-<wbr></wbr>level interface</a></td></tr><tr><td align="right">3&nbsp;</td><td><a href="low-level-interface.html" class="tocviewlink" data-pltdoc="x">Low-<wbr></wbr>level interface</a></td></tr><tr><td align="right">4&nbsp;</td><td><a href="Drivers.html" class="tocviewlink" data-pltdoc="x">Drivers</a></td></tr><tr><td align="right">5&nbsp;</td><td><a href="Management_and_Monitoring.html" class="tocviewselflink" data-pltdoc="x">Management and Monitoring</a></td></tr><tr><td align="right">6&nbsp;</td><td><a href="Examples.html" class="tocviewlink" data-pltdoc="x">Examples</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,&quot;tocview_1&quot;);">&#9658;</a></td><td>5&nbsp;</td><td><a href="Management_and_Monitoring.html" class="tocviewselflink" data-pltdoc="x">Management and Monitoring</a></td></tr></table><div class="tocviewsublistbottom" style="display: none;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">5.1&nbsp;</td><td><a href="Management_and_Monitoring.html#%28part._generic-spy%29" class="tocviewlink" data-pltdoc="x">generic-<wbr></wbr>spy</a></td></tr><tr><td align="right">5.2&nbsp;</td><td><a href="Management_and_Monitoring.html#%28part._logging%29" class="tocviewlink" data-pltdoc="x">logging (MARKETPLACE_<span class="mywbr"> &nbsp;</span>LOG)</a></td></tr><tr><td align="right">5.3&nbsp;</td><td><a href="Management_and_Monitoring.html#%28part._debugger__experimental_%29" class="tocviewlink" data-pltdoc="x">debugger (experimental)</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber">5.1<tt>&nbsp;</tt></span><a href="#%28part._generic-spy%29" class="tocsubseclink" data-pltdoc="x">generic-<wbr></wbr>spy</a></td></tr><tr><td><a href="#%28def._%28%28lib._marketplace%2Fsupport%2Fspy..rkt%29._generic-spy%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">generic-<wbr></wbr>spy</span></span></a></td></tr><tr><td><span class="tocsublinknumber">5.2<tt>&nbsp;</tt></span><a href="#%28part._logging%29" class="tocsubseclink" data-pltdoc="x">logging (MARKETPLACE_<span class="mywbr"> &nbsp;</span>LOG)</a></td></tr><tr><td><a href="#%28form._%28%28lib._marketplace%2Flog-untyped..rkt%29._.M.A.R.K.E.T.P.L.A.C.E_.L.O.G%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym">MARKETPLACE_<span class="mywbr"> &nbsp;</span>LOG</span></a></td></tr><tr><td><a href="#%28form._%28%28lib._marketplace%2Flog-untyped..rkt%29._marketplace-log%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">marketplace-<wbr></wbr>log</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._marketplace%2Flog-untyped..rkt%29._marketplace-root-logger%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">marketplace-<wbr></wbr>root-<wbr></wbr>logger</span></span></a></td></tr><tr><td><span class="tocsublinknumber">5.3<tt>&nbsp;</tt></span><a href="#%28part._debugger__experimental_%29" class="tocsubseclink" data-pltdoc="x">debugger (experimental)</a></td></tr><tr><td><a href="#%28def._%28%28lib._marketplace%2Fsupport%2Fdebug..rkt%29._debug%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">debug</span></span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="versionbox"><span class="version">6.0.0.1</span></div><div class="navsettop"><span class="navleft">&nbsp;&nbsp;</span><span class="navright">&nbsp;&nbsp;<a href="Drivers.html" title="backward to &quot;4 Drivers&quot;" data-pltdoc="x">&larr; prev</a>&nbsp;&nbsp;<a href="index.html" title="up to &quot;Marketplace: Network-Aware Programming&quot;" data-pltdoc="x">up</a>&nbsp;&nbsp;<a href="Examples.html" title="forward to &quot;6 Examples&quot;" data-pltdoc="x">next &rarr;</a></span>&nbsp;</div><h3>5<tt>&nbsp;</tt><a name="(part._.Management_and_.Monitoring)"></a>Management and Monitoring</h3><h4>5.1<tt>&nbsp;</tt><a name="(part._generic-spy)"></a><a name="(mod-path._marketplace/support/spy)"></a>generic-spy</h4><p><div class="SIntrapara"><table cellspacing="0" class="defmodule"><tr><td align="left"><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29" class="RktStxLink" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="Management_and_Monitoring.html#%28mod-path._marketplace%2Fsupport%2Fspy%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">marketplace/support/spy</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller">&nbsp;package:</span> <span class="stt">marketplace</span></span></td></tr></table></div><div class="SIntrapara"><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._marketplace/support/spy..rkt)._generic-spy))"></a><span title="Provided from: marketplace/support/spy"><span class="RktSym"><a href="Management_and_Monitoring.html#%28def._%28%28lib._marketplace%2Fsupport%2Fspy..rkt%29._generic-spy%29%29" class="RktValDef RktValLink" data-pltdoc="x">generic-spy</a></span></span><span class="hspace">&nbsp;</span><span class="RktVar">label</span><span class="RktPn">)</span><span class="hspace">&nbsp;</span>&rarr;<span class="hspace">&nbsp;</span><span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._.Spawn%29%29" class="RktValLink" data-pltdoc="x">Spawn</a></span></p></blockquote></td></tr><tr><td><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">label</span><span class="hspace">&nbsp;</span>:<span class="hspace">&nbsp;</span><span class="RktSym"><a href="http://docs.racket-lang.org/ts-reference/type-ref.html#%28form._%28%28lib._typed-racket%2Fbase-env%2Fbase-types..rkt%29._.Any%29%29" class="RktStxLink" data-pltdoc="x">Any</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Returns a <span class="RktSym"><a href="high-level-interface.html#%28form._%28%28lib._marketplace%2Fsugar-untyped..rkt%29._spawn%29%29" class="RktStxLink" data-pltdoc="x">spawn</a></span> action that, when executed, creates a process
with a <span class="RktPn">#:subscriber</span> <span class="RktSym">endpoint</span> listening for every
message. Each <span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._.Endpoint.Event%29%29" class="RktValLink" data-pltdoc="x">EndpointEvent</a></span> received by the endpoint is
printed to the current output port. Using this process gives a crude
trace of activity within a VM: <span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._presence-event%29%29" class="RktValLink" data-pltdoc="x">presence-event</a></span>s and
<span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._absence-event%29%29" class="RktValLink" data-pltdoc="x">absence-event</a></span>s (of <span class="RktPn">#:publishers</span>) are logged, as is
each <span class="RktVal">'</span><span class="RktVal">publisher</span> message sent to the VM&rsquo;s network.</div></p></div></p><h4>5.2<tt>&nbsp;</tt><a name="(part._logging)"></a><a name="(mod-path._marketplace/log-untyped)"></a><a name="(mod-path._marketplace/log-typed)"></a>logging (MARKETPLACE_LOG)</h4><p><div class="SIntrapara"><table cellspacing="0" class="defmodule"><tr><td align="left"><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29" class="RktStxLink" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="Management_and_Monitoring.html#%28mod-path._marketplace%2Flog-untyped%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">marketplace/log-untyped</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller">&nbsp;package:</span> <span class="stt">marketplace</span></span></td></tr><tr><td align="left" colspan="2"><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29" class="RktStxLink" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="Management_and_Monitoring.html#%28mod-path._marketplace%2Flog-typed%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">marketplace/log-typed</span></a><span class="RktPn">)</span></td></tr></table></div><div class="SIntrapara"><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>environment variable</p></div></div><p class="RForeground"><a name="(form._((lib._marketplace/log-untyped..rkt)._.M.A.R.K.E.T.P.L.A.C.E_.L.O.G))"></a><span title="Provided from: marketplace/log-untyped, marketplace/log-typed"><span class="RktSym"><span class="RktSymDef RktSym">MARKETPLACE_LOG</span></span></span></p></blockquote></td></tr></table></blockquote></div><div class="SIntrapara">Set the <span class="stt">MARKETPLACE_LOG</span> environment variable to "debug", "info",
"warning", "error" or "fatal" (i.e. any of Racket&rsquo;s
<span class="RktSym"><a href="http://docs.racket-lang.org/reference/logging.html#%28def._%28%28quote._~23~25kernel%29._log-level~3f%29%29" class="RktValLink" data-pltdoc="x">log-level?</a></span>s) to enable output of log messages at that level
and higher.</div></p></div><div class="SIntrapara">If <span class="stt">MARKETPLACE_LOG</span> is not defined in the environment, <span style="font-style: italic">no log
output will be produced</span>.</div><div class="SIntrapara"><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._marketplace/log-untyped..rkt)._marketplace-log))"></a><span title="Provided from: marketplace/log-untyped, marketplace/log-typed"><span class="RktSym"><a href="Management_and_Monitoring.html#%28form._%28%28lib._marketplace%2Flog-untyped..rkt%29._marketplace-log%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">marketplace-log</a></span></span><span class="hspace">&nbsp;</span><span class="RktVar">level</span><span class="hspace">&nbsp;</span><span class="RktVar">format-str</span><span class="hspace">&nbsp;</span><span class="RktVar">arg</span><span class="hspace">&nbsp;</span><span class="RktMeta">...</span><span class="RktPn">)</span></p></blockquote></td></tr><tr><td><span class="stt">&nbsp;</span></td></tr><tr><td><table cellspacing="0" class="specgrammar"><tr><td align="right" valign="baseline"><span class="RktVar">level</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktVar">expr</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="RktVar">format-str</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktVar">expr</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="RktVar">arg</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktVar">expr</span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">Analogous to Racket&rsquo;s core <span class="RktSym"><a href="http://docs.racket-lang.org/reference/logging.html#%28def._%28%28quote._~23~25kernel%29._log-message%29%29" class="RktValLink" data-pltdoc="x">log-message</a></span>, but uses
<span class="RktSym"><a href="Management_and_Monitoring.html#%28def._%28%28lib._marketplace%2Flog-untyped..rkt%29._marketplace-root-logger%29%29" class="RktValLink" data-pltdoc="x">marketplace-root-logger</a></span> instead of the system logger. The
<span class="RktVar">level</span> expression must evaluate to a level symbol (see
<span class="RktSym"><a href="http://docs.racket-lang.org/reference/logging.html#%28def._%28%28quote._~23~25kernel%29._log-level~3f%29%29" class="RktValLink" data-pltdoc="x">log-level?</a></span>), and <span class="RktVar">format-str</span> must evaluate to a
format string for use with <span class="RktSym"><a href="http://docs.racket-lang.org/reference/Writing.html#%28def._%28%28quote._~23~25kernel%29._format%29%29" class="RktValLink" data-pltdoc="x">format</a></span>.</div></p></div><div class="SIntrapara"><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>value</p></div></div><p class="RForeground"><a name="(def._((lib._marketplace/log-untyped..rkt)._marketplace-root-logger))"></a><span title="Provided from: marketplace/log-untyped, marketplace/log-typed"><span class="RktSym"><a href="Management_and_Monitoring.html#%28def._%28%28lib._marketplace%2Flog-untyped..rkt%29._marketplace-root-logger%29%29" class="RktValDef RktValLink" data-pltdoc="x">marketplace-root-logger</a></span></span><span class="hspace">&nbsp;</span>:<span class="hspace">&nbsp;</span><span class="RktSym"><a href="http://docs.racket-lang.org/reference/logging.html#%28def._%28%28quote._~23~25kernel%29._logger~3f%29%29" class="RktValLink" data-pltdoc="x">logger?</a></span></p></blockquote></td></tr></table></blockquote></div><div class="SIntrapara">The root logger for marketplace logging.</div></p></div></p><h4>5.3<tt>&nbsp;</tt><a name="(part._debugger__experimental_)"></a><a name="(mod-path._marketplace/support/debug)"></a>debugger (experimental)</h4><p><div class="SIntrapara"><table cellspacing="0" class="defmodule"><tr><td align="left" colspan="2"><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29" class="RktStxLink" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="Management_and_Monitoring.html#%28mod-path._marketplace%2Fsupport%2Fdebug%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">marketplace/support/debug</span></a><span class="RktPn">)</span></td></tr><tr><td align="left">&nbsp;</td><td align="right"><span class="RpackageSpec"><span class="Smaller">&nbsp;package:</span> <span class="stt">marketplace</span></span></td></tr></table></div><div class="SIntrapara"><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._marketplace/support/debug..rkt)._debug))"></a><span title="Provided from: marketplace/support/debug"><span class="RktSym"><a href="Management_and_Monitoring.html#%28def._%28%28lib._marketplace%2Fsupport%2Fdebug..rkt%29._debug%29%29" class="RktValDef RktValLink" data-pltdoc="x">debug</a></span></span><span class="hspace">&nbsp;</span><span class="RktVar">p</span><span class="RktPn">)</span><span class="hspace">&nbsp;</span>&rarr;<span class="hspace">&nbsp;</span><span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._.Spawn%29%29" class="RktValLink" data-pltdoc="x">Spawn</a></span></p></blockquote></td></tr><tr><td><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">p</span><span class="hspace">&nbsp;</span>:<span class="hspace">&nbsp;</span><span class="RktSym"><a href="low-level-interface.html#%28def._%28%28lib._marketplace%2Fmain..rkt%29._.Spawn%29%29" class="RktValLink" data-pltdoc="x">Spawn</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Translates a <span class="RktSym"><a href="high-level-interface.html#%28form._%28%28lib._marketplace%2Fsugar-untyped..rkt%29._spawn%29%29" class="RktStxLink" data-pltdoc="x">spawn</a></span> action to another spawn action which wraps
the to-be-spawned process in a debugging interface. Executing the
resulting action will not only create a process in the executing VM,
but will also open a debugger GUI.</div></p></div><div class="SIntrapara">N.B.: The debugger is experimental and likely to change quite quickly
and unpredictably.</div><div class="SIntrapara">See the file <span class="stt">"examples/debug-chat.rkt"</span> for an example of the
use of <span class="RktSym"><a href="Management_and_Monitoring.html#%28def._%28%28lib._marketplace%2Fsupport%2Fdebug..rkt%29._debug%29%29" class="RktValLink" data-pltdoc="x">debug</a></span>.</div></p><div class="navsetbottom"><span class="navleft">&nbsp;&nbsp;</span><span class="navright">&nbsp;&nbsp;<a href="Drivers.html" title="backward to &quot;4 Drivers&quot;" data-pltdoc="x">&larr; prev</a>&nbsp;&nbsp;<a href="index.html" title="up to &quot;Marketplace: Network-Aware Programming&quot;" data-pltdoc="x">up</a>&nbsp;&nbsp;<a href="Examples.html" title="forward to &quot;6 Examples&quot;" data-pltdoc="x">next &rarr;</a></span>&nbsp;</div></div></div><div id="contextindicator">&nbsp;</div></body></html>