You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by el...@apache.org on 2018/09/11 02:10:31 UTC
svn commit: r1840509 - in /phoenix/site: publish/language/datatypes.html
publish/language/functions.html publish/language/index.html
publish/server.html source/src/site/markdown/server.md
Author: elserj
Date: Tue Sep 11 02:10:30 2018
New Revision: 1840509
URL: http://svn.apache.org/viewvc?rev=1840509&view=rev
Log:
PHOENIX-4858 Update PQS docs for phoenix-client JXM metrics (Karan Mehta)
Modified:
phoenix/site/publish/language/datatypes.html
phoenix/site/publish/language/functions.html
phoenix/site/publish/language/index.html
phoenix/site/publish/server.html
phoenix/site/source/src/site/markdown/server.md
Modified: phoenix/site/publish/language/datatypes.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1840509&r1=1840508&r2=1840509&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Tue Sep 11 02:10:30 2018
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2018-08-28
+ Generated by Apache Maven Doxia at 2018-09-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=1840509&r1=1840508&r2=1840509&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Tue Sep 11 02:10:30 2018
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2018-08-28
+ Generated by Apache Maven Doxia at 2018-09-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=1840509&r1=1840508&r2=1840509&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Tue Sep 11 02:10:30 2018
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2018-08-28
+ Generated by Apache Maven Doxia at 2018-09-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/server.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/server.html?rev=1840509&r1=1840508&r2=1840509&view=diff
==============================================================================
--- phoenix/site/publish/server.html (original)
+++ phoenix/site/publish/server.html Tue Sep 11 02:10:30 2018
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2018-06-10
+ Generated by Apache Maven Doxia at 2018-09-10
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -234,6 +234,11 @@
<p>As a word of warning: there is no end-to-end test coverage for the HBase 0.98 and 1.1 Phoenix releases because of missing test-related code in those HBase releases. While we expect no issues on these Phoenix release lines, we recommend additional testing by the user to verify that there are no issues.</p>
</div>
<div class="section">
+ <h2 id="Metrics">Metrics</h2>
+ <p>By default, the Phoenix Query Server exposes various Phoenix global client metrics via JMX (for HBase versions 1.3 and up). The list of metrics are available <a class="externalLink" href="https://phoenix.apache.org/metrics.html">here</a>.</p>
+ <p>PQS Metrics use <a class="externalLink" href="https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Metrics.html">Hadoop Metrics 2</a> internally for metrics publishing. Hence it publishes various JVM related metrics. Metrics can be filtered based on certain tags, which can be configured by the property specified in hbase-site.xml on the classpath. Further details are provided in Configuration section.</p>
+</div>
+<div class="section">
<h2 id="Configuration">Configuration</h2>
<p>Server components are spread across a number of java packages, so effective logging configuration requires updating multiple packages. The default server logging configuration sets the following log levels:</p>
<div class="source">
@@ -438,6 +443,22 @@ log4j.logger.org.eclipse.jetty.server=IN
<td style="text-align: left;"> The name of the HTTP request parameter to use to extract the user name to execute the query as. </td>
<td>doAs</td>
</tr>
+ <tr class="b">
+ <td colspan="3"> </td>
+ </tr>
+ <tr class="a">
+ <td colspan="3"><b>Configurations relating to metrics.</b></td>
+ </tr>
+ <tr class="b">
+ <td><b>Property</b></td>
+ <td><b>Description</b></td>
+ <td><b>Default</b></td>
+ </tr>
+ <tr class="a">
+ <td><small>phoenix.client.metrics.tag</small></td>
+ <td style="text-align: left;"> Tag for filtering categories of Phoenix global client metrics emitted by PQS in hadoop-metrics2.properties </td>
+ <td>FAT_CLIENT</td>
+ </tr>
</tbody>
</table>
</div>
Modified: phoenix/site/source/src/site/markdown/server.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/server.md?rev=1840509&r1=1840508&r2=1840509&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/server.md (original)
+++ phoenix/site/source/src/site/markdown/server.md Tue Sep 11 02:10:30 2018
@@ -118,6 +118,14 @@ As a word of warning: there is no end-to
because of missing test-related code in those HBase releases. While we expect no issues on these
Phoenix release lines, we recommend additional testing by the user to verify that there are no issues.
+## Metrics
+
+By default, the Phoenix Query Server exposes various Phoenix global client metrics via JMX (for HBase versions 1.3 and up).
+The list of metrics are available [here](https://phoenix.apache.org/metrics.html).
+
+PQS Metrics use [Hadoop Metrics 2](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Metrics.html) internally for metrics publishing. Hence it publishes various JVM related metrics. Metrics can be filtered based on certain tags, which can be configured by the property specified in hbase-site.xml on the classpath. Further details are provided in Configuration section.
+
+
## Configuration
Server components are spread across a number of java packages, so effective
@@ -339,6 +347,18 @@ configuration.
</td>
<td>doAs</td>
</tr>
+ <tr><td colspan="3"> </td></tr>
+ <tr>
+ <td colspan="3"><b>Configurations relating to metrics.</b></td>
+ </tr>
+ <tr><td><b>Property</b></td><td><b>Description</b></td><td><b>Default</b></td></tr>
+ <tr>
+ <td><small>phoenix.client.metrics.tag</small></td>
+ <td style="text-align: left;">
+ Tag for filtering categories of Phoenix global client metrics emitted by PQS in hadoop-metrics2.properties
+ </td>
+ <td>FAT_CLIENT</td>
+ </tr>
</tbody>
</table>