You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by dm...@apache.org on 2011/10/13 01:52:08 UTC
svn commit: r1182618 - in /hbase/trunk/src/docbkx: book.xml build.xml
developer.xml ops_mgt.xml
Author: dmeil
Date: Wed Oct 12 23:52:08 2011
New Revision: 1182618
URL: http://svn.apache.org/viewvc?rev=1182618&view=rev
Log:
HBASE-4584. some chapter reorganization (book.xml, developer.xml, ops_mgt.xml).
Removed:
hbase/trunk/src/docbkx/build.xml
Modified:
hbase/trunk/src/docbkx/book.xml
hbase/trunk/src/docbkx/developer.xml
hbase/trunk/src/docbkx/ops_mgt.xml
Modified: hbase/trunk/src/docbkx/book.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/book.xml?rev=1182618&r1=1182617&r2=1182618&view=diff
==============================================================================
--- hbase/trunk/src/docbkx/book.xml (original)
+++ hbase/trunk/src/docbkx/book.xml Wed Oct 12 23:52:08 2011
@@ -607,70 +607,7 @@ admin.enableTable(table);
</chapter>
- <chapter xml:id="hbase_metrics">
- <title>Metrics</title>
- <section xml:id="metric_setup">
- <title>Metric Setup</title>
- <para>See <link xlink:href="http://hbase.apache.org/metrics.html">Metrics</link> for
- an introduction and how to enable Metrics emission.
- </para>
- </section>
- <section xml:id="rs_metrics">
- <title>RegionServer Metrics</title>
- <section xml:id="hbase.regionserver.blockCacheCount"><title><varname>hbase.regionserver.blockCacheCount</varname></title>
- <para>Block cache item count in memory. This is the number of blocks of storefiles (HFiles) in the cache.</para>
- </section>
- <section xml:id="hbase.regionserver.blockCacheFree"><title><varname>hbase.regionserver.blockCacheFree</varname></title>
- <para>Block cache memory available (bytes).</para>
- </section>
- <section xml:id="hbase.regionserver.blockCacheHitRatio"><title><varname>hbase.regionserver.blockCacheHitRatio</varname></title>
- <para>Block cache hit ratio (0 to 100). TODO: describe impact to ratio where read requests that have cacheBlocks=false</para>
- </section>
- <section xml:id="hbase.regionserver.blockCacheSize"><title><varname>hbase.regionserver.blockCacheSize</varname></title>
- <para>Block cache size in memory (bytes). i.e., memory in use by the BlockCache</para>
- </section>
- <section xml:id="hbase.regionserver.compactionQueueSize"><title><varname>hbase.regionserver.compactionQueueSize</varname></title>
- <para>Size of the compaction queue. This is the number of stores in the region that have been targeted for compaction.</para>
- </section>
- <section xml:id="hbase.regionserver.fsReadLatency_avg_time"><title><varname>hbase.regionserver.fsReadLatency_avg_time</varname></title>
- <para>Filesystem read latency (ms). This is the average time to read from HDFS.</para>
- </section>
- <section xml:id="hbase.regionserver.fsReadLatency_num_ops"><title><varname>hbase.regionserver.fsReadLatency_num_ops</varname></title>
- <para>TODO</para>
- </section>
- <section xml:id="hbase.regionserver.fsSyncLatency_avg_time"><title><varname>hbase.regionserver.fsSyncLatency_avg_time</varname></title>
- <para>Filesystem sync latency (ms)</para>
- </section>
- <section xml:id="hbase.regionserver.fsSyncLatency_num_ops"><title><varname>hbase.regionserver.fsSyncLatency_num_ops</varname></title>
- <para>TODO</para>
- </section>
- <section xml:id="hbase.regionserver.fsWriteLatency_avg_time"><title><varname>hbase.regionserver.fsWriteLatency_avg_time</varname></title>
- <para>Filesystem write latency (ms)</para>
- </section>
- <section xml:id="hbase.regionserver.fsWriteLatency_num_ops"><title><varname>hbase.regionserver.fsWriteLatency_num_ops</varname></title>
- <para>TODO</para>
- </section>
- <section xml:id="hbase.regionserver.memstoreSizeMB"><title><varname>hbase.regionserver.memstoreSizeMB</varname></title>
- <para>Sum of all the memstore sizes in this RegionServer (MB)</para>
- </section>
- <section xml:id="hbase.regionserver.regions"><title><varname>hbase.regionserver.regions</varname></title>
- <para>Number of regions served by the RegionServer</para>
- </section>
- <section xml:id="hbase.regionserver.requests"><title><varname>hbase.regionserver.requests</varname></title>
- <para>Total number of read and write requests. Requests correspond to RegionServer RPC calls, thus a single Get will result in 1 request, but a Scan with caching set to 1000 will result in 1 request for each 'next' call (i.e., not each row). A bulk-load request will constitute 1 request per HFile.</para>
- </section>
- <section xml:id="hbase.regionserver.storeFileIndexSizeMB"><title><varname>hbase.regionserver.storeFileIndexSizeMB</varname></title>
- <para>Sum of all the storefile index sizes in this RegionServer (MB)</para>
- </section>
- <section xml:id="hbase.regionserver.stores"><title><varname>hbase.regionserver.stores</varname></title>
- <para>Number of stores open on the RegionServer. A store corresponds to a column family. For example, if a table (which contains the column family) has 3 regions on a RegionServer, there will be 3 stores open for that column family. </para>
- </section>
- <section xml:id="hbase.regionserver.storeFiles"><title><varname>hbase.regionserver.storeFiles</varname></title>
- <para>Number of store filles open on the RegionServer. A store may have more than one storefile (HFile).</para>
- </section>
- </section>
- </chapter>
-
+
<chapter xml:id="datamodel">
<title>Data Model</title>
<para>In short, applications store data into an HBase table.
@@ -1782,7 +1719,6 @@ scan.setFilter(filter);
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="performance.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="build.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="developer.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="external_apis.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ops_mgt.xml" />
Modified: hbase/trunk/src/docbkx/developer.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/developer.xml?rev=1182618&r1=1182617&r2=1182618&view=diff
==============================================================================
--- hbase/trunk/src/docbkx/developer.xml (original)
+++ hbase/trunk/src/docbkx/developer.xml Wed Oct 12 23:52:08 2011
@@ -7,8 +7,9 @@
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
- <title>Developing HBase</title>
- <para>This chapter will be of interest only to those developing HBase (i.e., as opposed to using it).
+ <title>Building and Developing HBase</title>
+ <para>This chapter will be of interest only to those building and developing HBase (i.e., as opposed to
+ just downloading the latest distribution).
</para>
<section xml:id="repos">
<title>HBase Repositories</title>
@@ -24,7 +25,8 @@ svn co http://svn.apache.org/repos/asf/h
git clone git://git.apache.org/hbase.git
</programlisting>
</section>
- </section>
+ </section>
+
<section xml:id="ides">
<title>IDEs</title>
<section xml:id="eclipse">
@@ -96,6 +98,51 @@ Access restriction: The method getLong(O
</section>
</section>
</section>
+
+ <section xml:id="build">
+ <title>Building HBase</title>
+ <para>This section will be of interest only to those building HBase from source.
+ </para>
+ <section xml:id="build.snappy">
+ <title>Building in snappy compression support</title>
+ <para>Pass <code>-Dsnappy</code> to trigger the snappy maven profile for building
+ snappy native libs into hbase.</para>
+ </section>
+
+ <section xml:id="mvn_repo">
+ <title>Adding an HBase release to Apache's Maven Repository</title>
+ <para>Follow the instructions at
+ <link xlink:href="http://www.apache.org/dev/publishing-maven-artifacts.html">Publishing Maven Artifacts</link>.
+ The 'trick' to making it all work is answering the questions put to you by the mvn release plugin properly,
+ making sure it is using the actual branch AND before doing the <command>mvn release:perform</command> step,
+ VERY IMPORTANT, hand edit the release.properties file that was put under <varname>${HBASE_HOME}</varname>
+ by the previous step, <command>release:perform</command>. You need to edit it to make it point at
+ right locations in SVN.
+ </para>
+ <para>If you see run into the below, its because you need to edit version in the pom.xml and add
+ <code>-SNAPSHOT</code> to the version (and commit).
+ <programlisting>[INFO] Scanning for projects...
+[INFO] Searching repository for plugin with prefix: 'release'.
+[INFO] ------------------------------------------------------------------------
+[INFO] Building HBase
+[INFO] task-segment: [release:prepare] (aggregator-style)
+[INFO] ------------------------------------------------------------------------
+[INFO] [release:prepare {execution: default-cli}]
+[INFO] ------------------------------------------------------------------------
+[ERROR] BUILD FAILURE
+[INFO] ------------------------------------------------------------------------
+[INFO] You don't have a SNAPSHOT project in the reactor projects list.
+[INFO] ------------------------------------------------------------------------
+[INFO] For more information, run Maven with the -e switch
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 3 seconds
+[INFO] Finished at: Sat Mar 26 18:11:07 PDT 2011
+[INFO] Final Memory: 35M/423M
+[INFO] -----------------------------------------------------------------------</programlisting>
+ </para>
+ </section>
+ </section> <!-- build -->
+
<section xml:id="maven.build.commands">
<title>Maven Build Commands</title>
<para>All commands executed from the local HBase project directory.
Modified: hbase/trunk/src/docbkx/ops_mgt.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/ops_mgt.xml?rev=1182618&r1=1182617&r2=1182618&view=diff
==============================================================================
--- hbase/trunk/src/docbkx/ops_mgt.xml (original)
+++ hbase/trunk/src/docbkx/ops_mgt.xml Wed Oct 12 23:52:08 2011
@@ -246,6 +246,70 @@ false
</section>
</section> <!-- node mgt -->
+ <section xml:id="hbase_metrics">
+ <title>Metrics</title>
+ <section xml:id="metric_setup">
+ <title>Metric Setup</title>
+ <para>See <link xlink:href="http://hbase.apache.org/metrics.html">Metrics</link> for
+ an introduction and how to enable Metrics emission.
+ </para>
+ </section>
+ <section xml:id="rs_metrics">
+ <title>RegionServer Metrics</title>
+ <section xml:id="hbase.regionserver.blockCacheCount"><title><varname>hbase.regionserver.blockCacheCount</varname></title>
+ <para>Block cache item count in memory. This is the number of blocks of storefiles (HFiles) in the cache.</para>
+ </section>
+ <section xml:id="hbase.regionserver.blockCacheFree"><title><varname>hbase.regionserver.blockCacheFree</varname></title>
+ <para>Block cache memory available (bytes).</para>
+ </section>
+ <section xml:id="hbase.regionserver.blockCacheHitRatio"><title><varname>hbase.regionserver.blockCacheHitRatio</varname></title>
+ <para>Block cache hit ratio (0 to 100). TODO: describe impact to ratio where read requests that have cacheBlocks=false</para>
+ </section>
+ <section xml:id="hbase.regionserver.blockCacheSize"><title><varname>hbase.regionserver.blockCacheSize</varname></title>
+ <para>Block cache size in memory (bytes). i.e., memory in use by the BlockCache</para>
+ </section>
+ <section xml:id="hbase.regionserver.compactionQueueSize"><title><varname>hbase.regionserver.compactionQueueSize</varname></title>
+ <para>Size of the compaction queue. This is the number of stores in the region that have been targeted for compaction.</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsReadLatency_avg_time"><title><varname>hbase.regionserver.fsReadLatency_avg_time</varname></title>
+ <para>Filesystem read latency (ms). This is the average time to read from HDFS.</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsReadLatency_num_ops"><title><varname>hbase.regionserver.fsReadLatency_num_ops</varname></title>
+ <para>TODO</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsSyncLatency_avg_time"><title><varname>hbase.regionserver.fsSyncLatency_avg_time</varname></title>
+ <para>Filesystem sync latency (ms)</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsSyncLatency_num_ops"><title><varname>hbase.regionserver.fsSyncLatency_num_ops</varname></title>
+ <para>TODO</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsWriteLatency_avg_time"><title><varname>hbase.regionserver.fsWriteLatency_avg_time</varname></title>
+ <para>Filesystem write latency (ms)</para>
+ </section>
+ <section xml:id="hbase.regionserver.fsWriteLatency_num_ops"><title><varname>hbase.regionserver.fsWriteLatency_num_ops</varname></title>
+ <para>TODO</para>
+ </section>
+ <section xml:id="hbase.regionserver.memstoreSizeMB"><title><varname>hbase.regionserver.memstoreSizeMB</varname></title>
+ <para>Sum of all the memstore sizes in this RegionServer (MB)</para>
+ </section>
+ <section xml:id="hbase.regionserver.regions"><title><varname>hbase.regionserver.regions</varname></title>
+ <para>Number of regions served by the RegionServer</para>
+ </section>
+ <section xml:id="hbase.regionserver.requests"><title><varname>hbase.regionserver.requests</varname></title>
+ <para>Total number of read and write requests. Requests correspond to RegionServer RPC calls, thus a single Get will result in 1 request, but a Scan with caching set to 1000 will result in 1 request for each 'next' call (i.e., not each row). A bulk-load request will constitute 1 request per HFile.</para>
+ </section>
+ <section xml:id="hbase.regionserver.storeFileIndexSizeMB"><title><varname>hbase.regionserver.storeFileIndexSizeMB</varname></title>
+ <para>Sum of all the storefile index sizes in this RegionServer (MB)</para>
+ </section>
+ <section xml:id="hbase.regionserver.stores"><title><varname>hbase.regionserver.stores</varname></title>
+ <para>Number of stores open on the RegionServer. A store corresponds to a column family. For example, if a table (which contains the column family) has 3 regions on a RegionServer, there will be 3 stores open for that column family. </para>
+ </section>
+ <section xml:id="hbase.regionserver.storeFiles"><title><varname>hbase.regionserver.storeFiles</varname></title>
+ <para>Number of store filles open on the RegionServer. A store may have more than one storefile (HFile).</para>
+ </section>
+ </section>
+ </section>
+
<section xml:id="ops.monitoring">
<title >HBase Monitoring</title>
<para>TODO