taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

updating docs

Browse Source
This commit is contained in:
ainsley
2019-05-30 12:43:58 -05:00
parent 0ce229b29d
commit 7765f4b86a
162 changed files with 426 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/nats_server/monitoring.html
View File

@@ -2302,20 +2302,20 @@
<section class="normal markdown-section">
<h2 id="monitoring"><a name="monitoring" class="plugin-anchor" href="#monitoring"><i class="fa fa-link" aria-hidden="true"></i></a>Monitoring</h2>
<p>To monitor the NATS messaging system, <code>gnatsd</code> provides a lightweight HTTP server on a dedicated monitoring port. The monitoring server provides several endpoints, including <a href="#/varz">varz</a>, <a href="#/connz">connz</a>, <a href="#/routez">routez</a>, and <a href="#/subz">subsz</a>. All endpoints return a JSON object.</p>
<p>To monitor the NATS messaging system, <code>nats-server</code> provides a lightweight HTTP server on a dedicated monitoring port. The monitoring server provides several endpoints, including <a href="#/varz">varz</a>, <a href="#/connz">connz</a>, <a href="#/routez">routez</a>, and <a href="#/subz">subsz</a>. All endpoints return a JSON object.</p>
<p>The NATS monitoring endpoints support JSONP and CORS, making it easy to create single page monitoring web applications.</p>
<h2 id="enabling-monitoring"><a name="enabling-monitoring" class="plugin-anchor" href="#enabling-monitoring"><i class="fa fa-link" aria-hidden="true"></i></a>Enabling monitoring</h2>
<p>To enable the monitoring server, start the NATS server with the monitoring flag <code>-m</code> and the monitoring port, or turn it on in the <a href="configuration.html#configuration-properties">configuration file</a>.</p>
<pre class="language-"><code>-m, --http_port PORT HTTP PORT for monitoring
-ms,--https_port PORT Use HTTPS PORT for monitoring
</code></pre><p>Example:</p>
<pre class="language-"><code class="lang-sh">$ gnatsd -m 8222
<pre class="language-"><code class="lang-sh">$ nats-server -m 8222
<span class="token punctuation">[</span>4528<span class="token punctuation">]</span> 2015/08/19 20:09:58.572939 <span class="token punctuation">[</span>INF<span class="token punctuation">]</span> Starting gnatsd version 0.8.0
<span class="token punctuation">[</span>4528<span class="token punctuation">]</span> 2015/08/19 20:09:58.573007 <span class="token punctuation">[</span>INF<span class="token punctuation">]</span> Starting http monitor on port 8222
<span class="token punctuation">[</span>4528<span class="token punctuation">]</span> 2015/08/19 20:09:58.573071 <span class="token punctuation">[</span>INF<span class="token punctuation">]</span> Listening <span class="token keyword">for</span> client connections on 0.0.0.0:4222
<span class="token punctuation">[</span>4528<span class="token punctuation">]</span> 2015/08/19 20:09:58.573090 <span class="token punctuation">[</span>INF<span class="token punctuation">]</span> gnatsd is ready<span class="token operator">&lt;</span>/td<span class="token operator">&gt;</span>
</code></pre>
<p>To test, run <code>gnatsd -m 8222</code>, then go to <a href="http://localhost:8222/" target="_blank">http://localhost:8222/</a></p>
<p>To test, run <code>nats-server -m 8222</code>, then go to <a href="http://localhost:8222/" target="_blank">http://localhost:8222/</a></p>
<h2 id="monitoring-endpoints"><a name="monitoring-endpoints" class="plugin-anchor" href="#monitoring-endpoints"><i class="fa fa-link" aria-hidden="true"></i></a>Monitoring endpoints</h2>
<p>The following sections describe each supported monitoring endpoint: <code>varz</code>, <code>connz</code>, <code>routez</code>, and <code>subsz</code>.</p>
<h3 id="varz"><a name="varz" class="plugin-anchor" href="#varz"><i class="fa fa-link" aria-hidden="true"></i></a>/varz</h3>
@@ -2444,7 +2444,7 @@
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre>
<h2 id="monitoring-tools"><a name="monitoring-tools" class="plugin-anchor" href="#monitoring-tools"><i class="fa fa-link" aria-hidden="true"></i></a>Monitoring Tools</h2>
<p>In addition to writing custom monitoring tools, you can nats-server into Prometheus. The <a href="https://github.com/nats-io/prometheus-nats-exporter" target="_blank">Prometheus NATS Exporter</a> allows you to configure the metrics you want to observe and store in Prometheous. There&apos;s a sample <a href="https://graphana.com" target="_blank">Graphana</a> dashboard that you can use to visualize the server metrics.</p>
<p>In addition to writing custom monitoring tools, you can nats-server into Prometheus. The <a href="https://github.com/nats-io/prometheus-nats-exporter" target="_blank">Prometheus NATS Exporter</a> allows you to configure the metrics you want to observe and store in Prometheous. There&apos;s a sample <a href="https://grafana.com" target="_blank">Grafana</a> dashboard that you can use to visualize the server metrics.</p>
</section>
@@ -2488,7 +2488,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Monitoring","level":"4.5.6","depth":2,"next":{"title":"Managing A NATS Server","level":"4.6","depth":1,"path":"nats_admin/README.md","ref":"nats_admin/README.md","articles":[{"title":"Upgrading a Cluster","level":"4.6.1","depth":2,"path":"nats_admin/upgrading_cluster.md","ref":"nats_admin/upgrading_cluster.md","articles":[]},{"title":"Slow Consumers","level":"4.6.2","depth":2,"path":"nats_admin/slow_consumers.md","ref":"nats_admin/slow_consumers.md","articles":[]},{"title":"Signals","level":"4.6.3","depth":2,"path":"nats_admin/signals.md","ref":"nats_admin/signals.md","articles":[]},{"title":"System Accounts","level":"4.6.4","depth":2,"path":"sys_accounts/README.md","ref":"sys_accounts/README.md","articles":[{"title":"Configuration","level":"4.6.4.1","depth":3,"path":"sys_accounts/sys_accounts.md","ref":"sys_accounts/sys_accounts.md","articles":[]}]}]},"previous":{"title":"Logging","level":"4.5.5","depth":2,"path":"nats_server/logging.md","ref":"nats_server/logging.md","articles":[]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","include-html","toggle-chapters","anchors"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{"lang":{"ascii":"markup","text":"markup"}},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"include-html":{},"fontsettings":{"theme":"white","family":"sans","size":2},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{},"toggle-chapters":{}},"theme":"default","author":"The NATS Maintainers","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"NATS","gitbook":"*","description":"Administrative, developer and conceptual documentation for the NATS messaging system."},"file":{"path":"nats_server/monitoring.md","mtime":"2019-05-29T16:43:54.848Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-05-29T16:45:48.381Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Monitoring","level":"4.5.6","depth":2,"next":{"title":"Managing A NATS Server","level":"4.6","depth":1,"path":"nats_admin/README.md","ref":"nats_admin/README.md","articles":[{"title":"Upgrading a Cluster","level":"4.6.1","depth":2,"path":"nats_admin/upgrading_cluster.md","ref":"nats_admin/upgrading_cluster.md","articles":[]},{"title":"Slow Consumers","level":"4.6.2","depth":2,"path":"nats_admin/slow_consumers.md","ref":"nats_admin/slow_consumers.md","articles":[]},{"title":"Signals","level":"4.6.3","depth":2,"path":"nats_admin/signals.md","ref":"nats_admin/signals.md","articles":[]},{"title":"System Accounts","level":"4.6.4","depth":2,"path":"sys_accounts/README.md","ref":"sys_accounts/README.md","articles":[{"title":"Configuration","level":"4.6.4.1","depth":3,"path":"sys_accounts/sys_accounts.md","ref":"sys_accounts/sys_accounts.md","articles":[]}]}]},"previous":{"title":"Logging","level":"4.5.5","depth":2,"path":"nats_server/logging.md","ref":"nats_server/logging.md","articles":[]},"dir":"ltr"},"config":{"plugins":["prism","-highlight","include-html","toggle-chapters","anchors"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{"lang":{"ascii":"markup","text":"markup"}},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"include-html":{},"fontsettings":{"theme":"white","family":"sans","size":2},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{},"toggle-chapters":{}},"theme":"default","author":"The NATS Maintainers","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"NATS","gitbook":"*","description":"Administrative, developer and conceptual documentation for the NATS messaging system."},"file":{"path":"nats_server/monitoring.md","mtime":"2019-05-30T17:42:13.290Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-05-30T17:42:48.393Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>