This is an automated email from the ASF dual-hosted git repository.
bridgetb pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/drill-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new ebc4a2b update monitoring metrics doc
ebc4a2b is described below
commit ebc4a2bf424ba7a8f440f89dcb2a92ca250add33
Author: Bridget Bevens <[email protected]>
AuthorDate: Fri Nov 9 20:22:20 2018 -0800
update monitoring metrics doc
---
docs/monitoring-metrics/index.html | 155 ++++++++++++++++++++++++++++++++-----
feed.xml | 4 +-
2 files changed, 137 insertions(+), 22 deletions(-)
diff --git a/docs/monitoring-metrics/index.html
b/docs/monitoring-metrics/index.html
index a39a03c..6bc1940 100644
--- a/docs/monitoring-metrics/index.html
+++ b/docs/monitoring-metrics/index.html
@@ -1272,13 +1272,30 @@
</div>
- Jul 14, 2016
+ Nov 10, 2018
<link href="/css/docpage.css" rel="stylesheet" type="text/css">
<div class="int_text" align="left">
- <p>As of Drill 1.7, Drill uses JMX (<a
href="https://docs.oracle.com/javase/tutorial/jmx/";>Java Management
Extensions</a>) to monitor queries at runtime. JMX provides the architecture to
dynamically manage and monitor applications. JMX collects Drill system-level
metrics that you can access through the Metrics tab in the Drill Web Console or
a remote JMX monitoring tool, such as JConsole or the VisualVM + MBeans plugin.
The Web Console Metrics tab contains the collected metrics a [...]
+ <p>The Metrics page in the Drill Web UI
(http(s)://<drillbit-ip-address>:8047/metrics) lists JVM and operating system
metrics. You can use these metrics to debug the state of the cluster. The
Drill-specific metrics are prepended with <code>drill</code>, for example
<code>drill.fragments.running</code>. The other metrics relate specifically to
the JVM.</p>
+
+<p>Drill uses JMX (<a href="https://docs.oracle.com/javase/tutorial/jmx/";>Java
Management Extensions</a>) to monitor queries at runtime. JMX provides the
architecture to dynamically manage and monitor applications. JMX collects Drill
system-level metrics that you can see in the Metrics tab in the Drill Web UI or
a remote JMX monitoring tool, such as JConsole or the VisualVM + MBeans plugin.
</p>
+
+<p>Metrics collected by JMX are divided into the following categories on the
Metrics page in the Drill Web UI: </p>
+
+<ul>
+<li><strong>Gauges</strong><br>
+A gauge is an instantaneous measure of a value. See <a
href="/docs/monitoring-metrics/#gauges">Gauges</a>.<br></li>
+<li><strong>Counters</strong><br>
+A counter is a snapshot of the count of metrics at a particular point in time.
(A gauge for an <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicLong.html";>AtomicLong</a>
instance.) See <a
href="/docs/monitoring-metrics/#counters">Counters</a>.<br></li>
+<li><strong>Histograms</strong><br>
+A histogram measures the statistical distribution of values in a stream of
data.<br></li>
+<li><strong>Meters</strong><br>
+A meter measures the rate of events over time, for example requests per
second.<br></li>
+<li><strong>Timers</strong><br>
+A timer measures the rate that a particular piece of code is called and the
distribution of its duration.<br></li>
+</ul>
<h2 id="remote-monitoring">Remote Monitoring</h2>
@@ -1292,9 +1309,11 @@
<p>JMX metric collection is enabled, by default. You can disable the metrics
option if needed. </p>
<p>In <code>$DRILL_HOME/conf/drill-env.sh</code>, set the
<code>drill.metrics.jmx.enabled</code> option to false through the
<code>DRILLBIT_JAVA_OPTS</code> variable. Add the variable in
<code>drill-env.sh</code> if it does not exist:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">
export DRILLBIT_JAVA_OPTS="$DRILLBIT_JAVA_OPTS
-Ddrill.metrics.jmx.enabled=false"
+<div class="highlight"><pre><code class="language-text" data-lang="text">
export DRILLBIT_JAVA_OPTS="$DRILLBIT_JAVA_OPTS
-Ddrill.metrics.jmx.enabled=false"
</code></pre></div>
-<p>The following table lists the predefined Drill system-level metrics that
you can view through a JMX monitoring tool or the Drill Web Console: </p>
+<h2 id="gauges">Gauges</h2>
+
+<p>The following table lists the Drill-specific metrics in the Gauges section
of the Metrics page: </p>
<table><thead>
<tr>
@@ -1303,36 +1322,80 @@
</tr>
</thead><tbody>
<tr>
-<td>drill.queries.running</td>
-<td>The number of queries running for which this drillbit is the
Foreman.</td>
-</tr>
-<tr>
-<td>drill.queries.completed</td>
-<td>The number of queries completed, canceled, or failed for which this
drillbit was the Foreman.</td>
+<td>blocked.count</td>
+<td>The number of threads that are blocked because they are waiting on a
monitor lock. This metric is useful for debugging Drill issues.</td>
</tr>
<tr>
<td>drill.fragments.running</td>
-<td>The number of query fragments currently running in the drillbit.</td>
+<td>The number of query fragments currently running in the Drillbit.</td>
</tr>
<tr>
<td>drill.allocator.root.used</td>
-<td>The amount of memory (in bytes) used by the internal memory
allocator.</td>
+<td>The amount of memory (in bytes) used by the internal memory allocator.</td>
</tr>
<tr>
<td>drill.allocator.root.peak</td>
-<td>The peak amount of memory (in bytes) used by the internal memory
allocator.</td>
+<td>The peak amount of memory (in bytes) used by the internal memory
allocator.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.control.peak</td>
+<td>The maximum amount of bytes used across all outgoing and incoming
control connections for this Drillbit at this moment.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.control.used</td>
+<td>The total number of bytes currently used across all outgoing and
incoming control connections for this Drillbit.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.data.peak</td>
+<td>The maximum amount of memory used between all outgoing and incoming data
connections for this Drillbit up to this moment.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.data.used</td>
+<td>The total amount of memory used between all outgoing and incoming data
connections tor this Drillbit.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.user.peak</td>
+<td>The maximum amount of memory used across all incoming Drill client
connections to this Drillbit up to this moment.</td>
+</tr>
+<tr>
+<td>drill.allocator.rpc.bit.user.used</td>
+<td>The total amount of memory used across all incoming Drill client
connections to this Drillbit.</td>
+</tr>
+<tr>
+<td>drill.allocator.huge.size</td>
+<td>Total size in bytes of huge (greater than 16MB) direct buffers allocated
until now</td>
+</tr>
+<tr>
+<td>drill.allocator.huge.count</td>
+<td>Number of allocations done for direct buffer of size greater than 16MB.
Each of these allocation happens from OS which comes with an overhead rather
from Netty's buffer pool.</td>
+</tr>
+<tr>
+<td>drill.allocator.normal.count</td>
+<td>Number of allocations done for direct buffer of size less than equal to
16MB. Each of these allocation happens from Netty's buffer pool. This
counter is only updated in debug environment when asserts are enabled to
avoid overhead for each allocation during normal execution.</td>
+</tr>
+<tr>
+<td>drill.allocator.normal.size</td>
+<td>Total size in bytes of normal (less than and equal to 16MB) direct
buffers allocated until now. This counter is only updated in debug
environment when asserts are enabled to avoid overhead for each allocation
during normal execution.</td>
+</tr>
+<tr>
+<td>drill.allocator.normal.size</td>
+<td>Total size in bytes of normal (less than and equal to 16MB) direct
buffers allocated until now. This counter is only updated in debug
environment when asserts are enabled to avoid overhead for each allocation
during normal execution.</td>
</tr>
<tr>
<td>heap.used</td>
<td>The amount of heap memory (in bytes) used by the JVM.</td>
</tr>
<tr>
-<td>non-heap.used</td>
-<td>The amount of non-heap memory (in bytes) used by the JVM.</td>
+<td></td>
+<td>count</td>
</tr>
<tr>
-<td>count</td>
-<td>The number of live threads, including daemon and non-daemon threads.</td>
+<td></td>
+<td></td>
+</tr>
+<tr>
+<td>non-heap.used</td>
+<td>The amount of non-heap memory (in bytes) used by the JVM.</td>
</tr>
<tr>
<td>fd.usage</td>
@@ -1348,14 +1411,66 @@
</tr>
<tr>
<td>waiting.count</td>
-<td>The number of threads waiting to execute. Typically, threads waiting on
other threads to perform an action. This metric is useful for debugging Drill
issues.</td>
+<td>The number of threads waiting to execute. Typically, threads waiting on
other threads to perform an action. This metric is useful for debugging Drill
issues.</td>
</tr>
<tr>
-<td>blocked.count</td>
-<td>The number of threads that are blocked because they are waiting on a
monitor lock. This metric is useful for debugging Drill issues.</td>
+<td>load.avg</td>
+<td>Returns the "recent cpu usage" for the Drillbit process. This
value is a double in the [0.0,1.0] interval. A value of 0.0 means that none
of the CPUs were running threads from the Drillbit process during the recent
period of time observed, while a value of 1.0 means that all CPUs were
actively running threads from the Drillbit process 100% of the time during
the recent period being observed. Threads from the Drillbit process includes
the application threads as w [...]
+</tr>
+<tr>
+<td>uptime</td>
+<td>Total uptime of Drillbit JVM in miliseconds. See <a
href="https://docs.oracle.com/javase/7/docs/api/java/lang/management/RuntimeMXBean.html#getUptime()">getUptime()</a>.</td>
</tr>
</tbody></table>
+<h2 id="counters">Counters</h2>
+
+<p>The following table lists the Drill-specific metrics in the Counters
section of the Metrics page: </p>
+
+<table><thead>
+<tr>
+<th>Metric</th>
+<th>Description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>drill.queries.running</td>
+<td>The number of queries running for which this drillbit is the Foreman.</td>
+</tr>
+<tr>
+<td>drill.queries.completed</td>
+<td>The number of queries completed, canceled, or failed for which this
drillbit was the Foreman.</td>
+</tr>
+</tbody></table>
+
+<h2 id="histograms">Histograms</h2>
+
+<p>The following table lists the Drill-specific metrics in the Histograms
section of the Metrics page: </p>
+
+<table><thead>
+<tr>
+<th>Metric</th>
+<th>Description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>drill.allocator.huge.hist</td>
+<td>Displays the distribution of allocation of huge buffers up to the current
time. Like count, it specifies number of huge buffer allocations completed so
far. Max/Min specifies maximum/minimum size in bytes of the huge buffer
allocated. Mean and other percentiles show the distribution of the huge
buffer allocation size in bytes.</td>
+</tr>
+<tr>
+<td>drill.allocator.normal.hist</td>
+<td>Displays the distribution of allocation of the normal size buffers up to
the current time. Like count, it specifies the number of normal buffer
allocations completed so far. Max/Min specifies maximum/minimum size in bytes
of the normal buffer allocated. Mean and other percentiles show the
distribution of normal buffer allocation size in bytes.</td>
+</tr>
+</tbody></table>
+
+<h2 id="meters">Meters</h2>
+
+<p>No Drill-specific meters.</p>
+
+<h2 id="timers">Timers</h2>
+
+<p>No Drill-specific timers.</p>
+
<div class="doc-nav">
diff --git a/feed.xml b/feed.xml
index 6edd74b..5807992 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
</description>
<link>/</link>
<atom:link href="/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Wed, 07 Nov 2018 18:35:32 -0800</pubDate>
- <lastBuildDate>Wed, 07 Nov 2018 18:35:32 -0800</lastBuildDate>
+ <pubDate>Fri, 09 Nov 2018 20:20:43 -0800</pubDate>
+ <lastBuildDate>Fri, 09 Nov 2018 20:20:43 -0800</lastBuildDate>
<generator>Jekyll v2.5.2</generator>
<item>
