| <div class="docbook"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.4. Prometheus Metrics</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><th width="60%" align="center">Chapter 6. Management Channels</th><td width="20%" align="right"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Management-Metrics" />6.4. Prometheus Metrics</h2></div></div></div><p>This section describes the metrics endpoints exposing broker statistics in | |
| <a class="link" href="https://prometheus.io/" target="_top">Prometheus format</a>. | |
| The metrics endpoint is intended for scraping by Prometheus server to collect the Broker telemetry.</p><p>The Prometheus metric endpoints are mapped under /metrics path and /metrics/*. | |
| The latter allows to get the Virtual Host statistics by specify the path to the virtual host as | |
| /metrics/<virtual host node name>/< virtual host name>. | |
| The former allow to get all Broker statistics or Virtual Host statistics when called with HOST header | |
| set to the Virtual Host name</p><p> | |
| The metrics endpoints allow anonymous access by default. If required, an authentication can be enabled for the | |
| metrics endpoints by setting http management context variable | |
| <code class="literal">qpid.httpManagement.enableMetricContentAuthentication</code> to <code class="literal">true</code>. | |
| </p><p>The Broker JVM statistics are disabled by default. The metrics endpoints can be called with parameter | |
| <code class="literal">includeDisabled</code> set to <code class="literal">true</code> to include JVM broker metrics into endpoint | |
| output. If required, the JVM metrics could be enabled by setting context variable | |
| <code class="literal">qpid.metrics.includeDisabled</code> to <code class="literal">true</code>. | |
| </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>For more information about Prometheus, check out the | |
| <a class="link" href="https://prometheus.io/docs/introduction/overview/" target="_top">prometheus documentation</a>. | |
| </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.3. REST API </td><td width="20%" align="center"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td width="40%" align="right" valign="top"> 6.5. AMQP Intrinstic Management</td></tr></table></div></div> |