-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update mirage-monitoring doc to 0.0.2.
- Loading branch information
Showing
5 changed files
with
7 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,12 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (mirage-monitoring.Mirage_monitoring.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">mirage-monitoring</a> » <a href="../index.html">Mirage_monitoring</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Mirage_monitoring.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter" id="argument-1-T" class="anchored"><a href="#argument-1-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter" id="argument-2-P" class="anchored"><a href="#argument-2-P" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>P</span><span> : <span class="xref-unresolved">Mirage_clock</span>.PCLOCK</span></code></div></div><div class="odoc-spec"><div class="spec parameter" id="argument-3-S" class="anchored"><a href="#argument-3-S" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>S</span><span> : <span class="xref-unresolved">Tcpip</span>.Stack.V4V6</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (mirage-monitoring.Mirage_monitoring.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">mirage-monitoring</a> » <a href="../index.html">Mirage_monitoring</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Mirage_monitoring.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter" id="argument-1-T" class="anchored"><a href="#argument-1-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter" id="argument-2-P" class="anchored"><a href="#argument-2-P" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>P</span><span> : <span class="xref-unresolved">Mirage_clock</span>.PCLOCK</span></code></div></div><div class="odoc-spec"><div class="spec parameter" id="argument-3-S" class="anchored"><a href="#argument-3-S" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>S</span><span> : <span class="xref-unresolved">Tcpip</span>.Stack.V4V6</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : | ||
| <span>?interval:int <span class="arrow">-></span></span> | ||
| <span>?quick:bool <span class="arrow">-></span></span> | ||
| <span>?hostname:string <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Ipaddr</span>.t <span class="arrow">-></span></span> | ||
| <span>?port:int <span class="arrow">-></span></span> | ||
| <span>?listen_port:int <span class="arrow">-></span></span> | ||
| <span>?memtrace_port:int <span class="arrow">-></span></span> | ||
| <span>?sampling_rate:float <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">S</span>.t <span class="arrow">-></span></span> | ||
| unit</span></code></div><div class="spec-doc"><p><code>create ~interval ~hostname ip ~port ~listen_port ~memtrace_port ~sampling_rate stack</code> initiates monitoring on <code>stack</code> for the unikernel. The metrics are reported every <code>interval</code> (defaults to 10) seconds to <code>ip</code> on <code>port</code> (defaults to 8094) via TCP using the influxd wire protocol. On <code>listen_port</code> (defaults to 2323) a TCP connection can be initiated to adjust the log level and enable and disable metrics sources. On <code>memtrace_port</code> (defaults to 4242) a single TCP client can connect simultaneously to receive a <code>Gc.Memprof</code> trace. The <code>sampling_rate</code> defaults to <code>1e-4</code>.</p></div></div></div></body></html> | ||
| unit</span></code></div><div class="spec-doc"><p><code>create ~interval ~quick ~hostname ip ~port ~listen_port ~memtrace_port ~sampling_rate stack</code> initiates monitoring on <code>stack</code> for the unikernel. The metrics are reported every <code>interval</code> (defaults to 10) seconds to <code>ip</code> on <code>port</code> (defaults to 8094) via TCP using the influxd wire protocol. On <code>listen_port</code> (defaults to 2323) a TCP connection can be initiated to adjust the log level and enable and disable metrics sources. On <code>memtrace_port</code> (defaults to 4242) a single TCP client can connect simultaneously to receive a <code>Gc.Memprof</code> trace. The <code>sampling_rate</code> defaults to <code>1e-4</code>. If <code>quick</code> is provided and <code>false</code> (defaults to <code>true</code>), <code>Solo5_os.Memory.stat</code> is used, otherwise <code>Solo5_os.Memory.quick_stat</code> is used.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (mirage-monitoring.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – mirage-monitoring</nav><header class="odoc-preamble"><h1 id="mirage-monitoring-index"><a href="#mirage-monitoring-index" class="anchor"></a>mirage-monitoring index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-mirage-monitoring">Library mirage-monitoring</a></li></ul></nav><div class="odoc-content"><h2 id="library-mirage-monitoring"><a href="#library-mirage-monitoring" class="anchor"></a>Library mirage-monitoring</h2><p>The entry point of this library is the module: <a href="Mirage_monitoring/index.html"><code>Mirage_monitoring</code></a>.</p></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (mirage-monitoring.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – mirage-monitoring</nav><header class="odoc-preamble"><h1 id="mirage-monitoring-index"><a href="#mirage-monitoring-index" class="anchor"></a>mirage-monitoring index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-mirage-monitoring">Library mirage-monitoring</a></li></ul></nav><div class="odoc-content"><h2 id="library-mirage-monitoring"><a href="#library-mirage-monitoring" class="anchor"></a>Library mirage-monitoring</h2><p>The entry point of this library is the module: <a href="Mirage_monitoring/index.html"><code>Mirage_monitoring</code></a>.</p></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters