You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by sa...@apache.org on 2016/03/10 22:43:15 UTC
svn commit: r1734459 - in /phoenix/site: publish/ publish/language/
source/src/site/markdown/
Author: samarth
Date: Thu Mar 10 21:43:14 2016
New Revision: 1734459
URL: http://svn.apache.org/viewvc?rev=1734459&view=rev
Log:
Minor formatting changes to the metrics documentation page
Modified:
phoenix/site/publish/Phoenix-in-15-minutes-or-less.html
phoenix/site/publish/building_website.html
phoenix/site/publish/download.html
phoenix/site/publish/dynamic_columns.html
phoenix/site/publish/faq.html
phoenix/site/publish/flume.html
phoenix/site/publish/installation.html
phoenix/site/publish/joins.html
phoenix/site/publish/language/datatypes.html
phoenix/site/publish/language/functions.html
phoenix/site/publish/language/index.html
phoenix/site/publish/mailing_list.html
phoenix/site/publish/metrics.html
phoenix/site/publish/paged.html
phoenix/site/publish/phoenix_mr.html
phoenix/site/publish/phoenix_on_emr.html
phoenix/site/publish/pig_integration.html
phoenix/site/publish/release.html
phoenix/site/publish/resources.html
phoenix/site/publish/roadmap.html
phoenix/site/publish/salted.html
phoenix/site/publish/source.html
phoenix/site/publish/udf.html
phoenix/site/publish/update_statistics.html
phoenix/site/publish/upgrading.html
phoenix/site/source/src/site/markdown/metrics.md
Modified: phoenix/site/publish/Phoenix-in-15-minutes-or-less.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/Phoenix-in-15-minutes-or-less.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/Phoenix-in-15-minutes-or-less.html (original)
+++ phoenix/site/publish/Phoenix-in-15-minutes-or-less.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/building_website.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/building_website.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/building_website.html (original)
+++ phoenix/site/publish/building_website.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/download.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/download.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/download.html (original)
+++ phoenix/site/publish/download.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/dynamic_columns.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/dynamic_columns.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/dynamic_columns.html (original)
+++ phoenix/site/publish/dynamic_columns.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/faq.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/faq.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/faq.html (original)
+++ phoenix/site/publish/faq.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/flume.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/flume.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/flume.html (original)
+++ phoenix/site/publish/flume.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/installation.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/installation.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/installation.html (original)
+++ phoenix/site/publish/installation.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/joins.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/joins.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/joins.html (original)
+++ phoenix/site/publish/joins.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/language/datatypes.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/language/functions.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/functions.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/language/index.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/mailing_list.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/mailing_list.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/mailing_list.html (original)
+++ phoenix/site/publish/mailing_list.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/metrics.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/metrics.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/metrics.html (original)
+++ phoenix/site/publish/metrics.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -146,8 +146,8 @@
</div>
<p>Phoenix surfaces various metrics that provide an insight into what is going on within the Phoenix client as it is executing various SQL statements. These metrics are collected within the client JVM in two ways:</p>
<ul>
- <li>Request level metrics - collected at an individual SQL statement level</li>
- <li>Global metrics - collected at the client JVM level</li>
+ <li><b>Request level metrics</b> - collected at an individual SQL statement level</li>
+ <li><b>Global metrics</b> - collected at the client JVM level</li>
</ul>
<p>Request level metrics are helpful for figuring out at a more granular level about the amount of work done by every SQL statement executed by Phoenix. These metrics can be classified into three categories:</p>
<div class="section">
@@ -185,19 +185,28 @@
<li>WALL_CLOCK_TIME_MS - Wall clock time elapsed for the overall query execution</li>
<li>RESULT_SET_TIME_MS - Wall clock time elapsed for reading all records using resultSet.next()</li>
</ul>
- <p>Below are a few examples of how SQL statement level metrics could be used: - Log and report query execution details which could be later used for analysis. - Report top SQL queries by duration. Metric to use: WALL_CLOCK_TIME_MS - Check if the query is failing because it is timing out. Metric to use: QUERY_TIMEOUT_COUNTER > 0. - Monitor the amount of bytes being written to or read from HBase for a SQL statement. Metrics to use: MUTATION_BYTES and SCAN_BYTES - Check if the query is doing too much work or needs to be tuned. Possible metrics to use: TASK_EXECUTED_COUNTER, TASK_QUEUE_WAIT_TIME, WALL_CLOCK_TIME_MS - Check if a successful query is facing thread starvation i.e. number of threads in the thread pool possibly needs to be increased. This is symptomized by a relatively large difference between TASK_EXECUTION_TIME and TASK_END_TO_END_TIME.</p>
- <p>Request level metrics can be turned on/off for every Phoenix JDBC connection. Below is an example of how you can do that:</p>
- <div class="source">
- <pre> Properties props = new Properties();
+ <div class="section">
+ <h5 id="Below_are_a_few_examples_of_how_SQL_statement_level_metrics_could_be_used:">Below are a few examples of how SQL statement level metrics could be used:</h5>
+ <ul>
+ <li>Log and report query execution details which could be later used for analysis.</li>
+ <li>Report top SQL queries by duration. Metric to use: WALL_CLOCK_TIME_MS</li>
+ <li>Check if the query is failing because it is timing out. Metric to use: QUERY_TIMEOUT_COUNTER > 0.</li>
+ <li>Monitor the amount of bytes being written to or read from HBase for a SQL statement. Metrics to use: MUTATION_BYTES and SCAN_BYTES</li>
+ <li>Check if the query is doing too much work or needs to be tuned. Possible metrics to use: TASK_EXECUTED_COUNTER, TASK_QUEUE_WAIT_TIME, WALL_CLOCK_TIME_MS</li>
+ <li>Check if a successful query is facing thread starvation i.e. number of threads in the thread pool possibly needs to be increased. This is symptomized by a relatively large difference between TASK_EXECUTION_TIME and TASK_END_TO_END_TIME.</li>
+ </ul>
+ <p>Request level metrics can be turned on/off for every Phoenix JDBC connection. Below is an example of how you can do that:</p>
+ <div class="source">
+ <pre> Properties props = new Properties();
props.setProperty(QueryServices.COLLECT_REQUEST_LEVEL_METRICS, âtrueâ);
try (Connection conn = DriverManager.getConnection(getUrl(), props)) {
.....
}
</pre>
- </div>
- <p>A typical pattern for how one could get hold of read metrics for queries:</p>
- <div class="source">
- <pre>Map<String, Map<String, Long>> overAllQueryMetrics = null;
+ </div>
+ <p>A typical pattern for how one could get hold of read metrics for queries:</p>
+ <div class="source">
+ <pre>Map<String, Map<String, Long>> overAllQueryMetrics = null;
Map<String, Map<String, Long>> requestReadMetrics = null;
try (ResultSet rs = stmt.executeQuery()) {
while(rs.next()) {
@@ -209,10 +218,10 @@
PhoenixRuntime.resetMetrics(rs);
}
</pre>
- </div>
- <p>One could also get hold of write related metrics (collected per table) for DML statements by doing something like this:</p>
- <div class="source">
- <pre>Map<String, Map<String, Long>> mutationWriteMetrics = null;
+ </div>
+ <p>One could also get hold of write related metrics (collected per table) for DML statements by doing something like this:</p>
+ <div class="source">
+ <pre>Map<String, Map<String, Long>> mutationWriteMetrics = null;
Map<String, Map<String, Long>> mutationReadMetrics = null;
try (Connection conn = DriverManager.getConnection(url)) {
conn.createStatement.executeUpdate(dml1);
@@ -227,14 +236,17 @@
PhoenixRuntime.resetMetrics(rs);
}
</pre>
- </div>
- <p>Global Metrics on the other hand are collected at the Phoenix clientâs JVM level. These metrics could be used for building out a trend and seeing what is going on within Phoenix from clientâs perspective over time. Other than the metrics reported above for request level metrics, the global metrics also includes the following counters: </p>
- <ul>
- - MUTATION_SQL_COUNTER - Counter for number of mutation sql statements - SELECT_SQL_COUNTER - Counter for number of sql queries - OPEN_PHOENIX_CONNECTIONS_COUNTER - Number of open phoenix connections
- </ul>
- <p>Collection of global client metrics can be turned on/off (on by default) by setting the attribute phoenix.query.global.metrics.enabled to true/false in the client side hbase-site.xml. Below is a code snippet of how one can Phoenixâs global metrics by using a scheduled job that runs periodically:</p>
- <div class="source">
- <pre> ScheduledExecutorService service = Executors.newScheduledThreadPool(1);
+ </div>
+ <p>Global metrics on the other hand are collected at the Phoenix clientâs JVM level. These metrics could be used for building out a trend and seeing what is going on within Phoenix from clientâs perspective over time. Other than the metrics reported above for request level metrics, the global metrics also includes the following counters:</p>
+ <ul>
+ <li>MUTATION_SQL_COUNTER - Counter for number of mutation sql statements</li>
+ <li>SELECT_SQL_COUNTER - Counter for number of sql queries</li>
+ <li>OPEN_PHOENIX_CONNECTIONS_COUNTER - Number of open phoenix connections</li>
+ </ul>
+ <p>Global metrics could be helpful in monitoring and tuning various aspects of the execution environment. For example: an increase in the metric TASK_REJECTED_COUNTER is probably a symptom of too much work being submitted or the fact that the phoenix thread pool queue depth or number of threads or both need to be increased. Similarly, a spike in TASK_EXECUTION_TIME for a time frame could be symptomatic of several things including overloaded region servers, a network glitch, client or region servers undergoing garbage collection, etc.</p>
+ <p>Collection of global client metrics can be turned on/off (on by default) by setting the attribute phoenix.query.global.metrics.enabled to true/false in the client side hbase-site.xml. Below is a code snippet of how one can log/report global metrics by using a scheduled job that runs periodically:</p>
+ <div class="source">
+ <pre> ScheduledExecutorService service = Executors.newScheduledThreadPool(1);
service.submit(new Runnable() {
@Override
@@ -247,8 +259,8 @@
}
});
</pre>
+ </div>
</div>
- <p>Global metrics could be helpful in monitoring and tuning various aspects of the execution environment. For example: an increase in the metric TASK_REJECTED_COUNTER is probably a symptom of too much work being submitted or the fact that the phoenix thread pool queue depth or number of threads or both need to be increased. Similarly, a spike in TASK_EXECUTION_TIME for a time frame could be symptomatic of several things including overloaded region servers, a network glitch, client or region servers undergoing garbage collection, etc. </p>
</div>
</div>
</div>
Modified: phoenix/site/publish/paged.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/paged.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/paged.html (original)
+++ phoenix/site/publish/paged.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/phoenix_mr.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/phoenix_mr.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/phoenix_mr.html (original)
+++ phoenix/site/publish/phoenix_mr.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/phoenix_on_emr.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/phoenix_on_emr.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/phoenix_on_emr.html (original)
+++ phoenix/site/publish/phoenix_on_emr.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/pig_integration.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/pig_integration.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/pig_integration.html (original)
+++ phoenix/site/publish/pig_integration.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/release.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/release.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/release.html (original)
+++ phoenix/site/publish/release.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/resources.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/resources.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/resources.html (original)
+++ phoenix/site/publish/resources.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/roadmap.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/roadmap.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/roadmap.html (original)
+++ phoenix/site/publish/roadmap.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/salted.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/salted.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/salted.html (original)
+++ phoenix/site/publish/salted.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/source.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/source.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/source.html (original)
+++ phoenix/site/publish/source.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/udf.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/udf.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/udf.html (original)
+++ phoenix/site/publish/udf.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/update_statistics.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/update_statistics.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/update_statistics.html (original)
+++ phoenix/site/publish/update_statistics.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/upgrading.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/upgrading.html?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/publish/upgrading.html (original)
+++ phoenix/site/publish/upgrading.html Thu Mar 10 21:43:14 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-09
+ Generated by Apache Maven Doxia at 2016-03-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/source/src/site/markdown/metrics.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/metrics.md?rev=1734459&r1=1734458&r2=1734459&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/metrics.md (original)
+++ phoenix/site/source/src/site/markdown/metrics.md Thu Mar 10 21:43:14 2016
@@ -2,8 +2,8 @@
Phoenix surfaces various metrics that provide an insight into what is going on within the Phoenix client as it is executing various SQL statements. These metrics are collected within the client JVM in two ways:
-- Request level metrics - collected at an individual SQL statement level
-- Global metrics - collected at the client JVM level
+- **Request level metrics** - collected at an individual SQL statement level
+- **Global metrics** - collected at the client JVM level
Request level metrics are helpful for figuring out at a more granular level about the amount of work done by every SQL statement executed by Phoenix. These metrics can be classified into three categories:
@@ -12,6 +12,7 @@ Request level metrics are helpful for fi
- MUTATION_BYTES - Size of mutations in bytes
- MUTATION_COMMIT_TIME - Time it took to commit mutations
+
#### Scan Task Metrics
- NUM_PARALLEL_SCANS - Number of scans executed in parallel
- SCAN_BYTES - Number of bytes read by scans
@@ -26,13 +27,17 @@ Request level metrics are helpful for fi
- TASK_EXECUTED_COUNTER - Counter for number of tasks submitted to the thread pool executor
- TASK_REJECTED_COUNTER - Counter for number of tasks that were rejected by the thread pool executor
+
#### Overall Query Metrics
- QUERY_TIMEOUT_COUNTER - Number of times query timed out
- QUERY_FAILED_COUNTER - Number of times query failed
- WALL_CLOCK_TIME_MS - Wall clock time elapsed for the overall query execution
- RESULT_SET_TIME_MS - Wall clock time elapsed for reading all records using resultSet.next()
-Below are a few examples of how SQL statement level metrics could be used:
+
+
+
+##### Below are a few examples of how SQL statement level metrics could be used:
- Log and report query execution details which could be later used for analysis.
- Report top SQL queries by duration. Metric to use: WALL_CLOCK_TIME_MS
- Check if the query is failing because it is timing out. Metric to use: QUERY_TIMEOUT_COUNTER > 0.
@@ -40,6 +45,7 @@ Below are a few examples of how SQL stat
- Check if the query is doing too much work or needs to be tuned. Possible metrics to use: TASK_EXECUTED_COUNTER, TASK_QUEUE_WAIT_TIME, WALL_CLOCK_TIME_MS
- Check if a successful query is facing thread starvation i.e. number of threads in the thread pool possibly needs to be increased. This is symptomized by a relatively large difference between TASK_EXECUTION_TIME and TASK_END_TO_END_TIME.
+
Request level metrics can be turned on/off for every Phoenix JDBC connection. Below is an example of how you can do that:
Properties props = new Properties();
@@ -80,15 +86,19 @@ One could also get hold of write related
PhoenixRuntime.resetMetrics(rs);
}
-Global Metrics on the other hand are collected at the Phoenix clientâs JVM level. These metrics could be used for building out a trend and seeing what is going on within Phoenix from clientâs perspective over time. Other than the metrics reported above for request level metrics, the global metrics also includes the following counters:
-<ul>
-- MUTATION_SQL_COUNTER - Counter for number of mutation sql statements
-- SELECT_SQL_COUNTER - Counter for number of sql queries
-- OPEN_PHOENIX_CONNECTIONS_COUNTER - Number of open phoenix connections
-</ul>
+
+
+Global metrics on the other hand are collected at the Phoenix clientâs JVM level. These metrics could be used for building out a trend and seeing what is going on within Phoenix from clientâs perspective over time. Other than the metrics reported above for request level metrics, the global metrics also includes the following counters:
+
+- MUTATION_SQL_COUNTER - Counter for number of mutation sql statements
+- SELECT_SQL_COUNTER - Counter for number of sql queries
+- OPEN_PHOENIX_CONNECTIONS_COUNTER - Number of open phoenix connections
+
+
+Global metrics could be helpful in monitoring and tuning various aspects of the execution environment. For example: an increase in the metric TASK_REJECTED_COUNTER is probably a symptom of too much work being submitted or the fact that the phoenix thread pool queue depth or number of threads or both need to be increased. Similarly, a spike in TASK_EXECUTION_TIME for a time frame could be symptomatic of several things including overloaded region servers, a network glitch, client or region servers undergoing garbage collection, etc.
Collection of global client metrics can be turned on/off (on by default) by setting the attribute phoenix.query.global.metrics.enabled to true/false in the client side hbase-site.xml.
-Below is a code snippet of how one can Phoenixâs global metrics by using a scheduled job that runs periodically:
+Below is a code snippet of how one can log/report global metrics by using a scheduled job that runs periodically:
ScheduledExecutorService service = Executors.newScheduledThreadPool(1);
@@ -102,6 +112,4 @@ Below is a code snippet of how one can
}
}
- });
-
-Global metrics could be helpful in monitoring and tuning various aspects of the execution environment. For example: an increase in the metric TASK_REJECTED_COUNTER is probably a symptom of too much work being submitted or the fact that the phoenix thread pool queue depth or number of threads or both need to be increased. Similarly, a spike in TASK_EXECUTION_TIME for a time frame could be symptomatic of several things including overloaded region servers, a network glitch, client or region servers undergoing garbage collection, etc.
\ No newline at end of file
+ });
\ No newline at end of file