Repository: accumulo Updated Branches: refs/heads/master 2821a4815 -> 8031dcda6
ACCUMULO-3387 Update user manual to describe metric reporting capabilities Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/8031dcda Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/8031dcda Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/8031dcda Branch: refs/heads/master Commit: 8031dcda6f4f450e849095d52ec9e94b4e36c37d Parents: 2821a48 Author: Josh Elser <[email protected]> Authored: Fri Dec 5 19:52:44 2014 -0500 Committer: Josh Elser <[email protected]> Committed: Fri Dec 5 19:52:44 2014 -0500 ---------------------------------------------------------------------- .../main/asciidoc/chapters/administration.txt | 31 +++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/8031dcda/docs/src/main/asciidoc/chapters/administration.txt ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/chapters/administration.txt b/docs/src/main/asciidoc/chapters/administration.txt index 0e00d02..bf0b0d1 100644 --- a/docs/src/main/asciidoc/chapters/administration.txt +++ b/docs/src/main/asciidoc/chapters/administration.txt @@ -313,7 +313,8 @@ recommended that you restart the monitor so that the node list is up to date. [[monitoring]] === Monitoring -The Accumulo Master provides an interface for monitoring the status and health of +==== Accumulo Monitor +The Accumulo Monitor provides an interface for monitoring the status and health of Accumulo components. The Accumulo Monitor provides a web UI for accessing this information at +http://_monitorhost_:50095/+. @@ -361,6 +362,34 @@ This also allows you to access the Accumulo shell through the monitor page. The left navigation bar will have a new link to Shell. An Accumulo user name and password must be entered for access to the shell. +=== Metrics +Accumulo is capable of using the Hadoop Metrics2 library and is configured by default to use it. Metrics2 is a library +which allows for routing of metrics generated by registered MetricsSources to configured MetricsSinks. Examples of sinks +that are implemented by Hadoop include file-based logging, Graphite and Ganglia. All metric sources are exposed via JMX +when using Metrics2. + +Previous to Accumulo 1.7.0, JMX endpoints could be exposed in addition to file-based logging of those metrics configured via +the +accumulo-metrics.xml+ file. This mechanism can still be used by setting +general.legacy.metrics+ to +true+ in +accumulo-site.xml+. + +==== Metrics2 Configuration + +Metrics2 is configured by examining the classpath for a file that matches +hadoop-metrics2*.properties+. The example configuration +files that Accumulo provides for use include +hadoop-metrics2-accumulo.properties+ as a template which can be used to enable +file, Graphite or Ganglia sinks (some minimal configuration required for Graphite and Ganglia). Because the Hadoop configuration is +also on the Accumulo classpath, be sure that you do not have multiple Metrics2 configuration files. It is recommended to consolidate +metrics in a single properties file in a central location to remove ambiguity. The contents of +hadoop-metrics2-accumulo.properties+ +can be added to a central +hadoop-metrics2.properties+ in +$HADOOP_CONF_DIR+. + +As a note for configuring the file sink, the provided path should be absolute. A relative path or file name will be created relative +to the directory in which the Accumulo process was started. External tools, such as logrotate, can be used to prevent these files +from growing without bound. + +Each server process should have log messages from the Metrics2 library about the sinks that were created. Be sure to check +the Accumulo processes log files when debugging missing metrics output. + +For additional information on configuring Metrics2, visit the +https://hadoop.apache.org/docs/current/api/org/apache/hadoop/metrics2/package-summary.html[Javadoc page for Metrics2]. + [[tracing]] === Tracing It can be difficult to determine why some operations are taking longer
