You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by nd...@apache.org on 2015/08/19 00:35:53 UTC
[01/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Repository: hbase
Updated Branches:
refs/heads/branch-1.1 48a3d1013 -> 0acbff24c
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/zookeeper.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/zookeeper.xml b/src/main/docbkx/zookeeper.xml
deleted file mode 100644
index 206ccf5..0000000
--- a/src/main/docbkx/zookeeper.xml
+++ /dev/null
@@ -1,513 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="zookeeper"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>ZooKeeper<indexterm>
- <primary>ZooKeeper</primary>
- </indexterm></title>
-
- <para>A distributed Apache HBase installation depends on a running ZooKeeper cluster. All
- participating nodes and clients need to be able to access the running ZooKeeper ensemble. Apache
- HBase by default manages a ZooKeeper "cluster" for you. It will start and stop the ZooKeeper
- ensemble as part of the HBase start/stop process. You can also manage the ZooKeeper ensemble
- independent of HBase and just point HBase at the cluster it should use. To toggle HBase
- management of ZooKeeper, use the <varname>HBASE_MANAGES_ZK</varname> variable in
- <filename>conf/hbase-env.sh</filename>. This variable, which defaults to
- <varname>true</varname>, tells HBase whether to start/stop the ZooKeeper ensemble servers as
- part of HBase start/stop.</para>
-
- <para>When HBase manages the ZooKeeper ensemble, you can specify ZooKeeper configuration using its
- native <filename>zoo.cfg</filename> file, or, the easier option is to just specify ZooKeeper
- options directly in <filename>conf/hbase-site.xml</filename>. A ZooKeeper configuration option
- can be set as a property in the HBase <filename>hbase-site.xml</filename> XML configuration file
- by prefacing the ZooKeeper option name with <varname>hbase.zookeeper.property</varname>. For
- example, the <varname>clientPort</varname> setting in ZooKeeper can be changed by setting the
- <varname>hbase.zookeeper.property.clientPort</varname> property. For all default values used
- by HBase, including ZooKeeper configuration, see <xref
- linkend="hbase_default_configurations" />. Look for the
- <varname>hbase.zookeeper.property</varname> prefix. For the full list of ZooKeeper configurations, see ZooKeeper's
- <filename>zoo.cfg</filename>. HBase does not ship with a <filename>zoo.cfg</filename> so
- you will need to browse the <filename>conf</filename> directory in an appropriate ZooKeeper
- download.</para>
-
- <para>You must at least list the ensemble servers in <filename>hbase-site.xml</filename> using the
- <varname>hbase.zookeeper.quorum</varname> property. This property defaults to a single
- ensemble member at <varname>localhost</varname> which is not suitable for a fully distributed
- HBase. (It binds to the local machine only and remote clients will not be able to connect). </para>
- <note
- xml:id="how_many_zks">
- <title>How many ZooKeepers should I run?</title>
-
- <para>You can run a ZooKeeper ensemble that comprises 1 node only but in production it is
- recommended that you run a ZooKeeper ensemble of 3, 5 or 7 machines; the more members an
- ensemble has, the more tolerant the ensemble is of host failures. Also, run an odd number of
- machines. In ZooKeeper, an even number of peers is supported, but it is normally not used
- because an even sized ensemble requires, proportionally, more peers to form a quorum than an
- odd sized ensemble requires. For example, an ensemble with 4 peers requires 3 to form a
- quorum, while an ensemble with 5 also requires 3 to form a quorum. Thus, an ensemble of 5
- allows 2 peers to fail, and thus is more fault tolerant than the ensemble of 4, which allows
- only 1 down peer. </para>
- <para>Give each ZooKeeper server around 1GB of RAM, and if possible, its own dedicated disk (A
- dedicated disk is the best thing you can do to ensure a performant ZooKeeper ensemble). For
- very heavily loaded clusters, run ZooKeeper servers on separate machines from RegionServers
- (DataNodes and TaskTrackers).</para>
- </note>
-
- <para>For example, to have HBase manage a ZooKeeper quorum on nodes
- <emphasis>rs{1,2,3,4,5}.example.com</emphasis>, bound to port 2222 (the default is 2181)
- ensure <varname>HBASE_MANAGE_ZK</varname> is commented out or set to <varname>true</varname> in
- <filename>conf/hbase-env.sh</filename> and then edit <filename>conf/hbase-site.xml</filename>
- and set <varname>hbase.zookeeper.property.clientPort</varname> and
- <varname>hbase.zookeeper.quorum</varname>. You should also set
- <varname>hbase.zookeeper.property.dataDir</varname> to other than the default as the default
- has ZooKeeper persist data under <filename>/tmp</filename> which is often cleared on system
- restart. In the example below we have ZooKeeper persist to
- <filename>/user/local/zookeeper</filename>.</para>
- <programlisting language="java"><![CDATA[
- <configuration>
- ...
- <property>
- <name>hbase.zookeeper.property.clientPort</name>
- <value>2222</value>
- <description>Property from ZooKeeper's config zoo.cfg.
- The port at which the clients will connect.
- </description>
- </property>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>rs1.example.com,rs2.example.com,rs3.example.com,rs4.example.com,rs5.example.com</value>
- <description>Comma separated list of servers in the ZooKeeper Quorum.
- For example, "host1.mydomain.com,host2.mydomain.com,host3.mydomain.com".
- By default this is set to localhost for local and pseudo-distributed modes
- of operation. For a fully-distributed setup, this should be set to a full
- list of ZooKeeper quorum servers. If HBASE_MANAGES_ZK is set in hbase-env.sh
- this is the list of servers which we will start/stop ZooKeeper on.
- </description>
- </property>
- <property>
- <name>hbase.zookeeper.property.dataDir</name>
- <value>/usr/local/zookeeper</value>
- <description>Property from ZooKeeper's config zoo.cfg.
- The directory where the snapshot is stored.
- </description>
- </property>
- ...
- </configuration>]]></programlisting>
- <caution
- xml:id="zk.version">
- <title>What verion of ZooKeeper should I use?</title>
- <para>The newer version, the better. For example, some folks have been bitten by <link
- xlink:href="https://issues.apache.org/jira/browse/ZOOKEEPER-1277">ZOOKEEPER-1277</link>. If
- running zookeeper 3.5+, you can ask hbase to make use of the new multi operation by enabling <xref
- linkend="hbase.zookeeper.useMulti" />" in your <filename>hbase-site.xml</filename>. </para>
- </caution>
- <caution>
- <title>ZooKeeper Maintenance</title>
- <para>Be sure to set up the data dir cleaner described under <link
- xlink:href="http://zookeeper.apache.org/doc/r3.1.2/zookeeperAdmin.html#sc_maintenance">Zookeeper
- Maintenance</link> else you could have 'interesting' problems a couple of months in; i.e.
- zookeeper could start dropping sessions if it has to run through a directory of hundreds of
- thousands of logs which is wont to do around leader reelection time -- a process rare but run
- on occasion whether because a machine is dropped or happens to hiccup.</para>
- </caution>
-
- <section>
- <title>Using existing ZooKeeper ensemble</title>
-
- <para>To point HBase at an existing ZooKeeper cluster, one that is not managed by HBase, set
- <varname>HBASE_MANAGES_ZK</varname> in <filename>conf/hbase-env.sh</filename> to
- false</para>
- <screen language="bourne">
- ...
- # Tell HBase whether it should manage its own instance of Zookeeper or not.
- export HBASE_MANAGES_ZK=false</screen>
- <para>Next set ensemble locations and client port, if non-standard, in
- <filename>hbase-site.xml</filename>, or add a suitably configured
- <filename>zoo.cfg</filename> to HBase's <filename>CLASSPATH</filename>. HBase will prefer
- the configuration found in <filename>zoo.cfg</filename> over any settings in
- <filename>hbase-site.xml</filename>.</para>
-
- <para>When HBase manages ZooKeeper, it will start/stop the ZooKeeper servers as a part of the
- regular start/stop scripts. If you would like to run ZooKeeper yourself, independent of HBase
- start/stop, you would do the following</para>
-
- <screen language="bourne">
-${HBASE_HOME}/bin/hbase-daemons.sh {start,stop} zookeeper
-</screen>
-
- <para>Note that you can use HBase in this manner to spin up a ZooKeeper cluster, unrelated to
- HBase. Just make sure to set <varname>HBASE_MANAGES_ZK</varname> to <varname>false</varname>
- if you want it to stay up across HBase restarts so that when HBase shuts down, it doesn't take
- ZooKeeper down with it.</para>
-
- <para>For more information about running a distinct ZooKeeper cluster, see the ZooKeeper <link
- xlink:href="http://hadoop.apache.org/zookeeper/docs/current/zookeeperStarted.html">Getting
- Started Guide</link>. Additionally, see the <link
- xlink:href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ#A7">ZooKeeper Wiki</link> or the <link
- xlink:href="http://zookeeper.apache.org/doc/r3.3.3/zookeeperAdmin.html#sc_zkMulitServerSetup">ZooKeeper
- documentation</link> for more information on ZooKeeper sizing. </para>
- </section>
-
-
- <section
- xml:id="zk.sasl.auth">
- <title>SASL Authentication with ZooKeeper</title>
- <para>Newer releases of Apache HBase (>= 0.92) will support connecting to a ZooKeeper Quorum
- that supports SASL authentication (which is available in Zookeeper versions 3.4.0 or
- later).</para>
-
- <para>This describes how to set up HBase to mutually authenticate with a ZooKeeper Quorum.
- ZooKeeper/HBase mutual authentication (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-2418">HBASE-2418</link>) is required
- as part of a complete secure HBase configuration (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-3025">HBASE-3025</link>). For
- simplicity of explication, this section ignores additional configuration required (Secure HDFS
- and Coprocessor configuration). It's recommended to begin with an HBase-managed Zookeeper
- configuration (as opposed to a standalone Zookeeper quorum) for ease of learning. </para>
-
- <section>
- <title>Operating System Prerequisites</title>
-
- <para> You need to have a working Kerberos KDC setup. For each <code>$HOST</code> that will
- run a ZooKeeper server, you should have a principle <code>zookeeper/$HOST</code>. For each
- such host, add a service key (using the <code>kadmin</code> or <code>kadmin.local</code>
- tool's <code>ktadd</code> command) for <code>zookeeper/$HOST</code> and copy this file to
- <code>$HOST</code>, and make it readable only to the user that will run zookeeper on
- <code>$HOST</code>. Note the location of this file, which we will use below as
- <filename>$PATH_TO_ZOOKEEPER_KEYTAB</filename>. </para>
-
- <para> Similarly, for each <code>$HOST</code> that will run an HBase server (master or
- regionserver), you should have a principle: <code>hbase/$HOST</code>. For each host, add a
- keytab file called <filename>hbase.keytab</filename> containing a service key for
- <code>hbase/$HOST</code>, copy this file to <code>$HOST</code>, and make it readable only
- to the user that will run an HBase service on <code>$HOST</code>. Note the location of this
- file, which we will use below as <filename>$PATH_TO_HBASE_KEYTAB</filename>. </para>
-
- <para> Each user who will be an HBase client should also be given a Kerberos principal. This
- principal should usually have a password assigned to it (as opposed to, as with the HBase
- servers, a keytab file) which only this user knows. The client's principal's
- <code>maxrenewlife</code> should be set so that it can be renewed enough so that the user
- can complete their HBase client processes. For example, if a user runs a long-running HBase
- client process that takes at most 3 days, we might create this user's principal within
- <code>kadmin</code> with: <code>addprinc -maxrenewlife 3days</code>. The Zookeeper client
- and server libraries manage their own ticket refreshment by running threads that wake up
- periodically to do the refreshment. </para>
-
- <para>On each host that will run an HBase client (e.g. <code>hbase shell</code>), add the
- following file to the HBase home directory's <filename>conf</filename> directory:</para>
-
- <programlisting language="java">
-Client {
- com.sun.security.auth.module.Krb5LoginModule required
- useKeyTab=false
- useTicketCache=true;
-};
- </programlisting>
-
- <para>We'll refer to this JAAS configuration file as <filename>$CLIENT_CONF</filename>
- below.</para>
- </section>
- <section>
- <title>HBase-managed Zookeeper Configuration</title>
-
- <para>On each node that will run a zookeeper, a master, or a regionserver, create a <link
- xlink:href="http://docs.oracle.com/javase/1.4.2/docs/guide/security/jgss/tutorials/LoginConfigFile.html">JAAS</link>
- configuration file in the conf directory of the node's <filename>HBASE_HOME</filename>
- directory that looks like the following:</para>
-
- <programlisting language="java">
-Server {
- com.sun.security.auth.module.Krb5LoginModule required
- useKeyTab=true
- keyTab="$PATH_TO_ZOOKEEPER_KEYTAB"
- storeKey=true
- useTicketCache=false
- principal="zookeeper/$HOST";
-};
-Client {
- com.sun.security.auth.module.Krb5LoginModule required
- useKeyTab=true
- useTicketCache=false
- keyTab="$PATH_TO_HBASE_KEYTAB"
- principal="hbase/$HOST";
-};
- </programlisting>
-
- <para>where the <filename>$PATH_TO_HBASE_KEYTAB</filename> and
- <filename>$PATH_TO_ZOOKEEPER_KEYTAB</filename> files are what you created above, and
- <code>$HOST</code> is the hostname for that node.</para>
-
- <para>The <code>Server</code> section will be used by the Zookeeper quorum server, while the
- <code>Client</code> section will be used by the HBase master and regionservers. The path
- to this file should be substituted for the text <filename>$HBASE_SERVER_CONF</filename> in
- the <filename>hbase-env.sh</filename> listing below.</para>
-
- <para> The path to this file should be substituted for the text
- <filename>$CLIENT_CONF</filename> in the <filename>hbase-env.sh</filename> listing below. </para>
-
- <para>Modify your <filename>hbase-env.sh</filename> to include the following:</para>
-
- <programlisting language="bourne">
-export HBASE_OPTS="-Djava.security.auth.login.config=$CLIENT_CONF"
-export HBASE_MANAGES_ZK=true
-export HBASE_ZOOKEEPER_OPTS="-Djava.security.auth.login.config=$HBASE_SERVER_CONF"
-export HBASE_MASTER_OPTS="-Djava.security.auth.login.config=$HBASE_SERVER_CONF"
-export HBASE_REGIONSERVER_OPTS="-Djava.security.auth.login.config=$HBASE_SERVER_CONF"
- </programlisting>
-
- <para>where <filename>$HBASE_SERVER_CONF</filename> and <filename>$CLIENT_CONF</filename> are
- the full paths to the JAAS configuration files created above.</para>
-
- <para>Modify your <filename>hbase-site.xml</filename> on each node that will run zookeeper,
- master or regionserver to contain:</para>
-
- <programlisting language="java"><![CDATA[
-<configuration>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>$ZK_NODES</value>
- </property>
- <property>
- <name>hbase.cluster.distributed</name>
- <value>true</value>
- </property>
- <property>
- <name>hbase.zookeeper.property.authProvider.1</name>
- <value>org.apache.zookeeper.server.auth.SASLAuthenticationProvider</value>
- </property>
- <property>
- <name>hbase.zookeeper.property.kerberos.removeHostFromPrincipal</name>
- <value>true</value>
- </property>
- <property>
- <name>hbase.zookeeper.property.kerberos.removeRealmFromPrincipal</name>
- <value>true</value>
- </property>
-</configuration>
- ]]></programlisting>
-
- <para>where <code>$ZK_NODES</code> is the comma-separated list of hostnames of the Zookeeper
- Quorum hosts.</para>
-
- <para>Start your hbase cluster by running one or more of the following set of commands on the
- appropriate hosts: </para>
-
- <screen>
-bin/hbase zookeeper start
-bin/hbase master start
-bin/hbase regionserver start
- </screen>
-
- </section>
-
- <section>
- <title>External Zookeeper Configuration</title>
- <para>Add a JAAS configuration file that looks like:</para>
- <programlisting language="java">
-Client {
- com.sun.security.auth.module.Krb5LoginModule required
- useKeyTab=true
- useTicketCache=false
- keyTab="$PATH_TO_HBASE_KEYTAB"
- principal="hbase/$HOST";
-};
- </programlisting>
- <para>where the <filename>$PATH_TO_HBASE_KEYTAB</filename> is the keytab created above for
- HBase services to run on this host, and <code>$HOST</code> is the hostname for that node.
- Put this in the HBase home's configuration directory. We'll refer to this file's full
- pathname as <filename>$HBASE_SERVER_CONF</filename> below.</para>
-
- <para>Modify your hbase-env.sh to include the following:</para>
-
- <programlisting language="bourne">
-export HBASE_OPTS="-Djava.security.auth.login.config=$CLIENT_CONF"
-export HBASE_MANAGES_ZK=false
-export HBASE_MASTER_OPTS="-Djava.security.auth.login.config=$HBASE_SERVER_CONF"
-export HBASE_REGIONSERVER_OPTS="-Djava.security.auth.login.config=$HBASE_SERVER_CONF"
- </programlisting>
-
-
- <para>Modify your <filename>hbase-site.xml</filename> on each node that will run a master or
- regionserver to contain:</para>
-
- <programlisting language="xml"><![CDATA[
-<configuration>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>$ZK_NODES</value>
- </property>
- <property>
- <name>hbase.cluster.distributed</name>
- <value>true</value>
- </property>
-</configuration>
- ]]>
- </programlisting>
-
- <para>where <code>$ZK_NODES</code> is the comma-separated list of hostnames of the Zookeeper
- Quorum hosts.</para>
-
- <para> Add a <filename>zoo.cfg</filename> for each Zookeeper Quorum host containing:</para>
- <programlisting language="java">
-authProvider.1=org.apache.zookeeper.server.auth.SASLAuthenticationProvider
-kerberos.removeHostFromPrincipal=true
-kerberos.removeRealmFromPrincipal=true
- </programlisting>
- <para>Also on each of these hosts, create a JAAS configuration file containing:</para>
- <programlisting language="java">
-Server {
- com.sun.security.auth.module.Krb5LoginModule required
- useKeyTab=true
- keyTab="$PATH_TO_ZOOKEEPER_KEYTAB"
- storeKey=true
- useTicketCache=false
- principal="zookeeper/$HOST";
-};
- </programlisting>
- <para>where <code>$HOST</code> is the hostname of each Quorum host. We will refer to the full
- pathname of this file as <filename>$ZK_SERVER_CONF</filename> below. </para>
-
- <para> Start your Zookeepers on each Zookeeper Quorum host with:</para>
- <programlisting language="bourne">
-SERVER_JVMFLAGS="-Djava.security.auth.login.config=$ZK_SERVER_CONF" bin/zkServer start
- </programlisting>
-
- <para> Start your HBase cluster by running one or more of the following set of commands on the
- appropriate nodes: </para>
-
- <screen>
-bin/hbase master start
-bin/hbase regionserver start
- </screen>
-
-
- </section>
-
- <section>
- <title>Zookeeper Server Authentication Log Output</title>
- <para>If the configuration above is successful, you should see something similar to the
- following in your Zookeeper server logs:</para>
- <screen>
-11/12/05 22:43:39 INFO zookeeper.Login: successfully logged in.
-11/12/05 22:43:39 INFO server.NIOServerCnxnFactory: binding to port 0.0.0.0/0.0.0.0:2181
-11/12/05 22:43:39 INFO zookeeper.Login: TGT refresh thread started.
-11/12/05 22:43:39 INFO zookeeper.Login: TGT valid starting at: Mon Dec 05 22:43:39 UTC 2011
-11/12/05 22:43:39 INFO zookeeper.Login: TGT expires: Tue Dec 06 22:43:39 UTC 2011
-11/12/05 22:43:39 INFO zookeeper.Login: TGT refresh sleeping until: Tue Dec 06 18:36:42 UTC 2011
-..
-11/12/05 22:43:59 INFO auth.SaslServerCallbackHandler:
- Successfully authenticated client: authenticationID=hbase/ip-10-166-175-249.us-west-1.compute.internal@HADOOP.LOCALDOMAIN;
- authorizationID=hbase/ip-10-166-175-249.us-west-1.compute.internal@HADOOP.LOCALDOMAIN.
-11/12/05 22:43:59 INFO auth.SaslServerCallbackHandler: Setting authorizedID: hbase
-11/12/05 22:43:59 INFO server.ZooKeeperServer: adding SASL authorization for authorizationID: hbase
- </screen>
-
- </section>
-
- <section>
- <title>Zookeeper Client Authentication Log Output</title>
- <para>On the Zookeeper client side (HBase master or regionserver), you should see something
- similar to the following:</para>
- <screen>
-11/12/05 22:43:59 INFO zookeeper.ZooKeeper: Initiating client connection, connectString=ip-10-166-175-249.us-west-1.compute.internal:2181 sessionTimeout=180000 watcher=master:60000
-11/12/05 22:43:59 INFO zookeeper.ClientCnxn: Opening socket connection to server /10.166.175.249:2181
-11/12/05 22:43:59 INFO zookeeper.RecoverableZooKeeper: The identifier of this process is 14851@ip-10-166-175-249
-11/12/05 22:43:59 INFO zookeeper.Login: successfully logged in.
-11/12/05 22:43:59 INFO client.ZooKeeperSaslClient: Client will use GSSAPI as SASL mechanism.
-11/12/05 22:43:59 INFO zookeeper.Login: TGT refresh thread started.
-11/12/05 22:43:59 INFO zookeeper.ClientCnxn: Socket connection established to ip-10-166-175-249.us-west-1.compute.internal/10.166.175.249:2181, initiating session
-11/12/05 22:43:59 INFO zookeeper.Login: TGT valid starting at: Mon Dec 05 22:43:59 UTC 2011
-11/12/05 22:43:59 INFO zookeeper.Login: TGT expires: Tue Dec 06 22:43:59 UTC 2011
-11/12/05 22:43:59 INFO zookeeper.Login: TGT refresh sleeping until: Tue Dec 06 18:30:37 UTC 2011
-11/12/05 22:43:59 INFO zookeeper.ClientCnxn: Session establishment complete on server ip-10-166-175-249.us-west-1.compute.internal/10.166.175.249:2181, sessionid = 0x134106594320000, negotiated timeout = 180000
- </screen>
- </section>
-
- <section>
- <title>Configuration from Scratch</title>
-
- <para>This has been tested on the current standard Amazon Linux AMI. First setup KDC and
- principals as described above. Next checkout code and run a sanity check.</para>
-
- <screen>
-git clone git://git.apache.org/hbase.git
-cd hbase
-mvn clean test -Dtest=TestZooKeeperACL
- </screen>
-
- <para>Then configure HBase as described above. Manually edit target/cached_classpath.txt (see
- below): </para>
- <screen>
-bin/hbase zookeeper &
-bin/hbase master &
-bin/hbase regionserver &
- </screen>
- </section>
-
-
- <section>
- <title>Future improvements</title>
-
- <section>
- <title>Fix target/cached_classpath.txt</title>
- <para> You must override the standard hadoop-core jar file from the
- <code>target/cached_classpath.txt</code> file with the version containing the
- HADOOP-7070 fix. You can use the following script to do this:</para>
- <screen language="bourne">
-echo `find ~/.m2 -name "*hadoop-core*7070*SNAPSHOT.jar"` ':' `cat target/cached_classpath.txt` | sed 's/ //g' > target/tmp.txt
-mv target/tmp.txt target/cached_classpath.txt
- </screen>
- </section>
-
- <section>
- <title>Set JAAS configuration programmatically</title>
-
-
- <para>This would avoid the need for a separate Hadoop jar that fixes <link
- xlink:href="https://issues.apache.org/jira/browse/HADOOP-7070">HADOOP-7070</link>.
- </para>
- </section>
-
- <section>
- <title>Elimination of <code>kerberos.removeHostFromPrincipal</code> and
- <code>kerberos.removeRealmFromPrincipal</code></title>
- <para />
- </section>
-
- </section>
-
-
- </section>
- <!-- SASL Authentication with ZooKeeper -->
-
-
-
-
-</chapter>
[09/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/external_apis.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/external_apis.xml b/src/main/docbkx/external_apis.xml
deleted file mode 100644
index fa1abdc..0000000
--- a/src/main/docbkx/external_apis.xml
+++ /dev/null
@@ -1,79 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="external_apis"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase External APIs</title>
- <para> This chapter will cover access to Apache HBase either through non-Java languages, or
- through custom protocols. For information on using the native HBase APIs, refer to <link
- xlink:href="http://hbase.apache.org/apidocs/index.html">User API Reference</link> and the new <xref
- linkend="hbase_apis" /> chapter. </para>
- <section xml:id="nonjava.jvm">
- <title>Non-Java Languages Talking to the JVM</title>
- <para>Currently the documentation on this topic in the
- <link xlink:href="http://wiki.apache.org/hadoop/Hbase">Apache HBase Wiki</link>.
- See also the <link xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/thrift/package-summary.html#package_description">Thrift API Javadoc</link>.
- </para>
- </section>
-
- <section xml:id="rest">
- <title>REST</title>
- <para>Currently most of the documentation on REST exists in the
- <link xlink:href="http://wiki.apache.org/hadoop/Hbase/Stargate">Apache HBase Wiki on REST</link> (The REST gateway used to be
- called 'Stargate'). There are also a nice set of blogs on <link xlink:href="http://blog.cloudera.com/blog/2013/03/how-to-use-the-apache-hbase-rest-interface-part-1/">How-to: Use the Apache HBase REST Interface</link>
- by Jesse Anderson.
- </para>
- <para>
- To run your REST server under SSL, set hbase.rest.ssl.enabled to true and also set the
- following configs when you launch the REST server:(See example commands in
- <xref linkend="JMX_config" />)
-<programlisting>
-hbase.rest.ssl.keystore.store
-hbase.rest.ssl.keystore.password
-hbase.rest.ssl.keystore.keypassword</programlisting>
- </para>
- <para>
- HBase ships a simple REST client, see <link xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/rest/client/package-summary.html">REST client</link> package for details.
- To enable SSL support for it, please also import your certificate into local java
- cacerts keystore:
- <screen language="bourne">keytool -import -trustcacerts -file /home/user/restserver.cert -keystore $JAVA_HOME/jre/lib/security/cacerts</screen>
- </para>
- </section> <!-- rest -->
-
- <section>
- <title>Thrift</title>
- <para>Documentation about Thrift has moved to <xref linkend="thrift" />.</para>
- </section> <!-- thrift -->
-
- <section xml:id="c">
- <title>C/C++ Apache HBase Client</title>
- <para>FB's Chip Turner wrote a pure C/C++ client. <link xlink:href="https://github.com/facebook/native-cpp-hbase-client">Check it out</link>.
- </para>
- </section>
-
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/getting_started.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/getting_started.xml b/src/main/docbkx/getting_started.xml
deleted file mode 100644
index 79478ba..0000000
--- a/src/main/docbkx/getting_started.xml
+++ /dev/null
@@ -1,728 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="getting_started"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Getting Started</title>
-
- <section>
- <title>Introduction</title>
-
- <para><xref linkend="quickstart"/> will get you up and running on a single-node, standalone
- instance of HBase, followed by a pseudo-distributed single-machine instance, and finally a
- fully-distributed cluster. </para>
- </section>
-
- <section
- xml:id="quickstart">
- <title>Quick Start - Standalone HBase</title>
-
- <para>This guide describes setup of a standalone HBase instance running against the local
- filesystem. This is not an appropriate configuration for a production instance of HBase, but
- will allow you to experiment with HBase. This section shows you how to create a table in
- HBase using the <command>hbase shell</command> CLI, insert rows into the table, perform put
- and scan operations against the table, enable or disable the table, and start and stop HBase.
- Apart from downloading HBase, this procedure should take less than 10 minutes.</para>
- <warning
- xml:id="local.fs.durability">
- <title>Local Filesystem and Durability</title>
- <para><emphasis>The below advice is for HBase 0.98.2 and earlier releases only. This is fixed
- in HBase 0.98.3 and beyond. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11272">HBASE-11272</link> and
- <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11218">HBASE-11218</link>.</emphasis></para>
- <para>Using HBase with a local filesystem does not guarantee durability. The HDFS
- local filesystem implementation will lose edits if files are not properly closed. This is
- very likely to happen when you are experimenting with new software, starting and stopping
- the daemons often and not always cleanly. You need to run HBase on HDFS
- to ensure all writes are preserved. Running against the local filesystem is intended as a
- shortcut to get you familiar with how the general system works, as the very first phase of
- evaluation. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-3696" /> and its associated issues
- for more details about the issues of running on the local filesystem.</para>
- </warning>
- <note
- xml:id="loopback.ip.getting.started">
- <title>Loopback IP - HBase 0.94.x and earlier</title>
- <para><emphasis>The below advice is for hbase-0.94.x and older versions only. This is fixed in
- hbase-0.96.0 and beyond.</emphasis></para>
-
- <para>Prior to HBase 0.94.x, HBase expected the loopback IP address to be 127.0.0.1. Ubuntu
- and some other distributions default to 127.0.1.1 and this will cause problems for you . See <link
- xlink:href="http://blog.devving.com/why-does-hbase-care-about-etchosts/">Why does HBase
- care about /etc/hosts?</link> for detail.</para>
- <example>
- <title>Example /etc/hosts File for Ubuntu</title>
- <para>The following <filename>/etc/hosts</filename> file works correctly for HBase 0.94.x
- and earlier, on Ubuntu. Use this as a template if you run into trouble.</para>
- <screen>
-127.0.0.1 localhost
-127.0.0.1 ubuntu.ubuntu-domain ubuntu
- </screen>
- </example>
- </note>
-
- <section>
- <title>JDK Version Requirements</title>
- <para>HBase requires that a JDK be installed. See <xref linkend="java" /> for information
- about supported JDK versions.</para>
- </section>
-
- <section>
- <title>Get Started with HBase</title>
-
- <procedure>
- <title>Download, Configure, and Start HBase</title>
- <step>
- <para>Choose a download site from this list of <link
- xlink:href="http://www.apache.org/dyn/closer.cgi/hbase/">Apache Download Mirrors</link>.
- Click on the suggested top link. This will take you to a mirror of <emphasis>HBase
- Releases</emphasis>. Click on the folder named <filename>stable</filename> and then
- download the binary file that ends in <filename>.tar.gz</filename> to your local filesystem. Be
- sure to choose the version that corresponds with the version of Hadoop you are likely to use
- later. In most cases, you should choose the file for Hadoop 2, which will be called something
- like <filename>hbase-0.98.3-hadoop2-bin.tar.gz</filename>. Do not download the file ending in
- <filename>src.tar.gz</filename> for now.</para>
- </step>
- <step>
- <para>Extract the downloaded file, and change to the newly-created directory.</para>
- <screen language="bourne">
-$ tar xzvf hbase-<![CDATA[<?eval ${project.version}?>]]>-hadoop2-bin.tar.gz
-$ cd hbase-<![CDATA[<?eval ${project.version}?>]]>-hadoop2/
- </screen>
- </step>
- <step>
- <para>For HBase 0.98.5 and later, you are required to set the <envar>JAVA_HOME</envar>
- environment variable before starting HBase. Prior to 0.98.5, HBase attempted to detect
- the location of Java if the variables was not set. You can set the variable via your
- operating system's usual mechanism, but HBase provides a central mechanism,
- <filename>conf/hbase-env.sh</filename>. Edit this file, uncomment the line starting
- with <literal>JAVA_HOME</literal>, and set it to the appropriate location for your
- operating system. The <envar>JAVA_HOME</envar> variable should be set to a directory
- which contains the executable file <filename>bin/java</filename>. Most modern Linux
- operating systems provide a mechanism, such as /usr/bin/alternatives on RHEL or CentOS,
- for transparently switching between versions of executables such as Java. In this case,
- you can set <envar>JAVA_HOME</envar> to the directory containing the symbolic link to
- <filename>bin/java</filename>, which is usually <filename>/usr</filename>.</para>
- <screen>JAVA_HOME=/usr</screen>
- <note>
- <para>These instructions assume that each node of your cluster uses the same
- configuration. If this is not the case, you may need to set <envar>JAVA_HOME</envar>
- separately for each node.</para>
- </note>
- </step>
- <step>
- <para>Edit <filename>conf/hbase-site.xml</filename>, which is the main HBase configuration
- file. At this time, you only need to specify the directory on the local filesystem where
- HBase and Zookeeper write data. By default, a new directory is created under /tmp. Many
- servers are configured to delete the contents of /tmp upon reboot, so you should store
- the data elsewhere. The following configuration will store HBase's data in the
- <filename>hbase</filename> directory, in the home directory of the user called
- <systemitem>testuser</systemitem>. Paste the <markup><property></markup> tags beneath the
- <markup><configuration></markup> tags, which should be empty in a new HBase install.</para>
- <example>
- <title>Example <filename>hbase-site.xml</filename> for Standalone HBase</title>
- <programlisting language="xml"><![CDATA[
-<configuration>
- <property>
- <name>hbase.rootdir</name>
- <value>file:///home/testuser/hbase</value>
- </property>
- <property>
- <name>hbase.zookeeper.property.dataDir</name>
- <value>/home/testuser/zookeeper</value>
- </property>
-</configuration>
- ]]>
- </programlisting>
- </example>
- <para>You do not need to create the HBase data directory. HBase will do this for you. If
- you create the directory, HBase will attempt to do a migration, which is not what you
- want.</para>
- </step>
- <step xml:id="start_hbase">
- <para>The <filename>bin/start-hbase.sh</filename> script is provided as a convenient way
- to start HBase. Issue the command, and if all goes well, a message is logged to standard
- output showing that HBase started successfully. You can use the <command>jps</command>
- command to verify that you have one running process called <literal>HMaster</literal>.
- In standalone mode HBase runs all daemons within this single JVM, i.e. the HMaster, a
- single HRegionServer, and the ZooKeeper daemon.</para>
- <note><para>Java needs to be installed and available. If you get an error indicating that
- Java is not installed, but it is on your system, perhaps in a non-standard location,
- edit the <filename>conf/hbase-env.sh</filename> file and modify the
- <envar>JAVA_HOME</envar> setting to point to the directory that contains
- <filename>bin/java</filename> your system.</para></note>
- </step>
- </procedure>
-
- <procedure xml:id="shell_exercises">
- <title>Use HBase For the First Time</title>
- <step>
- <title>Connect to HBase.</title>
- <para>Connect to your running instance of HBase using the <command>hbase shell</command>
- command, located in the <filename>bin/</filename> directory of your HBase
- install. In this example, some usage and version information that is printed when you
- start HBase Shell has been omitted. The HBase Shell prompt ends with a
- <literal>></literal> character.</para>
- <screen language="bourne">
-$ <userinput>./bin/hbase shell</userinput>
-hbase(main):001:0>
- </screen>
- </step>
- <step>
- <title>Display HBase Shell Help Text.</title>
- <para>Type <literal>help</literal> and press Enter, to display some basic usage
- information for HBase Shell, as well as several example commands. Notice that table
- names, rows, columns all must be enclosed in quote characters.</para>
- </step>
- <step>
- <title>Create a table.</title>
- <para>Use the <code>create</code> command to create a new table. You must specify the
- table name and the ColumnFamily name.</para>
- <screen>
-hbase> <userinput>create 'test', 'cf'</userinput>
-0 row(s) in 1.2200 seconds
- </screen>
- </step>
- <step>
- <title>List Information About your Table</title>
- <para>Use the <code>list</code> command to </para>
- <screen>
-hbase> <userinput>list 'test'</userinput>
-TABLE
-test
-1 row(s) in 0.0350 seconds
-
-=> ["test"]
- </screen>
- </step>
- <step>
- <title>Put data into your table.</title>
- <para>To put data into your table, use the <code>put</code> command.</para>
- <screen>
-hbase> <userinput>put 'test', 'row1', 'cf:a', 'value1'</userinput>
-0 row(s) in 0.1770 seconds
-
-hbase> <userinput>put 'test', 'row2', 'cf:b', 'value2'</userinput>
-0 row(s) in 0.0160 seconds
-
-hbase> <userinput>put 'test', 'row3', 'cf:c', 'value3'</userinput>
-0 row(s) in 0.0260 seconds
- </screen>
- <para>Here, we insert three values, one at a time. The first insert is at
- <literal>row1</literal>, column <literal>cf:a</literal>, with a value of
- <literal>value1</literal>. Columns in HBase are comprised of a column family prefix,
- <literal>cf</literal> in this example, followed by a colon and then a column qualifier
- suffix, <literal>a</literal> in this case.</para>
- </step>
- <step>
- <title>Scan the table for all data at once.</title>
- <para>One of the ways to get data from HBase is to scan. Use the <command>scan</command>
- command to scan the table for data. You can limit your scan, but for now, all data is
- fetched.</para>
- <screen>
-hbase> <userinput>scan 'test'</userinput>
-ROW COLUMN+CELL
- row1 column=cf:a, timestamp=1403759475114, value=value1
- row2 column=cf:b, timestamp=1403759492807, value=value2
- row3 column=cf:c, timestamp=1403759503155, value=value3
-3 row(s) in 0.0440 seconds
- </screen>
- </step>
- <step>
- <title>Get a single row of data.</title>
- <para>To get a single row of data at a time, use the <command>get</command> command.</para>
- <screen>
-hbase> <userinput>get 'test', 'row1'</userinput>
-COLUMN CELL
- cf:a timestamp=1403759475114, value=value1
-1 row(s) in 0.0230 seconds
- </screen>
- </step>
- <step>
- <title>Disable a table.</title>
- <para>If you want to delete a table or change its settings, as well as in some other
- situations, you need to disable the table first, using the <code>disable</code>
- command. You can re-enable it using the <code>enable</code> command.</para>
- <screen>
-hbase> disable 'test'
-0 row(s) in 1.6270 seconds
-
-hbase> enable 'test'
-0 row(s) in 0.4500 seconds
- </screen>
- <para>Disable the table again if you tested the <command>enable</command> command above:</para>
- <screen>
-hbase> disable 'test'
-0 row(s) in 1.6270 seconds
- </screen>
- </step>
- <step>
- <title>Drop the table.</title>
- <para>To drop (delete) a table, use the <code>drop</code> command.</para>
- <screen>
-hbase> drop 'test'
-0 row(s) in 0.2900 seconds
- </screen>
- </step>
- <step>
- <title>Exit the HBase Shell.</title>
- <para>To exit the HBase Shell and disconnect from your cluster, use the
- <command>quit</command> command. HBase is still running in the background.</para>
- </step>
- </procedure>
-
- <procedure
- xml:id="stopping">
- <title>Stop HBase</title>
- <step>
- <para>In the same way that the <filename>bin/start-hbase.sh</filename> script is provided
- to conveniently start all HBase daemons, the <filename>bin/stop-hbase.sh</filename>
- script stops them.</para>
- <screen language="bourne">
-$ ./bin/stop-hbase.sh
-stopping hbase....................
-$
- </screen>
- </step>
- <step>
- <para>After issuing the command, it can take several minutes for the processes to shut
- down. Use the <command>jps</command> to be sure that the HMaster and HRegionServer
- processes are shut down.</para>
- </step>
- </procedure>
- </section>
-
- <section xml:id="quickstart-pseudo">
- <title>Intermediate - Pseudo-Distributed Local Install</title>
- <para>After working your way through <xref linkend="quickstart" />, you can re-configure HBase
- to run in pseudo-distributed mode. Pseudo-distributed mode means
- that HBase still runs completely on a single host, but each HBase daemon (HMaster,
- HRegionServer, and Zookeeper) runs as a separate process. By default, unless you configure the
- <code>hbase.rootdir</code> property as described in <xref linkend="quickstart" />, your data
- is still stored in <filename>/tmp/</filename>. In this walk-through, we store your data in
- HDFS instead, assuming you have HDFS available. You can skip the HDFS configuration to
- continue storing your data in the local filesystem.</para>
- <note>
- <title>Hadoop Configuration</title>
- <para>This procedure assumes that you have configured Hadoop and HDFS on your local system
- and or a remote system, and that they are running and available. It also assumes you are
- using Hadoop 2. Currently, the documentation on the Hadoop website does not include a
- quick start for Hadoop 2, but the guide at <link
- xlink:href="http://www.alexjf.net/blog/distributed-systems/hadoop-yarn-installation-definitive-guide">http://www.alexjf.net/blog/distributed-systems/hadoop-yarn-installation-definitive-guide</link>
- is a good starting point.</para>
- </note>
- <procedure>
- <step>
- <title>Stop HBase if it is running.</title>
- <para>If you have just finished <xref linkend="quickstart" /> and HBase is still running,
- stop it. This procedure will create a totally new directory where HBase will store its
- data, so any databases you created before will be lost.</para>
- </step>
- <step>
- <title>Configure HBase.</title>
- <para>
- Edit the <filename>hbase-site.xml</filename> configuration. First, add the following
- property. which directs HBase to run in distributed mode, with one JVM instance per
- daemon.
- </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.cluster.distributed</name>
- <value>true</value>
-</property>
- ]]></programlisting>
- <para>Next, change the <code>hbase.rootdir</code> from the local filesystem to the address
- of your HDFS instance, using the <code>hdfs:////</code> URI syntax. In this example,
- HDFS is running on the localhost at port 8020.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rootdir</name>
- <value>hdfs://localhost:8020/hbase</value>
-</property>
- ]]>
- </programlisting>
- <para>You do not need to create the directory in HDFS. HBase will do this for you. If you
- create the directory, HBase will attempt to do a migration, which is not what you
- want.</para>
- </step>
- <step>
- <title>Start HBase.</title>
- <para>Use the <filename>bin/start-hbase.sh</filename> command to start HBase. If your
- system is configured correctly, the <command>jps</command> command should show the
- HMaster and HRegionServer processes running.</para>
- </step>
- <step>
- <title>Check the HBase directory in HDFS.</title>
- <para>If everything worked correctly, HBase created its directory in HDFS. In the
- configuration above, it is stored in <filename>/hbase/</filename> on HDFS. You can use
- the <command>hadoop fs</command> command in Hadoop's <filename>bin/</filename> directory
- to list this directory.</para>
- <screen language="bourne">
-$ <userinput>./bin/hadoop fs -ls /hbase</userinput>
-Found 7 items
-drwxr-xr-x - hbase users 0 2014-06-25 18:58 /hbase/.tmp
-drwxr-xr-x - hbase users 0 2014-06-25 21:49 /hbase/WALs
-drwxr-xr-x - hbase users 0 2014-06-25 18:48 /hbase/corrupt
-drwxr-xr-x - hbase users 0 2014-06-25 18:58 /hbase/data
--rw-r--r-- 3 hbase users 42 2014-06-25 18:41 /hbase/hbase.id
--rw-r--r-- 3 hbase users 7 2014-06-25 18:41 /hbase/hbase.version
-drwxr-xr-x - hbase users 0 2014-06-25 21:49 /hbase/oldWALs
- </screen>
- </step>
- <step>
- <title>Create a table and populate it with data.</title>
- <para>You can use the HBase Shell to create a table, populate it with data, scan and get
- values from it, using the same procedure as in <xref linkend="shell_exercises" />.</para>
- </step>
- <step>
- <title>Start and stop a backup HBase Master (HMaster) server.</title>
- <note>
- <para>Running multiple HMaster instances on the same hardware does not make sense in a
- production environment, in the same way that running a pseudo-distributed cluster does
- not make sense for production. This step is offered for testing and learning purposes
- only.</para>
- </note>
- <para>The HMaster server controls the HBase cluster. You can start up to 9 backup HMaster
- servers, which makes 10 total HMasters, counting the primary. To start a backup HMaster,
- use the <command>local-master-backup.sh</command>. For each backup master you want to
- start, add a parameter representing the port offset for that master. Each HMaster uses
- three ports (16010, 16020, and 16030 by default). The port offset is added to these ports, so
- using an offset of 2, the backup HMaster would use ports 16012, 16022, and 16032. The
- following command starts 3 backup servers using ports 16012/16022/16032, 16013/16023/16033,
- and 16015/16025/16035.</para>
- <screen language="bourne">
-$ ./bin/local-master-backup.sh 2 3 5
- </screen>
- <para>To kill a backup master without killing the entire cluster, you need to find its
- process ID (PID). The PID is stored in a file with a name like
- <filename>/tmp/hbase-<replaceable>USER</replaceable>-<replaceable>X</replaceable>-master.pid</filename>.
- The only contents of the file are the PID. You can use the <command>kill -9</command>
- command to kill that PID. The following command will kill the master with port offset 1,
- but leave the cluster running:</para>
- <screen language="bourne">
-$ cat /tmp/hbase-testuser-1-master.pid |xargs kill -9
- </screen>
- </step>
- <step>
- <title>Start and stop additional RegionServers</title>
- <para>The HRegionServer manages the data in its StoreFiles as directed by the HMaster.
- Generally, one HRegionServer runs per node in the cluster. Running multiple
- HRegionServers on the same system can be useful for testing in pseudo-distributed mode.
- The <command>local-regionservers.sh</command> command allows you to run multiple
- RegionServers. It works in a similar way to the
- <command>local-master-backup.sh</command> command, in that each parameter you provide
- represents the port offset for an instance. Each RegionServer requires two ports, and
- the default ports are 16020 and 16030. However, the base ports for additional RegionServers
- are not the default ports since the default ports are used by the HMaster, which is also
- a RegionServer since HBase version 1.0.0. The base ports are 16200 and 16300 instead.
- You can run 99 additional RegionServers that are not a HMaster or backup HMaster,
- on a server. The following command starts four additional RegionServers, running on
- sequential ports starting at 16202/16302 (base ports 16200/16300 plus 2).</para>
- <screen language="bourne">
-$ .bin/local-regionservers.sh start 2 3 4 5
- </screen>
- <para>To stop a RegionServer manually, use the <command>local-regionservers.sh</command>
- command with the <literal>stop</literal> parameter and the offset of the server to
- stop.</para>
- <screen language="bourne">$ .bin/local-regionservers.sh stop 3</screen>
- </step>
- <step>
- <title>Stop HBase.</title>
- <para>You can stop HBase the same way as in the <xref
- linkend="quickstart" /> procedure, using the
- <filename>bin/stop-hbase.sh</filename> command.</para>
- </step>
- </procedure>
- </section>
-
- <section xml:id="quickstart-fully-distributed">
- <title>Advanced - Fully Distributed</title>
- <para>In reality, you need a fully-distributed configuration to fully test HBase and to use it
- in real-world scenarios. In a distributed configuration, the cluster contains multiple
- nodes, each of which runs one or more HBase daemon. These include primary and backup Master
- instances, multiple Zookeeper nodes, and multiple RegionServer nodes.</para>
- <para>This advanced quickstart adds two more nodes to your cluster. The architecture will be
- as follows:</para>
- <table>
- <title>Distributed Cluster Demo Architecture</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Node Name</entry>
- <entry>Master</entry>
- <entry>ZooKeeper</entry>
- <entry>RegionServer</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>node-a.example.com</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- <entry>no</entry>
- </row>
- <row>
- <entry>node-b.example.com</entry>
- <entry>backup</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- </row>
- <row>
- <entry>node-c.example.com</entry>
- <entry>no</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>This quickstart assumes that each node is a virtual machine and that they are all on the
- same network. It builds upon the previous quickstart, <xref linkend="quickstart-pseudo" />,
- assuming that the system you configured in that procedure is now <code>node-a</code>. Stop HBase on <code>node-a</code>
- before continuing.</para>
- <note>
- <para>Be sure that all the nodes have full access to communicate, and that no firewall rules
- are in place which could prevent them from talking to each other. If you see any errors like
- <literal>no route to host</literal>, check your firewall.</para>
- </note>
- <procedure xml:id="passwordless.ssh.quickstart">
- <title>Configure Password-Less SSH Access</title>
- <para><code>node-a</code> needs to be able to log into <code>node-b</code> and
- <code>node-c</code> (and to itself) in order to start the daemons. The easiest way to accomplish this is
- to use the same username on all hosts, and configure password-less SSH login from
- <code>node-a</code> to each of the others. </para>
- <step>
- <title>On <code>node-a</code>, generate a key pair.</title>
- <para>While logged in as the user who will run HBase, generate a SSH key pair, using the
- following command:
- </para>
- <screen language="bourne">$ ssh-keygen -t rsa</screen>
- <para>If the command succeeds, the location of the key pair is printed to standard output.
- The default name of the public key is <filename>id_rsa.pub</filename>.</para>
- </step>
- <step>
- <title>Create the directory that will hold the shared keys on the other nodes.</title>
- <para>On <code>node-b</code> and <code>node-c</code>, log in as the HBase user and create
- a <filename>.ssh/</filename> directory in the user's home directory, if it does not
- already exist. If it already exists, be aware that it may already contain other keys.</para>
- </step>
- <step>
- <title>Copy the public key to the other nodes.</title>
- <para>Securely copy the public key from <code>node-a</code> to each of the nodes, by
- using the <command>scp</command> or some other secure means. On each of the other nodes,
- create a new file called <filename>.ssh/authorized_keys</filename> <emphasis>if it does
- not already exist</emphasis>, and append the contents of the
- <filename>id_rsa.pub</filename> file to the end of it. Note that you also need to do
- this for <code>node-a</code> itself.</para>
- <screen language="bourne">$ cat id_rsa.pub >> ~/.ssh/authorized_keys</screen>
- </step>
- <step>
- <title>Test password-less login.</title>
- <para>If you performed the procedure correctly, if you SSH from <code>node-a</code> to
- either of the other nodes, using the same username, you should not be prompted for a password.
- </para>
- </step>
- <step>
- <para>Since <code>node-b</code> will run a backup Master, repeat the procedure above,
- substituting <code>node-b</code> everywhere you see <code>node-a</code>. Be sure not to
- overwrite your existing <filename>.ssh/authorized_keys</filename> files, but concatenate
- the new key onto the existing file using the <code>>></code> operator rather than
- the <code>></code> operator.</para>
- </step>
- </procedure>
-
- <procedure>
- <title>Prepare <code>node-a</code></title>
- <para><code>node-a</code> will run your primary master and ZooKeeper processes, but no
- RegionServers.</para>
- <step>
- <title>Stop the RegionServer from starting on <code>node-a</code>.</title>
- <para>Edit <filename>conf/regionservers</filename> and remove the line which contains
- <literal>localhost</literal>. Add lines with the hostnames or IP addresses for
- <code>node-b</code> and <code>node-c</code>. Even if you did want to run a
- RegionServer on <code>node-a</code>, you should refer to it by the hostname the other
- servers would use to communicate with it. In this case, that would be
- <literal>node-a.example.com</literal>. This enables you to distribute the
- configuration to each node of your cluster any hostname conflicts. Save the file.</para>
- </step>
- <step>
- <title>Configure HBase to use <code>node-b</code> as a backup master.</title>
- <para>Create a new file in <filename>conf/</filename> called
- <filename>backup-masters</filename>, and add a new line to it with the hostname for
- <code>node-b</code>. In this demonstration, the hostname is
- <literal>node-b.example.com</literal>.</para>
- </step>
- <step>
- <title>Configure ZooKeeper</title>
- <para>In reality, you should carefully consider your ZooKeeper configuration. You can find
- out more about configuring ZooKeeper in <xref
- linkend="zookeeper" />. This configuration will direct HBase to start and manage a
- ZooKeeper instance on each node of the cluster.</para>
- <para>On <code>node-a</code>, edit <filename>conf/hbase-site.xml</filename> and add the
- following properties.</para>
- <programlisting language="bourne"><![CDATA[
-<property>
- <name>hbase.zookeeper.quorum</name>
- <value>node-a.example.com,node-b.example.com,node-c.example.com</value>
-</property>
-<property>
- <name>hbase.zookeeper.property.dataDir</name>
- <value>/usr/local/zookeeper</value>
-</property>
- ]]></programlisting>
- </step>
- <step>
- <para>Everywhere in your configuration that you have referred to <code>node-a</code> as
- <literal>localhost</literal>, change the reference to point to the hostname that
- the other nodes will use to refer to <code>node-a</code>. In these examples, the
- hostname is <literal>node-a.example.com</literal>.</para>
- </step>
- </procedure>
- <procedure>
- <title>Prepare <code>node-b</code> and <code>node-c</code></title>
- <para><code>node-b</code> will run a backup master server and a ZooKeeper instance.</para>
- <step>
- <title>Download and unpack HBase.</title>
- <para>Download and unpack HBase to <code>node-b</code>, just as you did for the standalone
- and pseudo-distributed quickstarts.</para>
- </step>
- <step>
- <title>Copy the configuration files from <code>node-a</code> to <code>node-b</code>.and
- <code>node-c</code>.</title>
- <para>Each node of your cluster needs to have the same configuration information. Copy the
- contents of the <filename>conf/</filename> directory to the <filename>conf/</filename>
- directory on <code>node-b</code> and <code>node-c</code>.</para>
- </step>
- </procedure>
-
- <procedure>
- <title>Start and Test Your Cluster</title>
- <step>
- <title>Be sure HBase is not running on any node.</title>
- <para>If you forgot to stop HBase from previous testing, you will have errors. Check to
- see whether HBase is running on any of your nodes by using the <command>jps</command>
- command. Look for the processes <literal>HMaster</literal>,
- <literal>HRegionServer</literal>, and <literal>HQuorumPeer</literal>. If they exist,
- kill them.</para>
- </step>
- <step>
- <title>Start the cluster.</title>
- <para>On <code>node-a</code>, issue the <command>start-hbase.sh</command> command. Your
- output will be similar to that below.</para>
- <screen language="bourne">
-$ <userinput>bin/start-hbase.sh</userinput>
-node-c.example.com: starting zookeeper, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-zookeeper-node-c.example.com.out
-node-a.example.com: starting zookeeper, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-zookeeper-node-a.example.com.out
-node-b.example.com: starting zookeeper, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-zookeeper-node-b.example.com.out
-starting master, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-master-node-a.example.com.out
-node-c.example.com: starting regionserver, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-regionserver-node-c.example.com.out
-node-b.example.com: starting regionserver, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-regionserver-node-b.example.com.out
-node-b.example.com: starting master, logging to /home/hbuser/hbase-0.98.3-hadoop2/bin/../logs/hbase-hbuser-master-nodeb.example.com.out
- </screen>
- <para>ZooKeeper starts first, followed by the master, then the RegionServers, and finally
- the backup masters. </para>
- </step>
- <step>
- <title>Verify that the processes are running.</title>
- <para>On each node of the cluster, run the <command>jps</command> command and verify that
- the correct processes are running on each server. You may see additional Java processes
- running on your servers as well, if they are used for other purposes.</para>
- <example>
- <title><code>node-a</code> <command>jps</command> Output</title>
- <screen language="bourne">
-$ <userinput>jps</userinput>
-20355 Jps
-20071 HQuorumPeer
-20137 HMaster
- </screen>
- </example>
- <example>
- <title><code>node-b</code> <command>jps</command> Output</title>
- <screen language="bourne">
-$ <userinput>jps</userinput>
-15930 HRegionServer
-16194 Jps
-15838 HQuorumPeer
-16010 HMaster
- </screen>
- </example>
- <example>
- <title><code>node-c</code> <command>jps</command> Output</title>
- <screen language="bourne">
-$ <userinput>jps</userinput>
-13901 Jps
-13639 HQuorumPeer
-13737 HRegionServer
- </screen>
- </example>
- <note>
- <title>ZooKeeper Process Name</title>
- <para>The <code>HQuorumPeer</code> process is a ZooKeeper instance which is controlled
- and started by HBase. If you use ZooKeeper this way, it is limited to one instance per
- cluster node, , and is appropriate for testing only. If ZooKeeper is run outside of
- HBase, the process is called <code>QuorumPeer</code>. For more about ZooKeeper
- configuration, including using an external ZooKeeper instance with HBase, see <xref
- linkend="zookeeper" />.</para>
- </note>
- </step>
- <step>
- <title>Browse to the Web UI.</title>
- <note>
- <title>Web UI Port Changes</title>
- <para>In HBase newer than 0.98.x, the HTTP ports used by the HBase Web UI changed from
- 60010 for the Master and 60030 for each RegionServer to 16610 for the Master and 16030
- for the RegionServer.</para>
- </note>
- <para>If everything is set up correctly, you should be able to connect to the UI for the
- Master <literal>http://node-a.example.com:60110/</literal> or the secondary master at
- <literal>http://node-b.example.com:60110/</literal> for the secondary master, using a
- web browser. If you can connect via <code>localhost</code> but not from another host,
- check your firewall rules. You can see the web UI for each of the RegionServers at port
- 60130 of their IP addresses, or by clicking their links in the web UI for the
- Master.</para>
- </step>
- <step>
- <title>Test what happens when nodes or services disappear.</title>
- <para>With a three-node cluster like you have configured, things will not be very
- resilient. Still, you can test what happens when the primary Master or a RegionServer
- disappears, by killing the processes and watching the logs.</para>
- </step>
- </procedure>
- </section>
-
- <section>
- <title>Where to go next</title>
-
- <para>The next chapter, <xref
- linkend="configuration" />, gives more information about the different HBase run modes,
- system requirements for running HBase, and critical configuration areas for setting up a
- distributed HBase cluster.</para>
- </section>
- </section>
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/hbase_apis.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/hbase_apis.xml b/src/main/docbkx/hbase_apis.xml
deleted file mode 100644
index bc35aba..0000000
--- a/src/main/docbkx/hbase_apis.xml
+++ /dev/null
@@ -1,133 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="hbase_apis"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase APIs</title>
- <para>This chapter provides information about performing operations using HBase native APIs. This
- information is not exhaustive, and provides a quick reference in addition to the <link
- xlink:href="http://hbase.apache.org/apidocs/index.html">User API
- Reference</link>. The examples here are not comprehensive or complete, and should be used for
- purposes of illustration only.</para>
- <para>Apache HBase also works with multiple external APIs. See <xref linkend="external_apis" />
- for more information.</para>
-
- <example>
- <title>Create a Table Using Java</title>
- <para>This example has been tested on HBase 0.96.1.1.</para>
- <programlisting language="java">
-package com.example.hbase.admin;
-
-import java.io.IOException;
-
-import org.apache.hadoop.hbase.HBaseConfiguration;
-import org.apache.hadoop.hbase.HColumnDescriptor;
-import org.apache.hadoop.hbase.HTableDescriptor;
-import org.apache.hadoop.hbase.TableName;
-import org.apache.hadoop.hbase.client.HBaseAdmin;
-import org.apache.hadoop.hbase.io.compress.Compression.Algorithm;
-import org.apache.hadoop.conf.Configuration;
-
-import static com.example.hbase.Constants.*;
-
-public class CreateSchema {
-
- public static void createOrOverwrite(HBaseAdmin admin, HTableDescriptor table) throws IOException {
- if (admin.tableExists(table.getName())) {
- admin.disableTable(table.getName());
- admin.deleteTable(table.getName());
- }
- admin.createTable(table);
- }
-
- public static void createSchemaTables (Configuration config) {
- try {
- final HBaseAdmin admin = new HBaseAdmin(config);
- HTableDescriptor table = new HTableDescriptor(TableName.valueOf(TABLE_NAME));
- table.addFamily(new HColumnDescriptor(CF_DEFAULT).setCompressionType(Algorithm.SNAPPY));
-
- System.out.print("Creating table. ");
- createOrOverwrite(admin, table);
- System.out.println(" Done.");
-
- admin.close();
- } catch (Exception e) {
- e.printStackTrace();
- System.exit(-1);
- }
- }
-
-
-}
-
- </programlisting>
- </example>
- <example>
- <title>Add, Modify, and Delete a Table</title>
- <para>This example has been tested on HBase 0.96.1.1.</para>
- <programlisting language="java">
-public static void upgradeFrom0 (Configuration config) {
-
- try {
- final HBaseAdmin admin = new HBaseAdmin(config);
- TableName tableName = TableName.valueOf(TABLE_ASSETMETA);
- HTableDescriptor table_assetmeta = new HTableDescriptor(tableName);
- table_assetmeta.addFamily(new HColumnDescriptor(CF_DEFAULT).setCompressionType(Algorithm.SNAPPY));
-
- // Create a new table.
-
- System.out.print("Creating table_assetmeta. ");
- admin.createTable(table_assetmeta);
- System.out.println(" Done.");
-
- // Update existing table
- HColumnDescriptor newColumn = new HColumnDescriptor("NEWCF");
- newColumn.setCompactionCompressionType(Algorithm.GZ);
- newColumn.setMaxVersions(HConstants.ALL_VERSIONS);
- admin.addColumn(tableName, newColumn);
-
- // Disable an existing table
- admin.disableTable(tableName);
-
- // Delete an existing column family
- admin.deleteColumn(tableName, CF_DEFAULT);
-
- // Delete a table (Need to be disabled first)
- admin.deleteTable(tableName);
-
-
- admin.close();
- } catch (Exception e) {
- e.printStackTrace();
- System.exit(-1);
- }
- }
- </programlisting>
- </example>
-
-</chapter>
[06/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/rpc.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/rpc.xml b/src/main/docbkx/rpc.xml
deleted file mode 100644
index 2e5dd5f..0000000
--- a/src/main/docbkx/rpc.xml
+++ /dev/null
@@ -1,301 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix
- xml:id="hbase.rpc"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>0.95 RPC Specification</title>
- <para>In 0.95, all client/server communication is done with <link
- xlink:href="https://code.google.com/p/protobuf/">protobuf’ed</link> Messages rather than
- with <link
- xlink:href="http://hadoop.apache.org/docs/current/api/org/apache/hadoop/io/Writable.html">Hadoop
- Writables</link>. Our RPC wire format therefore changes. This document describes the
- client/server request/response protocol and our new RPC wire-format.</para>
- <para />
- <para>For what RPC is like in 0.94 and previous, see Benoît/Tsuna’s <link
- xlink:href="https://github.com/OpenTSDB/asynchbase/blob/master/src/HBaseRpc.java#L164">Unofficial
- Hadoop / HBase RPC protocol documentation</link>. For more background on how we arrived
- at this spec., see <link
- xlink:href="https://docs.google.com/document/d/1WCKwgaLDqBw2vpux0jPsAu2WPTRISob7HGCO8YhfDTA/edit#">HBase
- RPC: WIP</link></para>
- <para />
- <section>
- <title>Goals</title>
- <para>
- <orderedlist>
- <listitem>
- <para>A wire-format we can evolve</para>
- </listitem>
- <listitem>
- <para>A format that does not require our rewriting server core or radically
- changing its current architecture (for later).</para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>TODO</title>
- <para>
- <orderedlist>
- <listitem>
- <para>List of problems with currently specified format and where we would like
- to go in a version2, etc. For example, what would we have to change if
- anything to move server async or to support streaming/chunking?</para>
- </listitem>
- <listitem>
- <para>Diagram on how it works</para>
- </listitem>
- <listitem>
- <para>A grammar that succinctly describes the wire-format. Currently we have
- these words and the content of the rpc protobuf idl but a grammar for the
- back and forth would help with groking rpc. Also, a little state machine on
- client/server interactions would help with understanding (and ensuring
- correct implementation).</para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>RPC</title>
- <para>The client will send setup information on connection establish. Thereafter, the client
- invokes methods against the remote server sending a protobuf Message and receiving a
- protobuf Message in response. Communication is synchronous. All back and forth is
- preceded by an int that has the total length of the request/response. Optionally,
- Cells(KeyValues) can be passed outside of protobufs in follow-behind Cell blocks
- (because <link
- xlink:href="https://docs.google.com/document/d/1WEtrq-JTIUhlnlnvA0oYRLp0F8MKpEBeBSCFcQiacdw/edit#">we
- can’t protobuf megabytes of KeyValues</link> or Cells). These CellBlocks are encoded
- and optionally compressed.</para>
- <para />
- <para>For more detail on the protobufs involved, see the <link
- xlink:href="http://svn.apache.org/viewvc/hbase/trunk/hbase-protocol/src/main/protobuf/RPC.proto?view=markup">RPC.proto</link>
- file in trunk.</para>
-
- <section>
- <title>Connection Setup</title>
- <para>Client initiates connection.</para>
- <section>
- <title>Client</title>
- <para>On connection setup, client sends a preamble followed by a connection header. </para>
-
- <section>
- <title><preamble></title>
- <programlisting><MAGIC 4 byte integer> <1 byte RPC Format Version> <1 byte auth type></programlisting>
- <para> We need the auth method spec. here so the connection header is encoded if auth enabled.</para>
- <para>E.g.: HBas0x000x50 -- 4 bytes of MAGIC -- ‘HBas’ -- plus one-byte of
- version, 0 in this case, and one byte, 0x50 (SIMPLE). of an auth
- type.</para>
- </section>
-
- <section>
- <title><Protobuf ConnectionHeader Message></title>
- <para>Has user info, and “protocol”, as well as the encoders and compression the
- client will use sending CellBlocks. CellBlock encoders and compressors are
- for the life of the connection. CellBlock encoders implement
- org.apache.hadoop.hbase.codec.Codec. CellBlocks may then also be compressed.
- Compressors implement org.apache.hadoop.io.compress.CompressionCodec. This
- protobuf is written using writeDelimited so is prefaced by a pb varint with
- its serialized length</para>
- </section>
- </section>
- <!--Client-->
-
- <section>
- <title>Server</title>
- <para>After client sends preamble and connection header, server does NOT respond if
- successful connection setup. No response means server is READY to accept
- requests and to give out response. If the version or authentication in the
- preamble is not agreeable or the server has trouble parsing the preamble, it
- will throw a org.apache.hadoop.hbase.ipc.FatalConnectionException explaining the
- error and will then disconnect. If the client in the connection header -- i.e.
- the protobuf’d Message that comes after the connection preamble -- asks for for
- a Service the server does not support or a codec the server does not have, again
- we throw a FatalConnectionException with explanation.</para>
- </section>
- </section>
-
- <section>
- <title>Request</title>
- <para>After a Connection has been set up, client makes requests. Server responds.</para>
- <para>A request is made up of a protobuf RequestHeader followed by a protobuf Message
- parameter. The header includes the method name and optionally, metadata on the
- optional CellBlock that may be following. The parameter type suits the method being
- invoked: i.e. if we are doing a getRegionInfo request, the protobuf Message param
- will be an instance of GetRegionInfoRequest. The response will be a
- GetRegionInfoResponse. The CellBlock is optionally used ferrying the bulk of the RPC
- data: i.e Cells/KeyValues.</para>
- <section>
- <title>Request Parts</title>
- <section>
- <title><Total Length></title>
- <para>The request is prefaced by an int that holds the total length of what
- follows.</para>
- </section>
- <section>
- <title><Protobuf RequestHeader Message></title>
- <para>Will have call.id, trace.id, and method name, etc. including optional
- Metadata on the Cell block IFF one is following. Data is protobuf’d inline
- in this pb Message or optionally comes in the following CellBlock</para>
- </section>
- <section>
- <title><Protobuf Param Message></title>
- <para>If the method being invoked is getRegionInfo, if you study the Service
- descriptor for the client to regionserver protocol, you will find that the
- request sends a GetRegionInfoRequest protobuf Message param in this
- position.</para>
- </section>
- <section>
- <title><CellBlock></title>
- <para>An encoded and optionally compressed Cell block.</para>
- </section>
- </section>
- <!--Request parts-->
- </section>
- <!--Request-->
-
- <section>
- <title>Response</title>
- <para>Same as Request, it is a protobuf ResponseHeader followed by a protobuf Message
- response where the Message response type suits the method invoked. Bulk of the data
- may come in a following CellBlock.</para>
- <section>
- <title>Response Parts</title>
- <section>
- <title><Total Length></title>
- <para>The response is prefaced by an int that holds the total length of what
- follows.</para>
- </section>
- <section>
- <title><Protobuf ResponseHeader Message></title>
- <para>Will have call.id, etc. Will include exception if failed processing.
- Optionally includes metadata on optional, IFF there is a CellBlock
- following.</para>
- </section>
-
- <section>
- <title><Protobuf Response Message></title>
- <para>Return or may be nothing if exception. If the method being invoked is
- getRegionInfo, if you study the Service descriptor for the client to
- regionserver protocol, you will find that the response sends a
- GetRegionInfoResponse protobuf Message param in this position.</para>
- </section>
- <section>
- <title><CellBlock></title>
- <para>An encoded and optionally compressed Cell block.</para>
- </section>
- </section>
- <!--Parts-->
- </section>
- <!--Response-->
-
- <section>
- <title>Exceptions</title>
- <para>There are two distinct types. There is the request failed which is encapsulated
- inside the response header for the response. The connection stays open to receive
- new requests. The second type, the FatalConnectionException, kills the
- connection.</para>
- <para>Exceptions can carry extra information. See the ExceptionResponse protobuf type.
- It has a flag to indicate do-no-retry as well as other miscellaneous payload to help
- improve client responsiveness.</para>
- </section>
- <section>
- <title>CellBlocks</title>
- <para>These are not versioned. Server can do the codec or it cannot. If new version of a
- codec with say, tighter encoding, then give it a new class name. Codecs will live on
- the server for all time so old clients can connect.</para>
- </section>
- </section>
-
-
- <section>
- <title>Notes</title>
- <section>
- <title>Constraints</title>
- <para>In some part, current wire-format -- i.e. all requests and responses preceeded by
- a length -- has been dictated by current server non-async architecture.</para>
- </section>
- <section>
- <title>One fat pb request or header+param</title>
- <para>We went with pb header followed by pb param making a request and a pb header
- followed by pb response for now. Doing header+param rather than a single protobuf
- Message with both header and param content:</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Is closer to what we currently have</para>
- </listitem>
- <listitem>
- <para>Having a single fat pb requires extra copying putting the already pb’d
- param into the body of the fat request pb (and same making
- result)</para>
- </listitem>
- <listitem>
- <para>We can decide whether to accept the request or not before we read the
- param; for example, the request might be low priority. As is, we read
- header+param in one go as server is currently implemented so this is a
- TODO.</para>
- </listitem>
- </orderedlist>
- </para>
- <para>The advantages are minor. If later, fat request has clear advantage, can roll out
- a v2 later.</para>
- </section>
- <section
- xml:id="rpc.configs">
- <title>RPC Configurations</title>
- <section>
- <title>CellBlock Codecs</title>
- <para>To enable a codec other than the default <classname>KeyValueCodec</classname>,
- set <varname>hbase.client.rpc.codec</varname> to the name of the Codec class to
- use. Codec must implement hbase's <classname>Codec</classname> Interface. After
- connection setup, all passed cellblocks will be sent with this codec. The server
- will return cellblocks using this same codec as long as the codec is on the
- servers' CLASSPATH (else you will get
- <classname>UnsupportedCellCodecException</classname>).</para>
- <para>To change the default codec, set
- <varname>hbase.client.default.rpc.codec</varname>. </para>
- <para>To disable cellblocks completely and to go pure protobuf, set the default to
- the empty String and do not specify a codec in your Configuration. So, set
- <varname>hbase.client.default.rpc.codec</varname> to the empty string and do
- not set <varname>hbase.client.rpc.codec</varname>. This will cause the client to
- connect to the server with no codec specified. If a server sees no codec, it
- will return all responses in pure protobuf. Running pure protobuf all the time
- will be slower than running with cellblocks. </para>
- </section>
- <section>
- <title>Compression</title>
- <para>Uses hadoops compression codecs. To enable compressing of passed CellBlocks,
- set <varname>hbase.client.rpc.compressor</varname> to the name of the Compressor
- to use. Compressor must implement Hadoops' CompressionCodec Interface. After
- connection setup, all passed cellblocks will be sent compressed. The server will
- return cellblocks compressed using this same compressor as long as the
- compressor is on its CLASSPATH (else you will get
- <classname>UnsupportedCompressionCodecException</classname>).</para>
- </section>
- </section>
- </section>
-</appendix>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/schema_design.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/schema_design.xml b/src/main/docbkx/schema_design.xml
deleted file mode 100644
index 65e64b0..0000000
--- a/src/main/docbkx/schema_design.xml
+++ /dev/null
@@ -1,1247 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="schema"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- *
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>HBase and Schema Design</title>
- <para>A good general introduction on the strength and weaknesses modelling on the various
- non-rdbms datastores is Ian Varley's Master thesis, <link
- xlink:href="http://ianvarley.com/UT/MR/Varley_MastersReport_Full_2009-08-07.pdf">No Relation:
- The Mixed Blessings of Non-Relational Databases</link>. Recommended. Also, read <xref
- linkend="keyvalue" /> for how HBase stores data internally, and the section on <xref
- linkend="schema.casestudies" />. </para>
- <section
- xml:id="schema.creation">
- <title> Schema Creation </title>
- <para>HBase schemas can be created or updated with <xref
- linkend="shell" /> or by using <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HBaseAdmin.html">HBaseAdmin</link>
- in the Java API. </para>
- <para>Tables must be disabled when making ColumnFamily modifications, for example:</para>
- <programlisting language="java">
-Configuration config = HBaseConfiguration.create();
-HBaseAdmin admin = new HBaseAdmin(conf);
-String table = "myTable";
-
-admin.disableTable(table);
-
-HColumnDescriptor cf1 = ...;
-admin.addColumn(table, cf1); // adding new ColumnFamily
-HColumnDescriptor cf2 = ...;
-admin.modifyColumn(table, cf2); // modifying existing ColumnFamily
-
-admin.enableTable(table);
- </programlisting>
- <para>See <xref
- linkend="client_dependencies" /> for more information about configuring client
- connections.</para>
- <para>Note: online schema changes are supported in the 0.92.x codebase, but the 0.90.x codebase
- requires the table to be disabled. </para>
- <section
- xml:id="schema.updates">
- <title>Schema Updates</title>
- <para>When changes are made to either Tables or ColumnFamilies (e.g., region size, block
- size), these changes take effect the next time there is a major compaction and the
- StoreFiles get re-written. </para>
- <para>See <xref
- linkend="store" /> for more information on StoreFiles. </para>
- </section>
- </section>
- <section
- xml:id="number.of.cfs">
- <title> On the number of column families </title>
- <para> HBase currently does not do well with anything above two or three column families so keep
- the number of column families in your schema low. Currently, flushing and compactions are done
- on a per Region basis so if one column family is carrying the bulk of the data bringing on
- flushes, the adjacent families will also be flushed though the amount of data they carry is
- small. When many column families the flushing and compaction interaction can make for a bunch
- of needless i/o loading (To be addressed by changing flushing and compaction to work on a per
- column family basis). For more information on compactions, see <xref
- linkend="compaction" />. </para>
- <para>Try to make do with one column family if you can in your schemas. Only introduce a second
- and third column family in the case where data access is usually column scoped; i.e. you query
- one column family or the other but usually not both at the one time. </para>
- <section
- xml:id="number.of.cfs.card">
- <title>Cardinality of ColumnFamilies</title>
- <para>Where multiple ColumnFamilies exist in a single table, be aware of the cardinality
- (i.e., number of rows). If ColumnFamilyA has 1 million rows and ColumnFamilyB has 1 billion
- rows, ColumnFamilyA's data will likely be spread across many, many regions (and
- RegionServers). This makes mass scans for ColumnFamilyA less efficient. </para>
- </section>
- </section>
- <section
- xml:id="rowkey.design">
- <title>Rowkey Design</title>
- <section>
- <title>Hotspotting</title>
- <para>Rows in HBase are sorted lexicographically by row key. This design optimizes for scans,
- allowing you to store related rows, or rows that will be read together, near each other.
- However, poorly designed row keys are a common source of <firstterm>hotspotting</firstterm>.
- Hotspotting occurs when a large amount of client traffic is directed at one node, or only a
- few nodes, of a cluster. This traffic may represent reads, writes, or other operations. The
- traffic overwhelms the single machine responsible for hosting that region, causing
- performance degradation and potentially leading to region unavailability. This can also have
- adverse effects on other regions hosted by the same region server as that host is unable to
- service the requested load. It is important to design data access patterns such that the
- cluster is fully and evenly utilized.</para>
- <para>To prevent hotspotting on writes, design your row keys such that rows that truly do need
- to be in the same region are, but in the bigger picture, data is being written to multiple
- regions across the cluster, rather than one at a time. Some common techniques for avoiding
- hotspotting are described below, along with some of their advantages and drawbacks.</para>
- <formalpara>
- <title>Salting</title>
- <para>Salting in this sense has nothing to do with cryptography, but refers to adding random
- data to the start of a row key. In this case, salting refers to adding a randomly-assigned
- prefix to the row key to cause it to sort differently than it otherwise would. The number
- of possible prefixes correspond to the number of regions you want to spread the data
- across. Salting can be helpful if you have a few "hot" row key patterns which come up over
- and over amongst other more evenly-distributed rows. Consider the following example, which
- shows that salting can spread write load across multiple regionservers, and illustrates
- some of the negative implications for reads.</para>
- </formalpara>
- <example>
- <title>Salting Example</title>
- <para>Suppose you have the following list of row keys, and your table is split such that
- there is one region for each letter of the alphabet. Prefix 'a' is one region, prefix 'b'
- is another. In this table, all rows starting with 'f' are in the same region. This example
- focuses on rows with keys like the following:</para>
- <screen>
-foo0001
-foo0002
-foo0003
-foo0004
- </screen>
- <para>Now, imagine that you would like to spread these across four different regions. You
- decide to use four different salts: <literal>a</literal>, <literal>b</literal>,
- <literal>c</literal>, and <literal>d</literal>. In this scenario, each of these letter
- prefixes will be on a different region. After applying the salts, you have the following
- rowkeys instead. Since you can now write to four separate regions, you theoretically have
- four times the throughput when writing that you would have if all the writes were going to
- the same region.</para>
- <screen>
-a-foo0003
-b-foo0001
-c-foo0004
-d-foo0002
- </screen>
- <para>Then, if you add another row, it will randomly be assigned one of the four possible
- salt values and end up near one of the existing rows.</para>
- <screen>
-a-foo0003
-b-foo0001
-<emphasis>c-foo0003</emphasis>
-c-foo0004
-d-foo0002
- </screen>
- <para>Since this assignment will be random, you will need to do more work if you want to
- retrieve the rows in lexicographic order. In this way, salting attempts to increase
- throughput on writes, but has a cost during reads.</para>
- </example>
- <para></para>
- <formalpara>
- <title>Hashing</title>
- <para>Instead of a random assignment, you could use a one-way <firstterm>hash</firstterm>
- that would cause a given row to always be "salted" with the same prefix, in a way that
- would spread the load across the regionservers, but allow for predictability during reads.
- Using a deterministic hash allows the client to reconstruct the complete rowkey and use a
- Get operation to retrieve that row as normal.</para>
- </formalpara>
- <example>
- <title>Hashing Example</title>
- <para>Given the same situation in the salting example above, you could instead apply a
- one-way hash that would cause the row with key <literal>foo0003</literal> to always, and
- predictably, receive the <literal>a</literal> prefix. Then, to retrieve that row, you
- would already know the key. You could also optimize things so that certain pairs of keys
- were always in the same region, for instance.</para>
- </example>
- <formalpara>
- <title>Reversing the Key</title>
- <para>A third common trick for preventing hotspotting is to reverse a fixed-width or numeric
- row key so that the part that changes the most often (the least significant digit) is first.
- This effectively randomizes row keys, but sacrifices row ordering properties.</para>
- </formalpara>
- <para>See <link
- xlink:href="https://communities.intel.com/community/itpeernetwork/datastack/blog/2013/11/10/discussion-on-designing-hbase-tables"
- >https://communities.intel.com/community/itpeernetwork/datastack/blog/2013/11/10/discussion-on-designing-hbase-tables</link>,
- and <link xlink:href="http://phoenix.apache.org/salted.html">article on Salted Tables</link>
- from the Phoenix project, and the discussion in the comments of <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11682">HBASE-11682</link> for more
- information about avoiding hotspotting.</para>
- </section>
- <section
- xml:id="timeseries">
- <title> Monotonically Increasing Row Keys/Timeseries Data </title>
- <para> In the HBase chapter of Tom White's book <link
- xlink:href="http://oreilly.com/catalog/9780596521981">Hadoop: The Definitive Guide</link>
- (O'Reilly) there is a an optimization note on watching out for a phenomenon where an import
- process walks in lock-step with all clients in concert pounding one of the table's regions
- (and thus, a single node), then moving onto the next region, etc. With monotonically
- increasing row-keys (i.e., using a timestamp), this will happen. See this comic by IKai Lan
- on why monotonically increasing row keys are problematic in BigTable-like datastores: <link
- xlink:href="http://ikaisays.com/2011/01/25/app-engine-datastore-tip-monotonically-increasing-values-are-bad/">monotonically
- increasing values are bad</link>. The pile-up on a single region brought on by
- monotonically increasing keys can be mitigated by randomizing the input records to not be in
- sorted order, but in general it's best to avoid using a timestamp or a sequence (e.g. 1, 2,
- 3) as the row-key. </para>
- <para>If you do need to upload time series data into HBase, you should study <link
- xlink:href="http://opentsdb.net/">OpenTSDB</link> as a successful example. It has a page
- describing the <link
- xlink:href=" http://opentsdb.net/schema.html">schema</link> it uses in HBase. The key
- format in OpenTSDB is effectively [metric_type][event_timestamp], which would appear at
- first glance to contradict the previous advice about not using a timestamp as the key.
- However, the difference is that the timestamp is not in the <emphasis>lead</emphasis>
- position of the key, and the design assumption is that there are dozens or hundreds (or
- more) of different metric types. Thus, even with a continual stream of input data with a mix
- of metric types, the Puts are distributed across various points of regions in the table. </para>
- <para>See <xref
- linkend="schema.casestudies" /> for some rowkey design examples. </para>
- </section>
- <section
- xml:id="keysize">
- <title>Try to minimize row and column sizes</title>
- <subtitle>Or why are my StoreFile indices large?</subtitle>
- <para>In HBase, values are always freighted with their coordinates; as a cell value passes
- through the system, it'll be accompanied by its row, column name, and timestamp - always. If
- your rows and column names are large, especially compared to the size of the cell value,
- then you may run up against some interesting scenarios. One such is the case described by
- Marc Limotte at the tail of <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-3551?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13005272#comment-13005272">HBASE-3551</link>
- (recommended!). Therein, the indices that are kept on HBase storefiles (<xref
- linkend="hfile" />) to facilitate random access may end up occupyng large chunks of the
- HBase allotted RAM because the cell value coordinates are large. Mark in the above cited
- comment suggests upping the block size so entries in the store file index happen at a larger
- interval or modify the table schema so it makes for smaller rows and column names.
- Compression will also make for larger indices. See the thread <link
- xlink:href="http://search-hadoop.com/m/hemBv1LiN4Q1/a+question+storefileIndexSize&subj=a+question+storefileIndexSize">a
- question storefileIndexSize</link> up on the user mailing list. </para>
- <para>Most of the time small inefficiencies don't matter all that much. Unfortunately, this is
- a case where they do. Whatever patterns are selected for ColumnFamilies, attributes, and
- rowkeys they could be repeated several billion times in your data. </para>
- <para>See <xref
- linkend="keyvalue" /> for more information on HBase stores data internally to see why this
- is important.</para>
- <section
- xml:id="keysize.cf">
- <title>Column Families</title>
- <para>Try to keep the ColumnFamily names as small as possible, preferably one character
- (e.g. "d" for data/default). </para>
- <para>See <xref
- linkend="keyvalue" /> for more information on HBase stores data internally to see why
- this is important.</para>
- </section>
- <section
- xml:id="keysize.attributes">
- <title>Attributes</title>
- <para>Although verbose attribute names (e.g., "myVeryImportantAttribute") are easier to
- read, prefer shorter attribute names (e.g., "via") to store in HBase. </para>
- <para>See <xref
- linkend="keyvalue" /> for more information on HBase stores data internally to see why
- this is important.</para>
- </section>
- <section
- xml:id="keysize.row">
- <title>Rowkey Length</title>
- <para>Keep them as short as is reasonable such that they can still be useful for required
- data access (e.g., Get vs. Scan). A short key that is useless for data access is not
- better than a longer key with better get/scan properties. Expect tradeoffs when designing
- rowkeys. </para>
- </section>
- <section
- xml:id="keysize.patterns">
- <title>Byte Patterns</title>
- <para>A long is 8 bytes. You can store an unsigned number up to 18,446,744,073,709,551,615
- in those eight bytes. If you stored this number as a String -- presuming a byte per
- character -- you need nearly 3x the bytes. </para>
- <para>Not convinced? Below is some sample code that you can run on your own.</para>
- <programlisting language="java">
-// long
-//
-long l = 1234567890L;
-byte[] lb = Bytes.toBytes(l);
-System.out.println("long bytes length: " + lb.length); // returns 8
-
-String s = "" + l;
-byte[] sb = Bytes.toBytes(s);
-System.out.println("long as string length: " + sb.length); // returns 10
-
-// hash
-//
-MessageDigest md = MessageDigest.getInstance("MD5");
-byte[] digest = md.digest(Bytes.toBytes(s));
-System.out.println("md5 digest bytes length: " + digest.length); // returns 16
-
-String sDigest = new String(digest);
-byte[] sbDigest = Bytes.toBytes(sDigest);
-System.out.println("md5 digest as string length: " + sbDigest.length); // returns 26
- </programlisting>
- <para>Unfortunately, using a binary representation of a type will make your data harder to
- read outside of your code. For example, this is what you will see in the shell when you
- increment a value:</para>
- <programlisting>
-hbase(main):001:0> incr 't', 'r', 'f:q', 1
-COUNTER VALUE = 1
-
-hbase(main):002:0> get 't', 'r'
-COLUMN CELL
- f:q timestamp=1369163040570, value=\x00\x00\x00\x00\x00\x00\x00\x01
-1 row(s) in 0.0310 seconds
- </programlisting>
- <para>The shell makes a best effort to print a string, and it this case it decided to just
- print the hex. The same will happen to your row keys inside the region names. It can be
- okay if you know what's being stored, but it might also be unreadable if arbitrary data
- can be put in the same cells. This is the main trade-off. </para>
- </section>
-
- </section>
- <section
- xml:id="reverse.timestamp">
- <title>Reverse Timestamps</title>
- <note>
- <title>Reverse Scan API</title>
- <para>
- <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-4811">HBASE-4811</link>
- implements an API to scan a table or a range within a table in reverse, reducing the need
- to optimize your schema for forward or reverse scanning. This feature is available in
- HBase 0.98 and later. See <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html#setReversed%28boolean" />
- for more information. </para>
- </note>
-
- <para>A common problem in database processing is quickly finding the most recent version of a
- value. A technique using reverse timestamps as a part of the key can help greatly with a
- special case of this problem. Also found in the HBase chapter of Tom White's book Hadoop:
- The Definitive Guide (O'Reilly), the technique involves appending (<code>Long.MAX_VALUE -
- timestamp</code>) to the end of any key, e.g., [key][reverse_timestamp]. </para>
- <para>The most recent value for [key] in a table can be found by performing a Scan for [key]
- and obtaining the first record. Since HBase keys are in sorted order, this key sorts before
- any older row-keys for [key] and thus is first. </para>
- <para>This technique would be used instead of using <xref
- linkend="schema.versions" /> where the intent is to hold onto all versions "forever" (or a
- very long time) and at the same time quickly obtain access to any other version by using the
- same Scan technique. </para>
- </section>
- <section
- xml:id="rowkey.scope">
- <title>Rowkeys and ColumnFamilies</title>
- <para>Rowkeys are scoped to ColumnFamilies. Thus, the same rowkey could exist in each
- ColumnFamily that exists in a table without collision. </para>
- </section>
- <section
- xml:id="changing.rowkeys">
- <title>Immutability of Rowkeys</title>
- <para>Rowkeys cannot be changed. The only way they can be "changed" in a table is if the row
- is deleted and then re-inserted. This is a fairly common question on the HBase dist-list so
- it pays to get the rowkeys right the first time (and/or before you've inserted a lot of
- data). </para>
- </section>
- <section
- xml:id="rowkey.regionsplits">
- <title>Relationship Between RowKeys and Region Splits</title>
- <para>If you pre-split your table, it is <emphasis>critical</emphasis> to understand how your
- rowkey will be distributed across the region boundaries. As an example of why this is
- important, consider the example of using displayable hex characters as the lead position of
- the key (e.g., "0000000000000000" to "ffffffffffffffff"). Running those key ranges through
- <code>Bytes.split</code> (which is the split strategy used when creating regions in
- <code>HBaseAdmin.createTable(byte[] startKey, byte[] endKey, numRegions)</code> for 10
- regions will generate the following splits...</para>
- <screen>
-48 48 48 48 48 48 48 48 48 48 48 48 48 48 48 48 // 0
-54 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 -10 // 6
-61 -67 -67 -67 -67 -67 -67 -67 -67 -67 -67 -67 -67 -67 -67 -68 // =
-68 -124 -124 -124 -124 -124 -124 -124 -124 -124 -124 -124 -124 -124 -124 -126 // D
-75 75 75 75 75 75 75 75 75 75 75 75 75 75 75 72 // K
-82 18 18 18 18 18 18 18 18 18 18 18 18 18 18 14 // R
-88 -40 -40 -40 -40 -40 -40 -40 -40 -40 -40 -40 -40 -40 -40 -44 // X
-95 -97 -97 -97 -97 -97 -97 -97 -97 -97 -97 -97 -97 -97 -97 -102 // _
-102 102 102 102 102 102 102 102 102 102 102 102 102 102 102 102 // f
- </screen>
- <para>... (note: the lead byte is listed to the right as a comment.) Given that the first
- split is a '0' and the last split is an 'f', everything is great, right? Not so fast. </para>
- <para>The problem is that all the data is going to pile up in the first 2 regions and the last
- region thus creating a "lumpy" (and possibly "hot") region problem. To understand why, refer
- to an <link
- xlink:href="http://www.asciitable.com">ASCII Table</link>. '0' is byte 48, and 'f' is byte
- 102, but there is a huge gap in byte values (bytes 58 to 96) that will <emphasis>never
- appear in this keyspace</emphasis> because the only values are [0-9] and [a-f]. Thus, the
- middle regions regions will never be used. To make pre-spliting work with this example
- keyspace, a custom definition of splits (i.e., and not relying on the built-in split method)
- is required. </para>
- <para>Lesson #1: Pre-splitting tables is generally a best practice, but you need to pre-split
- them in such a way that all the regions are accessible in the keyspace. While this example
- demonstrated the problem with a hex-key keyspace, the same problem can happen with
- <emphasis>any</emphasis> keyspace. Know your data. </para>
- <para>Lesson #2: While generally not advisable, using hex-keys (and more generally,
- displayable data) can still work with pre-split tables as long as all the created regions
- are accessible in the keyspace. </para>
- <para>To conclude this example, the following is an example of how appropriate splits can be
- pre-created for hex-keys:. </para>
- <programlisting language="java"><![CDATA[public static boolean createTable(HBaseAdmin admin, HTableDescriptor table, byte[][] splits)
-throws IOException {
- try {
- admin.createTable( table, splits );
- return true;
- } catch (TableExistsException e) {
- logger.info("table " + table.getNameAsString() + " already exists");
- // the table already exists...
- return false;
- }
-}
-
-public static byte[][] getHexSplits(String startKey, String endKey, int numRegions) {
- byte[][] splits = new byte[numRegions-1][];
- BigInteger lowestKey = new BigInteger(startKey, 16);
- BigInteger highestKey = new BigInteger(endKey, 16);
- BigInteger range = highestKey.subtract(lowestKey);
- BigInteger regionIncrement = range.divide(BigInteger.valueOf(numRegions));
- lowestKey = lowestKey.add(regionIncrement);
- for(int i=0; i < numRegions-1;i++) {
- BigInteger key = lowestKey.add(regionIncrement.multiply(BigInteger.valueOf(i)));
- byte[] b = String.format("%016x", key).getBytes();
- splits[i] = b;
- }
- return splits;
-}]]></programlisting>
- </section>
- </section>
- <!-- rowkey design -->
- <section
- xml:id="schema.versions">
- <title> Number of Versions </title>
- <section
- xml:id="schema.versions.max">
- <title>Maximum Number of Versions</title>
- <para>The maximum number of row versions to store is configured per column family via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html">HColumnDescriptor</link>.
- The default for max versions is 1. This is an important parameter because as described in <xref
- linkend="datamodel" /> section HBase does <emphasis>not</emphasis> overwrite row values,
- but rather stores different values per row by time (and qualifier). Excess versions are
- removed during major compactions. The number of max versions may need to be increased or
- decreased depending on application needs. </para>
- <para>It is not recommended setting the number of max versions to an exceedingly high level
- (e.g., hundreds or more) unless those old values are very dear to you because this will
- greatly increase StoreFile size. </para>
- </section>
- <section
- xml:id="schema.minversions">
- <title> Minimum Number of Versions </title>
- <para>Like maximum number of row versions, the minimum number of row versions to keep is
- configured per column family via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html">HColumnDescriptor</link>.
- The default for min versions is 0, which means the feature is disabled. The minimum number
- of row versions parameter is used together with the time-to-live parameter and can be
- combined with the number of row versions parameter to allow configurations such as "keep the
- last T minutes worth of data, at most N versions, <emphasis>but keep at least M versions
- around</emphasis>" (where M is the value for minimum number of row versions, M<N). This
- parameter should only be set when time-to-live is enabled for a column family and must be
- less than the number of row versions. </para>
- </section>
- </section>
- <section
- xml:id="supported.datatypes">
- <title> Supported Datatypes </title>
- <para>HBase supports a "bytes-in/bytes-out" interface via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Put.html">Put</link>
- and <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Result.html">Result</link>,
- so anything that can be converted to an array of bytes can be stored as a value. Input could
- be strings, numbers, complex objects, or even images as long as they can rendered as bytes. </para>
- <para>There are practical limits to the size of values (e.g., storing 10-50MB objects in HBase
- would probably be too much to ask); search the mailling list for conversations on this topic.
- All rows in HBase conform to the <xref
- linkend="datamodel" />, and that includes versioning. Take that into consideration when
- making your design, as well as block size for the ColumnFamily. </para>
-
- <section
- xml:id="counters">
- <title>Counters</title>
- <para> One supported datatype that deserves special mention are "counters" (i.e., the ability
- to do atomic increments of numbers). See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html#increment%28org.apache.hadoop.hbase.client.Increment%29">Increment</link>
- in HTable. </para>
- <para>Synchronization on counters are done on the RegionServer, not in the client. </para>
- </section>
- </section>
- <section
- xml:id="schema.joins">
- <title>Joins</title>
- <para>If you have multiple tables, don't forget to factor in the potential for <xref
- linkend="joins" /> into the schema design. </para>
- </section>
- <section
- xml:id="ttl">
- <title>Time To Live (TTL)</title>
- <para> ColumnFamilies can set a TTL length in seconds, and HBase will automatically delete rows
- once the expiration time is reached. This applies to <emphasis>all</emphasis> versions of a
- row - even the current one. The TTL time encoded in the HBase for the row is specified in UTC.
- </para>
- <para> Store files which contains only expired rows are deleted on minor compaction. Setting
- <varname>hbase.store.delete.expired.storefile</varname> to <code>false</code> disables this
- feature. Setting <link linkend="schema.minversions">minimum number of versions</link> to other
- than 0 also disables this.</para>
- <para> See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html"
- >HColumnDescriptor</link> for more information. </para>
- </section>
- <section
- xml:id="cf.keep.deleted">
- <title> Keeping Deleted Cells </title>
- <para>By default, delete markers extend back to the beginning of time. Therefore, <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Get.html">Get</link>
- or <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">Scan</link>
- operations will not see a deleted cell (row or column), even when the Get or Scan operation
- indicates a time range
- before the delete marker was placed.</para>
- <para>ColumnFamilies can optionally keep deleted cells. In this case, deleted cells can still be
- retrieved, as long as these operations specify a time range that ends before the timestamp of
- any delete that would affect the cells. This allows for point-in-time queries even in the
- presence of deletes. </para>
- <para> Deleted cells are still subject to TTL and there will never be more than "maximum number
- of versions" deleted cells. A new "raw" scan options returns all deleted rows and the delete
- markers. </para>
- <example>
- <title>Change the Value of <code>KEEP_DELETED_CELLS</code> Using HBase Shell</title>
- <screen>hbase> hbase> alter ‘t1′, NAME => ‘f1′, KEEP_DELETED_CELLS => true</screen>
- </example>
- <example>
- <title>Change the Value of <code>KEEP_DELETED_CELLS</code> Using the API</title>
- <programlisting language="java">...
-HColumnDescriptor.setKeepDeletedCells(true);
-...
- </programlisting>
- </example>
- <para>See the API documentation for <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html#KEEP_DELETED_CELLS"
- >KEEP_DELETED_CELLS</link> for more information. </para>
- </section>
- <section
- xml:id="secondary.indexes">
- <title> Secondary Indexes and Alternate Query Paths </title>
- <para>This section could also be titled "what if my table rowkey looks like
- <emphasis>this</emphasis> but I also want to query my table like <emphasis>that</emphasis>."
- A common example on the dist-list is where a row-key is of the format "user-timestamp" but
- there are reporting requirements on activity across users for certain time ranges. Thus,
- selecting by user is easy because it is in the lead position of the key, but time is not. </para>
- <para>There is no single answer on the best way to handle this because it depends on... </para>
- <itemizedlist>
- <listitem>
- <para>Number of users</para>
- </listitem>
- <listitem>
- <para>Data size and data arrival rate</para>
- </listitem>
- <listitem>
- <para>Flexibility of reporting requirements (e.g., completely ad-hoc date selection vs.
- pre-configured ranges) </para>
- </listitem>
- <listitem>
- <para>Desired execution speed of query (e.g., 90 seconds may be reasonable to some for an
- ad-hoc report, whereas it may be too long for others) </para>
- </listitem>
- </itemizedlist>
- <para>... and solutions are also influenced by the size of the cluster and how much processing
- power you have to throw at the solution. Common techniques are in sub-sections below. This is
- a comprehensive, but not exhaustive, list of approaches. </para>
- <para>It should not be a surprise that secondary indexes require additional cluster space and
- processing. This is precisely what happens in an RDBMS because the act of creating an
- alternate index requires both space and processing cycles to update. RDBMS products are more
- advanced in this regard to handle alternative index management out of the box. However, HBase
- scales better at larger data volumes, so this is a feature trade-off. </para>
- <para>Pay attention to <xref
- linkend="performance" /> when implementing any of these approaches.</para>
- <para>Additionally, see the David Butler response in this dist-list thread <link
- xlink:href="http://search-hadoop.com/m/nvbiBp2TDP/Stargate%252Bhbase&subj=Stargate+hbase">HBase,
- mail # user - Stargate+hbase</link>
- </para>
- <section
- xml:id="secondary.indexes.filter">
- <title> Filter Query </title>
- <para>Depending on the case, it may be appropriate to use <xref
- linkend="client.filter" />. In this case, no secondary index is created. However, don't
- try a full-scan on a large table like this from an application (i.e., single-threaded
- client). </para>
- </section>
- <section
- xml:id="secondary.indexes.periodic">
- <title> Periodic-Update Secondary Index </title>
- <para>A secondary index could be created in an other table which is periodically updated via a
- MapReduce job. The job could be executed intra-day, but depending on load-strategy it could
- still potentially be out of sync with the main data table.</para>
- <para>See <xref
- linkend="mapreduce.example.readwrite" /> for more information.</para>
- </section>
- <section
- xml:id="secondary.indexes.dualwrite">
- <title> Dual-Write Secondary Index </title>
- <para>Another strategy is to build the secondary index while publishing data to the cluster
- (e.g., write to data table, write to index table). If this is approach is taken after a data
- table already exists, then bootstrapping will be needed for the secondary index with a
- MapReduce job (see <xref
- linkend="secondary.indexes.periodic" />).</para>
- </section>
- <section
- xml:id="secondary.indexes.summary">
- <title> Summary Tables </title>
- <para>Where time-ranges are very wide (e.g., year-long report) and where the data is
- voluminous, summary tables are a common approach. These would be generated with MapReduce
- jobs into another table.</para>
- <para>See <xref
- linkend="mapreduce.example.summary" /> for more information.</para>
- </section>
- <section
- xml:id="secondary.indexes.coproc">
- <title> Coprocessor Secondary Index </title>
- <para>Coprocessors act like RDBMS triggers. These were added in 0.92. For more information,
- see <xref
- linkend="coprocessors" />
- </para>
- </section>
- </section>
- <section
- xml:id="constraints">
- <title>Constraints</title>
- <para>HBase currently supports 'constraints' in traditional (SQL) database parlance. The advised
- usage for Constraints is in enforcing business rules for attributes in the table (eg. make
- sure values are in the range 1-10). Constraints could also be used to enforce referential
- integrity, but this is strongly discouraged as it will dramatically decrease the write
- throughput of the tables where integrity checking is enabled. Extensive documentation on using
- Constraints can be found at: <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/constraint">Constraint</link>
- since version 0.94. </para>
- </section>
- <section
- xml:id="schema.casestudies">
- <title>Schema Design Case Studies</title>
- <para>The following will describe some typical data ingestion use-cases with HBase, and how the
- rowkey design and construction can be approached. Note: this is just an illustration of
- potential approaches, not an exhaustive list. Know your data, and know your processing
- requirements. </para>
- <para>It is highly recommended that you read the rest of the <xref
- linkend="schema" /> first, before reading these case studies. </para>
- <para>The following case studies are described: </para>
- <itemizedlist>
- <listitem>
- <para>Log Data / Timeseries Data</para>
- </listitem>
- <listitem>
- <para>Log Data / Timeseries on Steroids</para>
- </listitem>
- <listitem>
- <para>Customer/Order</para>
- </listitem>
- <listitem>
- <para>Tall/Wide/Middle Schema Design</para>
- </listitem>
- <listitem>
- <para>List Data</para>
- </listitem>
- </itemizedlist>
- <section
- xml:id="schema.casestudies.log-timeseries">
- <title>Case Study - Log Data and Timeseries Data</title>
- <para>Assume that the following data elements are being collected. </para>
- <itemizedlist>
- <listitem>
- <para>Hostname</para>
- </listitem>
- <listitem>
- <para>Timestamp</para>
- </listitem>
- <listitem>
- <para>Log event</para>
- </listitem>
- <listitem>
- <para>Value/message</para>
- </listitem>
- </itemizedlist>
- <para>We can store them in an HBase table called LOG_DATA, but what will the rowkey be? From
- these attributes the rowkey will be some combination of hostname, timestamp, and log-event -
- but what specifically? </para>
- <section
- xml:id="schema.casestudies.log-timeseries.tslead">
- <title>Timestamp In The Rowkey Lead Position</title>
- <para>The rowkey <code>[timestamp][hostname][log-event]</code> suffers from the
- monotonically increasing rowkey problem described in <xref
- linkend="timeseries" />. </para>
- <para>There is another pattern frequently mentioned in the dist-lists about “bucketing”
- timestamps, by performing a mod operation on the timestamp. If time-oriented scans are
- important, this could be a useful approach. Attention must be paid to the number of
- buckets, because this will require the same number of scans to return results.</para>
- <programlisting language="java">
-long bucket = timestamp % numBuckets;
- </programlisting>
- <para>… to construct:</para>
- <programlisting>
-[bucket][timestamp][hostname][log-event]
- </programlisting>
- <para>As stated above, to select data for a particular timerange, a Scan will need to be
- performed for each bucket. 100 buckets, for example, will provide a wide distribution in
- the keyspace but it will require 100 Scans to obtain data for a single timestamp, so there
- are trade-offs. </para>
- </section>
- <!-- ts lead -->
- <section
- xml:id="schema.casestudies.log-timeseries.hostlead">
- <title>Host In The Rowkey Lead Position</title>
- <para>The rowkey <code>[hostname][log-event][timestamp]</code> is a candidate if there is a
- large-ish number of hosts to spread the writes and reads across the keyspace. This
- approach would be useful if scanning by hostname was a priority. </para>
- </section>
- <!-- host lead -->
- <section
- xml:id="schema.casestudies.log-timeseries.revts">
- <title>Timestamp, or Reverse Timestamp?</title>
- <para>If the most important access path is to pull most recent events, then storing the
- timestamps as reverse-timestamps (e.g., <code>timestamp = Long.MAX_VALUE –
- timestamp</code>) will create the property of being able to do a Scan on
- <code>[hostname][log-event]</code> to obtain the quickly obtain the most recently
- captured events. </para>
- <para>Neither approach is wrong, it just depends on what is most appropriate for the
- situation. </para>
- <note>
- <title>Reverse Scan API</title>
- <para>
- <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-4811">HBASE-4811</link>
- implements an API to scan a table or a range within a table in reverse, reducing the
- need to optimize your schema for forward or reverse scanning. This feature is available
- in HBase 0.98 and later. See <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html#setReversed%28boolean" />
- for more information. </para>
- </note>
- </section>
- <!-- revts -->
- <section
- xml:id="schema.casestudies.log-timeseries.varkeys">
- <title>Variangle Length or Fixed Length Rowkeys?</title>
- <para>It is critical to remember that rowkeys are stamped on every column in HBase. If the
- hostname is “a” and the event type is “e1” then the resulting rowkey would be quite small.
- However, what if the ingested hostname is “myserver1.mycompany.com” and the event type is
- “com.package1.subpackage2.subsubpackage3.ImportantService”? </para>
- <para>It might make sense to use some substitution in the rowkey. There are at least two
- approaches: hashed and numeric. In the Hostname In The Rowkey Lead Position example, it
- might look like this: </para>
- <para>Composite Rowkey With Hashes:</para>
- <itemizedlist>
- <listitem>
- <para>[MD5 hash of hostname] = 16 bytes</para>
- </listitem>
- <listitem>
- <para>[MD5 hash of event-type] = 16 bytes</para>
- </listitem>
- <listitem>
- <para>[timestamp] = 8 bytes</para>
- </listitem>
- </itemizedlist>
- <para>Composite Rowkey With Numeric Substitution: </para>
- <para>For this approach another lookup table would be needed in addition to LOG_DATA, called
- LOG_TYPES. The rowkey of LOG_TYPES would be: </para>
- <itemizedlist>
- <listitem>
- <para>[type] (e.g., byte indicating hostname vs. event-type)</para>
- </listitem>
- <listitem>
- <para>[bytes] variable length bytes for raw hostname or event-type.</para>
- </listitem>
- </itemizedlist>
- <para>A column for this rowkey could be a long with an assigned number, which could be
- obtained by using an <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html#incrementColumnValue%28byte[],%20byte[],%20byte[],%20long%29">HBase
- counter</link>. </para>
- <para>So the resulting composite rowkey would be: </para>
- <itemizedlist>
- <listitem>
- <para>[substituted long for hostname] = 8 bytes</para>
- </listitem>
- <listitem>
- <para>[substituted long for event type] = 8 bytes</para>
- </listitem>
- <listitem>
- <para>[timestamp] = 8 bytes</para>
- </listitem>
- </itemizedlist>
- <para>In either the Hash or Numeric substitution approach, the raw values for hostname and
- event-type can be stored as columns. </para>
- </section>
- <!-- varkeys -->
- </section>
- <!-- log data and timeseries -->
- <section
- xml:id="schema.casestudies.log-steroids">
- <title>Case Study - Log Data and Timeseries Data on Steroids</title>
- <para>This effectively is the OpenTSDB approach. What OpenTSDB does is re-write data and pack
- rows into columns for certain time-periods. For a detailed explanation, see: <link
- xlink:href="http://opentsdb.net/schema.html">http://opentsdb.net/schema.html</link>, and <link
- xlink:href="http://www.cloudera.com/content/cloudera/en/resources/library/hbasecon/video-hbasecon-2012-lessons-learned-from-opentsdb.html">Lessons
- Learned from OpenTSDB</link> from HBaseCon2012. </para>
- <para>But this is how the general concept works: data is ingested, for example, in this
- manner…</para>
- <screen>
-[hostname][log-event][timestamp1]
-[hostname][log-event][timestamp2]
-[hostname][log-event][timestamp3]
- </screen>
- <para>… with separate rowkeys for each detailed event, but is re-written like this… </para>
- <screen>[hostname][log-event][timerange]</screen>
- <para>… and each of the above events are converted into columns stored with a time-offset
- relative to the beginning timerange (e.g., every 5 minutes). This is obviously a very
- advanced processing technique, but HBase makes this possible. </para>
- </section>
- <!-- log data timeseries steroids -->
-
- <section
- xml:id="schema.casestudies.custorder">
- <title>Case Study - Customer/Order</title>
- <para>Assume that HBase is used to store customer and order information. There are two core
- record-types being ingested: a Customer record type, and Order record type. </para>
- <para>The Customer record type would include all the things that you’d typically expect: </para>
- <itemizedlist>
- <listitem>
- <para>Customer number</para>
- </listitem>
- <listitem>
- <para>Customer name</para>
- </listitem>
- <listitem>
- <para>Address (e.g., city, state, zip)</para>
- </listitem>
- <listitem>
- <para>Phone numbers, etc.</para>
- </listitem>
- </itemizedlist>
- <para>The Order record type would include things like: </para>
- <itemizedlist>
- <listitem>
- <para>Customer number</para>
- </listitem>
- <listitem>
- <para>Order number</para>
- </listitem>
- <listitem>
- <para>Sales date</para>
- </listitem>
- <listitem>
- <para>A series of nested objects for shipping locations and line-items (see <xref
- linkend="schema.casestudies.custorder.obj" /> for details)</para>
- </listitem>
- </itemizedlist>
- <para>Assuming that the combination of customer number and sales order uniquely identify an
- order, these two attributes will compose the rowkey, and specifically a composite key such
- as: </para>
- <screen>[customer number][order number]</screen>
- <para>… for a ORDER table. However, there are more design decisions to make: are the
- <emphasis>raw</emphasis> values the best choices for rowkeys? </para>
- <para>The same design questions in the Log Data use-case confront us here. What is the
- keyspace of the customer number, and what is the format (e.g., numeric? alphanumeric?) As it
- is advantageous to use fixed-length keys in HBase, as well as keys that can support a
- reasonable spread in the keyspace, similar options appear: </para>
- <para>Composite Rowkey With Hashes: </para>
- <itemizedlist>
- <listitem>
- <para>[MD5 of customer number] = 16 bytes</para>
- </listitem>
- <listitem>
- <para>[MD5 of order number] = 16 bytes</para>
- </listitem>
- </itemizedlist>
- <para>Composite Numeric/Hash Combo Rowkey: </para>
- <itemizedlist>
- <listitem>
- <para>[substituted long for customer number] = 8 bytes</para>
- </listitem>
- <listitem>
- <para>[MD5 of order number] = 16 bytes</para>
- </listitem>
- </itemizedlist>
- <section
- xml:id="schema.casestudies.custorder.tables">
- <title>Single Table? Multiple Tables?</title>
- <para>A traditional design approach would have separate tables for CUSTOMER and SALES.
- Another option is to pack multiple record types into a single table (e.g., CUSTOMER++). </para>
- <para>Customer Record Type Rowkey: </para>
- <itemizedlist>
- <listitem>
- <para>[customer-id]</para>
- </listitem>
- <listitem>
- <para>[type] = type indicating ‘1’ for customer record type</para>
- </listitem>
- </itemizedlist>
- <para>Order Record Type Rowkey: </para>
- <itemizedlist>
- <listitem>
- <para>[customer-id]</para>
- </listitem>
- <listitem>
- <para>[type] = type indicating ‘2’ for order record type</para>
- </listitem>
- <listitem>
- <para>[order]</para>
- </listitem>
- </itemizedlist>
- <para>The advantage of this particular CUSTOMER++ approach is that organizes many different
- record-types by customer-id (e.g., a single scan could get you everything about that
- customer). The disadvantage is that it’s not as easy to scan for a particular record-type.
- </para>
- </section>
- <section
- xml:id="schema.casestudies.custorder.obj">
- <title>Order Object Design</title>
- <para>Now we need to address how to model the Order object. Assume that the class structure
- is as follows:</para>
- <variablelist>
- <varlistentry>
- <term>Order</term>
- <listitem>
- <para>(an Order can have multiple ShippingLocations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>LineItem</term>
- <listitem>
- <para>(a ShippingLocation can have multiple LineItems</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>... there are multiple options on storing this data. </para>
- <section
- xml:id="schema.casestudies.custorder.obj.norm">
- <title>Completely Normalized</title>
- <para>With this approach, there would be separate tables for ORDER, SHIPPING_LOCATION, and
- LINE_ITEM. </para>
- <para>The ORDER table's rowkey was described above: <xref
- linkend="schema.casestudies.custorder" />
- </para>
- <para>The SHIPPING_LOCATION's composite rowkey would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[shipping location number] (e.g., 1st location, 2nd, etc.)</para>
- </listitem>
- </itemizedlist>
- <para>The LINE_ITEM table's composite rowkey would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[shipping location number] (e.g., 1st location, 2nd, etc.)</para>
- </listitem>
- <listitem>
- <para>[line item number] (e.g., 1st lineitem, 2nd, etc.)</para>
- </listitem>
- </itemizedlist>
- <para>Such a normalized model is likely to be the approach with an RDBMS, but that's not
- your only option with HBase. The cons of such an approach is that to retrieve
- information about any Order, you will need: </para>
- <itemizedlist>
- <listitem>
- <para>Get on the ORDER table for the Order</para>
- </listitem>
- <listitem>
- <para>Scan on the SHIPPING_LOCATION table for that order to get the ShippingLocation
- instances</para>
- </listitem>
- <listitem>
- <para>Scan on the LINE_ITEM for each ShippingLocation</para>
- </listitem>
- </itemizedlist>
- <para>... granted, this is what an RDBMS would do under the covers anyway, but since there
- are no joins in HBase you're just more aware of this fact. </para>
- </section>
- <section
- xml:id="schema.casestudies.custorder.obj.rectype">
- <title>Single Table With Record Types</title>
- <para>With this approach, there would exist a single table ORDER that would contain </para>
- <para>The Order rowkey was described above: <xref
- linkend="schema.casestudies.custorder" /></para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[ORDER record type]</para>
- </listitem>
- </itemizedlist>
- <para>The ShippingLocation composite rowkey would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[SHIPPING record type]</para>
- </listitem>
- <listitem>
- <para>[shipping location number] (e.g., 1st location, 2nd, etc.)</para>
- </listitem>
- </itemizedlist>
- <para>The LineItem composite rowkey would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[LINE record type]</para>
- </listitem>
- <listitem>
- <para>[shipping location number] (e.g., 1st location, 2nd, etc.)</para>
- </listitem>
- <listitem>
- <para>[line item number] (e.g., 1st lineitem, 2nd, etc.)</para>
- </listitem>
- </itemizedlist>
- </section>
- <section
- xml:id="schema.casestudies.custorder.obj.denorm">
- <title>Denormalized</title>
- <para>A variant of the Single Table With Record Types approach is to denormalize and
- flatten some of the object hierarchy, such as collapsing the ShippingLocation attributes
- onto each LineItem instance. </para>
- <para>The LineItem composite rowkey would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>[order-rowkey]</para>
- </listitem>
- <listitem>
- <para>[LINE record type]</para>
- </listitem>
- <listitem>
- <para>[line item number] (e.g., 1st lineitem, 2nd, etc. - care must be taken that
- there are unique across the entire order)</para>
- </listitem>
- </itemizedlist>
- <para>... and the LineItem columns would be something like this: </para>
- <itemizedlist>
- <listitem>
- <para>itemNumber</para>
- </listitem>
- <listitem>
- <para>quantity</para>
- </listitem>
- <listitem>
- <para>price</para>
- </listitem>
- <listitem>
- <para>shipToLine1 (denormalized from ShippingLocation)</para>
- </listitem>
- <listitem>
- <para>shipToLine2 (denormalized from ShippingLocation)</para>
- </listitem>
- <listitem>
- <para>shipToCity (denormalized from ShippingLocation)</para>
- </listitem>
- <listitem>
- <para>shipToState (denormalized from ShippingLocation)</para>
- </listitem>
- <listitem>
- <para>shipToZip (denormalized from ShippingLocation)</para>
- </listitem>
- </itemizedlist>
- <para>The pros of this approach include a less complex object heirarchy, but one of the
- cons is that updating gets more complicated in case any of this information changes.
- </para>
- </section>
- <section
- xml:id="schema.casestudies.custorder.obj.singleobj">
- <title>Object BLOB</title>
- <para>With this approach, the entire Order object graph is treated, in one way or another,
- as a BLOB. For example, the ORDER table's rowkey was described above: <xref
- linkend="schema.casestudies.custorder" />, and a single column called "order" would
- contain an object that could be deserialized that contained a container Order,
- ShippingLocations, and LineItems. </para>
- <para>There are many options here: JSON, XML, Java Serialization, Avro, Hadoop Writables,
- etc. All of them are variants of the same approach: encode the object graph to a
- byte-array. Care should be taken with this approach to ensure backward compatibilty in
- case the object model changes such that older persisted structures can still be read
- back out of HBase. </para>
- <para>Pros are being able to manage complex object graphs with minimal I/O (e.g., a single
- HBase Get per Order in this example), but the cons include the aforementioned warning
- about backward compatiblity of serialization, language dependencies of serialization
- (e.g., Java Serialization only works with Java clients), the fact that you have to
- deserialize the entire object to get any piece of information inside the BLOB, and the
- difficulty in getting frameworks like Hive to work with custom objects like this.
- </para>
- </section>
- </section>
- <!-- cust/order order object -->
- </section>
- <!-- cust/order -->
-
- <section
- xml:id="schema.smackdown">
- <title>Case Study - "Tall/Wide/Middle" Schema Design Smackdown</title>
- <para>This section will describe additional schema design questions that appear on the
- dist-list, specifically about tall and wide tables. These are general guidelines and not
- laws - each application must consider its own needs. </para>
- <section
- xml:id="schema.smackdown.rowsversions">
- <title>Rows vs. Versions</title>
- <para>A common question is whether one should prefer rows or HBase's built-in-versioning.
- The context is typically where there are "a lot" of versions of a row to be retained
- (e.g., where it is significantly above the HBase default of 1 max versions). The
- rows-approach would require storing a timestamp in some portion of the rowkey so that they
- would not overwite with each successive update. </para>
- <para>Preference: Rows (generally speaking). </para>
- </section>
- <section
- xml:id="schema.smackdown.rowscols">
- <title>Rows vs. Columns</title>
- <para>Another common question is whether one should prefer rows or columns. The context is
- typically in extreme cases of wide tables, such as having 1 row with 1 million attributes,
- or 1 million rows with 1 columns apiece. </para>
- <para>Preference: Rows (generally speaking). To be clear, this guideline is in the context
- is in extremely wide cases, not in the standard use-case where one needs to store a few
- dozen or hundred columns. But there is also a middle path between these two options, and
- that is "Rows as Columns." </para>
- </section>
- <section
- xml:id="schema.smackdown.rowsascols">
- <title>Rows as Columns</title>
- <para>The middle path between Rows vs. Columns is packing data that would be a separate row
- into columns, for certain rows. OpenTSDB is the best example of this case where a single
- row represents a defined time-range, and then discrete events are treated as columns. This
- approach is often more complex, and may require the additional complexity of re-writing
- your data, but has the advantage of being I/O efficient. For an overview of this approach,
- see <xref
- linkend="schema.casestudies.log-steroids" />. </para>
- </section>
- </section>
- <!-- note: the following id is not consistent with the others becaus it was formerly in the Case Studies chapter,
- but I didn't want to break backward compatibility of the link. But future entries should look like the above case-study
- links (schema.casestudies. ...) -->
- <section
- xml:id="casestudies.schema.listdata">
- <title>Case Study - List Data</title>
- <para>The following is an exchange from the user dist-list regarding a fairly common question:
- how to handle per-user list data in Apache HBase. </para>
- <para>*** QUESTION ***</para>
- <para> We're looking at how to store a large amount of (per-user) list data in HBase, and we
- were trying to figure out what kind of access pattern made the most sense. One option is
- store the majority of the data in a key, so we could have something like: </para>
-
- <programlisting><![CDATA[
-<FixedWidthUserName><FixedWidthValueId1>:"" (no value)
-<FixedWidthUserName><FixedWidthValueId2>:"" (no value)
-<FixedWidthUserName><FixedWidthValueId3>:"" (no value)
-]]></programlisting>
-
- <para>The other option we had was to do this entirely using:</para>
- <programlisting language="xml"><![CDATA[
-<FixedWidthUserName><FixedWidthPageNum0>:<FixedWidthLength><FixedIdNextPageNum><ValueId1><ValueId2><ValueId3>...
-<FixedWidthUserName><FixedWidthPageNum1>:<FixedWidthLength><FixedIdNextPageNum><ValueId1><ValueId2><ValueId3>...
- ]]></programlisting>
- <para> where each row would contain multiple values. So in one case reading the first thirty
- values would be: </para>
- <programlisting language="java"><![CDATA[
-scan { STARTROW => 'FixedWidthUsername' LIMIT => 30}
- ]]></programlisting>
- <para>And in the second case it would be </para>
- <programlisting>
-get 'FixedWidthUserName\x00\x00\x00\x00'
- </programlisting>
- <para> The general usage pattern would be to read only the first 30 values of these lists,
- with infrequent access reading deeper into the lists. Some users would have <= 30 total
- values in these lists, and some users would have millions (i.e. power-law distribution) </para>
- <para> The single-value format seems like it would take up more space on HBase, but would
- offer some improved retrieval / pagination flexibility. Would there be any significant
- performance advantages to be able to paginate via gets vs paginating with scans? </para>
- <para> My initial understanding was that doing a scan should be faster if our paging size is
- unknown (and caching is set appropriately), but that gets should be faster if we'll always
- need the same page size. I've ended up hearing different people tell me opposite things
- about performance. I assume the page sizes would be relatively consistent, so for most use
- cases we could guarantee that we only wanted one page of data in the fixed-page-length case.
- I would also assume that we would have infrequent updates, but may have inserts into the
- middle of these lists (meaning we'd need to update all subsequent rows). </para>
- <para> Thanks for help / suggestions / follow-up questions. </para>
- <para>*** ANSWER ***</para>
- <para> If I understand you correctly, you're ultimately trying to store triples in the form
- "user, valueid, value", right? E.g., something like: </para>
- <programlisting>
-"user123, firstname, Paul",
-"user234, lastname, Smith"
- </programlisting>
- <para> (But the usernames are fixed width, and the valueids are fixed width). </para>
- <para> And, your access pattern is along the lines of: "for user X, list the next 30 values,
- starting with valueid Y". Is that right? And these values should be returned sorted by
- valueid? </para>
- <para> The tl;dr version is that you should probably go with one row per user+value, and not
- build a complicated intra-row pagination scheme on your own unless you're really sure it is
- needed. </para>
- <para> Your two options mirror a common question people have when designing HBase schemas:
- should I go "tall" or "wide"? Your first schema is "tall": each row represents one value for
- one user, and so there are many rows in the table for each user; the row key is user +
- valueid, and there would be (presumably) a single column qualifier that means "the value".
- This is great if you want to scan over rows in sorted order by row key (thus my question
- above, about whether these ids are sorted correctly). You can start a scan at any
- user+valueid, read the next 30, and be done. What you're giving up is the ability to have
- transactional guarantees around all the rows for one user, but it doesn't sound like you
- need that. Doing it this way is generally recommended (see here <link
- xlink:href="http://hbase.apache.org/book.html#schema.smackdown">http://hbase.apache.org/book.html#schema.smackdown</link>). </para>
- <para> Your second option is "wide": you store a bunch of values in one row, using different
- qualifiers (where the qualifier is the valueid). The simple way to do that would be to just
- store ALL values for one user in a single row. I'm guessing you jumped to the "paginated"
- version because you're assuming that storing millions of columns in a single row would be
- bad for performance, which may or may not be true; as long as you're not trying to do too
- much in a single request, or do things like scanning over and returning all of the cells in
- the row, it shouldn't be fundamentally worse. The client has methods that allow you to get
- specific slices of columns. </para>
- <para> Note that neither case fundamentally uses more disk space than the other; you're just
- "shifting" part of the identifying information for a value either to the left (into the row
- key, in option one) or to the right (into the column qualifiers in option 2). Under the
- covers, every key/value still stores the whole row key, and column family name. (If this is
- a bit confusing, take an hour and watch Lars George's excellent video about understanding
- HBase schema design: <link
- xlink:href="http://www.youtube.com/watch?v=_HLoH_PgrLk)">http://www.youtube.com/watch?v=_HLoH_PgrLk)</link>. </para>
- <para> A manually paginated version has lots more complexities, as you note, like having to
- keep track of how many things are in each page, re-shuffling if new values are inserted,
- etc. That seems significantly more complex. It might have some slight speed advantages (or
- disadvantages!) at extremely high throughput, and the only way to really know that would be
- to try it out. If you don't have time to build it both ways and compare, my advice would be
- to start with the simplest option (one row per user+value). Start simple and iterate! :)
- </para>
- </section>
- <!-- listdata -->
-
- </section>
- <!-- schema design cases -->
- <section
- xml:id="schema.ops">
- <title>Operational and Performance Configuration Options</title>
- <para>See the Performance section <xref
- linkend="perf.schema" /> for more information operational and performance schema design
- options, such as Bloom Filters, Table-configured regionsizes, compression, and blocksizes.
- </para>
- </section>
-
-</chapter>
-<!-- schema design -->
[11/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/cp.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/cp.xml b/src/main/docbkx/cp.xml
deleted file mode 100644
index 8624309..0000000
--- a/src/main/docbkx/cp.xml
+++ /dev/null
@@ -1,431 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="cp"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase Coprocessors</title>
- <para> HBase coprocessors are modeled after the coprocessors which are part of Google's BigTable
- (<link xlink:href="http://www.scribd.com/doc/21631448/Dean-Keynote-Ladis2009"/>, pages
- 66-67.). Coprocessors function in a similar way to Linux kernel modules. They provide a way to
- run server-level code against locally-stored data. The functionality they provide is very
- powerful, but also carries great risk and can have adverse effects on the system, at the level
- of the operating system. The information in this chapter is primarily sourced and heavily reused
- from Mingjie Lai's blog post at <link
- xlink:href="https://blogs.apache.org/hbase/entry/coprocessor_introduction"/>. </para>
-
- <para> Coprocessors are not designed to be used by end users of HBase, but by HBase developers who
- need to add specialized functionality to HBase. One example of the use of coprocessors is
- pluggable compaction and scan policies, which are provided as coprocessors in <link
- xlink:href="HBASE-6427">HBASE-6427</link>. </para>
-
- <section>
- <title>Coprocessor Framework</title>
- <para>The implementation of HBase coprocessors diverges from the BigTable implementation. The
- HBase framework provides a library and runtime environment for executing user code within the
- HBase region server and master processes. </para>
- <para> The framework API is provided in the <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/coprocessor/package-summary.html">coprocessor</link>
- package.</para>
- <para>Two different types of coprocessors are provided by the framework, based on their
- scope.</para>
- <variablelist>
- <title>Types of Coprocessors</title>
- <varlistentry>
- <term>System Coprocessors</term>
- <listitem>
- <para>System coprocessors are loaded globally on all tables and regions hosted by a region
- server.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Table Coprocessors</term>
- <listitem>
- <para>You can specify which coprocessors should be loaded on all regions for a table on a
- per-table basis.</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The framework provides two different aspects of extensions as well:
- <firstterm>observers</firstterm> and <firstterm>endpoints</firstterm>.</para>
- <variablelist>
- <varlistentry>
- <term>Observers</term>
- <listitem>
- <para>Observers are analogous to triggers in conventional databases. They allow you to
- insert user code by overriding upcall methods provided by the coprocessor framework.
- Callback functions are executed from core HBase code when events occur. Callbacks are
- handled by the framework, and the coprocessor itself only needs to insert the extended
- or alternate functionality.</para>
- <variablelist>
- <title>Provided Observer Interfaces</title>
- <varlistentry>
- <term><link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/coprocessor/RegionObserver.html">RegionObserver</link></term>
- <listitem>
- <para>A RegionObserver provides hooks for data manipulation events, such as Get,
- Put, Delete, Scan. An instance of a RegionObserver coprocessor exists for each
- table region. The scope of the observations a RegionObserver can make is
- constrained to that region. </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/coprocessor/RegionServerObserver.html">RegionServerObserver</link></term>
- <listitem>
- <para>A RegionServerObserver provides for operations related to the RegionServer,
- such as stopping the RegionServer and performing operations before or after
- merges, commits, or rollbacks.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/coprocessor/WALObserver.html">WALObserver</link></term>
- <listitem>
- <para>A WALObserver provides hooks for operations related to the write-ahead log
- (WAL). You can observe or intercept WAL writing and reconstruction events. A
- WALObserver runs in the context of WAL processing. A single WALObserver exists on
- a single region server.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/coprocessor/MasterObserver.html">MasterObserver</link></term>
- <listitem>
- <para>A MasterObserver provides hooks for DDL-type operation, such as create,
- delete, modify table. The MasterObserver runs within the context of the HBase
- master. </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>More than one observer of a given type can be loaded at once. Multiple observers are
- chained to execute sequentially by order of assigned priority. Nothing prevents a
- coprocessor implementor from communicating internally among its installed
- observers.</para>
- <para>An observer of a higher priority can preempt lower-priority observers by throwing an
- IOException or a subclass of IOException.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Endpoints (HBase 0.96.x and later)</term>
- <listitem>
- <para>The implementation for endpoints changed significantly in HBase 0.96.x due to the
- introduction of protocol buffers (protobufs) (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-5448">HBASE-5488</link>). If
- you created endpoints before 0.96.x, you will need to rewrite them. Endpoints are now
- defined and callable as protobuf services, rather than endpoint invocations passed
- through as Writable blobs</para>
- <para>Dynamic RPC endpoints resemble stored procedures. An endpoint can be invoked at any
- time from the client. When it is invoked, it is executed remotely at the target region
- or regions, and results of the executions are returned to the client.</para>
- <para>The endpoint implementation is installed on the server and is invoked using HBase
- RPC. The client library provides convenience methods for invoking these dynamic
- interfaces. </para>
- <para>An endpoint, like an observer, can communicate with any installed observers. This
- allows you to plug new features into HBase without modifying or recompiling HBase
- itself.</para>
- <itemizedlist>
- <title>Steps to Implement an Endpoint</title>
- <listitem><para>Define the coprocessor service and related messages in a <filename>.proto</filename> file</para></listitem>
- <listitem><para>Run the <command>protoc</command> command to generate the code.</para></listitem>
- <listitem><para>Write code to implement the following:</para>
- <itemizedlist>
- <listitem><para>the generated protobuf Service interface</para></listitem>
- <listitem>
- <para>the new <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html#coprocessorService(byte[])">org.apache.hadoop.hbase.coprocessor.CoprocessorService</link>
- interface (required for the <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.html">RegionCoprocessorHost</link>
- to register the exposed service)</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>The client calls the new HTable.coprocessorService() methods to perform the endpoint RPCs.</para></listitem>
- </itemizedlist>
-
- <para>For more information and examples, refer to the API documentation for the <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/coprocessor/package-summary.html">coprocessor</link>
- package, as well as the included RowCount example in the
- <filename>/hbase-examples/src/test/java/org/apache/hadoop/hbase/coprocessor/example/</filename>
- of the HBase source.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Endpoints (HBase 0.94.x and earlier)</term>
- <listitem>
- <para>Dynamic RPC endpoints resemble stored procedures. An endpoint can be invoked at any
- time from the client. When it is invoked, it is executed remotely at the target region
- or regions, and results of the executions are returned to the client.</para>
- <para>The endpoint implementation is installed on the server and is invoked using HBase
- RPC. The client library provides convenience methods for invoking these dynamic
- interfaces. </para>
- <para>An endpoint, like an observer, can communicate with any installed observers. This
- allows you to plug new features into HBase without modifying or recompiling HBase
- itself.</para>
- <itemizedlist>
- <title>Steps to Implement an Endpoint</title>
- <listitem>
- <bridgehead>Server-Side</bridgehead>
- <itemizedlist>
- <listitem>
- <para>Create new protocol interface which extends CoprocessorProtocol.</para>
- </listitem>
- <listitem>
- <para>Implement the Endpoint interface. The implementation will be loaded into and
- executed from the region context.</para>
- </listitem>
- <listitem>
- <para>Extend the abstract class BaseEndpointCoprocessor. This convenience class
- hides some internal details that the implementer does not need to be concerned
- about, ˆ such as coprocessor framework class loading.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <bridgehead>Client-Side</bridgehead>
- <para>Endpoint can be invoked by two new HBase client APIs:</para>
- <itemizedlist>
- <listitem>
- <para><code>HTableInterface.coprocessorProxy(Class<T> protocol, byte[]
- row)</code> for executing against a single region</para>
- </listitem>
- <listitem>
- <para><code>HTableInterface.coprocessorExec(Class<T> protocol, byte[]
- startKey, byte[] endKey, Batch.Call<T,R> callable)</code> for executing
- over a range of regions</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section>
- <title>Examples</title>
- <para>An example of an observer is included in
- <filename>hbase-examples/src/test/java/org/apache/hadoop/hbase/coprocessor/example/TestZooKeeperScanPolicyObserver.java</filename>.
- Several endpoint examples are included in the same directory.</para>
- </section>
-
-
-
- <section>
- <title>Building A Coprocessor</title>
-
- <para>Before you can build a processor, it must be developed, compiled, and packaged in a JAR
- file. The next step is to configure the coprocessor framework to use your coprocessor. You can
- load the coprocessor from your HBase configuration, so that the coprocessor starts with HBase,
- or you can configure the coprocessor from the HBase shell, as a table attribute, so that it is
- loaded dynamically when the table is opened or reopened.</para>
- <section>
- <title>Load from Configuration</title>
- <para> To configure a coprocessor to be loaded when HBase starts, modify the RegionServer's
- <filename>hbase-site.xml</filename> and configure one of the following properties, based
- on the type of observer you are configuring: </para>
- <itemizedlist>
- <listitem>
- <para><code>hbase.coprocessor.region.classes</code>for RegionObservers and
- Endpoints</para>
- </listitem>
- <listitem>
- <para><code>hbase.coprocessor.wal.classes</code>for WALObservers</para>
- </listitem>
- <listitem>
- <para><code>hbase.coprocessor.master.classes</code>for MasterObservers</para>
- </listitem>
- </itemizedlist>
- <example>
- <title>Example RegionObserver Configuration</title>
- <para>In this example, one RegionObserver is configured for all the HBase tables.</para>
- <screen language="xml"><![CDATA[
-<property>
- <name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.coprocessor.AggregateImplementation</value>
- </property> ]]>
- </screen>
- </example>
-
- <para> If multiple classes are specified for loading, the class names must be comma-separated.
- The framework attempts to load all the configured classes using the default class loader.
- Therefore, the jar file must reside on the server-side HBase classpath.</para>
-
- <para>Coprocessors which are loaded in this way will be active on all regions of
- all tables. These are the system coprocessor introduced earlier. The first listed
- coprocessors will be assigned the priority <literal>Coprocessor.Priority.SYSTEM</literal>.
- Each subsequent coprocessor in the list will have its priority value incremented by one
- (which reduces its priority, because priorities have the natural sort order of Integers). </para>
- <para>When calling out to registered observers, the framework executes their callbacks methods
- in the sorted order of their priority. Ties are broken arbitrarily.</para>
- </section>
-
- <section>
- <title>Load from the HBase Shell</title>
- <para> You can load a coprocessor on a specific table via a table attribute. The following
- example will load the <systemitem>FooRegionObserver</systemitem> observer when table
- <systemitem>t1</systemitem> is read or re-read. </para>
- <example>
- <title>Load a Coprocessor On a Table Using HBase Shell</title>
- <screen>
-hbase(main):005:0> <userinput>alter 't1', METHOD => 'table_att',
- 'coprocessor'=>'hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2'</userinput>
-<computeroutput>Updating all regions with the new schema...
-1/1 regions updated.
-Done.
-0 row(s) in 1.0730 seconds</computeroutput>
-
-hbase(main):006:0> <userinput>describe 't1'</userinput>
-<computeroutput>DESCRIPTION ENABLED
- {NAME => 't1', coprocessor$1 => 'hdfs:///foo.jar|com.foo.FooRegio false
- nObserver|1001|arg1=1,arg2=2', FAMILIES => [{NAME => 'c1', DATA_B
- LOCK_ENCODING => 'NONE', BLOOMFILTER => 'NONE', REPLICATION_SCOPE
- => '0', VERSIONS => '3', COMPRESSION => 'NONE', MIN_VERSIONS =>
- '0', TTL => '2147483647', KEEP_DELETED_CELLS => 'false', BLOCKSIZ
- E => '65536', IN_MEMORY => 'false', ENCODE_ON_DISK => 'true', BLO
- CKCACHE => 'true'}, {NAME => 'f1', DATA_BLOCK_ENCODING => 'NONE',
- BLOOMFILTER => 'NONE', REPLICATION_SCOPE => '0', VERSIONS => '3'
- , COMPRESSION => 'NONE', MIN_VERSIONS => '0', TTL => '2147483647'
- , KEEP_DELETED_CELLS => 'false', BLOCKSIZE => '65536', IN_MEMORY
- => 'false', ENCODE_ON_DISK => 'true', BLOCKCACHE => 'true'}]}
-1 row(s) in 0.0190 seconds</computeroutput>
- </screen>
- </example>
-
- <para>The coprocessor framework will try to read the class information from the coprocessor
- table attribute value. The value contains four pieces of information which are separated by
- the <literal>|</literal> character.</para>
-
- <itemizedlist>
- <listitem>
- <para>File path: The jar file containing the coprocessor implementation must be in a
- location where all region servers can read it. You could copy the file onto the local
- disk on each region server, but it is recommended to store it in HDFS.</para>
- </listitem>
- <listitem>
- <para>Class name: The full class name of the coprocessor.</para>
- </listitem>
- <listitem>
- <para>Priority: An integer. The framework will determine the execution sequence of all
- configured observers registered at the same hook using priorities. This field can be
- left blank. In that case the framework will assign a default priority value.</para>
- </listitem>
- <listitem>
- <para>Arguments: This field is passed to the coprocessor implementation.</para>
- </listitem>
- </itemizedlist>
- <example>
- <title>Unload a Coprocessor From a Table Using HBase Shell</title>
- <screen>
-hbase(main):007:0> <userinput>alter 't1', METHOD => 'table_att_unset',</userinput>
-hbase(main):008:0* <userinput>NAME => 'coprocessor$1'</userinput>
-<computeroutput>Updating all regions with the new schema...
-1/1 regions updated.
-Done.
-0 row(s) in 1.1130 seconds</computeroutput>
-
-hbase(main):009:0> <userinput>describe 't1'</userinput>
-<computeroutput>DESCRIPTION ENABLED
- {NAME => 't1', FAMILIES => [{NAME => 'c1', DATA_BLOCK_ENCODING => false
- 'NONE', BLOOMFILTER => 'NONE', REPLICATION_SCOPE => '0', VERSION
- S => '3', COMPRESSION => 'NONE', MIN_VERSIONS => '0', TTL => '214
- 7483647', KEEP_DELETED_CELLS => 'false', BLOCKSIZE => '65536', IN
- _MEMORY => 'false', ENCODE_ON_DISK => 'true', BLOCKCACHE => 'true
- '}, {NAME => 'f1', DATA_BLOCK_ENCODING => 'NONE', BLOOMFILTER =>
- 'NONE', REPLICATION_SCOPE => '0', VERSIONS => '3', COMPRESSION =>
- 'NONE', MIN_VERSIONS => '0', TTL => '2147483647', KEEP_DELETED_C
- ELLS => 'false', BLOCKSIZE => '65536', IN_MEMORY => 'false', ENCO
- DE_ON_DISK => 'true', BLOCKCACHE => 'true'}]}
-1 row(s) in 0.0180 seconds </computeroutput>
- </screen>
- </example>
- <warning>
- <para>There is no guarantee that the framework will load a given coprocessor successfully.
- For example, the shell command neither guarantees a jar file exists at a particular
- location nor verifies whether the given class is actually contained in the jar file.
- </para>
- </warning>
- </section>
- </section>
- <section>
- <title>Check the Status of a Coprocessor</title>
- <para>To check the status of a coprocessor after it has been configured, use the
- <command>status</command> HBase Shell command.</para>
- <screen>
-hbase(main):020:0> <userinput>status 'detailed'</userinput>
-<computeroutput>version 0.92-tm-6
-0 regionsInTransition
-master coprocessors: []
-1 live servers
- localhost:52761 1328082515520
- requestsPerSecond=3, numberOfOnlineRegions=3, usedHeapMB=32, maxHeapMB=995
- -ROOT-,,0
- numberOfStores=1, numberOfStorefiles=1, storefileUncompressedSizeMB=0, storefileSizeMB=0, memstoreSizeMB=0,
-storefileIndexSizeMB=0, readRequestsCount=54, writeRequestsCount=1, rootIndexSizeKB=0, totalStaticIndexSizeKB=0,
-totalStaticBloomSizeKB=0, totalCompactingKVs=0, currentCompactedKVs=0, compactionProgressPct=NaN, coprocessors=[]
- .META.,,1
- numberOfStores=1, numberOfStorefiles=0, storefileUncompressedSizeMB=0, storefileSizeMB=0, memstoreSizeMB=0,
-storefileIndexSizeMB=0, readRequestsCount=97, writeRequestsCount=4, rootIndexSizeKB=0, totalStaticIndexSizeKB=0,
-totalStaticBloomSizeKB=0, totalCompactingKVs=0, currentCompactedKVs=0, compactionProgressPct=NaN, coprocessors=[]
- t1,,1328082575190.c0491168a27620ffe653ec6c04c9b4d1.
- numberOfStores=2, numberOfStorefiles=1, storefileUncompressedSizeMB=0, storefileSizeMB=0, memstoreSizeMB=0,
-storefileIndexSizeMB=0, readRequestsCount=0, writeRequestsCount=0, rootIndexSizeKB=0, totalStaticIndexSizeKB=0,
-totalStaticBloomSizeKB=0, totalCompactingKVs=0, currentCompactedKVs=0, compactionProgressPct=NaN,
-coprocessors=[AggregateImplementation]
-0 dead servers </computeroutput>
- </screen>
- </section>
- <section>
- <title>Monitor Time Spent in Coprocessors</title>
- <para>HBase 0.98.5 introduced the ability to monitor some statistics relating to the amount of
- time spent executing a given coprocessor. You can see these statistics via the HBase Metrics
- framework (see <xref linkend="hbase_metrics"/> or the Web UI for a given Region Server, via
- the <guilabel>Coprocessor Metrics</guilabel> tab. These statistics are valuable for debugging
- and benchmarking the performance impact of a given coprocessor on your cluster. Tracked
- statistics include min, max, average, and 90th, 95th, and 99th percentile. All times are shown
- in milliseconds. The statistics are calculated over coprocessor
- execution samples recorded during the reporting interval, which is 10 seconds by default. The
- metrics sampling rate as described in <xref linkend="hbase_metrics" />.</para>
- <figure>
- <title>Coprocessor Metrics UI</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="coprocessor_stats.png" width="100%"/>
- </imageobject>
- <caption>
- <para>The Coprocessor Metrics UI shows statistics about time spent executing a given
- coprocessor, including min, max, average, and 90th, 95th, and 99th percentile.</para>
- </caption>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Status of Coprocessors in HBase</title>
- <para> Coprocessors and the coprocessor framework are evolving rapidly and work is ongoing on
- several different JIRAs. </para>
- </section>
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/customization.xsl
----------------------------------------------------------------------
diff --git a/src/main/docbkx/customization.xsl b/src/main/docbkx/customization.xsl
deleted file mode 100644
index 5d0ec2c..0000000
--- a/src/main/docbkx/customization.xsl
+++ /dev/null
@@ -1,49 +0,0 @@
-<?xml version="1.0"?>
-<xsl:stylesheet
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- version="1.0">
-<!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <xsl:import href="urn:docbkx:stylesheet"/>
- <xsl:import href="urn:docbkx:stylesheet/highlight.xsl"/>
- <xsl:output method="html" encoding="UTF-8" indent="no"/>
-
- <xsl:template name="user.header.content">
- <script type="text/javascript">
- var disqus_shortname = 'hbase'; // required: replace example with your forum shortname
- var disqus_url = 'http://hbase.apache.org/book/<xsl:value-of select="@xml:id" />.html';
- <!--var disqus_identifier = '<xsl:value-of select="@xml:id" />';--></script>
- </xsl:template>
-
- <xsl:template name="user.footer.content">
-<div id="disqus_thread"></div>
-<script type="text/javascript">
- /* * * DON'T EDIT BELOW THIS LINE * * */
- (function() {
- var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
- dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
- (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
- })();
-</script>
-<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
-<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
- </xsl:template>
-
-</xsl:stylesheet>
[14/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/book.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/book.xml b/src/main/docbkx/book.xml
deleted file mode 100644
index f835dc7..0000000
--- a/src/main/docbkx/book.xml
+++ /dev/null
@@ -1,6107 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-/**
- *
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-<book
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook"
- xml:id="book">
- <info>
-
- <title><link
- xlink:href="http://www.hbase.org"> The Apache HBase™ Reference Guide </link></title>
- <subtitle><link
- xlink:href="http://www.hbase.org">
- <inlinemediaobject>
- <imageobject>
- <imagedata
- align="center"
- valign="left"
- fileref="hbase_logo.png" />
- </imageobject>
- </inlinemediaobject>
- <inlinemediaobject>
- <imageobject>
- <imagedata
- align="center"
- valign="right"
- fileref="jumping-orca_rotated_25percent.png" />
- </imageobject>
- </inlinemediaobject>
- </link>
- </subtitle>
- <copyright>
- <year>2014</year>
- <holder>Apache Software Foundation. All Rights Reserved. Apache Hadoop, Hadoop, MapReduce,
- HDFS, Zookeeper, HBase, and the HBase project logo are trademarks of the Apache Software
- Foundation. </holder>
- </copyright>
- <abstract>
- <para>This is the official reference guide of <link
- xlink:href="http://www.hbase.org">Apache HBase™</link>, a distributed, versioned, big
- data store built on top of <link
- xlink:href="http://hadoop.apache.org/">Apache Hadoop™</link> and <link
- xlink:href="http://zookeeper.apache.org/">Apache ZooKeeper™</link>. </para>
- </abstract>
-
- <revhistory>
- <revision>
- <revnumber>
- <?eval ${project.version}?>
- </revnumber>
- <date>
- <?eval ${buildDate}?>
- </date>
- </revision>
- </revhistory>
- </info>
-
- <!--XInclude some chapters-->
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="preface.xml" />
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="getting_started.xml" />
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="configuration.xml" />
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="upgrading.xml" />
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="shell.xml" />
-
- <chapter
- xml:id="datamodel">
- <title>Data Model</title>
- <para>In HBase, data is stored in tables, which have rows and columns. This is a terminology
- overlap with relational databases (RDBMSs), but this is not a helpful analogy. Instead, it can
- be helpful to think of an HBase table as a multi-dimensional map.</para>
- <variablelist>
- <title>HBase Data Model Terminology</title>
- <varlistentry>
- <term>Table</term>
- <listitem>
- <para>An HBase table consists of multiple rows.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Row</term>
- <listitem>
- <para>A row in HBase consists of a row key and one or more columns with values associated
- with them. Rows are sorted alphabetically by the row key as they are stored. For this
- reason, the design of the row key is very important. The goal is to store data in such a
- way that related rows are near each other. A common row key pattern is a website domain.
- If your row keys are domains, you should probably store them in reverse (org.apache.www,
- org.apache.mail, org.apache.jira). This way, all of the Apache domains are near each
- other in the table, rather than being spread out based on the first letter of the
- subdomain.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Column</term>
- <listitem>
- <para>A column in HBase consists of a column family and a column qualifier, which are
- delimited by a <literal>:</literal> (colon) character.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Column Family</term>
- <listitem>
- <para>Column families physically colocate a set of columns and their values, often for
- performance reasons. Each column family has a set of storage properties, such as whether
- its values should be cached in memory, how its data is compressed or its row keys are
- encoded, and others. Each row in a table has the same column
- families, though a given row might not store anything in a given column family.</para>
- <para>Column families are specified when you create your table, and influence the way your
- data is stored in the underlying filesystem. Therefore, the column families should be
- considered carefully during schema design.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Column Qualifier</term>
- <listitem>
- <para>A column qualifier is added to a column family to provide the index for a given
- piece of data. Given a column family <literal>content</literal>, a column qualifier
- might be <literal>content:html</literal>, and another might be
- <literal>content:pdf</literal>. Though column families are fixed at table creation,
- column qualifiers are mutable and may differ greatly between rows.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Cell</term>
- <listitem>
- <para>A cell is a combination of row, column family, and column qualifier, and contains a
- value and a timestamp, which represents the value's version.</para>
- <para>A cell's value is an uninterpreted array of bytes.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Timestamp</term>
- <listitem>
- <para>A timestamp is written alongside each value, and is the identifier for a given
- version of a value. By default, the timestamp represents the time on the RegionServer
- when the data was written, but you can specify a different timestamp value when you put
- data into the cell.</para>
- <caution>
- <para>Direct manipulation of timestamps is an advanced feature which is only exposed for
- special cases that are deeply integrated with HBase, and is discouraged in general.
- Encoding a timestamp at the application level is the preferred pattern.</para>
- </caution>
- <para>You can specify the maximum number of versions of a value that HBase retains, per column
- family. When the maximum number of versions is reached, the oldest versions are
- eventually deleted. By default, only the newest version is kept.</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <section
- xml:id="conceptual.view">
- <title>Conceptual View</title>
- <para>You can read a very understandable explanation of the HBase data model in the blog post <link
- xlink:href="http://jimbojw.com/wiki/index.php?title=Understanding_Hbase_and_BigTable">Understanding
- HBase and BigTable</link> by Jim R. Wilson. Another good explanation is available in the
- PDF <link
- xlink:href="http://0b4af6cdc2f0c5998459-c0245c5c937c5dedcca3f1764ecc9b2f.r43.cf2.rackcdn.com/9353-login1210_khurana.pdf">Introduction
- to Basic Schema Design</link> by Amandeep Khurana. It may help to read different
- perspectives to get a solid understanding of HBase schema design. The linked articles cover
- the same ground as the information in this section.</para>
- <para> The following example is a slightly modified form of the one on page 2 of the <link
- xlink:href="http://research.google.com/archive/bigtable.html">BigTable</link> paper. There
- is a table called <varname>webtable</varname> that contains two rows
- (<literal>com.cnn.www</literal>
- and <literal>com.example.www</literal>), three column families named
- <varname>contents</varname>, <varname>anchor</varname>, and <varname>people</varname>. In
- this example, for the first row (<literal>com.cnn.www</literal>),
- <varname>anchor</varname> contains two columns (<varname>anchor:cssnsi.com</varname>,
- <varname>anchor:my.look.ca</varname>) and <varname>contents</varname> contains one column
- (<varname>contents:html</varname>). This example contains 5 versions of the row with the
- row key <literal>com.cnn.www</literal>, and one version of the row with the row key
- <literal>com.example.www</literal>. The <varname>contents:html</varname> column qualifier contains the entire
- HTML of a given website. Qualifiers of the <varname>anchor</varname> column family each
- contain the external site which links to the site represented by the row, along with the
- text it used in the anchor of its link. The <varname>people</varname> column family represents
- people associated with the site.
- </para>
- <note>
- <title>Column Names</title>
- <para> By convention, a column name is made of its column family prefix and a
- <emphasis>qualifier</emphasis>. For example, the column
- <emphasis>contents:html</emphasis> is made up of the column family
- <varname>contents</varname> and the <varname>html</varname> qualifier. The colon
- character (<literal>:</literal>) delimits the column family from the column family
- <emphasis>qualifier</emphasis>. </para>
- </note>
- <table
- frame="all">
- <title>Table <varname>webtable</varname></title>
- <tgroup
- cols="5"
- align="left"
- colsep="1"
- rowsep="1">
- <colspec
- colname="c1" />
- <colspec
- colname="c2" />
- <colspec
- colname="c3" />
- <colspec
- colname="c4" />
- <colspec
- colname="c5" />
- <thead>
- <row>
- <entry>Row Key</entry>
- <entry>Time Stamp</entry>
- <entry>ColumnFamily <varname>contents</varname></entry>
- <entry>ColumnFamily <varname>anchor</varname></entry>
- <entry>ColumnFamily <varname>people</varname></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t9</entry>
- <entry />
- <entry><varname>anchor:cnnsi.com</varname> = "CNN"</entry>
- <entry />
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t8</entry>
- <entry />
- <entry><varname>anchor:my.look.ca</varname> = "CNN.com"</entry>
- <entry />
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t6</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- <entry />
- <entry />
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t5</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- <entry />
- <entry />
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t3</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- <entry />
- <entry />
- </row>
- <row>
- <entry>"com.example.www"</entry>
- <entry>t5</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- <entry></entry>
- <entry>people:author = "John Doe"</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>Cells in this table that appear to be empty do not take space, or in fact exist, in
- HBase. This is what makes HBase "sparse." A tabular view is not the only possible way to
- look at data in HBase, or even the most accurate. The following represents the same
- information as a multi-dimensional map. This is only a mock-up for illustrative
- purposes and may not be strictly accurate.</para>
- <programlisting><![CDATA[
-{
- "com.cnn.www": {
- contents: {
- t6: contents:html: "<html>..."
- t5: contents:html: "<html>..."
- t3: contents:html: "<html>..."
- }
- anchor: {
- t9: anchor:cnnsi.com = "CNN"
- t8: anchor:my.look.ca = "CNN.com"
- }
- people: {}
- }
- "com.example.www": {
- contents: {
- t5: contents:html: "<html>..."
- }
- anchor: {}
- people: {
- t5: people:author: "John Doe"
- }
- }
-}
- ]]></programlisting>
-
- </section>
- <section
- xml:id="physical.view">
- <title>Physical View</title>
- <para> Although at a conceptual level tables may be viewed as a sparse set of rows, they are
- physically stored by column family. A new column qualifier (column_family:column_qualifier)
- can be added to an existing column family at any time.</para>
- <table
- frame="all">
- <title>ColumnFamily <varname>anchor</varname></title>
- <tgroup
- cols="3"
- align="left"
- colsep="1"
- rowsep="1">
- <colspec
- colname="c1" />
- <colspec
- colname="c2" />
- <colspec
- colname="c3" />
- <thead>
- <row>
- <entry>Row Key</entry>
- <entry>Time Stamp</entry>
- <entry>Column Family <varname>anchor</varname></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t9</entry>
- <entry><varname>anchor:cnnsi.com</varname> = "CNN"</entry>
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t8</entry>
- <entry><varname>anchor:my.look.ca</varname> = "CNN.com"</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table
- frame="all">
- <title>ColumnFamily <varname>contents</varname></title>
- <tgroup
- cols="3"
- align="left"
- colsep="1"
- rowsep="1">
- <colspec
- colname="c1" />
- <colspec
- colname="c2" />
- <colspec
- colname="c3" />
- <thead>
- <row>
- <entry>Row Key</entry>
- <entry>Time Stamp</entry>
- <entry>ColumnFamily "contents:"</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t6</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t5</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- </row>
- <row>
- <entry>"com.cnn.www"</entry>
- <entry>t3</entry>
- <entry><varname>contents:html</varname> = "<html>..."</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>The empty cells shown in the
- conceptual view are not stored at all.
- Thus a request for the value of the <varname>contents:html</varname> column at time stamp
- <literal>t8</literal> would return no value. Similarly, a request for an
- <varname>anchor:my.look.ca</varname> value at time stamp <literal>t9</literal> would
- return no value. However, if no timestamp is supplied, the most recent value for a
- particular column would be returned. Given multiple versions, the most recent is also the
- first one found, since timestamps
- are stored in descending order. Thus a request for the values of all columns in the row
- <varname>com.cnn.www</varname> if no timestamp is specified would be: the value of
- <varname>contents:html</varname> from timestamp <literal>t6</literal>, the value of
- <varname>anchor:cnnsi.com</varname> from timestamp <literal>t9</literal>, the value of
- <varname>anchor:my.look.ca</varname> from timestamp <literal>t8</literal>. </para>
- <para>For more information about the internals of how Apache HBase stores data, see <xref
- linkend="regions.arch" />. </para>
- </section>
-
- <section
- xml:id="namespace">
- <title>Namespace</title>
- <para> A namespace is a logical grouping of tables analogous to a database in relation
- database systems. This abstraction lays the groundwork for upcoming multi-tenancy related
- features: <itemizedlist>
- <listitem>
- <para>Quota Management (HBASE-8410) - Restrict the amount of resources (ie regions,
- tables) a namespace can consume.</para>
- </listitem>
- <listitem>
- <para>Namespace Security Administration (HBASE-9206) - provide another level of security
- administration for tenants.</para>
- </listitem>
- <listitem>
- <para>Region server groups (HBASE-6721) - A namespace/table can be pinned onto a subset
- of regionservers thus guaranteeing a course level of isolation.</para>
- </listitem>
- </itemizedlist>
- </para>
- <section
- xml:id="namespace_creation">
- <title>Namespace management</title>
- <para> A namespace can be created, removed or altered. Namespace membership is determined
- during table creation by specifying a fully-qualified table name of the form:</para>
-
- <programlisting language="xml"><![CDATA[<table namespace>:<table qualifier>]]></programlisting>
-
-
- <example>
- <title>Examples</title>
-
- <programlisting language="bourne">
-#Create a namespace
-create_namespace 'my_ns'
- </programlisting>
- <programlisting language="bourne">
-#create my_table in my_ns namespace
-create 'my_ns:my_table', 'fam'
- </programlisting>
- <programlisting language="bourne">
-#drop namespace
-drop_namespace 'my_ns'
- </programlisting>
- <programlisting language="bourne">
-#alter namespace
-alter_namespace 'my_ns', {METHOD => 'set', 'PROPERTY_NAME' => 'PROPERTY_VALUE'}
- </programlisting>
- </example>
- </section>
- <section
- xml:id="namespace_special">
- <title>Predefined namespaces</title>
- <para> There are two predefined special namespaces: </para>
- <itemizedlist>
- <listitem>
- <para>hbase - system namespace, used to contain hbase internal tables</para>
- </listitem>
- <listitem>
- <para>default - tables with no explicit specified namespace will automatically fall into
- this namespace.</para>
- </listitem>
- </itemizedlist>
- <example>
- <title>Examples</title>
-
- <programlisting language="bourne">
-#namespace=foo and table qualifier=bar
-create 'foo:bar', 'fam'
-
-#namespace=default and table qualifier=bar
-create 'bar', 'fam'
-</programlisting>
- </example>
- </section>
- </section>
-
- <section
- xml:id="table">
- <title>Table</title>
- <para> Tables are declared up front at schema definition time. </para>
- </section>
-
- <section
- xml:id="row">
- <title>Row</title>
- <para>Row keys are uninterrpreted bytes. Rows are lexicographically sorted with the lowest
- order appearing first in a table. The empty byte array is used to denote both the start and
- end of a tables' namespace.</para>
- </section>
-
- <section
- xml:id="columnfamily">
- <title>Column Family<indexterm><primary>Column Family</primary></indexterm></title>
- <para> Columns in Apache HBase are grouped into <emphasis>column families</emphasis>. All
- column members of a column family have the same prefix. For example, the columns
- <emphasis>courses:history</emphasis> and <emphasis>courses:math</emphasis> are both
- members of the <emphasis>courses</emphasis> column family. The colon character
- (<literal>:</literal>) delimits the column family from the <indexterm><primary>column
- family qualifier</primary><secondary>Column Family Qualifier</secondary></indexterm>.
- The column family prefix must be composed of <emphasis>printable</emphasis> characters. The
- qualifying tail, the column family <emphasis>qualifier</emphasis>, can be made of any
- arbitrary bytes. Column families must be declared up front at schema definition time whereas
- columns do not need to be defined at schema time but can be conjured on the fly while the
- table is up an running.</para>
- <para>Physically, all column family members are stored together on the filesystem. Because
- tunings and storage specifications are done at the column family level, it is advised that
- all column family members have the same general access pattern and size
- characteristics.</para>
-
- </section>
- <section
- xml:id="cells">
- <title>Cells<indexterm><primary>Cells</primary></indexterm></title>
- <para>A <emphasis>{row, column, version} </emphasis>tuple exactly specifies a
- <literal>cell</literal> in HBase. Cell content is uninterrpreted bytes</para>
- </section>
- <section
- xml:id="data_model_operations">
- <title>Data Model Operations</title>
- <para>The four primary data model operations are Get, Put, Scan, and Delete. Operations are
- applied via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html">Table</link>
- instances.
- </para>
- <section
- xml:id="get">
- <title>Get</title>
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Get.html">Get</link>
- returns attributes for a specified row. Gets are executed via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html#get(org.apache.hadoop.hbase.client.Get)">
- Table.get</link>. </para>
- </section>
- <section
- xml:id="put">
- <title>Put</title>
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Put.html">Put</link>
- either adds new rows to a table (if the key is new) or can update existing rows (if the
- key already exists). Puts are executed via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html#put(org.apache.hadoop.hbase.client.Put)">
- Table.put</link> (writeBuffer) or <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html#batch(java.util.List, java.lang.Object[])">
- Table.batch</link> (non-writeBuffer). </para>
- </section>
- <section
- xml:id="scan">
- <title>Scans</title>
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">Scan</link>
- allow iteration over multiple rows for specified attributes. </para>
- <para>The following is an example of a Scan on a Table instance. Assume that a table is
- populated with rows with keys "row1", "row2", "row3", and then another set of rows with
- the keys "abc1", "abc2", and "abc3". The following example shows how to set a Scan
- instance to return the rows beginning with "row".</para>
-<programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-
-Table table = ... // instantiate a Table instance
-
-Scan scan = new Scan();
-scan.addColumn(CF, ATTR);
-scan.setRowPrefixFilter(Bytes.toBytes("row"));
-ResultScanner rs = table.getScanner(scan);
-try {
- for (Result r = rs.next(); r != null; r = rs.next()) {
- // process result...
-} finally {
- rs.close(); // always close the ResultScanner!
-</programlisting>
- <para>Note that generally the easiest way to specify a specific stop point for a scan is by
- using the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html">InclusiveStopFilter</link>
- class. </para>
- </section>
- <section
- xml:id="delete">
- <title>Delete</title>
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Delete.html">Delete</link>
- removes a row from a table. Deletes are executed via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Table.html#delete(org.apache.hadoop.hbase.client.Delete)">
- HTable.delete</link>. </para>
- <para>HBase does not modify data in place, and so deletes are handled by creating new
- markers called <emphasis>tombstones</emphasis>. These tombstones, along with the dead
- values, are cleaned up on major compactions. </para>
- <para>See <xref
- linkend="version.delete" /> for more information on deleting versions of columns, and
- see <xref
- linkend="compaction" /> for more information on compactions. </para>
-
- </section>
-
- </section>
-
-
- <section
- xml:id="versions">
- <title>Versions<indexterm><primary>Versions</primary></indexterm></title>
-
- <para>A <emphasis>{row, column, version} </emphasis>tuple exactly specifies a
- <literal>cell</literal> in HBase. It's possible to have an unbounded number of cells where
- the row and column are the same but the cell address differs only in its version
- dimension.</para>
-
- <para>While rows and column keys are expressed as bytes, the version is specified using a long
- integer. Typically this long contains time instances such as those returned by
- <code>java.util.Date.getTime()</code> or <code>System.currentTimeMillis()</code>, that is:
- <quote>the difference, measured in milliseconds, between the current time and midnight,
- January 1, 1970 UTC</quote>.</para>
-
- <para>The HBase version dimension is stored in decreasing order, so that when reading from a
- store file, the most recent values are found first.</para>
-
- <para>There is a lot of confusion over the semantics of <literal>cell</literal> versions, in
- HBase. In particular:</para>
- <itemizedlist>
- <listitem>
- <para>If multiple writes to a cell have the same version, only the last written is
- fetchable.</para>
- </listitem>
-
- <listitem>
- <para>It is OK to write cells in a non-increasing version order.</para>
- </listitem>
- </itemizedlist>
-
- <para>Below we describe how the version dimension in HBase currently works. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-2406">HBASE-2406</link> for
- discussion of HBase versions. <link
- xlink:href="http://outerthought.org/blog/417-ot.html">Bending time in HBase</link>
- makes for a good read on the version, or time, dimension in HBase. It has more detail on
- versioning than is provided here. As of this writing, the limiitation
- <emphasis>Overwriting values at existing timestamps</emphasis> mentioned in the
- article no longer holds in HBase. This section is basically a synopsis of this article
- by Bruno Dumon.</para>
-
- <section xml:id="specify.number.of.versions">
- <title>Specifying the Number of Versions to Store</title>
- <para>The maximum number of versions to store for a given column is part of the column
- schema and is specified at table creation, or via an <command>alter</command> command, via
- <code>HColumnDescriptor.DEFAULT_VERSIONS</code>. Prior to HBase 0.96, the default number
- of versions kept was <literal>3</literal>, but in 0.96 and newer has been changed to
- <literal>1</literal>.</para>
- <example>
- <title>Modify the Maximum Number of Versions for a Column</title>
- <para>This example uses HBase Shell to keep a maximum of 5 versions of column
- <code>f1</code>. You could also use <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html"
- >HColumnDescriptor</link>.</para>
- <screen><![CDATA[hbase> alter ‘t1′, NAME => ‘f1′, VERSIONS => 5]]></screen>
- </example>
- <example>
- <title>Modify the Minimum Number of Versions for a Column</title>
- <para>You can also specify the minimum number of versions to store. By default, this is
- set to 0, which means the feature is disabled. The following example sets the minimum
- number of versions on field <code>f1</code> to <literal>2</literal>, via HBase Shell.
- You could also use <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html"
- >HColumnDescriptor</link>.</para>
- <screen><![CDATA[hbase> alter ‘t1′, NAME => ‘f1′, MIN_VERSIONS => 2]]></screen>
- </example>
- <para>Starting with HBase 0.98.2, you can specify a global default for the maximum number of
- versions kept for all newly-created columns, by setting
- <option>hbase.column.max.version</option> in <filename>hbase-site.xml</filename>. See
- <xref linkend="hbase.column.max.version"/>.</para>
- </section>
-
- <section
- xml:id="versions.ops">
- <title>Versions and HBase Operations</title>
-
- <para>In this section we look at the behavior of the version dimension for each of the core
- HBase operations.</para>
-
- <section>
- <title>Get/Scan</title>
-
- <para>Gets are implemented on top of Scans. The below discussion of <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Get.html">Get</link>
- applies equally to <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">Scans</link>.</para>
-
- <para>By default, i.e. if you specify no explicit version, when doing a
- <literal>get</literal>, the cell whose version has the largest value is returned
- (which may or may not be the latest one written, see later). The default behavior can be
- modified in the following ways:</para>
-
- <itemizedlist>
- <listitem>
- <para>to return more than one version, see <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Get.html#setMaxVersions()">Get.setMaxVersions()</link></para>
- </listitem>
-
- <listitem>
- <para>to return versions other than the latest, see <link
- xlink:href="???">Get.setTimeRange()</link></para>
-
- <para>To retrieve the latest version that is less than or equal to a given value, thus
- giving the 'latest' state of the record at a certain point in time, just use a range
- from 0 to the desired version and set the max versions to 1.</para>
- </listitem>
- </itemizedlist>
-
- </section>
- <section
- xml:id="default_get_example">
- <title>Default Get Example</title>
- <para>The following Get will only retrieve the current version of the row</para>
- <programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-Get get = new Get(Bytes.toBytes("row1"));
-Result r = table.get(get);
-byte[] b = r.getValue(CF, ATTR); // returns current version of value
-</programlisting>
- </section>
- <section
- xml:id="versioned_get_example">
- <title>Versioned Get Example</title>
- <para>The following Get will return the last 3 versions of the row.</para>
- <programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-Get get = new Get(Bytes.toBytes("row1"));
-get.setMaxVersions(3); // will return last 3 versions of row
-Result r = table.get(get);
-byte[] b = r.getValue(CF, ATTR); // returns current version of value
-List<KeyValue> kv = r.getColumn(CF, ATTR); // returns all versions of this column
-</programlisting>
- </section>
-
- <section>
- <title>Put</title>
-
- <para>Doing a put always creates a new version of a <literal>cell</literal>, at a certain
- timestamp. By default the system uses the server's <literal>currentTimeMillis</literal>,
- but you can specify the version (= the long integer) yourself, on a per-column level.
- This means you could assign a time in the past or the future, or use the long value for
- non-time purposes.</para>
-
- <para>To overwrite an existing value, do a put at exactly the same row, column, and
- version as that of the cell you would overshadow.</para>
- <section
- xml:id="implicit_version_example">
- <title>Implicit Version Example</title>
- <para>The following Put will be implicitly versioned by HBase with the current
- time.</para>
- <programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-Put put = new Put(Bytes.toBytes(row));
-put.add(CF, ATTR, Bytes.toBytes( data));
-table.put(put);
-</programlisting>
- </section>
- <section
- xml:id="explicit_version_example">
- <title>Explicit Version Example</title>
- <para>The following Put has the version timestamp explicitly set.</para>
- <programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-Put put = new Put( Bytes.toBytes(row));
-long explicitTimeInMs = 555; // just an example
-put.add(CF, ATTR, explicitTimeInMs, Bytes.toBytes(data));
-table.put(put);
-</programlisting>
- <para>Caution: the version timestamp is internally by HBase for things like time-to-live
- calculations. It's usually best to avoid setting this timestamp yourself. Prefer using
- a separate timestamp attribute of the row, or have the timestamp a part of the rowkey,
- or both. </para>
- </section>
-
- </section>
-
- <section
- xml:id="version.delete">
- <title>Delete</title>
-
- <para>There are three different types of internal delete markers. See Lars Hofhansl's blog
- for discussion of his attempt adding another, <link
- xlink:href="http://hadoop-hbase.blogspot.com/2012/01/scanning-in-hbase.html">Scanning
- in HBase: Prefix Delete Marker</link>. </para>
- <itemizedlist>
- <listitem>
- <para>Delete: for a specific version of a column.</para>
- </listitem>
- <listitem>
- <para>Delete column: for all versions of a column.</para>
- </listitem>
- <listitem>
- <para>Delete family: for all columns of a particular ColumnFamily</para>
- </listitem>
- </itemizedlist>
- <para>When deleting an entire row, HBase will internally create a tombstone for each
- ColumnFamily (i.e., not each individual column). </para>
- <para>Deletes work by creating <emphasis>tombstone</emphasis> markers. For example, let's
- suppose we want to delete a row. For this you can specify a version, or else by default
- the <literal>currentTimeMillis</literal> is used. What this means is <quote>delete all
- cells where the version is less than or equal to this version</quote>. HBase never
- modifies data in place, so for example a delete will not immediately delete (or mark as
- deleted) the entries in the storage file that correspond to the delete condition.
- Rather, a so-called <emphasis>tombstone</emphasis> is written, which will mask the
- deleted values. When HBase does a major compaction, the tombstones are processed to
- actually remove the dead values, together with the tombstones themselves. If the version
- you specified when deleting a row is larger than the version of any value in the row,
- then you can consider the complete row to be deleted.</para>
- <para>For an informative discussion on how deletes and versioning interact, see the thread <link
- xlink:href="http://comments.gmane.org/gmane.comp.java.hadoop.hbase.user/28421">Put w/
- timestamp -> Deleteall -> Put w/ timestamp fails</link> up on the user mailing
- list.</para>
- <para>Also see <xref
- linkend="keyvalue" /> for more information on the internal KeyValue format. </para>
- <para>Delete markers are purged during the next major compaction of the store, unless the
- <option>KEEP_DELETED_CELLS</option> option is set in the column family. To keep the
- deletes for a configurable amount of time, you can set the delete TTL via the
- <option>hbase.hstore.time.to.purge.deletes</option> property in
- <filename>hbase-site.xml</filename>. If
- <option>hbase.hstore.time.to.purge.deletes</option> is not set, or set to 0, all
- delete markers, including those with timestamps in the future, are purged during the
- next major compaction. Otherwise, a delete marker with a timestamp in the future is kept
- until the major compaction which occurs after the time represented by the marker's
- timestamp plus the value of <option>hbase.hstore.time.to.purge.deletes</option>, in
- milliseconds. </para>
- <note>
- <para>This behavior represents a fix for an unexpected change that was introduced in
- HBase 0.94, and was fixed in <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10118">HBASE-10118</link>.
- The change has been backported to HBase 0.94 and newer branches.</para>
- </note>
- </section>
- </section>
-
- <section>
- <title>Current Limitations</title>
-
- <section>
- <title>Deletes mask Puts</title>
-
- <para>Deletes mask puts, even puts that happened after the delete
- was entered. See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-2256"
- >HBASE-2256</link>. Remember that a delete writes a tombstone, which only
- disappears after then next major compaction has run. Suppose you do
- a delete of everything <= T. After this you do a new put with a
- timestamp <= T. This put, even if it happened after the delete,
- will be masked by the delete tombstone. Performing the put will not
- fail, but when you do a get you will notice the put did have no
- effect. It will start working again after the major compaction has
- run. These issues should not be a problem if you use
- always-increasing versions for new puts to a row. But they can occur
- even if you do not care about time: just do delete and put
- immediately after each other, and there is some chance they happen
- within the same millisecond.</para>
- </section>
-
- <section
- xml:id="major.compactions.change.query.results">
- <title>Major compactions change query results</title>
-
- <para><quote>...create three cell versions at t1, t2 and t3, with a maximum-versions
- setting of 2. So when getting all versions, only the values at t2 and t3 will be
- returned. But if you delete the version at t2 or t3, the one at t1 will appear again.
- Obviously, once a major compaction has run, such behavior will not be the case
- anymore...</quote> (See <emphasis>Garbage Collection</emphasis> in <link
- xlink:href="http://outerthought.org/blog/417-ot.html">Bending time in
- HBase</link>.)</para>
- </section>
- </section>
- </section>
- <section xml:id="dm.sort">
- <title>Sort Order</title>
- <para>All data model operations HBase return data in sorted order. First by row,
- then by ColumnFamily, followed by column qualifier, and finally timestamp (sorted
- in reverse, so newest records are returned first).
- </para>
- </section>
- <section xml:id="dm.column.metadata">
- <title>Column Metadata</title>
- <para>There is no store of column metadata outside of the internal KeyValue instances for a ColumnFamily.
- Thus, while HBase can support not only a wide number of columns per row, but a heterogenous set of columns
- between rows as well, it is your responsibility to keep track of the column names.
- </para>
- <para>The only way to get a complete set of columns that exist for a ColumnFamily is to process all the rows.
- For more information about how HBase stores data internally, see <xref linkend="keyvalue" />.
- </para>
- </section>
- <section xml:id="joins"><title>Joins</title>
- <para>Whether HBase supports joins is a common question on the dist-list, and there is a simple answer: it doesn't,
- at not least in the way that RDBMS' support them (e.g., with equi-joins or outer-joins in SQL). As has been illustrated
- in this chapter, the read data model operations in HBase are Get and Scan.
- </para>
- <para>However, that doesn't mean that equivalent join functionality can't be supported in your application, but
- you have to do it yourself. The two primary strategies are either denormalizing the data upon writing to HBase,
- or to have lookup tables and do the join between HBase tables in your application or MapReduce code (and as RDBMS'
- demonstrate, there are several strategies for this depending on the size of the tables, e.g., nested loops vs.
- hash-joins). So which is the best approach? It depends on what you are trying to do, and as such there isn't a single
- answer that works for every use case.
- </para>
- </section>
- <section xml:id="acid"><title>ACID</title>
- <para>See <link xlink:href="http://hbase.apache.org/acid-semantics.html">ACID Semantics</link>.
- Lars Hofhansl has also written a note on
- <link xlink:href="http://hadoop-hbase.blogspot.com/2012/03/acid-in-hbase.html">ACID in HBase</link>.</para>
- </section>
- </chapter> <!-- data model -->
-
- <!-- schema design -->
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="schema_design.xml"/>
-
- <chapter
- xml:id="mapreduce">
- <title>HBase and MapReduce</title>
- <para>Apache MapReduce is a software framework used to analyze large amounts of data, and is
- the framework used most often with <link
- xlink:href="http://hadoop.apache.org/">Apache Hadoop</link>. MapReduce itself is out of the
- scope of this document. A good place to get started with MapReduce is <link
- xlink:href="http://hadoop.apache.org/docs/r1.2.1/mapred_tutorial.html" />. MapReduce version
- 2 (MR2)is now part of <link
- xlink:href="http://hadoop.apache.org/docs/r2.3.0/hadoop-yarn/hadoop-yarn-site/">YARN</link>. </para>
-
- <para> This chapter discusses specific configuration steps you need to take to use MapReduce on
- data within HBase. In addition, it discusses other interactions and issues between HBase and
- MapReduce jobs.
- <note>
- <title>mapred and mapreduce</title>
- <para>There are two mapreduce packages in HBase as in MapReduce itself: <filename>org.apache.hadoop.hbase.mapred</filename>
- and <filename>org.apache.hadoop.hbase.mapreduce</filename>. The former does old-style API and the latter
- the new style. The latter has more facility though you can usually find an equivalent in the older
- package. Pick the package that goes with your mapreduce deploy. When in doubt or starting over, pick the
- <filename>org.apache.hadoop.hbase.mapreduce</filename>. In the notes below, we refer to
- o.a.h.h.mapreduce but replace with the o.a.h.h.mapred if that is what you are using.
- </para>
- </note>
- </para>
-
- <section
- xml:id="hbase.mapreduce.classpath">
- <title>HBase, MapReduce, and the CLASSPATH</title>
- <para>Ny default, MapReduce jobs deployed to a MapReduce cluster do not have access to either
- the HBase configuration under <envar>$HBASE_CONF_DIR</envar> or the HBase classes.</para>
- <para>To give the MapReduce jobs the access they need, you could add
- <filename>hbase-site.xml</filename> to the
- <filename><replaceable>$HADOOP_HOME</replaceable>/conf/</filename> directory and add the
- HBase JARs to the <filename><replaceable>HADOOP_HOME</replaceable>/conf/</filename>
- directory, then copy these changes across your cluster. You could add hbase-site.xml to
- $HADOOP_HOME/conf and add HBase jars to the $HADOOP_HOME/lib. You would then need to copy
- these changes across your cluster or edit
- <filename><replaceable>$HADOOP_HOME</replaceable>conf/hadoop-env.sh</filename> and add
- them to the <envar>HADOOP_CLASSPATH</envar> variable. However, this approach is not
- recommended because it will pollute your Hadoop install with HBase references. It also
- requires you to restart the Hadoop cluster before Hadoop can use the HBase data.</para>
- <para> Since HBase 0.90.x, HBase adds its dependency JARs to the job configuration itself. The
- dependencies only need to be available on the local CLASSPATH. The following example runs
- the bundled HBase <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/RowCounter.html">RowCounter</link>
- MapReduce job against a table named <systemitem>usertable</systemitem> If you have not set
- the environment variables expected in the command (the parts prefixed by a
- <literal>$</literal> sign and curly braces), you can use the actual system paths instead.
- Be sure to use the correct version of the HBase JAR for your system. The backticks
- (<literal>`</literal> symbols) cause ths shell to execute the sub-commands, setting the
- CLASSPATH as part of the command. This example assumes you use a BASH-compatible shell. </para>
- <screen language="bourne">$ <userinput>HADOOP_CLASSPATH=`${HBASE_HOME}/bin/hbase classpath` ${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server-VERSION.jar rowcounter usertable</userinput></screen>
- <para>When the command runs, internally, the HBase JAR finds the dependencies it needs for
- zookeeper, guava, and its other dependencies on the passed <envar>HADOOP_CLASSPATH</envar>
- and adds the JARs to the MapReduce job configuration. See the source at
- TableMapReduceUtil#addDependencyJars(org.apache.hadoop.mapreduce.Job) for how this is done. </para>
- <note>
- <para> The example may not work if you are running HBase from its build directory rather
- than an installed location. You may see an error like the following:</para>
- <screen>java.lang.RuntimeException: java.lang.ClassNotFoundException: org.apache.hadoop.hbase.mapreduce.RowCounter$RowCounterMapper</screen>
- <para>If this occurs, try modifying the command as follows, so that it uses the HBase JARs
- from the <filename>target/</filename> directory within the build environment.</para>
- <screen language="bourne">$ <userinput>HADOOP_CLASSPATH=${HBASE_HOME}/hbase-server/target/hbase-server-VERSION-SNAPSHOT.jar:`${HBASE_HOME}/bin/hbase classpath` ${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server/target/hbase-server-VERSION-SNAPSHOT.jar rowcounter usertable</userinput></screen>
- </note>
- <caution>
- <title>Notice to Mapreduce users of HBase 0.96.1 and above</title>
- <para>Some mapreduce jobs that use HBase fail to launch. The symptom is an exception similar
- to the following:</para>
- <screen>
-Exception in thread "main" java.lang.IllegalAccessError: class
- com.google.protobuf.ZeroCopyLiteralByteString cannot access its superclass
- com.google.protobuf.LiteralByteString
- at java.lang.ClassLoader.defineClass1(Native Method)
- at java.lang.ClassLoader.defineClass(ClassLoader.java:792)
- at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
- at java.net.URLClassLoader.defineClass(URLClassLoader.java:449)
- at java.net.URLClassLoader.access$100(URLClassLoader.java:71)
- at java.net.URLClassLoader$1.run(URLClassLoader.java:361)
- at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
- at java.security.AccessController.doPrivileged(Native Method)
- at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
- at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
- at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
- at
- org.apache.hadoop.hbase.protobuf.ProtobufUtil.toScan(ProtobufUtil.java:818)
- at
- org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.convertScanToString(TableMapReduceUtil.java:433)
- at
- org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.initTableMapperJob(TableMapReduceUtil.java:186)
- at
- org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.initTableMapperJob(TableMapReduceUtil.java:147)
- at
- org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.initTableMapperJob(TableMapReduceUtil.java:270)
- at
- org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.initTableMapperJob(TableMapReduceUtil.java:100)
-...
-</screen>
- <para>This is caused by an optimization introduced in <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-9867">HBASE-9867</link> that
- inadvertently introduced a classloader dependency. </para>
- <para>This affects both jobs using the <code>-libjars</code> option and "fat jar," those
- which package their runtime dependencies in a nested <code>lib</code> folder.</para>
- <para>In order to satisfy the new classloader requirements, hbase-protocol.jar must be
- included in Hadoop's classpath. See <xref
- linkend="hbase.mapreduce.classpath" /> for current recommendations for resolving
- classpath errors. The following is included for historical purposes.</para>
- <para>This can be resolved system-wide by including a reference to the hbase-protocol.jar in
- hadoop's lib directory, via a symlink or by copying the jar into the new location.</para>
- <para>This can also be achieved on a per-job launch basis by including it in the
- <code>HADOOP_CLASSPATH</code> environment variable at job submission time. When
- launching jobs that package their dependencies, all three of the following job launching
- commands satisfy this requirement:</para>
- <screen language="bourne">
-$ <userinput>HADOOP_CLASSPATH=/path/to/hbase-protocol.jar:/path/to/hbase/conf hadoop jar MyJob.jar MyJobMainClass</userinput>
-$ <userinput>HADOOP_CLASSPATH=$(hbase mapredcp):/path/to/hbase/conf hadoop jar MyJob.jar MyJobMainClass</userinput>
-$ <userinput>HADOOP_CLASSPATH=$(hbase classpath) hadoop jar MyJob.jar MyJobMainClass</userinput>
- </screen>
- <para>For jars that do not package their dependencies, the following command structure is
- necessary:</para>
- <screen language="bourne">
-$ <userinput>HADOOP_CLASSPATH=$(hbase mapredcp):/etc/hbase/conf hadoop jar MyApp.jar MyJobMainClass -libjars $(hbase mapredcp | tr ':' ',')</userinput> ...
- </screen>
- <para>See also <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10304">HBASE-10304</link> for
- further discussion of this issue.</para>
- </caution>
- </section>
-
- <section>
- <title>MapReduce Scan Caching</title>
- <para>TableMapReduceUtil now restores the option to set scanner caching (the number of rows
- which are cached before returning the result to the client) on the Scan object that is
- passed in. This functionality was lost due to a bug in HBase 0.95 (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11558">HBASE-11558</link>), which
- is fixed for HBase 0.98.5 and 0.96.3. The priority order for choosing the scanner caching is
- as follows:</para>
- <orderedlist>
- <listitem>
- <para>Caching settings which are set on the scan object.</para>
- </listitem>
- <listitem>
- <para>Caching settings which are specified via the configuration option
- <option>hbase.client.scanner.caching</option>, which can either be set manually in
- <filename>hbase-site.xml</filename> or via the helper method
- <code>TableMapReduceUtil.setScannerCaching()</code>.</para>
- </listitem>
- <listitem>
- <para>The default value <code>HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING</code>, which is set to
- <literal>100</literal>.</para>
- </listitem>
- </orderedlist>
- <para>Optimizing the caching settings is a balance between the time the client waits for a
- result and the number of sets of results the client needs to receive. If the caching setting
- is too large, the client could end up waiting for a long time or the request could even time
- out. If the setting is too small, the scan needs to return results in several pieces.
- If you think of the scan as a shovel, a bigger cache setting is analogous to a bigger
- shovel, and a smaller cache setting is equivalent to more shoveling in order to fill the
- bucket.</para>
- <para>The list of priorities mentioned above allows you to set a reasonable default, and
- override it for specific operations.</para>
- <para>See the API documentation for <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html"
- >Scan</link> for more details.</para>
- </section>
-
- <section>
- <title>Bundled HBase MapReduce Jobs</title>
- <para>The HBase JAR also serves as a Driver for some bundled mapreduce jobs. To learn about
- the bundled MapReduce jobs, run the following command.</para>
-
- <screen language="bourne">$ <userinput>${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server-VERSION.jar</userinput>
-<computeroutput>An example program must be given as the first argument.
-Valid program names are:
- copytable: Export a table from local cluster to peer cluster
- completebulkload: Complete a bulk data load.
- export: Write table data to HDFS.
- import: Import data written by Export.
- importtsv: Import data in TSV format.
- rowcounter: Count rows in HBase table</computeroutput>
- </screen>
- <para>Each of the valid program names are bundled MapReduce jobs. To run one of the jobs,
- model your command after the following example.</para>
- <screen language="bourne">$ <userinput>${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server-VERSION.jar rowcounter myTable</userinput></screen>
- </section>
-
- <section>
- <title>HBase as a MapReduce Job Data Source and Data Sink</title>
- <para>HBase can be used as a data source, <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html">TableInputFormat</link>,
- and data sink, <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.html">TableOutputFormat</link>
- or <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/MultiTableOutputFormat.html">MultiTableOutputFormat</link>,
- for MapReduce jobs. Writing MapReduce jobs that read or write HBase, it is advisable to
- subclass <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableMapper.html">TableMapper</link>
- and/or <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableReducer.html">TableReducer</link>.
- See the do-nothing pass-through classes <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/IdentityTableMapper.html">IdentityTableMapper</link>
- and <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/IdentityTableReducer.html">IdentityTableReducer</link>
- for basic usage. For a more involved example, see <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/RowCounter.html">RowCounter</link>
- or review the <code>org.apache.hadoop.hbase.mapreduce.TestTableMapReduce</code> unit test. </para>
- <para>If you run MapReduce jobs that use HBase as source or sink, need to specify source and
- sink table and column names in your configuration.</para>
-
- <para>When you read from HBase, the <code>TableInputFormat</code> requests the list of regions
- from HBase and makes a map, which is either a <code>map-per-region</code> or
- <code>mapreduce.job.maps</code> map, whichever is smaller. If your job only has two maps,
- raise <code>mapreduce.job.maps</code> to a number greater than the number of regions. Maps
- will run on the adjacent TaskTracker if you are running a TaskTracer and RegionServer per
- node. When writing to HBase, it may make sense to avoid the Reduce step and write back into
- HBase from within your map. This approach works when your job does not need the sort and
- collation that MapReduce does on the map-emitted data. On insert, HBase 'sorts' so there is
- no point double-sorting (and shuffling data around your MapReduce cluster) unless you need
- to. If you do not need the Reduce, you myour map might emit counts of records processed for
- reporting at the end of the jobj, or set the number of Reduces to zero and use
- TableOutputFormat. If running the Reduce step makes sense in your case, you should typically
- use multiple reducers so that load is spread across the HBase cluster.</para>
-
- <para>A new HBase partitioner, the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/HRegionPartitioner.html">HRegionPartitioner</link>,
- can run as many reducers the number of existing regions. The HRegionPartitioner is suitable
- when your table is large and your upload will not greatly alter the number of existing
- regions upon completion. Otherwise use the default partitioner. </para>
- </section>
-
- <section>
- <title>Writing HFiles Directly During Bulk Import</title>
- <para>If you are importing into a new table, you can bypass the HBase API and write your
- content directly to the filesystem, formatted into HBase data files (HFiles). Your import
- will run faster, perhaps an order of magnitude faster. For more on how this mechanism works,
- see <xref
- linkend="arch.bulk.load" />.</para>
- </section>
-
- <section>
- <title>RowCounter Example</title>
- <para>The included <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/RowCounter.html">RowCounter</link>
- MapReduce job uses <code>TableInputFormat</code> and does a count of all rows in the specified
- table. To run it, use the following command: </para>
- <screen language="bourne">$ <userinput>./bin/hadoop jar hbase-X.X.X.jar</userinput></screen>
- <para>This will
- invoke the HBase MapReduce Driver class. Select <literal>rowcounter</literal> from the choice of jobs
- offered. This will print rowcouner usage advice to standard output. Specify the tablename,
- column to count, and output
- directory. If you have classpath errors, see <xref linkend="hbase.mapreduce.classpath" />.</para>
- </section>
-
- <section
- xml:id="splitter">
- <title>Map-Task Splitting</title>
- <section
- xml:id="splitter.default">
- <title>The Default HBase MapReduce Splitter</title>
- <para>When <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html">TableInputFormat</link>
- is used to source an HBase table in a MapReduce job, its splitter will make a map task for
- each region of the table. Thus, if there are 100 regions in the table, there will be 100
- map-tasks for the job - regardless of how many column families are selected in the
- Scan.</para>
- </section>
- <section
- xml:id="splitter.custom">
- <title>Custom Splitters</title>
- <para>For those interested in implementing custom splitters, see the method
- <code>getSplits</code> in <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableInputFormatBase.html">TableInputFormatBase</link>.
- That is where the logic for map-task assignment resides. </para>
- </section>
- </section>
- <section
- xml:id="mapreduce.example">
- <title>HBase MapReduce Examples</title>
- <section
- xml:id="mapreduce.example.read">
- <title>HBase MapReduce Read Example</title>
- <para>The following is an example of using HBase as a MapReduce source in read-only manner.
- Specifically, there is a Mapper instance but no Reducer, and nothing is being emitted from
- the Mapper. There job would be defined as follows...</para>
- <programlisting language="java">
-Configuration config = HBaseConfiguration.create();
-Job job = new Job(config, "ExampleRead");
-job.setJarByClass(MyReadJob.class); // class that contains mapper
-
-Scan scan = new Scan();
-scan.setCaching(500); // 1 is the default in Scan, which will be bad for MapReduce jobs
-scan.setCacheBlocks(false); // don't set to true for MR jobs
-// set other scan attrs
-...
-
-TableMapReduceUtil.initTableMapperJob(
- tableName, // input HBase table name
- scan, // Scan instance to control CF and attribute selection
- MyMapper.class, // mapper
- null, // mapper output key
- null, // mapper output value
- job);
-job.setOutputFormatClass(NullOutputFormat.class); // because we aren't emitting anything from mapper
-
-boolean b = job.waitForCompletion(true);
-if (!b) {
- throw new IOException("error with job!");
-}
- </programlisting>
- <para>...and the mapper instance would extend <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableMapper.html">TableMapper</link>...</para>
- <programlisting language="java">
-public static class MyMapper extends TableMapper<Text, Text> {
-
- public void map(ImmutableBytesWritable row, Result value, Context context) throws InterruptedException, IOException {
- // process data for the row from the Result instance.
- }
-}
- </programlisting>
- </section>
- <section
- xml:id="mapreduce.example.readwrite">
- <title>HBase MapReduce Read/Write Example</title>
- <para>The following is an example of using HBase both as a source and as a sink with
- MapReduce. This example will simply copy data from one table to another.</para>
- <programlisting language="java">
-Configuration config = HBaseConfiguration.create();
-Job job = new Job(config,"ExampleReadWrite");
-job.setJarByClass(MyReadWriteJob.class); // class that contains mapper
-
-Scan scan = new Scan();
-scan.setCaching(500); // 1 is the default in Scan, which will be bad for MapReduce jobs
-scan.setCacheBlocks(false); // don't set to true for MR jobs
-// set other scan attrs
-
-TableMapReduceUtil.initTableMapperJob(
- sourceTable, // input table
- scan, // Scan instance to control CF and attribute selection
- MyMapper.class, // mapper class
- null, // mapper output key
- null, // mapper output value
- job);
-TableMapReduceUtil.initTableReducerJob(
- targetTable, // output table
- null, // reducer class
- job);
-job.setNumReduceTasks(0);
-
-boolean b = job.waitForCompletion(true);
-if (!b) {
- throw new IOException("error with job!");
-}
- </programlisting>
- <para>An explanation is required of what <classname>TableMapReduceUtil</classname> is doing,
- especially with the reducer. <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.html">TableOutputFormat</link>
- is being used as the outputFormat class, and several parameters are being set on the
- config (e.g., TableOutputFormat.OUTPUT_TABLE), as well as setting the reducer output key
- to <classname>ImmutableBytesWritable</classname> and reducer value to
- <classname>Writable</classname>. These could be set by the programmer on the job and
- conf, but <classname>TableMapReduceUtil</classname> tries to make things easier.</para>
- <para>The following is the example mapper, which will create a <classname>Put</classname>
- and matching the input <classname>Result</classname> and emit it. Note: this is what the
- CopyTable utility does. </para>
- <programlisting language="java">
-public static class MyMapper extends TableMapper<ImmutableBytesWritable, Put> {
-
- public void map(ImmutableBytesWritable row, Result value, Context context) throws IOException, InterruptedException {
- // this example is just copying the data from the source table...
- context.write(row, resultToPut(row,value));
- }
-
- private static Put resultToPut(ImmutableBytesWritable key, Result result) throws IOException {
- Put put = new Put(key.get());
- for (KeyValue kv : result.raw()) {
- put.add(kv);
- }
- return put;
- }
-}
- </programlisting>
- <para>There isn't actually a reducer step, so <classname>TableOutputFormat</classname> takes
- care of sending the <classname>Put</classname> to the target table. </para>
- <para>This is just an example, developers could choose not to use
- <classname>TableOutputFormat</classname> and connect to the target table themselves.
- </para>
- </section>
- <section
- xml:id="mapreduce.example.readwrite.multi">
- <title>HBase MapReduce Read/Write Example With Multi-Table Output</title>
- <para>TODO: example for <classname>MultiTableOutputFormat</classname>. </para>
- </section>
- <section
- xml:id="mapreduce.example.summary">
- <title>HBase MapReduce Summary to HBase Example</title>
- <para>The following example uses HBase as a MapReduce source and sink with a summarization
- step. This example will count the number of distinct instances of a value in a table and
- write those summarized counts in another table.
- <programlisting language="java">
-Configuration config = HBaseConfiguration.create();
-Job job = new Job(config,"ExampleSummary");
-job.setJarByClass(MySummaryJob.class); // class that contains mapper and reducer
-
-Scan scan = new Scan();
-scan.setCaching(500); // 1 is the default in Scan, which will be bad for MapReduce jobs
-scan.setCacheBlocks(false); // don't set to true for MR jobs
-// set other scan attrs
-
-TableMapReduceUtil.initTableMapperJob(
- sourceTable, // input table
- scan, // Scan instance to control CF and attribute selection
- MyMapper.class, // mapper class
- Text.class, // mapper output key
- IntWritable.class, // mapper output value
- job);
-TableMapReduceUtil.initTableReducerJob(
- targetTable, // output table
- MyTableReducer.class, // reducer class
- job);
-job.setNumReduceTasks(1); // at least one, adjust as required
-
-boolean b = job.waitForCompletion(true);
-if (!b) {
- throw new IOException("error with job!");
-}
- </programlisting>
- In this example mapper a column with a String-value is chosen as the value to summarize
- upon. This value is used as the key to emit from the mapper, and an
- <classname>IntWritable</classname> represents an instance counter.
- <programlisting language="java">
-public static class MyMapper extends TableMapper<Text, IntWritable> {
- public static final byte[] CF = "cf".getBytes();
- public static final byte[] ATTR1 = "attr1".getBytes();
-
- private final IntWritable ONE = new IntWritable(1);
- private Text text = new Text();
-
- public void map(ImmutableBytesWritable row, Result value, Context context) throws IOException, InterruptedException {
- String val = new String(value.getValue(CF, ATTR1));
- text.set(val); // we can only emit Writables...
-
- context.write(text, ONE);
- }
-}
- </programlisting>
- In the reducer, the "ones" are counted (just like any other MR example that does this),
- and then emits a <classname>Put</classname>.
- <programlisting language="java">
-public static class MyTableReducer extends TableReducer<Text, IntWritable, ImmutableBytesWritable> {
- public static final byte[] CF = "cf".getBytes();
- public static final byte[] COUNT = "count".getBytes();
-
- public void reduce(Text key, Iterable<IntWritable> values, Context context) throws IOException, InterruptedException {
- int i = 0;
- for (IntWritable val : values) {
- i += val.get();
- }
- Put put = new Put(Bytes.toBytes(key.toString()));
- put.add(CF, COUNT, Bytes.toBytes(i));
-
- context.write(null, put);
- }
-}
- </programlisting>
- </para>
- </section>
- <section
- xml:id="mapreduce.example.summary.file">
- <title>HBase MapReduce Summary to File Example</title>
- <para>This very similar to the summary example above, with exception that this is using
- HBase as a MapReduce source but HDFS as the sink. The differences are in the job setup and
- in the reducer. The mapper remains the same. </para>
- <programlisting language="java">
-Configuration config = HBaseConfiguration.create();
-Job job = new Job(config,"ExampleSummaryToFile");
-job.setJarByClass(MySummaryFileJob.class); // class that contains mapper and reducer
-
-Scan scan = new Scan();
-scan.setCaching(500); // 1 is the default in Scan, which will be bad for MapReduce jobs
-scan.setCacheBlocks(false); // don't set to true for MR jobs
-// set other scan attrs
-
-TableMapReduceUtil.initTableMapperJob(
- sourceTable, // input table
- scan, // Scan instance to control CF and attribute selection
- MyMapper.class, // mapper class
- Text.class, // mapper output key
- IntWritable.class, // mapper output value
- job);
-job.setReducerClass(MyReducer.class); // reducer class
-job.setNumReduceTasks(1); // at least one, adjust as required
-FileOutputFormat.setOutputPath(job, new Path("/tmp/mr/mySummaryFile")); // adjust directories as required
-
-boolean b = job.waitForCompletion(true);
-if (!b) {
- throw new IOException("error with job!");
-}
- </programlisting>
- <para>As stated above, the previous Mapper can run unchanged with this example. As for the
- Reducer, it is a "generic" Reducer instead of extending TableMapper and emitting
- Puts.</para>
- <programlisting language="java">
- public static class MyReducer extends Reducer<Text, IntWritable, Text, IntWritable> {
-
- public void reduce(Text key, Iterable<IntWritable> values, Context context) throws IOException, InterruptedException {
- int i = 0;
- for (IntWritable val : values) {
- i += val.get();
- }
- context.write(key, new IntWritable(i));
- }
-}
- </programlisting>
- </section>
- <section
- xml:id="mapreduce.example.summary.noreducer">
- <title>HBase MapReduce Summary to HBase Without Reducer</title>
- <para>It is also possible to perform summaries without a reducer - if you use HBase as the
- reducer. </para>
- <para>An HBase target table would need to exist for the job summary. The Table method
- <code>incrementColumnValue</code> would be used to atomically increment values. From a
- performance perspective, it might make sense to keep a Map of values with their values to
- be incremeneted for each map-task, and make one update per key at during the <code>
- cleanup</code> method of the mapper. However, your milage may vary depending on the
- number of rows to be processed and unique keys. </para>
- <para>In the end, the summary results are in HBase. </para>
- </section>
- <section
- xml:id="mapreduce.example.summary.rdbms">
- <title>HBase MapReduce Summary to RDBMS</title>
- <para>Sometimes it is more appropriate to generate summaries to an RDBMS. For these cases,
- it is possible to generate summaries directly to an RDBMS via a custom reducer. The
- <code>setup</code> method can connect to an RDBMS (the connection information can be
- passed via custom parameters in the context) and the cleanup method can close the
- connection. </para>
- <para>It is critical to understand that number of reducers for the job affects the
- summarization implementation, and you'll have to design this into your reducer.
- Specifically, whether it is designed to run as a singleton (one reducer) or multiple
- reducers. Neither is right or wrong, it depends on your use-case. Recognize that the more
- reducers that are assigned to the job, the more simultaneous connections to the RDBMS will
- be created - this will scale, but only to a point. </para>
- <programlisting language="java">
- public static class MyRdbmsReducer extends Reducer<Text, IntWritable, Text, IntWritable> {
-
- private Connection c = null;
-
- public void setup(Context context) {
- // create DB connection...
- }
-
- public void reduce(Text key, Iterable<IntWritable> values, Context context) throws IOException, InterruptedException {
- // do summarization
- // in this example the keys are Text, but this is just an example
- }
-
- public void cleanup(Context context) {
- // close db connection
- }
-
-}
- </programlisting>
- <para>In the end, the summary results are written to your RDBMS table/s. </para>
- </section>
-
- </section>
- <!-- mr examples -->
- <section
- xml:id="mapreduce.htable.access">
- <title>Accessing Other HBase Tables in a MapReduce Job</title>
- <para>Although the framework currently allows one HBase table as input to a MapReduce job,
- other HBase tables can be accessed as lookup tables, etc., in a MapReduce job via creating
- an Table instance in the setup method of the Mapper.
- <programlisting language="java">public class MyMapper extends TableMapper<Text, LongWritable> {
- private Table myOtherTable;
-
- public void setup(Context context) {
- // In here create a Connection to the cluster and save it or use the Connection
- // from the existing table
- myOtherTable = connection.getTable("myOtherTable");
- }
-
- public void map(ImmutableBytesWritable row, Result value, Context context) throws IOException, InterruptedException {
- // process Result...
- // use 'myOtherTable' for lookups
- }
-
- </programlisting>
- </para>
- </section>
- <section
- xml:id="mapreduce.specex">
- <title>Speculative Execution</title>
- <para>It is generally advisable to turn off speculative execution for MapReduce jobs that use
- HBase as a source. This can either be done on a per-Job basis through properties, on on the
- entire cluster. Especially for longer running jobs, speculative execution will create
- duplicate map-tasks which will double-write your data to HBase; this is probably not what
- you want. </para>
- <para>See <xref
- linkend="spec.ex" /> for more information. </para>
- </section>
- </chapter> <!-- mapreduce -->
-
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml" />
-
- <chapter xml:id="architecture">
- <title>Architecture</title>
- <section xml:id="arch.overview">
- <title>Overview</title>
- <section xml:id="arch.overview.nosql">
- <title>NoSQL?</title>
- <para>HBase is a type of "NoSQL" database. "NoSQL" is a general term meaning that the database isn't an RDBMS which
- supports SQL as its primary access language, but there are many types of NoSQL databases: BerkeleyDB is an
- example of a local NoSQL database, whereas HBase is very much a distributed database. Technically speaking,
- HBase is really more a "Data Store" than "Data Base" because it lacks many of the features you find in an RDBMS,
- such as typed columns, secondary indexes, triggers, and advanced query languages, etc.
- </para>
- <para>However, HBase has many features which supports both linear and modular scaling. HBase clusters expand
- by adding RegionServers that are hosted on commodity class servers. If a cluster expands from 10 to 20
- RegionServers, for example, it doubles both in terms of storage and as well as processing capacity.
- RDBMS can scale well, but only up to a point - specifically, the size of a single database server - and for the best
- performance requires specialized hardware and storage devices. HBase features of note are:
- <itemizedlist>
- <listitem><para>Strongly consistent reads/writes: HBase is not an "eventually consistent" DataStore. This
- makes it very suitable for tasks such as high-speed counter aggregation.</para> </listitem>
- <listitem><para>Automatic sharding: HBase tables are distributed on the cluster via regions, and regions are
- automatically split and re-distributed as your data grows.</para></listitem>
- <listitem><para>Automatic RegionServer failover</para></listitem>
- <listitem><para>Hadoop/HDFS Integration: HBase supports HDFS out of the box as its distributed file system.</para></listitem>
- <listitem><para>MapReduce: HBase supports massively parallelized processing via MapReduce for using HBase as both
- source and sink.</para></listitem>
- <listitem><para>Java Client API: HBase supports an easy to use Java API for programmatic access.</para></listitem>
- <listitem><para>Thrift/REST API: HBase also supports Thrift and REST for non-Java front-ends.</para></listitem>
- <listitem><para>Block Cache and Bloom Filters: HBase supports a Block Cache and Bloom Filters for high volume query optimization.</para></listitem>
- <listitem><para>Operational Management: HBase provides build-in web-pages for operational insight as well as JMX metrics.</para></listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section xml:id="arch.overview.when">
- <title>When Should I Use HBase?</title>
- <para>HBase isn't suitable for every problem.</para>
- <para>First, make sure you have enough data. If you have hundreds of millions or billions of rows, then
- HBase is a good candidate. If you only have a few thousand/million rows, then using a traditional RDBMS
- might be a better choice due to the fact that all of your data might wind up on a single node (or two) and
- the rest of the cluster may be sitting idle.
- </para>
- <para>Second, make sure you can live without all the extra features that an RDBMS provides (e.g., typed columns,
- secondary indexes, transactions, advanced query languages, etc.) An application built against an RDBMS cannot be
- "ported" to HBase by simply changing a JDBC driver, for example. Consider moving from an RDBMS to HBase as a
- complete redesign as opposed to a port.
- </para>
- <para>Third, make sure you have enough hardware. Even HDFS doesn't do well with anything less than
- 5 DataNodes (due to things such as HDFS block replication which has a default of 3), plus a NameNode.
- </para>
- <para>HBase can run quite well stand-alone on a laptop - but this should be considered a development
- configuration only.
- </para>
- </section>
- <section xml:id="arch.overview.hbasehdfs">
- <title>What Is The Difference Between HBase and Hadoop/HDFS?</title>
- <para><link xlink:href="http://hadoop.apache.org/hdfs/">HDFS</link> is a distributed file system that is well suited for the storage of large files.
- Its documentation states that it is not, however, a general purpose file system, and does not provide fast individual record lookups in files.
- HBase, on the other hand, is built on top of HDFS and provides fast record lookups (and updates) for large tables.
- This can sometimes be a point of conceptual confusion. HBase internally puts your data in indexed "StoreFiles" that exist
- on HDFS for high-speed lookups. See the <xref linkend="datamodel" /> and the rest of this chapter for more information on how HBase achieves its goals.
- </para>
- </section>
- </section>
-
- <section
- xml:id="arch.catalog">
- <title>Catalog Tables</title>
- <para>The catalog table <code>hbase:meta</code> exists as an HBase table and is filtered out of the HBase
- shell's <code>list</code> command, but is in fact a table just like any other. </para>
- <section
- xml:id="arch.catalog.root">
- <title>-ROOT-</title>
- <note>
- <para>The <code>-ROOT-</code> table was removed in HBase 0.96.0. Information here should
- be considered historical.</para>
- </note>
- <para>The <code>-ROOT-</code> table kept track of the location of the
- <code>.META</code> table (the previous name for the table now called <code>hbase:meta</code>) prior to HBase
- 0.96. The <code>-ROOT-</code> table structure was as follows: </para>
- <itemizedlist>
- <title>Key</title>
- <listitem>
- <para>.META. region key (<code>.META.,,1</code>)</para>
- </listitem>
- </itemizedlist>
-
- <itemizedlist>
- <title>Values</title>
- <listitem>
- <para><code>info:regioninfo</code> (serialized <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HRegionInfo.html">HRegionInfo</link>
- instance of hbase:meta)</para>
- </listitem>
- <listitem>
- <para><code>info:server</code> (server:port of the RegionServer holding
- hbase:meta)</para>
- </listitem>
- <listitem>
- <para><code>info:serverstartcode</code> (start-time of the RegionServer process holding
- hbase:meta)</para>
- </listitem>
- </itemizedlist>
- </section>
- <section
- xml:id="arch.catalog.meta">
- <title>hbase:meta</title>
- <para>The <code>hbase:meta</code> table (previously called <code>.META.</code>) keeps a list
- of all regions in the system. The location of <code>hbase:meta</code> was previously
- tracked within the <code>-ROOT-</code> table, but is now stored in Zookeeper.</para>
- <para>The <code>hbase:meta</code> table structure is as follows: </para>
- <itemizedlist>
- <title>Key</title>
- <listitem>
- <para>Region key of the format (<code>[table],[region start key],[region
- id]</code>)</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Values</title>
- <listitem>
- <para><code>info:regioninfo</code> (serialized <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HRegionInfo.html">
- HRegionInfo</link> instance for this region)</para>
- </listitem>
- <listitem>
- <para><code>info:server</code> (server:port of the RegionServer containing this
- region)</para>
- </listitem>
- <listitem>
- <para><code>info:serverstartcode</code> (start-time of the RegionServer process
- containing this region)</para>
- </listitem>
- </itemizedlist>
- <para>When a table is in the process of splitting, two other columns will be created, called
- <code>info:splitA</code> and <code>info:splitB</code>. These columns represent the two
- daughter regions. The values for these columns are also serialized HRegionInfo instances.
- After the region has been split, eventually this row will be deleted. </para>
- <note>
- <title>Note on HRegionInfo</title>
- <para>The empty key is used to denote table start and table end. A region with an empty
- start key is the first region in a table. If a region has both an empty start and an
- empty end key, it is the only region in the table </para>
- </note>
- <para>In the (hopefully unlikely) event that programmatic processing of catalog metadata is
- required, see the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Writables.html#getHRegionInfo%28byte[]%29">Writables</link>
- utility. </para>
- </section>
- <section
- xml:id="arc
<TRUNCATED>
[08/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/ops_mgt.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/ops_mgt.xml b/src/main/docbkx/ops_mgt.xml
deleted file mode 100644
index 0af8f02..0000000
--- a/src/main/docbkx/ops_mgt.xml
+++ /dev/null
@@ -1,2488 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="ops_mgt"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work forf additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase Operational Management</title>
- <para> This chapter will cover operational tools and practices required of a running Apache HBase
- cluster. The subject of operations is related to the topics of <xref
- linkend="trouble" />, <xref
- linkend="performance" />, and <xref
- linkend="configuration" /> but is a distinct topic in itself. </para>
-
- <section
- xml:id="tools">
- <title>HBase Tools and Utilities</title>
-
- <para>HBase provides several tools for administration, analysis, and debugging of your cluster.
- The entry-point to most of these tools is the <filename>bin/hbase</filename> command, though
- some tools are available in the <filename>dev-support/</filename> directory.</para>
- <para>To see usage instructions for <filename>bin/hbase</filename> command, run it with no
- arguments, or with the <option>-h</option> argument. These are the usage instructions for
- HBase 0.98.x. Some commands, such as <command>version</command>, <command>pe</command>,
- <command>ltt</command>, <command>clean</command>, are not available in previous
- versions.</para>
- <screen>
-$ <userinput>bin/hbase</userinput>
-<![CDATA[Usage: hbase [<options>] <command> [<args>]]]>
-Options:
- --config DIR Configuration direction to use. Default: ./conf
- --hosts HOSTS Override the list in 'regionservers' file
-
-Commands:
-Some commands take arguments. Pass no args or -h for usage.
- shell Run the HBase shell
- hbck Run the hbase 'fsck' tool
- hlog Write-ahead-log analyzer
- hfile Store file analyzer
- zkcli Run the ZooKeeper shell
- upgrade Upgrade hbase
- master Run an HBase HMaster node
- regionserver Run an HBase HRegionServer node
- zookeeper Run a Zookeeper server
- rest Run an HBase REST server
- thrift Run the HBase Thrift server
- thrift2 Run the HBase Thrift2 server
- clean Run the HBase clean up script
- classpath Dump hbase CLASSPATH
- mapredcp Dump CLASSPATH entries required by mapreduce
- pe Run PerformanceEvaluation
- ltt Run LoadTestTool
- version Print the version
- CLASSNAME Run the class named CLASSNAME
- </screen>
- <para>Some of the tools and utilities below are Java classes which are passed directly to the
- <filename>bin/hbase</filename> command, as referred to in the last line of the usage
- instructions. Others, such as <command>hbase shell</command> (<xref linkend="shell"/>),
- <command>hbase upgrade</command> (<xref linkend="upgrading"/>), and <command>hbase
- thrift</command> (<xref linkend="thrift"/>), are documented elsewhere in this guide.</para>
- <section
- xml:id="canary">
- <title>Canary</title>
- <para> There is a Canary class can help users to canary-test the HBase cluster status, with
- every column-family for every regions or regionservers granularity. To see the usage, use
- the <literal>--help</literal> parameter. </para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase org.apache.hadoop.hbase.tool.Canary -help
-
-Usage: bin/hbase org.apache.hadoop.hbase.tool.Canary [opts] [table1 [table2]...] | [regionserver1 [regionserver2]..]
- where [opts] are:
- -help Show this help and exit.
- -regionserver replace the table argument to regionserver,
- which means to enable regionserver mode
- -daemon Continuous check at defined intervals.
- -interval <N> Interval between checks (sec)
- -e Use region/regionserver as regular expression
- which means the region/regionserver is regular expression pattern
- -f <B> stop whole program if first error occurs, default is true
- -t <N> timeout for a check, default is 600000 (milliseconds)</screen>
- <para> This tool will return non zero error codes to user for collaborating with other
- monitoring tools, such as Nagios. The error code definitions are: </para>
- <programlisting language="java">private static final int USAGE_EXIT_CODE = 1;
-private static final int INIT_ERROR_EXIT_CODE = 2;
-private static final int TIMEOUT_ERROR_EXIT_CODE = 3;
-private static final int ERROR_EXIT_CODE = 4;</programlisting>
- <para> Here are some examples based on the following given case. There are two HTable called
- test-01 and test-02, they have two column family cf1 and cf2 respectively, and deployed on
- the 3 regionservers. see following table. </para>
-
- <informaltable>
- <tgroup
- cols="3"
- align="center"
- colsep="1"
- rowsep="1">
- <colspec
- colname="regionserver"
- align="center" />
- <colspec
- colname="test-01"
- align="center" />
- <colspec
- colname="test-02"
- align="center" />
- <thead>
- <row>
- <entry>RegionServer</entry>
- <entry>test-01</entry>
- <entry>test-02</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rs1</entry>
- <entry>r1</entry>
- <entry>r2</entry>
- </row>
- <row>
- <entry>rs2</entry>
- <entry>r2</entry>
- <entry />
- </row>
- <row>
- <entry>rs3</entry>
- <entry>r2</entry>
- <entry>r1</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para> Following are some examples based on the previous given case. </para>
- <section>
- <title>Canary test for every column family (store) of every region of every table</title>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase org.apache.hadoop.hbase.tool.Canary
-
-3/12/09 03:26:32 INFO tool.Canary: read from region test-01,,1386230156732.0e3c7d77ffb6361ea1b996ac1042ca9a. column family cf1 in 2ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-01,,1386230156732.0e3c7d77ffb6361ea1b996ac1042ca9a. column family cf2 in 2ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-01,0004883,1386230156732.87b55e03dfeade00f441125159f8ca87. column family cf1 in 4ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-01,0004883,1386230156732.87b55e03dfeade00f441125159f8ca87. column family cf2 in 1ms
-...
-13/12/09 03:26:32 INFO tool.Canary: read from region test-02,,1386559511167.aa2951a86289281beee480f107bb36ee. column family cf1 in 5ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-02,,1386559511167.aa2951a86289281beee480f107bb36ee. column family cf2 in 3ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-02,0004883,1386559511167.cbda32d5e2e276520712d84eaaa29d84. column family cf1 in 31ms
-13/12/09 03:26:32 INFO tool.Canary: read from region test-02,0004883,1386559511167.cbda32d5e2e276520712d84eaaa29d84. column family cf2 in 8ms
-</screen>
- <para> So you can see, table test-01 has two regions and two column families, so the Canary
- tool will pick 4 small piece of data from 4 (2 region * 2 store) different stores. This is
- a default behavior of the this tool does. </para>
- </section>
-
- <section>
- <title>Canary test for every column family (store) of every region of specific
- table(s)</title>
- <para> You can also test one or more specific tables.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase orghapache.hadoop.hbase.tool.Canary test-01 test-02</screen>
- </section>
-
- <section>
- <title>Canary test with regionserver granularity</title>
- <para> This will pick one small piece of data from each regionserver, and can also put your
- resionserver name as input options for canary-test specific regionservers.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase org.apache.hadoop.hbase.tool.Canary -regionserver
-
-13/12/09 06:05:17 INFO tool.Canary: Read from table:test-01 on region server:rs2 in 72ms
-13/12/09 06:05:17 INFO tool.Canary: Read from table:test-02 on region server:rs3 in 34ms
-13/12/09 06:05:17 INFO tool.Canary: Read from table:test-01 on region server:rs1 in 56ms</screen>
- </section>
- <section>
- <title>Canary test with regular expression pattern</title>
- <para> This will test both table test-01 and test-02.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase orghapache.hadoop.hbase.tool.Canary -e test-0[1-2]</screen>
- </section>
-
- <section>
- <title>Run canary test as daemon mode</title>
- <para> Run repeatedly with interval defined in option -interval whose default value is 6
- seconds. This daemon will stop itself and return non-zero error code if any error occurs,
- due to the default value of option -f is true.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase orghapache.hadoop.hbase.tool.Canary -daemon</screen>
- <para>Run repeatedly with internal 5 seconds and will not stop itself even error occurs in
- the test.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase orghapache.hadoop.hbase.tool.Canary -daemon -interval 50000 -f false</screen>
- </section>
-
- <section>
- <title>Force timeout if canary test stuck</title>
- <para>In some cases, we suffered the request stucked on the regionserver and not response
- back to the client. The regionserver in problem, would also not indicated to be dead by
- Master, which would bring the clients hung. So we provide the timeout option to kill the
- canary test forcefully and return non-zero error code as well. This run sets the timeout
- value to 60 seconds, the default value is 600 seconds.</para>
- <screen language="bourne">$ ${HBASE_HOME}/bin/hbase orghapache.hadoop.hbase.tool.Canary -t 600000</screen>
- </section>
-
- </section>
-
- <section
- xml:id="health.check">
- <title>Health Checker</title>
- <para>You can configure HBase to run a script on a period and if it fails N times
- (configurable), have the server exit. See <link
- xlink:href="">HBASE-7351 Periodic health check script</link> for configurations and
- detail. </para>
- </section>
-
- <section
- xml:id="driver">
- <title>Driver</title>
- <para>Several frequently-accessed utilities are provided as <code>Driver</code> classes, and executed by
- the <filename>bin/hbase</filename> command. These utilities represent MapReduce jobs which
- run on your cluster. They are run in the following way, replacing
- <replaceable>UtilityName</replaceable> with the utility you want to run. This command
- assumes you have set the environment variable <literal>HBASE_HOME</literal> to the directory
- where HBase is unpacked on your server.</para>
- <screen language="bourne">
-${HBASE_HOME}/bin/hbase org.apache.hadoop.hbase.mapreduce.<replaceable>UtilityName</replaceable>
- </screen>
- <para>The following utilities are available:</para>
- <variablelist>
- <varlistentry>
- <term><command>LoadIncrementalHFiles</command></term>
- <listitem><para>Complete a bulk data load.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>CopyTable</command></term>
- <listitem><para>Export a table from the local cluster to a peer cluster.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>Export</command></term>
- <listitem><para>Write table data to HDFS.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>Import</command></term>
- <listitem><para>Import data written by a previous <command>Export</command> operation.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>ImportTsv</command></term>
- <listitem><para>Import data in TSV format.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>RowCounter</command></term>
- <listitem><para>Count rows in an HBase table.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><command>replication.VerifyReplication</command></term>
- <listitem><para>Compare the data from tables in two different clusters. WARNING: It
- doesn't work for incrementColumnValues'd cells since the timestamp is changed. Note that
- this command is in a different package than the others.</para></listitem>
- </varlistentry>
- </variablelist>
- <para>Each command except <command>RowCounter</command> accepts a single
- <literal>--help</literal> argument to print usage instructions.</para>
- </section>
- <section
- xml:id="hbck">
- <title>HBase <application>hbck</application></title>
- <subtitle>An <command>fsck</command> for your HBase install</subtitle>
- <para>To run <application>hbck</application> against your HBase cluster run <command>$
- ./bin/hbase hbck</command> At the end of the command's output it prints
- <literal>OK</literal> or <literal>INCONSISTENCY</literal>. If your cluster reports
- inconsistencies, pass <command>-details</command> to see more detail emitted. If
- inconsistencies, run <command>hbck</command> a few times because the inconsistency may be
- transient (e.g. cluster is starting up or a region is splitting). Passing
- <command>-fix</command> may correct the inconsistency (This latter is an experimental
- feature). </para>
- <para>For more information, see <xref
- linkend="hbck.in.depth" />. </para>
- </section>
- <section
- xml:id="hfile_tool2">
- <title>HFile Tool</title>
- <para>See <xref
- linkend="hfile_tool" />.</para>
- </section>
- <section
- xml:id="wal_tools">
- <title>WAL Tools</title>
-
- <section
- xml:id="hlog_tool">
- <title><classname>FSHLog</classname> tool</title>
-
- <para>The main method on <classname>FSHLog</classname> offers manual split and dump
- facilities. Pass it WALs or the product of a split, the content of the
- <filename>recovered.edits</filename>. directory.</para>
-
- <para>You can get a textual dump of a WAL file content by doing the following:</para>
- <screen language="bourne"> $ ./bin/hbase org.apache.hadoop.hbase.regionserver.wal.FSHLog --dump hdfs://example.org:8020/hbase/.logs/example.org,60020,1283516293161/10.10.21.10%3A60020.1283973724012 </screen>
- <para>The return code will be non-zero if issues with the file so you can test wholesomeness
- of file by redirecting <varname>STDOUT</varname> to <code>/dev/null</code> and testing the
- program return.</para>
-
- <para>Similarly you can force a split of a log file directory by doing:</para>
- <screen language="bourne"> $ ./bin/hbase org.apache.hadoop.hbase.regionserver.wal.FSHLog --split hdfs://example.org:8020/hbase/.logs/example.org,60020,1283516293161/</screen>
-
- <section
- xml:id="hlog_tool.prettyprint">
- <title>WAL Pretty Printer</title>
- <para>The WAL Pretty Printer is a tool with configurable options to
- print the contents of a WAL. You can invoke it via the hbase cli with the 'wal' command.
- </para>
- <screen langauge="bourne"> $ ./bin/hbase wal hdfs://example.org:8020/hbase/.logs/example.org,60020,1283516293161/10.10.21.10%3A60020.1283973724012</screen>
- <note>
- <title>WAL Printing in older versions of HBase</title>
- <para>Prior to version 2.0, the WAL Pretty Printer was called the
- <classname>HLogPrettyPrinter</classname>, after an internal name for HBase's write
- ahead log. In those versions, you can pring the contents of a WAL using the same
- configuration as above, but with the 'hlog' command.
- </para>
- <screen langauge="bourne"> $ ./bin/hbase hlog hdfs://example.org:8020/hbase/.logs/example.org,60020,1283516293161/10.10.21.10%3A60020.1283973724012</screen>
- </note>
- </section>
-
- </section>
- </section>
- <section
- xml:id="compression.tool">
- <title>Compression Tool</title>
- <para>See <xref
- linkend="compression.test" />.</para>
- </section>
- <section
- xml:id="copytable">
- <title>CopyTable</title>
- <para> CopyTable is a utility that can copy part or of all of a table, either to the same
- cluster or another cluster. The target table must first exist. The usage is as
- follows:</para>
-
- <screen language="bourne">
-$ <userinput>./bin/hbase org.apache.hadoop.hbase.mapreduce.CopyTable --help </userinput>
-/bin/hbase org.apache.hadoop.hbase.mapreduce.CopyTable --help
-Usage: CopyTable [general options] [--starttime=X] [--endtime=Y] [--new.name=NEW] [--peer.adr=ADR] <tablename>
-
-Options:
- rs.class hbase.regionserver.class of the peer cluster,
- specify if different from current cluster
- rs.impl hbase.regionserver.impl of the peer cluster,
- startrow the start row
- stoprow the stop row
- starttime beginning of the time range (unixtime in millis)
- without endtime means from starttime to forever
- endtime end of the time range. Ignored if no starttime specified.
- versions number of cell versions to copy
- new.name new table's name
- peer.adr Address of the peer cluster given in the format
- hbase.zookeeer.quorum:hbase.zookeeper.client.port:zookeeper.znode.parent
- families comma-separated list of families to copy
- To copy from cf1 to cf2, give sourceCfName:destCfName.
- To keep the same name, just give "cfName"
- all.cells also copy delete markers and deleted cells
-
-Args:
- tablename Name of the table to copy
-
-Examples:
- To copy 'TestTable' to a cluster that uses replication for a 1 hour window:
- $ bin/hbase org.apache.hadoop.hbase.mapreduce.CopyTable --starttime=1265875194289 --endtime=1265878794289 --peer.adr=server1,server2,server3:2181:/hbase --families=myOldCf:myNewCf,cf2,cf3 TestTable
-
-For performance consider the following general options:
- It is recommended that you set the following to >=100. A higher value uses more memory but
- decreases the round trip time to the server and may increase performance.
- -Dhbase.client.scanner.caching=100
- The following should always be set to false, to prevent writing data twice, which may produce
- inaccurate results.
- -Dmapred.map.tasks.speculative.execution=false
- </screen>
- <note>
- <title>Scanner Caching</title>
- <para>Caching for the input Scan is configured via <code>hbase.client.scanner.caching</code>
- in the job configuration. </para>
- </note>
- <note>
- <title>Versions</title>
- <para>By default, CopyTable utility only copies the latest version of row cells unless
- <code>--versions=n</code> is explicitly specified in the command. </para>
- </note>
- <para> See Jonathan Hsieh's <link
- xlink:href="http://www.cloudera.com/blog/2012/06/online-hbase-backups-with-copytable-2/">Online
- HBase Backups with CopyTable</link> blog post for more on <command>CopyTable</command>.
- </para>
- </section>
- <section
- xml:id="export">
- <title>Export</title>
- <para>Export is a utility that will dump the contents of table to HDFS in a sequence file.
- Invoke via:</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.Export <tablename> <outputdir> [<versions> [<starttime> [<endtime>]]]
-</screen>
-
- <para>Note: caching for the input Scan is configured via
- <code>hbase.client.scanner.caching</code> in the job configuration. </para>
- </section>
- <section
- xml:id="import">
- <title>Import</title>
- <para>Import is a utility that will load data that has been exported back into HBase. Invoke
- via:</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.Import <tablename> <inputdir>
-</screen>
- <para>To import 0.94 exported files in a 0.96 cluster or onwards, you need to set system
- property "hbase.import.version" when running the import command as below:</para>
- <screen language="bourne">$ bin/hbase -Dhbase.import.version=0.94 org.apache.hadoop.hbase.mapreduce.Import <tablename> <inputdir>
-</screen>
- </section>
- <section
- xml:id="importtsv">
- <title>ImportTsv</title>
- <para>ImportTsv is a utility that will load data in TSV format into HBase. It has two distinct
- usages: loading data from TSV format in HDFS into HBase via Puts, and preparing StoreFiles
- to be loaded via the <code>completebulkload</code>. </para>
- <para>To load data via Puts (i.e., non-bulk loading):</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.ImportTsv -Dimporttsv.columns=a,b,c <tablename> <hdfs-inputdir>
-</screen>
-
- <para>To generate StoreFiles for bulk-loading:</para>
- <programlisting language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.ImportTsv -Dimporttsv.columns=a,b,c -Dimporttsv.bulk.output=hdfs://storefile-outputdir <tablename> <hdfs-data-inputdir>
-</programlisting>
- <para>These generated StoreFiles can be loaded into HBase via <xref
- linkend="completebulkload" />. </para>
- <section
- xml:id="importtsv.options">
- <title>ImportTsv Options</title>
- <para>Running <command>ImportTsv</command> with no arguments prints brief usage
- information:</para>
- <screen>
-Usage: importtsv -Dimporttsv.columns=a,b,c <tablename> <inputdir>
-
-Imports the given input directory of TSV data into the specified table.
-
-The column names of the TSV data must be specified using the -Dimporttsv.columns
-option. This option takes the form of comma-separated column names, where each
-column name is either a simple column family, or a columnfamily:qualifier. The special
-column name HBASE_ROW_KEY is used to designate that this column should be used
-as the row key for each imported record. You must specify exactly one column
-to be the row key, and you must specify a column name for every column that exists in the
-input data.
-
-By default importtsv will load data directly into HBase. To instead generate
-HFiles of data to prepare for a bulk data load, pass the option:
- -Dimporttsv.bulk.output=/path/for/output
- Note: the target table will be created with default column family descriptors if it does not already exist.
-
-Other options that may be specified with -D include:
- -Dimporttsv.skip.bad.lines=false - fail if encountering an invalid line
- '-Dimporttsv.separator=|' - eg separate on pipes instead of tabs
- -Dimporttsv.timestamp=currentTimeAsLong - use the specified timestamp for the import
- -Dimporttsv.mapper.class=my.Mapper - A user-defined Mapper to use instead of org.apache.hadoop.hbase.mapreduce.TsvImporterMapper
- </screen>
- </section>
- <section
- xml:id="importtsv.example">
- <title>ImportTsv Example</title>
- <para>For example, assume that we are loading data into a table called 'datatsv' with a
- ColumnFamily called 'd' with two columns "c1" and "c2". </para>
- <para>Assume that an input file exists as follows:
- <screen>
-row1 c1 c2
-row2 c1 c2
-row3 c1 c2
-row4 c1 c2
-row5 c1 c2
-row6 c1 c2
-row7 c1 c2
-row8 c1 c2
-row9 c1 c2
-row10 c1 c2
- </screen>
- </para>
- <para>For ImportTsv to use this imput file, the command line needs to look like this:</para>
- <screen language="bourne">
- HADOOP_CLASSPATH=`${HBASE_HOME}/bin/hbase classpath` ${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server-VERSION.jar importtsv -Dimporttsv.columns=HBASE_ROW_KEY,d:c1,d:c2 -Dimporttsv.bulk.output=hdfs://storefileoutput datatsv hdfs://inputfile
- </screen>
- <para> ... and in this example the first column is the rowkey, which is why the
- HBASE_ROW_KEY is used. The second and third columns in the file will be imported as "d:c1"
- and "d:c2", respectively. </para>
- </section>
- <section
- xml:id="importtsv.warning">
- <title>ImportTsv Warning</title>
- <para>If you have preparing a lot of data for bulk loading, make sure the target HBase table
- is pre-split appropriately. </para>
- </section>
- <section
- xml:id="importtsv.also">
- <title>See Also</title>
- <para>For more information about bulk-loading HFiles into HBase, see <xref
- linkend="arch.bulk.load" /></para>
- </section>
- </section>
-
- <section
- xml:id="completebulkload">
- <title>CompleteBulkLoad</title>
- <para>The <code>completebulkload</code> utility will move generated StoreFiles into an HBase
- table. This utility is often used in conjunction with output from <xref
- linkend="importtsv" />. </para>
- <para>There are two ways to invoke this utility, with explicit classname and via the
- driver:</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.LoadIncrementalHFiles <hdfs://storefileoutput> <tablename>
-</screen>
- <para> .. and via the Driver..</para>
- <screen language="bourne">HADOOP_CLASSPATH=`${HBASE_HOME}/bin/hbase classpath` ${HADOOP_HOME}/bin/hadoop jar ${HBASE_HOME}/hbase-server-VERSION.jar completebulkload <hdfs://storefileoutput> <tablename>
-</screen>
- <section
- xml:id="completebulkload.warning">
- <title>CompleteBulkLoad Warning</title>
- <para>Data generated via MapReduce is often created with file permissions that are not
- compatible with the running HBase process. Assuming you're running HDFS with permissions
- enabled, those permissions will need to be updated before you run CompleteBulkLoad.</para>
- <para>For more information about bulk-loading HFiles into HBase, see <xref
- linkend="arch.bulk.load" />. </para>
- </section>
-
- </section>
- <section
- xml:id="walplayer">
- <title>WALPlayer</title>
- <para>WALPlayer is a utility to replay WAL files into HBase. </para>
- <para>The WAL can be replayed for a set of tables or all tables, and a timerange can be
- provided (in milliseconds). The WAL is filtered to this set of tables. The output can
- optionally be mapped to another set of tables. </para>
- <para>WALPlayer can also generate HFiles for later bulk importing, in that case only a single
- table and no mapping can be specified. </para>
- <para>Invoke via:</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.WALPlayer [options] <wal inputdir> <tables> [<tableMappings>]>
-</screen>
- <para>For example:</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.WALPlayer /backuplogdir oldTable1,oldTable2 newTable1,newTable2
-</screen>
- <para> WALPlayer, by default, runs as a mapreduce job. To NOT run WALPlayer as a mapreduce job
- on your cluster, force it to run all in the local process by adding the flags
- <code>-Dmapreduce.jobtracker.address=local</code> on the command line. </para>
- </section>
- <section
- xml:id="rowcounter">
- <title>RowCounter and CellCounter</title>
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/RowCounter.html">RowCounter</link>
- is a mapreduce job to count all the rows of a table. This is a good utility to use as a
- sanity check to ensure that HBase can read all the blocks of a table if there are any
- concerns of metadata inconsistency. It will run the mapreduce all in a single process but it
- will run faster if you have a MapReduce cluster in place for it to exploit.</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.RowCounter <tablename> [<column1> <column2>...]
-</screen>
- <para>Note: caching for the input Scan is configured via
- <code>hbase.client.scanner.caching</code> in the job configuration. </para>
- <para>HBase ships another diagnostic mapreduce job called <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/CellCounter.html">CellCounter</link>.
- Like RowCounter, it gathers more fine-grained statistics about your table. The statistics
- gathered by RowCounter are more fine-grained and include: </para>
- <itemizedlist>
- <listitem>
- <para>Total number of rows in the table.</para>
- </listitem>
- <listitem>
- <para>Total number of CFs across all rows.</para>
- </listitem>
- <listitem>
- <para>Total qualifiers across all rows.</para>
- </listitem>
- <listitem>
- <para>Total occurrence of each CF.</para>
- </listitem>
- <listitem>
- <para>Total occurrence of each qualifier.</para>
- </listitem>
- <listitem>
- <para>Total number of versions of each qualifier.</para>
- </listitem>
- </itemizedlist>
- <para>The program allows you to limit the scope of the run. Provide a row regex or prefix to
- limit the rows to analyze. Use <code>hbase.mapreduce.scan.column.family</code> to specify
- scanning a single column family.</para>
- <screen language="bourne">$ bin/hbase org.apache.hadoop.hbase.mapreduce.CellCounter <tablename> <outputDir> [regex or prefix]</screen>
- <para>Note: just like RowCounter, caching for the input Scan is configured via
- <code>hbase.client.scanner.caching</code> in the job configuration. </para>
- </section>
- <section
- xml:id="mlockall">
- <title>mlockall</title>
- <para>It is possible to optionally pin your servers in physical memory making them less likely
- to be swapped out in oversubscribed environments by having the servers call <link
- xlink:href="http://linux.die.net/man/2/mlockall">mlockall</link> on startup. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-4391">HBASE-4391 Add ability to
- start RS as root and call mlockall</link> for how to build the optional library and have
- it run on startup. </para>
- </section>
- <section
- xml:id="compaction.tool">
- <title>Offline Compaction Tool</title>
- <para>See the usage for the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/regionserver/CompactionTool.html">Compaction
- Tool</link>. Run it like this <command>./bin/hbase
- org.apache.hadoop.hbase.regionserver.CompactionTool</command>
- </para>
- </section>
-
- <section>
- <title><command>hbase clean</command></title>
- <para>The <command>hbase clean</command> command cleans HBase data from ZooKeeper, HDFS, or
- both. It is appropriate to use for testing. Run it with no options for usage instructions.
- The <command>hbase clean</command> command was introduced in HBase 0.98.</para>
- <screen>
-$ <userinput>bin/hbase clean</userinput>
-Usage: hbase clean (--cleanZk|--cleanHdfs|--cleanAll)
-Options:
- --cleanZk cleans hbase related data from zookeeper.
- --cleanHdfs cleans hbase related data from hdfs.
- --cleanAll cleans hbase related data from both zookeeper and hdfs.
- </screen>
- </section>
- <section>
- <title><command>hbase pe</command></title>
- <para>The <command>hbase pe</command> command is a shortcut provided to run the
- <code>org.apache.hadoop.hbase.PerformanceEvaluation</code> tool, which is used for
- testing. The <command>hbase pe</command> command was introduced in HBase 0.98.4.</para>
- <para>The PerformanceEvaluation tool accepts many different options and commands. For usage
- instructions, run the command with no options.</para>
- <para>To run PerformanceEvaluation prior to HBase 0.98.4, issue the command
- <command>hbase org.apache.hadoop.hbase.PerformanceEvaluation</command>.</para>
- <para>The PerformanceEvaluation tool has received many updates in recent HBase releases,
- including support for namespaces, support for tags, cell-level ACLs and visibility labels,
- multiget support for RPC calls, increased sampling sizes, an option to randomly sleep during
- testing, and ability to "warm up" the cluster before testing starts.</para>
- </section>
- <section>
- <title><command>hbase ltt</command></title>
- <para>The <command>hbase ltt</command> command is a shortcut provided to run the
- <code>org.apache.hadoop.hbase.util.LoadTestTool</code> utility, which is used for
- testing. The <command>hbase ltt</command> command was introduced in HBase 0.98.4.</para>
- <para>You must specify either <option>-write</option> or <option>-update-read</option> as the
- first option. For general usage instructions, pass the <option>-h</option> option.</para>
- <para>To run LoadTestTool prior to HBase 0.98.4, issue the command <command>hbase
- org.apache.hadoop.hbase.util.LoadTestTool</command>.</para>
- <para>The LoadTestTool has received many updates in recent HBase releases, including support
- for namespaces, support for tags, cell-level ACLS and visibility labels, testing
- security-related features, ability to specify the number of regions per server, tests for
- multi-get RPC calls, and tests relating to replication.</para>
- </section>
- </section>
- <!-- tools -->
-
- <section
- xml:id="ops.regionmgt">
- <title>Region Management</title>
- <section
- xml:id="ops.regionmgt.majorcompact">
- <title>Major Compaction</title>
- <para>Major compactions can be requested via the HBase shell or <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HBaseAdmin.html#majorCompact%28java.lang.String%29">HBaseAdmin.majorCompact</link>. </para>
- <para>Note: major compactions do NOT do region merges. See <xref
- linkend="compaction" /> for more information about compactions. </para>
- </section>
- <section
- xml:id="ops.regionmgt.merge">
- <title>Merge</title>
- <para>Merge is a utility that can merge adjoining regions in the same table (see
- org.apache.hadoop.hbase.util.Merge).</para>
- <programlisting language="bourne">$ bin/hbase org.apache.hadoop.hbase.util.Merge <tablename> <region1> <region2>
-</programlisting>
- <para>If you feel you have too many regions and want to consolidate them, Merge is the utility
- you need. Merge must run be done when the cluster is down. See the <link
- xlink:href="http://ofps.oreilly.com/titles/9781449396107/performance.html">O'Reilly HBase
- Book</link> for an example of usage. </para>
- <para>You will need to pass 3 parameters to this application. The first one is the table name.
- The second one is the fully qualified name of the first region to merge, like
- "table_name,\x0A,1342956111995.7cef47f192318ba7ccc75b1bbf27a82b.". The third one is the
- fully qualified name for the second region to merge. </para>
- <para>Additionally, there is a Ruby script attached to <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-1621">HBASE-1621</link> for region
- merging. </para>
- </section>
- </section>
-
- <section
- xml:id="node.management">
- <title>Node Management</title>
- <section
- xml:id="decommission">
- <title>Node Decommission</title>
- <para>You can stop an individual RegionServer by running the following script in the HBase
- directory on the particular node:</para>
- <screen language="bourne">$ ./bin/hbase-daemon.sh stop regionserver</screen>
- <para> The RegionServer will first close all regions and then shut itself down. On shutdown,
- the RegionServer's ephemeral node in ZooKeeper will expire. The master will notice the
- RegionServer gone and will treat it as a 'crashed' server; it will reassign the nodes the
- RegionServer was carrying. </para>
- <note>
- <title>Disable the Load Balancer before Decommissioning a node</title>
- <para>If the load balancer runs while a node is shutting down, then there could be
- contention between the Load Balancer and the Master's recovery of the just decommissioned
- RegionServer. Avoid any problems by disabling the balancer first. See <xref
- linkend="lb" /> below. </para>
- </note>
- <note>
- <title xml:id="considerAsDead.sh">Kill Node Tool</title>
- <para>In hbase-2.0, in the bin directory, we added a script named
- <filename>considerAsDead.sh</filename> that can be used to kill a regionserver.
- Hardware issues could be detected by specialized monitoring tools before the
- zookeeper timeout has expired. <filename>considerAsDead.sh</filename> is a
- simple function to mark a RegionServer as dead. It deletes all the znodes
- of the server, starting the recovery process. Plug in the script into
- your monitoring/fault detection tools to initiate faster failover. Be
- careful how you use this disruptive tool. Copy the script if you need to
- make use of it in a version of hbase previous to hbase-2.0.
- </para>
- </note>
- <para> A downside to the above stop of a RegionServer is that regions could be offline for a
- good period of time. Regions are closed in order. If many regions on the server, the first
- region to close may not be back online until all regions close and after the master notices
- the RegionServer's znode gone. In Apache HBase 0.90.2, we added facility for having a node
- gradually shed its load and then shutdown itself down. Apache HBase 0.90.2 added the
- <filename>graceful_stop.sh</filename> script. Here is its usage:</para>
- <screen language="bourne">$ ./bin/graceful_stop.sh
-Usage: graceful_stop.sh [--config &conf-dir>] [--restart] [--reload] [--thrift] [--rest] &hostname>
- thrift If we should stop/start thrift before/after the hbase stop/start
- rest If we should stop/start rest before/after the hbase stop/start
- restart If we should restart after graceful stop
- reload Move offloaded regions back on to the stopped server
- debug Move offloaded regions back on to the stopped server
- hostname Hostname of server we are to stop</screen>
- <para> To decommission a loaded RegionServer, run the following: <command>$
- ./bin/graceful_stop.sh HOSTNAME</command> where <varname>HOSTNAME</varname> is the host
- carrying the RegionServer you would decommission. </para>
- <note>
- <title>On <varname>HOSTNAME</varname></title>
- <para>The <varname>HOSTNAME</varname> passed to <filename>graceful_stop.sh</filename> must
- match the hostname that hbase is using to identify RegionServers. Check the list of
- RegionServers in the master UI for how HBase is referring to servers. Its usually hostname
- but can also be FQDN. Whatever HBase is using, this is what you should pass the
- <filename>graceful_stop.sh</filename> decommission script. If you pass IPs, the script
- is not yet smart enough to make a hostname (or FQDN) of it and so it will fail when it
- checks if server is currently running; the graceful unloading of regions will not run.
- </para>
- </note>
- <para> The <filename>graceful_stop.sh</filename> script will move the regions off the
- decommissioned RegionServer one at a time to minimize region churn. It will verify the
- region deployed in the new location before it will moves the next region and so on until the
- decommissioned server is carrying zero regions. At this point, the
- <filename>graceful_stop.sh</filename> tells the RegionServer <command>stop</command>. The
- master will at this point notice the RegionServer gone but all regions will have already
- been redeployed and because the RegionServer went down cleanly, there will be no WAL logs to
- split. </para>
- <note
- xml:id="lb">
- <title>Load Balancer</title>
- <para> It is assumed that the Region Load Balancer is disabled while the
- <command>graceful_stop</command> script runs (otherwise the balancer and the
- decommission script will end up fighting over region deployments). Use the shell to
- disable the balancer:</para>
- <programlisting>hbase(main):001:0> balance_switch false
-true
-0 row(s) in 0.3590 seconds</programlisting>
- <para> This turns the balancer OFF. To reenable, do:</para>
- <programlisting>hbase(main):001:0> balance_switch true
-false
-0 row(s) in 0.3590 seconds</programlisting>
- <para>The <command>graceful_stop</command> will check the balancer and if enabled, will turn
- it off before it goes to work. If it exits prematurely because of error, it will not have
- reset the balancer. Hence, it is better to manage the balancer apart from
- <command>graceful_stop</command> reenabling it after you are done w/ graceful_stop.
- </para>
- </note>
- <section
- xml:id="draining.servers">
- <title>Decommissioning several Regions Servers concurrently</title>
- <para>If you have a large cluster, you may want to decommission more than one machine at a
- time by gracefully stopping mutiple RegionServers concurrently. To gracefully drain
- multiple regionservers at the same time, RegionServers can be put into a "draining" state.
- This is done by marking a RegionServer as a draining node by creating an entry in
- ZooKeeper under the <filename>hbase_root/draining</filename> znode. This znode has format
- <code>name,port,startcode</code> just like the regionserver entries under
- <filename>hbase_root/rs</filename> znode. </para>
- <para>Without this facility, decommissioning mulitple nodes may be non-optimal because
- regions that are being drained from one region server may be moved to other regionservers
- that are also draining. Marking RegionServers to be in the draining state prevents this
- from happening. See this <link
- xlink:href="http://inchoate-clatter.blogspot.com/2012/03/hbase-ops-automation.html">blog
- post</link> for more details.</para>
- </section>
-
- <section
- xml:id="bad.disk">
- <title>Bad or Failing Disk</title>
- <para>It is good having <xref
- linkend="dfs.datanode.failed.volumes.tolerated" /> set if you have a decent number of
- disks per machine for the case where a disk plain dies. But usually disks do the "John
- Wayne" -- i.e. take a while to go down spewing errors in <filename>dmesg</filename> -- or
- for some reason, run much slower than their companions. In this case you want to
- decommission the disk. You have two options. You can <link
- xlink:href="http://wiki.apache.org/hadoop/FAQ#I_want_to_make_a_large_cluster_smaller_by_taking_out_a_bunch_of_nodes_simultaneously._How_can_this_be_done.3F">decommission
- the datanode</link> or, less disruptive in that only the bad disks data will be
- rereplicated, can stop the datanode, unmount the bad volume (You can't umount a volume
- while the datanode is using it), and then restart the datanode (presuming you have set
- dfs.datanode.failed.volumes.tolerated > 0). The regionserver will throw some errors in its
- logs as it recalibrates where to get its data from -- it will likely roll its WAL log too
- -- but in general but for some latency spikes, it should keep on chugging. </para>
- <note>
- <title>Short Circuit Reads</title>
- <para>If you are doing short-circuit reads, you will have to move the regions off the
- regionserver before you stop the datanode; when short-circuiting reading, though chmod'd
- so regionserver cannot have access, because it already has the files open, it will be
- able to keep reading the file blocks from the bad disk even though the datanode is down.
- Move the regions back after you restart the datanode.</para>
- </note>
- </section>
- </section>
- <section
- xml:id="rolling">
- <title>Rolling Restart</title>
-
- <para>Some cluster configuration changes require either the entire cluster, or the
- RegionServers, to be restarted in order to pick up the changes. In addition, rolling
- restarts are supported for upgrading to a minor or maintenance release, and to a major
- release if at all possible. See the release notes for release you want to upgrade to, to
- find out about limitations to the ability to perform a rolling upgrade.</para>
- <para>There are multiple ways to restart your cluster nodes, depending on your situation.
- These methods are detailed below.</para>
- <section>
- <title>Using the <command>rolling-restart.sh</command> Script</title>
-
- <para>HBase ships with a script, <filename>bin/rolling-restart.sh</filename>, that allows
- you to perform rolling restarts on the entire cluster, the master only, or the
- RegionServers only. The script is provided as a template for your own script, and is not
- explicitly tested. It requires password-less SSH login to be configured and assumes that
- you have deployed using a tarball. The script requires you to set some environment
- variables before running it. Examine the script and modify it to suit your needs.</para>
- <example>
- <title><filename>rolling-restart.sh</filename> General Usage</title>
- <screen language="bourne">
-$ <userinput>./bin/rolling-restart.sh --help</userinput><![CDATA[
-Usage: rolling-restart.sh [--config <hbase-confdir>] [--rs-only] [--master-only] [--graceful] [--maxthreads xx]
- ]]></screen>
- </example>
- <variablelist>
- <varlistentry>
- <term>Rolling Restart on RegionServers Only</term>
- <listitem>
- <para>To perform a rolling restart on the RegionServers only, use the
- <code>--rs-only</code> option. This might be necessary if you need to reboot the
- individual RegionServer or if you make a configuration change that only affects
- RegionServers and not the other HBase processes.</para>
- <para>If you need to restart only a single RegionServer, or if you need to do extra
- actions during the restart, use the <filename>bin/graceful_stop.sh</filename>
- command instead. See <xref linkend="rolling.restart.manual" />.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Rolling Restart on Masters Only</term>
- <listitem>
- <para>To perform a rolling restart on the active and backup Masters, use the
- <code>--master-only</code> option. You might use this if you know that your
- configuration change only affects the Master and not the RegionServers, or if you
- need to restart the server where the active Master is running.</para>
- <para>If you are not running backup Masters, the Master is simply restarted. If you
- are running backup Masters, they are all stopped before any are restarted, to avoid
- a race condition in ZooKeeper to determine which is the new Master. First the main
- Master is restarted, then the backup Masters are restarted. Directly after restart,
- it checks for and cleans out any regions in transition before taking on its normal
- workload.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Graceful Restart</term>
- <listitem>
- <para>If you specify the <code>--graceful</code> option, RegionServers are restarted
- using the <filename>bin/graceful_stop.sh</filename> script, which moves regions off
- a RegionServer before restarting it. This is safer, but can delay the
- restart.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Limiting the Number of Threads</term>
- <listitem>
- <para>To limit the rolling restart to using only a specific number of threads, use the
- <code>--maxthreads</code> option.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section xml:id="rolling.restart.manual">
- <title>Manual Rolling Restart</title>
- <para>To retain more control over the process, you may wish to manually do a rolling restart
- across your cluster. This uses the <command>graceful-stop.sh</command> command <xref
- linkend="decommission" />. In this method, you can restart each RegionServer
- individually and then move its old regions back into place, retaining locality. If you
- also need to restart the Master, you need to do it separately, and restart the Master
- before restarting the RegionServers using this method. The following is an example of such
- a command. You may need to tailor it to your environment. This script does a rolling
- restart of RegionServers only. It disables the load balancer before moving the
- regions.</para>
- <screen><![CDATA[
-$ for i in `cat conf/regionservers|sort`; do ./bin/graceful_stop.sh --restart --reload --debug $i; done &> /tmp/log.txt &;
- ]]></screen>
- <para>Monitor the output of the <filename>/tmp/log.txt</filename> file to follow the
- progress of the script. </para>
- </section>
-
- <section>
- <title>Logic for Crafting Your Own Rolling Restart Script</title>
- <para>Use the following guidelines if you want to create your own rolling restart script.</para>
- <orderedlist>
- <listitem>
- <para>Extract the new release, verify its configuration, and synchronize it to all nodes
- of your cluster using <command>rsync</command>, <command>scp</command>, or another
- secure synchronization mechanism.</para></listitem>
- <listitem><para>Use the hbck utility to ensure that the cluster is consistent.</para>
- <screen>
-$ ./bin/hbck
- </screen>
- <para>Perform repairs if required. See <xref linkend="hbck" /> for details.</para>
- </listitem>
- <listitem><para>Restart the master first. You may need to modify these commands if your
- new HBase directory is different from the old one, such as for an upgrade.</para>
- <screen>
-$ ./bin/hbase-daemon.sh stop master; ./bin/hbase-daemon.sh start master
- </screen>
- </listitem>
- <listitem><para>Gracefully restart each RegionServer, using a script such as the
- following, from the Master.</para>
- <screen><![CDATA[
-$ for i in `cat conf/regionservers|sort`; do ./bin/graceful_stop.sh --restart --reload --debug $i; done &> /tmp/log.txt &
- ]]></screen>
- <para>If you are running Thrift or REST servers, pass the --thrift or --rest options.
- For other available options, run the <command>bin/graceful-stop.sh --help</command>
- command.</para>
- <para>It is important to drain HBase regions slowly when restarting multiple
- RegionServers. Otherwise, multiple regions go offline simultaneously and must be
- reassigned to other nodes, which may also go offline soon. This can negatively affect
- performance. You can inject delays into the script above, for instance, by adding a
- Shell command such as <command>sleep</command>. To wait for 5 minutes between each
- RegionServer restart, modify the above script to the following:</para>
- <screen><![CDATA[
-$ for i in `cat conf/regionservers|sort`; do ./bin/graceful_stop.sh --restart --reload --debug $i & sleep 5m; done &> /tmp/log.txt &
- ]]></screen>
- </listitem>
- <listitem><para>Restart the Master again, to clear out the dead servers list and re-enable
- the load balancer.</para></listitem>
- <listitem><para>Run the <command>hbck</command> utility again, to be sure the cluster is
- consistent.</para></listitem>
- </orderedlist>
- </section>
- </section>
- <section
- xml:id="adding.new.node">
- <title>Adding a New Node</title>
- <para>Adding a new regionserver in HBase is essentially free, you simply start it like this:
- <command>$ ./bin/hbase-daemon.sh start regionserver</command> and it will register itself
- with the master. Ideally you also started a DataNode on the same machine so that the RS can
- eventually start to have local files. If you rely on ssh to start your daemons, don't forget
- to add the new hostname in <filename>conf/regionservers</filename> on the master. </para>
- <para>At this point the region server isn't serving data because no regions have moved to it
- yet. If the balancer is enabled, it will start moving regions to the new RS. On a
- small/medium cluster this can have a very adverse effect on latency as a lot of regions will
- be offline at the same time. It is thus recommended to disable the balancer the same way
- it's done when decommissioning a node and move the regions manually (or even better, using a
- script that moves them one by one). </para>
- <para>The moved regions will all have 0% locality and won't have any blocks in cache so the
- region server will have to use the network to serve requests. Apart from resulting in higher
- latency, it may also be able to use all of your network card's capacity. For practical
- purposes, consider that a standard 1GigE NIC won't be able to read much more than
- <emphasis>100MB/s</emphasis>. In this case, or if you are in a OLAP environment and
- require having locality, then it is recommended to major compact the moved regions. </para>
-
- </section>
- </section>
- <!-- node mgt -->
-
- <section xml:id="hbase_metrics">
- <title>HBase Metrics</title>
- <para>HBase emits metrics which adhere to the <link
- xlink:href="http://hadoop.apache.org/core/docs/current/api/org/apache/hadoop/metrics/package-summary.html"
- >Hadoop metrics</link> API. Starting with HBase 0.95<footnote><para>The Metrics system was redone in
- HBase 0.96. See <link xlink:href="https://blogs.apache.org/hbase/entry/migration_to_the_new_metrics">Migration
- to the New Metrics Hotness – Metrics2</link> by Elliot Clark for detail</para></footnote>,
- HBase is configured to emit a default
- set of metrics with a default sampling period of every 10 seconds. You can use HBase
- metrics in conjunction with Ganglia. You can also filter which metrics are emitted and extend
- the metrics framework to capture custom metrics appropriate for your environment.</para>
- <section xml:id="metric_setup">
- <title>Metric Setup</title>
- <para>For HBase 0.95 and newer, HBase ships with a default metrics configuration, or
- <firstterm>sink</firstterm>. This includes a wide variety of individual metrics, and emits
- them every 10 seconds by default. To configure metrics for a given region server, edit the
- <filename>conf/hadoop-metrics2-hbase.properties</filename> file. Restart the region server
- for the changes to take effect.</para>
- <para>To change the sampling rate for the default sink, edit the line beginning with
- <literal>*.period</literal>. To filter which metrics are emitted or to extend the metrics
- framework, see <link
- xlink:href="http://hadoop.apache.org/docs/current/api/org/apache/hadoop/metrics2/package-summary.html"
- />
- </para>
- <note xml:id="rs_metrics_ganglia">
- <title>HBase Metrics and Ganglia</title>
- <para>By default, HBase emits a large number of metrics per region server. Ganglia may have
- difficulty processing all these metrics. Consider increasing the capacity of the Ganglia
- server or reducing the number of metrics emitted by HBase. See <link
- xlink:href="http://hadoop.apache.org/docs/current/api/org/apache/hadoop/metrics2/package-summary.html#filtering"
- >Metrics Filtering</link>.</para>
- </note>
- </section>
- <section>
- <title>Disabling Metrics</title>
- <para>To disable metrics for a region server, edit the
- <filename>conf/hadoop-metrics2-hbase.properties</filename> file and comment out any
- uncommented lines. Restart the region server for the changes to take effect.</para>
- </section>
-
- <section xml:id="discovering.available.metrics">
- <title>Discovering Available Metrics</title>
- <para>Rather than listing each metric which HBase emits by default, you can browse through the
- available metrics, either as a JSON output or via JMX. Different metrics are
- exposed for the Master process and each region server process.</para>
- <procedure>
- <title>Access a JSON Output of Available Metrics</title>
- <step>
- <para>After starting HBase, access the region server's web UI, at
- <literal>http://REGIONSERVER_HOSTNAME:60030</literal> by default (or port 16030 in HBase 1.0+).</para>
- </step>
- <step>
- <para>Click the <guilabel>Metrics Dump</guilabel> link near the top. The metrics for the region server are
- presented as a dump of the JMX bean in JSON format. This will dump out all metrics names and their
- values.
- To include metrics descriptions in the listing — this can be useful when you are exploring
- what is available — add a query string of
- <literal>?description=true</literal> so your URL becomes
- <literal>http://REGIONSERVER_HOSTNAME:60030/jmx?description=true</literal>.
- Not all beans and attributes have descriptions.
- </para>
- </step>
- <step>
- <para>To view metrics for the Master, connect to the Master's web UI instead (defaults to
- <literal>http://localhost:60010</literal> or port 16010 in HBase 1.0+) and click its <guilabel>Metrics
- Dump</guilabel> link.
- To include metrics descriptions in the listing — this can be useful when you are exploring
- what is available — add a query string of
- <literal>?description=true</literal> so your URL becomes
- <literal>http://REGIONSERVER_HOSTNAME:60010/jmx?description=true</literal>.
- Not all beans and attributes have descriptions.
- </para>
- </step>
- </procedure>
-
- <procedure>
- <title>Browse the JMX Output of Available Metrics</title>
- <para>You can use many different tools to view JMX content by browsing MBeans. This
- procedure uses <command>jvisualvm</command>, which is an application usually available in the JDK.
- </para>
- <step>
- <para>Start HBase, if it is not already running.</para>
- </step>
- <step>
- <para>Run the command <command>jvisualvm</command> command on a host with a GUI display.
- You can launch it from the command line or another method appropriate for your operating
- system.</para>
- </step>
- <step>
- <para>Be sure the <guilabel>VisualVM-MBeans</guilabel> plugin is installed. Browse to <menuchoice>
- <guimenu>Tools</guimenu>
- <guimenuitem>Plugins</guimenuitem>
- </menuchoice>. Click <guilabel>Installed</guilabel> and check whether the plugin is
- listed. If not, click <guilabel>Available Plugins</guilabel>, select it, and click
- <guibutton>Install</guibutton>. When finished, click
- <guibutton>Close</guibutton>.</para>
- </step>
- <step>
- <para>To view details for a given HBase process, double-click the process in the
- <guilabel>Local</guilabel> sub-tree in the left-hand panel. A detailed view opens in
- the right-hand panel. Click the <guilabel>MBeans</guilabel> tab which appears as a tab
- in the top of the right-hand panel.</para>
- </step>
- <step>
- <para>To access the HBase metrics, navigate to the appropriate sub-bean:</para>
- <itemizedlist>
- <listitem>
- <para>Master: <menuchoice>
- <guimenu>Hadoop</guimenu>
- <guisubmenu>HBase</guisubmenu>
- <guisubmenu>Master</guisubmenu>
- <guisubmenu>Server</guisubmenu>
- </menuchoice></para>
- </listitem>
- <listitem>
- <para>RegionServer: <menuchoice>
- <guimenu>Hadoop</guimenu>
- <guisubmenu>HBase</guisubmenu>
- <guisubmenu>RegionServer</guisubmenu>
- <guisubmenu>Server</guisubmenu>
- </menuchoice></para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <para>The name of each metric and its current value is displayed in the
- <guilabel>Attributes</guilabel> tab. For a view which includes more details, including
- the description of each attribute, click the <guilabel>Metadata</guilabel> tab.</para>
- </step>
- </procedure>
- </section>
- <section>
- <title>Units of Measure for Metrics</title>
- <para>Different metrics are expressed in different units, as appropriate. Often, the unit of
- measure is in the name (as in the metric <code>shippedKBs</code>). Otherwise, use the
- following guidelines. When in doubt, you may need to examine the source for a given
- metric.</para>
- <itemizedlist>
- <listitem>
- <para>Metrics that refer to a point in time are usually expressed as a timestamp.</para>
- </listitem>
- <listitem>
- <para>Metrics that refer to an age (such as <code>ageOfLastShippedOp</code>) are usually
- expressed in milliseconds.</para>
- </listitem>
- <listitem>
- <para>Metrics that refer to memory sizes are in bytes.</para>
- </listitem>
- <listitem>
- <para>Sizes of queues (such as <code>sizeOfLogQueue</code>) are expressed as the number of
- items in the queue. Determine the size by multiplying by the block size (default is 64
- MB in HDFS).</para>
- </listitem>
- <listitem>
- <para>Metrics that refer to things like the number of a given type of operations (such as
- <code>logEditsRead</code>) are expressed as an integer.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section xml:id="master_metrics">
- <title>Most Important Master Metrics</title>
- <para>Note: Counts are usually over the last metrics reporting interval.</para>
- <variablelist>
- <varlistentry>
- <term>hbase.master.numRegionServers</term>
- <listitem><para>Number of live regionservers</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.master.numDeadRegionServers</term>
- <listitem><para>Number of dead regionservers</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.master.ritCount </term>
- <listitem><para>The number of regions in transition</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.master.ritCountOverThreshold</term>
- <listitem><para>The number of regions that have been in transition longer than
- a threshold time (default: 60 seconds)</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.master.ritOldestAge</term>
- <listitem><para>The age of the longest region in transition, in milliseconds
- </para></listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section xml:id="rs_metrics">
- <title>Most Important RegionServer Metrics</title>
- <para>Note: Counts are usually over the last metrics reporting interval.</para>
- <variablelist>
- <varlistentry>
- <term>hbase.regionserver.regionCount</term>
- <listitem><para>The number of regions hosted by the regionserver</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.storeFileCount</term>
- <listitem><para>The number of store files on disk currently managed by the
- regionserver</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.storeFileSize</term>
- <listitem><para>Aggregate size of the store files on disk</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.hlogFileCount</term>
- <listitem><para>The number of write ahead logs not yet archived</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.totalRequestCount</term>
- <listitem><para>The total number of requests received</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.readRequestCount</term>
- <listitem><para>The number of read requests received</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.writeRequestCount</term>
- <listitem><para>The number of write requests received</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.numOpenConnections</term>
- <listitem><para>The number of open connections at the RPC layer</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.numActiveHandler</term>
- <listitem><para>The number of RPC handlers actively servicing requests</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.numCallsInGeneralQueue</term>
- <listitem><para>The number of currently enqueued user requests</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.numCallsInReplicationQueue</term>
- <listitem><para>The number of currently enqueued operations received from
- replication</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.numCallsInPriorityQueue</term>
- <listitem><para>The number of currently enqueued priority (internal housekeeping)
- requests</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.flushQueueLength</term>
- <listitem><para>Current depth of the memstore flush queue. If increasing, we are falling
- behind with clearing memstores out to HDFS.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.updatesBlockedTime</term>
- <listitem><para>Number of milliseconds updates have been blocked so the memstore can be
- flushed</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.compactionQueueLength</term>
- <listitem><para>Current depth of the compaction request queue. If increasing, we are
- falling behind with storefile compaction.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.blockCacheHitCount</term>
- <listitem><para>The number of block cache hits</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.blockCacheMissCount</term>
- <listitem><para>The number of block cache misses</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.blockCacheExpressHitPercent </term>
- <listitem><para>The percent of the time that requests with the cache turned on hit the
- cache</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.percentFilesLocal</term>
- <listitem><para>Percent of store file data that can be read from the local DataNode,
- 0-100</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.<op>_<measure></term>
- <listitem><para>Operation latencies, where <op> is one of Append, Delete, Mutate,
- Get, Replay, Increment; and where <measure> is one of min, max, mean, median,
- 75th_percentile, 95th_percentile, 99th_percentile</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.slow<op>Count </term>
- <listitem><para>The number of operations we thought were slow, where <op> is one
- of the list above</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.GcTimeMillis</term>
- <listitem><para>Time spent in garbage collection, in milliseconds</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.GcTimeMillisParNew</term>
- <listitem><para>Time spent in garbage collection of the young generation, in
- milliseconds</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.GcTimeMillisConcurrentMarkSweep</term>
- <listitem><para>Time spent in garbage collection of the old generation, in
- milliseconds</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.authenticationSuccesses</term>
- <listitem><para>Number of client connections where authentication succeeded</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.authenticationFailures</term>
- <listitem><para>Number of client connection authentication failures</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>hbase.regionserver.mutationsWithoutWALCount </term>
- <listitem><para>Count of writes submitted with a flag indicating they should bypass the
- write ahead log</para></listitem>
- </varlistentry>
- </variablelist>
- </section>
- </section>
-
- <section
- xml:id="ops.monitoring">
- <title>HBase Monitoring</title>
- <section
- xml:id="ops.monitoring.overview">
- <title>Overview</title>
- <para>The following metrics are arguably the most important to monitor for each RegionServer
- for "macro monitoring", preferably with a system like <link
- xlink:href="http://opentsdb.net/">OpenTSDB</link>. If your cluster is having performance
- issues it's likely that you'll see something unusual with this group. </para>
- <itemizedlist>
- <title>HBase:</title>
- <listitem>
- <para>See <xref
- linkend="rs_metrics" /></para>
- </listitem>
- </itemizedlist>
-
- <itemizedlist>
- <title>OS:</title>
- <listitem>
- <para>IO Wait</para>
- </listitem>
- <listitem>
- <para>User CPU</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Java:</title>
- <listitem>
- <para>GC</para>
- </listitem>
- </itemizedlist>
- <para> For more information on HBase metrics, see <xref
- linkend="hbase_metrics" />. </para>
- </section>
-
- <section
- xml:id="ops.slow.query">
- <title>Slow Query Log</title>
- <para>The HBase slow query log consists of parseable JSON structures describing the properties
- of those client operations (Gets, Puts, Deletes, etc.) that either took too long to run, or
- produced too much output. The thresholds for "too long to run" and "too much output" are
- configurable, as described below. The output is produced inline in the main region server
- logs so that it is easy to discover further details from context with other logged events.
- It is also prepended with identifying tags <constant>(responseTooSlow)</constant>,
- <constant>(responseTooLarge)</constant>, <constant>(operationTooSlow)</constant>, and
- <constant>(operationTooLarge)</constant> in order to enable easy filtering with grep, in
- case the user desires to see only slow queries. </para>
-
- <section>
- <title>Configuration</title>
- <para>There are two configuration knobs that can be used to adjust the thresholds for when
- queries are logged. </para>
-
- <itemizedlist>
- <listitem>
- <para><varname>hbase.ipc.warn.response.time</varname> Maximum number of milliseconds
- that a query can be run without being logged. Defaults to 10000, or 10 seconds. Can be
- set to -1 to disable logging by time. </para>
- </listitem>
- <listitem>
- <para><varname>hbase.ipc.warn.response.size</varname> Maximum byte size of response that
- a query can return without being logged. Defaults to 100 megabytes. Can be set to -1
- to disable logging by size. </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Metrics</title>
- <para>The slow query log exposes to metrics to JMX.</para>
- <itemizedlist>
- <listitem>
- <para><varname>hadoop.regionserver_rpc_slowResponse</varname> a global metric reflecting
- the durations of all responses that triggered logging.</para>
- </listitem>
- <listitem>
- <para><varname>hadoop.regionserver_rpc_methodName.aboveOneSec</varname> A metric
- reflecting the durations of all responses that lasted for more than one second.</para>
- </listitem>
- </itemizedlist>
-
- </section>
-
- <section>
- <title>Output</title>
- <para>The output is tagged with operation e.g. <constant>(operationTooSlow)</constant> if
- the call was a client operation, such as a Put, Get, or Delete, which we expose detailed
- fingerprint information for. If not, it is tagged <constant>(responseTooSlow)</constant>
- and still produces parseable JSON output, but with less verbose information solely
- regarding its duration and size in the RPC itself. <constant>TooLarge</constant> is
- substituted for <constant>TooSlow</constant> if the response size triggered the logging,
- with <constant>TooLarge</constant> appearing even in the case that both size and duration
- triggered logging. </para>
- </section>
- <section>
- <title>Example</title>
- <para>
- <programlisting>2011-09-08 10:01:25,824 WARN org.apache.hadoop.ipc.HBaseServer: (operationTooSlow): {"tables":{"riley2":{"puts":[{"totalColumns":11,"families":{"actions":[{"timestamp":1315501284459,"qualifier":"0","vlen":9667580},{"timestamp":1315501284459,"qualifier":"1","vlen":10122412},{"timestamp":1315501284459,"qualifier":"2","vlen":11104617},{"timestamp":1315501284459,"qualifier":"3","vlen":13430635}]},"row":"cfcd208495d565ef66e7dff9f98764da:0"}],"families":["actions"]}},"processingtimems":956,"client":"10.47.34.63:33623","starttimems":1315501284456,"queuetimems":0,"totalPuts":1,"class":"HRegionServer","responsesize":0,"method":"multiPut"}</programlisting>
- </para>
-
- <para>Note that everything inside the "tables" structure is output produced by MultiPut's
- fingerprint, while the rest of the information is RPC-specific, such as processing time
- and client IP/port. Other client operations follow the same pattern and the same general
- structure, with necessary differences due to the nature of the individual operations. In
- the case that the call is not a client operation, that detailed fingerprint information
- will be completely absent. </para>
-
- <para>This particular example, for example, would indicate that the likely cause of slowness
- is simply a very large (on the order of 100MB) multiput, as we can tell by the "vlen," or
- value length, fields of each put in the multiPut. </para>
- </section>
- </section>
- <section>
- <title>Block Cache Monitoring</title>
- <para>Starting with HBase 0.98, the HBase Web UI includes the ability to monitor and report on
- the performance of the block cache. To view the block cache reports, click <menuchoice>
- <guimenu>Tasks</guimenu>
- <guisubmenu>Show Non-RPC Tasks</guisubmenu>
- <guimenuitem>Block Cache</guimenuitem>
- </menuchoice>. Following are a few examples of the reporting capabilities.</para>
- <figure>
- <title>Basic Info</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="bc_basic.png" width="100%"/>
- </imageobject>
- <caption>
- <para>Shows the cache implementation</para>
- </caption>
- </mediaobject>
- </figure>
- <figure>
- <title>Config</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="bc_config.png" width="100%"/>
- </imageobject>
- <caption>
- <para>Shows all cache configuration options.</para>
- </caption>
- </mediaobject>
- </figure>
- <figure>
- <title>Stats</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="bc_stats.png" width="100%"/>
- </imageobject>
- <caption>
- <para>Shows statistics about the performance of the cache.</para>
- </caption>
- </mediaobject>
- </figure>
- <figure>
- <title>L1 and L2</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="bc_l1.png" width="100%"/>
- </imageobject>
- <imageobject>
- <imagedata fileref="bc_l2_buckets.png" width="100%"/>
- </imageobject>
- <caption>
- <para>Shows information about the L1 and L2 caches.</para>
- </caption>
- </mediaobject>
- </figure>
- <para>This is not an exhaustive list of all the screens and reports available. Have a look in
- the Web UI.</para>
- </section>
-
-
-
- </section>
-
- <section
- xml:id="cluster_replication">
- <title>Cluster Replication</title>
- <note>
- <para>This information was previously available at <link
- xlink:href="http://hbase.apache.org/replication.html">Cluster Replication</link>. </para>
- </note>
- <para>HBase provides a replication mechanism to copy data between HBase
- clusters. Replication can be used as a disaster recovery solution and as a mechanism for high
- availability. You can also use replication to separate web-facing operations from back-end
- jobs such as MapReduce.</para>
-
- <para>In terms of architecture, HBase replication is master-push. This takes advantage of the
- fact that each region server has its own write-ahead log (WAL). One master cluster can
- replicate to any number of slave clusters, and each region server replicates its own stream of
- edits. For more information on the different properties of master/slave replication and other
- types of replication, see the article <link
- xlink:href="http://highscalability.com/blog/2009/8/24/how-google-serves-data-from-multiple-datacenters.html">How
- Google Serves Data From Multiple Datacenters</link>.</para>
-
- <para>Replication is asynchronous, allowing clusters to be geographically distant or to have
- some gaps in availability. This also means that data between master and slave clusters will
- not be instantly consistent. Rows inserted on the master are not immediately available or
- consistent with rows on the slave clusters. rows inserted on the master cluster won’t be
- available at the same time on the slave clusters. The goal is eventual consistency. </para>
-
- <para>The replication format used in this design is conceptually the same as the <firstterm><link
- xlink:href="http://dev.mysql.com/doc/refman/5.1/en/replication-formats.html">statement-based
- replication</link></firstterm> design used by MySQL. Instead of SQL statements, entire
- WALEdits (consisting of multiple cell inserts coming from Put and Delete operations on the
- clients) are replicated in order to maintain atomicity. </para>
-
- <para>The WALs for each region server must be kept in HDFS as long as they are needed to
- replicate data to any slave cluster. Each region server reads from the oldest log it needs to
- replicate and keeps track of the current position inside ZooKeeper to simplify failure
- recovery. That position, as well as the queue of WALs to process, may be different for every
- slave cluster.</para>
-
- <para>The clusters participating in replication can be of different sizes. The master
- cluster relies on randomization to attempt to balance the stream of replication on the slave clusters</para>
-
- <para>HBase supports master/master and cyclic replication as well as replication to multiple
- slaves.</para>
-
- <figure>
- <title>Replication Architecture Overview</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="replication_overview.png" />
- </imageobject>
- <caption>
- <para>Illustration of the replication architecture in HBase, as described in the prior
- text.</para>
- </caption>
- </mediaobject>
- </figure>
-
- <formalpara>
- <title>Enabling and Configuring Replication</title>
- <para>See the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/replication/package-summary.html#requirements">
- API documentation for replication</link> for information on enabling and configuring
- replication.</para>
- </formalpara>
-
- <section>
- <title>Life of a WAL Edit</title>
- <para>A single WAL edit goes through several steps in order to be replicated to a slave
- cluster.</para>
-
- <orderedlist>
- <title>When the slave responds correctly:</title>
- <listitem>
- <para>A HBase client uses a Put or Delete operation to manipulate data in HBase.</para>
- </listitem>
- <listitem>
- <para>The region server writes the request to the WAL in a way that would allow it to be
- replayed if it were not written successfully.</para>
- </listitem>
- <listitem>
- <para>If the changed cell corresponds to a column family that is scoped for replication,
- the edit is added to the queue for replication.</para>
- </listitem>
- <listitem>
- <para>In a separate thread, the edit is read from the log, as part of a batch process.
- Only the KeyValues that are eligible for replication are kept. Replicable KeyValues are
- part of a column family whose schema is scoped GLOBAL, are not part of a catalog such as
- <code>hbase:meta</code>, and did not originate from the target slave cluster, in the
- case of cyclic replication.</para>
- </listitem>
- <listitem>
- <para>The edit is tagged with the master's UUID and added to a buffer. When the buffer is
- filled, or the reader reaches the end of the file, the buffer is sent to a random region
- server on the slave cluster.</para>
- </listitem>
- <listitem>
- <para>The region server reads the edits sequentially and separates them into buffers, one
- buffer per table. After all edits are read, each buffer is flushed using <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html"
- >HTable</link>, HBase's normal client. The master's UUID is preserved in the edits
- they are applied, in order to allow for cyclic replication.</para>
- </listitem>
- <listitem>
- <para>In the master, the offset for the WAL that is currently being replicated is
- registered in ZooKeeper.</para>
- </listitem>
- </orderedlist>
- <orderedlist>
- <title>When the slave does not respond:</title>
- <listitem>
- <para>The first three steps, where the edit is inserted, are identical.</para>
- </listitem>
- <listitem>
- <para>Again in a separate thread, the region server reads, filters, and edits the log
- edits in the same way as above. The slave region server does not answer the RPC
- call.</para>
- </listitem>
- <listitem>
- <para>The master sleeps and tries again a configurable number of times.</para>
- </listitem>
- <listitem>
- <para>If the slave region server is still not available, the master selects a new subset
- of region server to replicate to, and tr
<TRUNCATED>
[10/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/developer.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/developer.xml b/src/main/docbkx/developer.xml
deleted file mode 100644
index a6b5dc2..0000000
--- a/src/main/docbkx/developer.xml
+++ /dev/null
@@ -1,2343 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="developer"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Building and Developing Apache HBase</title>
- <para>This chapter contains information and guidelines for building and releasing HBase code and
- documentation. Being familiar with these guidelines will help the HBase committers to use
- your contributions more easily.</para>
- <section xml:id="getting.involved">
- <title>Getting Involved</title>
- <para>Apache HBase gets better only when people contribute! If you are looking to contribute
- to Apache HBase, look for <link
- xlink:href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20HBASE%20AND%20labels%20in%20(beginner)"
- >issues in JIRA tagged with the label 'beginner'</link>. These are issues HBase
- contributors have deemed worthy but not of immediate priority and a good way to ramp on
- HBase internals. See <link xlink:href="http://search-hadoop.com/m/DHED43re96">What label
- is used for issues that are good on ramps for new contributors?</link> from the dev
- mailing list for background.</para>
- <para>Before you get started submitting code to HBase, please refer to <xref
- linkend="developing"/>.</para>
- <para>As Apache HBase is an Apache Software Foundation project, see <xref linkend="asf"/>
- for more information about how the ASF functions. </para>
- <section xml:id="mailing.list">
- <title>Mailing Lists</title>
- <para>Sign up for the dev-list and the user-list. See the
- <link xlink:href="http://hbase.apache.org/mail-lists.html">mailing lists</link> page.
- Posing questions - and helping to answer other people's questions - is encouraged!
- There are varying levels of experience on both lists so patience and politeness are encouraged (and please
- stay on topic.)
- </para>
- </section>
- <section xml:id="irc">
- <title>Internet Relay Chat (IRC)</title>
- <para>For real-time questions and discussions, use the <literal>#hbase</literal> IRC
- channel on the <link xlink:href="https://freenode.net/">FreeNode</link> IRC network.
- FreeNode offers a web-based client, but most people prefer a native client, and
- several clients are available for each operating system.</para>
- </section>
- <section xml:id="jira">
- <title>Jira</title>
- <para>Check for existing issues in <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE">Jira</link>. If it's
- either a new feature request, enhancement, or a bug, file a ticket. </para>
- <para>To check for existing issues which you can tackle as a beginner, search for <link
- xlink:href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20HBASE%20AND%20labels%20in%20(beginner)"
- >issues in JIRA tagged with the label 'beginner'</link>.</para>
- <itemizedlist xml:id="jira.priorities">
- <title>JIRA Priorities</title>
- <listitem>
- <para>Blocker: Should only be used if the issue WILL cause data loss or cluster
- instability reliably.</para>
- </listitem>
- <listitem>
- <para>Critical: The issue described can cause data loss or cluster instability
- in some cases.</para>
- </listitem>
- <listitem>
- <para>Major: Important but not tragic issues, like updates to the client API
- that will add a lot of much-needed functionality or significant bugs that
- need to be fixed but that don't cause data loss.</para>
- </listitem>
- <listitem>
- <para>Minor: Useful enhancements and annoying but not damaging bugs.</para>
- </listitem>
- <listitem>
- <para>Trivial: Useful enhancements but generally cosmetic.</para>
- </listitem>
- </itemizedlist>
- <example xml:id="submitting.patches.jira.code">
- <title>Code Blocks in Jira Comments</title>
- <para>A commonly used macro in Jira is {code}. Everything inside the tags is
- preformatted, as in this example.</para>
- <programlisting>
-{code}
-code snippet
-{code}
- </programlisting>
- </example>
- </section> <!-- jira -->
-
- </section> <!-- getting involved -->
-
- <section xml:id="repos">
- <title>Apache HBase Repositories</title>
- <para>There are two different repositories for Apache HBase: Subversion (SVN) and Git. GIT
- is our repository of record for all but the Apache HBase website. We used to be on SVN.
- We migrated. See <link xlink:href="https://issues.apache.org/jira/browse/INFRA-7768"
- >Migrate Apache HBase SVN Repos to Git</link>. Updating hbase.apache.org still
- requires use of SVN (See <xref linkend="hbase.org"/>). See <link
- xlink:href="http://hbase.apache.org/source-repository.html">Source Code
- Management</link> page for contributor and committer links or seach for HBase on the
- <link xlink:href="http://git.apache.org/">Apache Git</link> page.</para>
- </section>
-
- <section xml:id="ides">
- <title>IDEs</title>
- <section xml:id="eclipse">
- <title>Eclipse</title>
- <section xml:id="eclipse.code.formatting">
- <title>Code Formatting</title>
- <para>Under the <filename>dev-support/</filename> folder, you will find
- <filename>hbase_eclipse_formatter.xml</filename>. We encourage you to have
- this formatter in place in eclipse when editing HBase code.</para>
- <procedure>
- <title>Load the HBase Formatter Into Eclipse</title>
- <step>
- <para>Open the <menuchoice>
- <guimenu>Eclipse</guimenu>
- <guimenuitem>Preferences</guimenuitem>
- </menuchoice> menu item.</para>
- </step>
- <step>
- <para>In Preferences, click the <menuchoice>
- <guimenu>Java</guimenu>
- <guisubmenu>Code Style</guisubmenu>
- <guimenuitem>Formatter</guimenuitem>
- </menuchoice> menu item.</para>
- </step>
- <step>
- <para>Click <guibutton>Import</guibutton> and browse to the location of the
- <filename>hbase_eclipse_formatter.xml</filename> file, which is in
- the <filename>dev-support/</filename> directory. Click
- <guibutton>Apply</guibutton>.</para>
- </step>
- <step>
- <para>Still in Preferences, click <menuchoice>
- <guimenu>Java Editor</guimenu>
- <guimenuitem>Save Actions</guimenuitem>
- </menuchoice>. Be sure the following options are selected:</para>
- <itemizedlist>
- <listitem><para>Perform the selected actions on save</para></listitem>
- <listitem><para>Format source code</para></listitem>
- <listitem><para>Format edited lines</para></listitem>
- </itemizedlist>
- <para>Click <guibutton>Apply</guibutton>. Close all dialog boxes and return
- to the main window.</para>
- </step>
- </procedure>
-
- <para>In addition to the automatic formatting, make sure you follow the style
- guidelines explained in <xref linkend="common.patch.feedback"/></para>
- <para>Also, no <code>@author</code> tags - that's a rule. Quality Javadoc comments
- are appreciated. And include the Apache license.</para>
- </section>
- <section xml:id="eclipse.git.plugin">
- <title>Eclipse Git Plugin</title>
- <para>If you cloned the project via git, download and install the Git plugin (EGit).
- Attach to your local git repo (via the <guilabel>Git Repositories</guilabel>
- window) and you'll be able to see file revision history, generate patches,
- etc.</para>
- </section>
- <section xml:id="eclipse.maven.setup">
- <title>HBase Project Setup in Eclipse using <code>m2eclipse</code></title>
- <para>The easiest way is to use the <command>m2eclipse</command> plugin for Eclipse.
- Eclipse Indigo or newer includes <command>m2eclipse</command>, or you can
- download it from <link xlink:href="http://www.eclipse.org/m2e/"
- >http://www.eclipse.org/m2e/</link>/. It provides Maven integration for
- Eclipse, and even lets you use the direct Maven commands from within Eclipse to
- compile and test your project.</para>
- <para>To import the project, click <menuchoice>
- <guimenu>File</guimenu>
- <guisubmenu>Import</guisubmenu>
- <guisubmenu>Maven</guisubmenu>
- <guimenuitem>Existing Maven Projects</guimenuitem>
- </menuchoice> and select the HBase root directory. <code>m2eclipse</code>
- locates all the hbase modules for you.</para>
- <para>If you install <command>m2eclipse</command> and import HBase in your
- workspace, do the following to fix your eclipse Build Path. </para>
- <orderedlist>
- <listitem>
- <para>Remove <filename>target</filename> folder</para>
- </listitem>
- <listitem>
- <para>Add <filename>target/generated-jamon</filename> and
- <filename>target/generated-sources/java</filename> folders.</para>
- </listitem>
- <listitem>
- <para>Remove from your Build Path the exclusions on the
- <filename>src/main/resources</filename> and
- <filename>src/test/resources</filename> to avoid error message in
- the console, such as the following:</para>
- <screen>Failed to execute goal
-org.apache.maven.plugins:maven-antrun-plugin:1.6:run (default) on project hbase:
-'An Ant BuildException has occured: Replace: source file .../target/classes/hbase-default.xml
-doesn't exist</screen>
- <para>This will also reduce the eclipse build cycles and make your life
- easier when developing. </para>
- </listitem>
- </orderedlist>
- </section>
- <section xml:id="eclipse.commandline">
- <title>HBase Project Setup in Eclipse Using the Command Line</title>
- <para>Instead of using <code>m2eclipse</code>, you can generate the Eclipse files
- from the command line. </para>
- <orderedlist>
- <listitem>
- <para>First, run the following command, which builds HBase. You only need to
- do this once.</para>
- <programlisting language="bourne">mvn clean install -DskipTests</programlisting>
- </listitem>
- <listitem>
- <para>Close Eclipse, and execute the following command from the terminal, in
- your local HBase project directory, to generate new
- <filename>.project</filename> and <filename>.classpath</filename>
- files.</para>
- <programlisting language="bourne">mvn eclipse:eclipse</programlisting>
- </listitem>
- <listitem>
- <para>Reopen Eclipse and import the <filename>.project</filename> file in
- the HBase directory to a workspace.</para>
- </listitem>
- </orderedlist>
- </section>
- <section xml:id="eclipse.maven.class">
- <title>Maven Classpath Variable</title>
- <para>The <varname>$M2_REPO</varname> classpath variable needs to be set up for the
- project. This needs to be set to your local Maven repository, which is usually
- <filename>~/.m2/repository</filename></para>
- <para>If this classpath variable is not configured, you will see compile errors in
- Eclipse like this: </para>
- <screen>
-Description Resource Path Location Type
-The project cannot be built until build path errors are resolved hbase Unknown Java Problem
-Unbound classpath variable: 'M2_REPO/asm/asm/3.1/asm-3.1.jar' in project 'hbase' hbase Build path Build Path Problem
-Unbound classpath variable: 'M2_REPO/com/google/guava/guava/r09/guava-r09.jar' in project 'hbase' hbase Build path Build Path Problem
-Unbound classpath variable: 'M2_REPO/com/google/protobuf/protobuf-java/2.3.0/protobuf-java-2.3.0.jar' in project 'hbase' hbase Build path Build Path Problem Unbound classpath variable:
- </screen>
- </section>
- <section xml:id="eclipse.issues">
- <title>Eclipse Known Issues</title>
- <para>Eclipse will currently complain about <filename>Bytes.java</filename>. It is
- not possible to turn these errors off.</para>
- <screen>
-Description Resource Path Location Type
-Access restriction: The method arrayBaseOffset(Class) from the type Unsafe is not accessible due to restriction on required library /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Classes/classes.jar Bytes.java /hbase/src/main/java/org/apache/hadoop/hbase/util line 1061 Java Problem
-Access restriction: The method arrayIndexScale(Class) from the type Unsafe is not accessible due to restriction on required library /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Classes/classes.jar Bytes.java /hbase/src/main/java/org/apache/hadoop/hbase/util line 1064 Java Problem
-Access restriction: The method getLong(Object, long) from the type Unsafe is not accessible due to restriction on required library /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Classes/classes.jar Bytes.java /hbase/src/main/java/org/apache/hadoop/hbase/util line 1111 Java Problem
- </screen>
- </section>
- <section xml:id="eclipse.more">
- <title>Eclipse - More Information</title>
- <para>For additional information on setting up Eclipse for HBase development on
- Windows, see <link
- xlink:href="http://michaelmorello.blogspot.com/2011/09/hbase-subversion-eclipse-windows.html"
- >Michael Morello's blog</link> on the topic. </para>
- </section>
- </section>
- <section>
- <title>IntelliJ IDEA</title>
- <para>You can set up IntelliJ IDEA for similar functinoality as Eclipse. Follow these steps.</para>
- <orderedlist>
- <title>Project Setup in IntelliJ IDEA</title>
- <listitem>
- <para>Select <menuchoice>
- <guimenu>Import Project</guimenu>
- <guisubmenu>Import Project From External Model</guisubmenu>
- <guimenuitem>Maven</guimenuitem>
- </menuchoice></para>
- </listitem>
- <listitem>
- <para>You do not need to select a profile. Be sure <guilabel>Maven project
- required</guilabel> is selected, and click
- <guibutton>Next</guibutton>.</para>
- </listitem>
- <listitem>
- <para>Select the location for the JDK.</para>
- </listitem>
- </orderedlist>
- <formalpara>
- <title>Using the HBase Formatter in IntelliJ IDEA</title>
- <para>Using the Eclipse Code Formatter plugin for IntelliJ IDEA, you can import the
- HBase code formatter described in <xref linkend="eclipse.code.formatting" />.</para>
- </formalpara>
- </section>
- <section>
- <title>Other IDEs</title>
- <para>It would be userful to mirror the <xref linkend="eclipse"/> set-up instructions
- for other IDEs. If you would like to assist, please have a look at <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11704"
- >HBASE-11704</link>.</para>
- </section>
- </section>
-
- <section xml:id="build">
- <title>Building Apache HBase</title>
- <section xml:id="build.basic">
- <title>Basic Compile</title>
- <para>HBase is compiled using Maven. You must use Maven 3.x. To check your Maven
- version, run the command <command>mvn -version</command>.</para>
- <note>
- <title>JDK Version Requirements</title>
- <para> Starting with HBase 1.0 you must use Java 7 or later to build from source
- code. See <xref linkend="java"/> for more complete information about supported
- JDK versions. </para>
- </note>
- <section xml:id="maven.build.commands">
- <title>Maven Build Commands</title>
- <para>All commands are executed from the local HBase project directory. </para>
- <section>
- <title>Package</title>
- <para>The simplest command to compile HBase from its java source code is to use
- the <code>package</code> target, which builds JARs with the compiled
- files.</para>
- <programlisting language="bourne">mvn package -DskipTests</programlisting>
- <para>Or, to clean up before compiling:</para>
- <programlisting language="bourne">mvn clean package -DskipTests</programlisting>
- <para>With Eclipse set up as explained above in <xref linkend="eclipse"/>, you
- can also use the <guimenu>Build</guimenu> command in Eclipse. To create the
- full installable HBase package takes a little bit more work, so read on.
- </para>
- </section>
- <section xml:id="maven.build.commands.compile">
- <title>Compile</title>
- <para>The <code>compile</code> target does not create the JARs with the compiled
- files.</para>
- <programlisting language="bourne">mvn compile</programlisting>
- <programlisting language="bourne">mvn clean compile</programlisting>
- </section>
- <section>
- <title>Install</title>
- <para>To install the JARs in your <filename>~/.m2/</filename> directory, use the
- <code>install</code> target.</para>
- <programlisting language="bourne">mvn install</programlisting>
- <programlisting language="bourne">mvn clean install</programlisting>
- <programlisting language="bourne">mvn clean install -DskipTests</programlisting>
- </section>
- </section>
- <section xml:id="maven.build.commands.unitall">
- <title>Running all or individual Unit Tests</title>
- <para>See the <xref linkend="hbase.unittests.cmds"/> section in <xref
- linkend="hbase.unittests"/></para>
- </section>
-
- <section xml:id="maven.build.hadoop">
- <title>Building against various hadoop versions.</title>
- <para>As of 0.96, Apache HBase supports building against Apache Hadoop versions:
- 1.0.3, 2.0.0-alpha and 3.0.0-SNAPSHOT. By default, in 0.96 and earlier, we will
- build with Hadoop-1.0.x. As of 0.98, Hadoop 1.x is deprecated and Hadoop 2.x is
- the default. To change the version to build against, add a hadoop.profile
- property when you invoke <command>mvn</command>:</para>
- <programlisting language="bourne">mvn -Dhadoop.profile=1.0 ...</programlisting>
- <para> The above will build against whatever explicit hadoop 1.x version we have in
- our <filename>pom.xml</filename> as our '1.0' version. Tests may not all pass so
- you may need to pass <code>-DskipTests</code> unless you are inclined to fix the
- failing tests.</para>
- <note xml:id="maven.build.passing.default.profile">
- <title>'dependencyManagement.dependencies.dependency.artifactId' for
- org.apache.hbase:${compat.module}:test-jar with value '${compat.module}'
- does not match a valid id pattern</title>
- <para>You will see ERRORs like the above title if you pass the
- <emphasis>default</emphasis> profile; e.g. if you pass
- <property>hadoop.profile=1.1</property> when building 0.96 or
- <property>hadoop.profile=2.0</property> when building hadoop 0.98; just
- drop the hadoop.profile stipulation in this case to get your build to run
- again. This seems to be a maven pecularity that is probably fixable but
- we've not spent the time trying to figure it.</para>
- </note>
-
- <para> Similarly, for 3.0, you would just replace the profile value. Note that
- Hadoop-3.0.0-SNAPSHOT does not currently have a deployed maven artificat - you
- will need to build and install your own in your local maven repository if you
- want to run against this profile. </para>
- <para> In earilier versions of Apache HBase, you can build against older versions of
- Apache Hadoop, notably, Hadoop 0.22.x and 0.23.x. If you are running, for
- example HBase-0.94 and wanted to build against Hadoop 0.23.x, you would run
- with:</para>
- <programlisting language="bourne">mvn -Dhadoop.profile=22 ...</programlisting>
- </section>
- <section xml:id="build.protobuf">
- <title>Build Protobuf</title>
- <para>You may need to change the protobuf definitions that reside in the
- <filename>hbase-protocol</filename> module or other modules.</para>
- <para> The protobuf files are located in
- <filename>hbase-protocol/src/main/protobuf</filename>. For the change to be
- effective, you will need to regenerate the classes. You can use maven profile
- <code>compile-protobuf</code> to do this.</para>
- <programlisting language="bourne">mvn compile -Pcompile-protobuf</programlisting>
- <para>You may also want to define <varname>protoc.path</varname> for the protoc
- binary, using the following command:</para>
- <programlisting language="bourne">
-mvn compile -Pcompile-protobuf -Dprotoc.path=/opt/local/bin/protoc
- </programlisting>
- <para>Read the <filename>hbase-protocol/README.txt</filename> for more details.
- </para>
- </section>
-
- <section xml:id="build.thrift">
- <title>Build Thrift</title>
- <para>You may need to change the thrift definitions that reside in the
- <filename>hbase-thrift</filename> module or other modules.</para>
- <para>The thrift files are located in
- <filename>hbase-thrift/src/main/resources</filename>.
- For the change to be effective, you will need to regenerate the classes.
- You can use maven profile <code>compile-thrift</code> to do this.</para>
- <programlisting language="bourne">mvn compile -Pcompile-thrift</programlisting>
- <para>You may also want to define <varname>thrift.path</varname> for the thrift
- binary, using the following command:</para>
- <programlisting language="bourne">
- mvn compile -Pcompile-thrift -Dthrift.path=/opt/local/bin/thrift
- </programlisting>
- </section>
-
- <section>
- <title>Build a Tarball</title>
- <para>You can build a tarball without going through the release process described in
- <xref linkend="releasing"/>, by running the following command:</para>
- <screen>mvn -DskipTests clean install && mvn -DskipTests package assembly:single</screen>
- <para>The distribution tarball is built in
- <filename>hbase-assembly/target/hbase-<replaceable><version></replaceable>-bin.tar.gz</filename>.</para>
- </section>
- <section xml:id="build.gotchas">
- <title>Build Gotchas</title>
- <para>If you see <code>Unable to find resource 'VM_global_library.vm'</code>, ignore
- it. Its not an error. It is <link
- xlink:href="http://jira.codehaus.org/browse/MSITE-286">officially
- ugly</link> though. </para>
- </section>
- <section xml:id="build.snappy">
- <title>Building in snappy compression support</title>
- <para>Pass <code>-Psnappy</code> to trigger the <code>hadoop-snappy</code> maven profile
- for building Google Snappy native libraries into HBase. See also <xref
- linkend="snappy.compression.installation"/></para>
- </section>
- </section>
- </section>
- <section xml:id="releasing">
- <title>Releasing Apache HBase</title>
- <note>
- <title>Building against HBase 1.x</title>
- <para>HBase 1.x requires Java 7 to build. See <xref linkend="java"/> for Java
- requirements per HBase release.</para>
- </note>
- <section>
- <title>Building against HBase 0.96-0.98</title>
- <para>HBase 0.96.x will run on Hadoop 1.x or Hadoop 2.x. HBase 0.98 still runs on both,
- but HBase 0.98 deprecates use of Hadoop 1. HBase 1.x will <emphasis>not</emphasis>
- run on Hadoop 1. In the following procedures, we make a distinction between HBase
- 1.x builds and the awkward process involved building HBase 0.96/0.98 for either
- Hadoop 1 or Hadoop 2 targets. </para>
- <para>You must choose which Hadoop to build against. It is not possible to build a
- single HBase binary that runs against both Hadoop 1 and Hadoop 2. Hadoop is included
- in the build, because it is needed to run HBase in standalone mode. Therefore, the
- set of modules included in the tarball changes, depending on the build target. To
- determine which HBase you have, look at the HBase version. The Hadoop version is
- embedded within it.</para>
- <para>Maven, our build system, natively does not allow a single product to be built
- against different dependencies. Also, Maven cannot change the set of included
- modules and write out the correct <filename>pom.xml</filename> files with
- appropriate dependencies, even using two build targets, one for Hadoop 1 and another
- for Hadoop 2. A prerequisite step is required, which takes as input the current
- <filename>pom.xml</filename>s and generates Hadoop 1 or Hadoop 2 versions using
- a script in the <filename>dev-tools/</filename> directory, called
- <filename>generate-hadoop<replaceable>X</replaceable>-poms.sh</filename>
- where <replaceable>X</replaceable> is either <literal>1</literal> or
- <literal>2</literal>. You then reference these generated poms when you build.
- For now, just be aware of the difference between HBase 1.x builds and those of HBase
- 0.96-0.98. This difference is important to the build instructions.</para>
-
-
- <example xml:id="mvn.settings.file">
- <title>Example <filename>~/.m2/settings.xml</filename> File</title>
- <para>Publishing to maven requires you sign the artifacts you want to upload. For
- the build to sign them for you, you a properly configured
- <filename>settings.xml</filename> in your local repository under
- <filename>.m2</filename>, such as the following.</para>
- <programlisting language="xml"><![CDATA[<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
- http://maven.apache.org/xsd/settings-1.0.0.xsd">
- <servers>
- <!- To publish a snapshot of some part of Maven -->
- <server>
- <id>apache.snapshots.https</id>
- <username>YOUR_APACHE_ID
- </username>
- <password>YOUR_APACHE_PASSWORD
- </password>
- </server>
- <!-- To publish a website using Maven -->
- <!-- To stage a release of some part of Maven -->
- <server>
- <id>apache.releases.https</id>
- <username>YOUR_APACHE_ID
- </username>
- <password>YOUR_APACHE_PASSWORD
- </password>
- </server>
- </servers>
- <profiles>
- <profile>
- <id>apache-release</id>
- <properties>
- <gpg.keyname>YOUR_KEYNAME</gpg.keyname>
- <!--Keyname is something like this ... 00A5F21E... do gpg --list-keys to find it-->
- <gpg.passphrase>YOUR_KEY_PASSWORD
- </gpg.passphrase>
- </properties>
- </profile>
- </profiles>
-</settings>]]>
- </programlisting>
- </example>
-
- </section>
- <section xml:id="maven.release">
- <title>Making a Release Candidate</title>
- <note>
- <para>These instructions are for building HBase 1.0.x. For building earlier
- versions, the process is different. See this section under the respective
- release documentation folders. </para></note>
- <formalpara>
- <title>Point Releases</title>
- <para>If you are making a point release (for example to quickly address a critical
- incompatability or security problem) off of a release branch instead of a
- development branch, the tagging instructions are slightly different. I'll prefix
- those special steps with <emphasis>Point Release Only</emphasis>. </para>
- </formalpara>
-
- <formalpara>
- <title>Before You Begin</title>
- <para>Before you make a release candidate, do a practice run by deploying a
- snapshot. Before you start, check to be sure recent builds have been passing for
- the branch from where you are going to take your release. You should also have
- tried recent branch tips out on a cluster under load, perhaps by running the
- <code>hbase-it</code> integration test suite for a few hours to 'burn in'
- the near-candidate bits. </para>
- </formalpara>
- <note>
- <title>Point Release Only</title>
- <para>At this point you should tag the previous release branch (ex: 0.96.1) with the
- new point release tag (e.g. 0.96.1.1 tag). Any commits with changes for the
- point release should be appled to the new tag. </para>
- </note>
-
-
- <para>The Hadoop <link xlink:href="http://wiki.apache.org/hadoop/HowToRelease">How To
- Release</link> wiki page is used as a model for most of the instructions below,
- and may have more detail on particular sections, so it is worth review.</para>
-
- <note>
- <title>Specifying the Heap Space for Maven on OSX</title>
- <para>On OSX, you may need to specify the heap space for Maven commands, by setting
- the <varname>MAVEN_OPTS</varname> variable to <literal>-Xmx3g</literal>. You can
- prefix the variable to the Maven command, as in the following example:</para>
- <screen>MAVEN_OPTS="-Xmx2g" mvn package</screen>
- <para>You could also set this in an environment variable or alias in your
- shell.</para>
- </note>
- <procedure>
- <title>Release Procedure</title>
- <para>The script <filename>dev-support/make_rc.sh</filename> automates many of these
- steps. It does not do the modification of the <filename>CHANGES.txt</filename>
- for the release, the close of the staging repository in Apache Maven (human
- intervention is needed here), the checking of the produced artifacts to ensure
- they are 'good' -- e.g. extracting the produced tarballs, verifying that they
- look right, then starting HBase and checking that everything is running
- correctly, then the signing and pushing of the tarballs to <link
- xlink:href="http://people.apache.org">people.apache.org</link>. The script
- handles everything else, and comes in handy.</para>
- <step>
- <title>Update the <filename>CHANGES.txt</filename> file and the POM files.</title>
- <para>Update <filename>CHANGES.txt</filename> with the changes since the last
- release. Make sure the URL to the JIRA points to the proper location which
- lists fixes for this release. Adjust the version in all the POM files
- appropriately. If you are making a release candidate, you must remove the
- <literal>-SNAPSHOT</literal> label from all versions. If you are running
- this receipe to publish a snapshot, you must keep the
- <literal>-SNAPSHOT</literal> suffix on the hbase version. The <link
- xlink:href="http://mojo.codehaus.org/versions-maven-plugin/">Versions
- Maven Plugin</link> can be of use here. To set a version in all the many
- poms of the hbase multi-module project, use a command like the
- following:</para>
- <programlisting language="bourne">
-$ mvn clean org.codehaus.mojo:versions-maven-plugin:1.3.1:set -DnewVersion=0.96.0
- </programlisting>
- <para>Checkin the <filename>CHANGES.txt</filename> and any version
- changes.</para>
- </step>
- <step>
- <title>Update the documentation.</title>
- <para> Update the documentation under <filename>src/main/docbkx</filename>. This
- usually involves copying the latest from trunk and making version-particular
- adjustments to suit this release candidate version. </para>
- </step>
- <step>
- <title>Build the source tarball.</title>
- <para>Now, build the source tarball. This tarball is Hadoop-version-independent.
- It is just the pure source code and documentation without a particular
- hadoop taint, etc. Add the <varname>-Prelease</varname> profile when
- building. It checks files for licenses and will fail the build if unlicensed
- files are present.</para>
- <programlisting language="bourne">
-$ mvn clean install -DskipTests assembly:single -Dassembly.file=hbase-assembly/src/main/assembly/src.xml -Prelease
- </programlisting>
- <para>Extract the tarball and make sure it looks good. A good test for the src
- tarball being 'complete' is to see if you can build new tarballs from this
- source bundle. If the source tarball is good, save it off to a
- <emphasis>version directory</emphasis>, a directory somewhere where you
- are collecting all of the tarballs you will publish as part of the release
- candidate. For example if you were building a hbase-0.96.0 release
- candidate, you might call the directory
- <filename>hbase-0.96.0RC0</filename>. Later you will publish this directory
- as our release candidate up on <link xlink:href="people.apache.org/~YOU"
- >people.apache.org/<replaceable>~YOU</replaceable>/</link>. </para>
- </step>
- <step>
- <title>Build the binary tarball.</title>
- <para>Next, build the binary tarball. Add the <varname>-Prelease</varname>
- profile when building. It checks files for licenses and will fail the build
- if unlicensed files are present. Do it in two steps.</para>
- <substeps>
- <step>
- <para>First install into the local repository</para>
- <programlisting language="bourne">
-$ mvn clean install -DskipTests -Prelease</programlisting>
- </step>
- <step>
- <para>Next, generate documentation and assemble the tarball.</para>
- <programlisting language="bourne">
-$ mvn install -DskipTests site assembly:single -Prelease</programlisting>
- </step>
- </substeps>
- <para> Otherwise, the build complains that hbase modules are not in the maven
- repository when you try to do it at once, especially on fresh repository. It
- seems that you need the install goal in both steps.</para>
- <para>Extract the generated tarball and check it out. Look at the documentation,
- see if it runs, etc. If good, copy the tarball to the above mentioned
- <emphasis>version directory</emphasis>. </para>
- </step>
- <step>
- <title>Create a new tag.</title>
- <note>
- <title>Point Release Only</title>
- <para>The following step that creates a new tag can be skipped since you've
- already created the point release tag</para>
- </note>
- <para>Tag the release at this point since it looks good. If you find an issue
- later, you can delete the tag and start over. Release needs to be tagged for
- the next step.</para>
- </step>
- <step>
- <title>Deploy to the Maven Repository.</title>
- <para>Next, deploy HBase to the Apache Maven repository, using the
- <varname>apache-release</varname> profile instead of the
- <varname>release</varname> profile when running the <command>mvn
- deploy</command> command. This profile invokes the Apache pom referenced
- by our pom files, and also signs your artifacts published to Maven, as long
- as the <filename>settings.xml</filename> is configured correctly, as
- described in <xref linkend="mvn.settings.file"/>.</para>
- <programlisting language="bourne">
-$ mvn deploy -DskipTests -Papache-release</programlisting>
- <para>This command copies all artifacts up to a temporary staging Apache mvn
- repository in an 'open' state. More work needs to be done on these maven
- artifacts to make them generally available. </para>
- </step>
- <step>
- <title>Make the Release Candidate available.</title>
- <para>The artifacts are in the maven repository in the staging area in the
- 'open' state. While in this 'open' state you can check out what you've
- published to make sure all is good. To do this, login at <link
- xlink:href="http://repository.apache.org">repository.apache.org</link>
- using your Apache ID. Find your artifacts in the staging repository. Browse
- the content. Make sure all artifacts made it up and that the poms look
- generally good. If it checks out, 'close' the repo. This will make the
- artifacts publically available. You will receive an email with the URL to
- give out for the temporary staging repository for others to use trying out
- this new release candidate. Include it in the email that announces the
- release candidate. Folks will need to add this repo URL to their local poms
- or to their local <filename>settings.xml</filename> file to pull the
- published release candidate artifacts. If the published artifacts are
- incomplete or have problems, just delete the 'open' staged artifacts.</para>
- <note>
- <title>hbase-downstreamer</title>
- <para> See the <link
- xlink:href="https://github.com/saintstack/hbase-downstreamer"
- >hbase-downstreamer</link> test for a simple example of a project
- that is downstream of HBase an depends on it. Check it out and run its
- simple test to make sure maven artifacts are properly deployed to the
- maven repository. Be sure to edit the pom to point to the proper staging
- repository. Make sure you are pulling from the repository when tests run
- and that you are not getting from your local repository, by either
- passing the <code>-U</code> flag or deleting your local repo content and
- check maven is pulling from remote out of the staging repository.
- </para>
- </note>
- <para>See <link
- xlink:href="http://www.apache.org/dev/publishing-maven-artifacts.html"
- >Publishing Maven Artifacts</link> for some pointers on this maven
- staging process.</para>
- <note>
- <para>We no longer publish using the maven release plugin. Instead we do
- <command>mvn deploy</command>. It seems to give us a backdoor to
- maven release publishing. If there is no <emphasis>-SNAPSHOT</emphasis>
- on the version string, then we are 'deployed' to the apache maven
- repository staging directory from which we can publish URLs for
- candidates and later, if they pass, publish as release (if a
- <emphasis>-SNAPSHOT</emphasis> on the version string, deploy will
- put the artifacts up into apache snapshot repos). </para>
- </note>
- <para>If the HBase version ends in <varname>-SNAPSHOT</varname>, the artifacts
- go elsewhere. They are put into the Apache snapshots repository directly and
- are immediately available. Making a SNAPSHOT release, this is what you want
- to happen.</para>
- </step>
- <step>
- <title>If you used the <filename>make_rc.sh</filename> script instead of doing
- the above manually, do your sanity checks now.</title>
- <para> At this stage, you have two tarballs in your 'version directory' and a
- set of artifacts in a staging area of the maven repository, in the 'closed'
- state. These are publicly accessible in a temporary staging repository whose
- URL you should have gotten in an email. The above mentioned script,
- <filename>make_rc.sh</filename> does all of the above for you minus the
- check of the artifacts built, the closing of the staging repository up in
- maven, and the tagging of the release. If you run the script, do your checks
- at this stage verifying the src and bin tarballs and checking what is up in
- staging using hbase-downstreamer project. Tag before you start the build.
- You can always delete it if the build goes haywire. </para>
- </step>
- <step>
- <title>Sign and upload your version directory to <link
- xlink:href="http://people.apache.org">people.apache.org</link>.</title>
- <para> If all checks out, next put the <emphasis>version directory</emphasis> up
- on <link xlink:href="http://people.apache.org">people.apache.org</link>. You
- will need to sign and fingerprint them before you push them up. In the
- <emphasis>version directory</emphasis> run the following commands:
- </para>
- <programlisting language="bourne">
-$ for i in *.tar.gz; do echo $i; gpg --print-mds $i > $i.mds ; done
-$ for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i ; done
-$ cd ..
-# Presuming our 'version directory' is named 0.96.0RC0, now copy it up to people.apache.org.
-$ rsync -av 0.96.0RC0 people.apache.org:public_html
- </programlisting>
- <para>Make sure the <link xlink:href="http://people.apache.org"
- >people.apache.org</link> directory is showing and that the mvn repo
- URLs are good. Announce the release candidate on the mailing list and call a
- vote. </para>
- </step>
- </procedure>
- </section>
- <section xml:id="maven.snapshot">
- <title>Publishing a SNAPSHOT to maven</title>
- <para>Make sure your <filename>settings.xml</filename> is set up properly, as in <xref
- linkend="mvn.settings.file"/>. Make sure the hbase version includes
- <varname>-SNAPSHOT</varname> as a suffix. Following is an example of publishing
- SNAPSHOTS of a release that had an hbase version of 0.96.0 in its poms.</para>
- <programlisting language="bourne">
- $ mvn clean install -DskipTests javadoc:aggregate site assembly:single -Prelease
- $ mvn -DskipTests deploy -Papache-release</programlisting>
- <para>The <filename>make_rc.sh</filename> script mentioned above (see <xref
- linkend="maven.release"/>) can help you publish <varname>SNAPSHOTS</varname>.
- Make sure your <varname>hbase.version</varname> has a <varname>-SNAPSHOT</varname>
- suffix before running the script. It will put a snapshot up into the apache snapshot
- repository for you. </para>
- </section>
-
- </section>
-
- <section xml:id="hbase.rc.voting">
- <title>Voting on Release Candidates</title>
- <para> Everyone is encouraged to try and vote on HBase release candidates. Only the votes of
- PMC members are binding. PMC members, please read this WIP doc on policy voting for a
- release candidate, <link
- xlink:href="https://github.com/rectang/asfrelease/blob/master/release.md">Release
- Policy</link>. <quote>Before casting +1 binding votes, individuals are required to
- download the signed source code package onto their own hardware, compile it as
- provided, and test the resulting executable on their own platform, along with also
- validating cryptographic signatures and verifying that the package meets the
- requirements of the ASF policy on releases.</quote> Regards the latter, run
- <command>mvn apache-rat:check</command> to verify all files are suitably licensed.
- See <link xlink:href="http://search-hadoop.com/m/DHED4dhFaU">HBase, mail # dev - On
- recent discussion clarifying ASF release policy</link>. for how we arrived at this
- process. </para>
- </section>
- <section xml:id="documentation">
- <title>Generating the HBase Reference Guide</title>
- <para>The manual is marked up using <link xlink:href="http://www.docbook.org/"
- >docbook</link>. We then use the <link
- xlink:href="http://code.google.com/p/docbkx-tools/">docbkx maven plugin</link> to
- transform the markup to html. This plugin is run when you specify the
- <command>site</command> goal as in when you run <command>mvn site</command> or you
- can call the plugin explicitly to just generate the manual by doing <command>mvn
- docbkx:generate-html</command>. When you run <command>mvn site</command>, the
- documentation is generated twice, once to generate the multipage manual and then again
- for the single page manual, which is easier to search. See <xref
- linkend="appendix_contributing_to_documentation"/> for more information on building
- the documentation. </para>
- </section>
- <section xml:id="hbase.org">
- <title>Updating <link xlink:href="http://hbase.apache.org">hbase.apache.org</link></title>
- <section xml:id="hbase.org.site.contributing">
- <title>Contributing to hbase.apache.org</title>
- <para>See <xref linkend="appendix_contributing_to_documentation"/> for more information
- on contributing to the documentation or website.</para>
- </section>
- <section xml:id="hbase.org.site.publishing">
- <title>Publishing <link xlink:href="http://hbase.apache.org"
- >hbase.apache.org</link></title>
- <para>As of <link xlink:href="https://issues.apache.org/jira/browse/INFRA-5680"
- >INFRA-5680 Migrate apache hbase website</link>, to publish the website, build
- it using Maven, and then deploy it over a checkout of
- <filename>https://svn.apache.org/repos/asf/hbase/hbase.apache.org/trunk</filename>
- and check in your changes. The script
- <filename>dev-scripts/publish_hbase_website.sh</filename> is provided to
- automate this process and to be sure that stale files are removed from SVN. Review
- the script even if you decide to publish the website manually. Use the script as
- follows:</para>
- <screen>$ <userinput>publish_hbase_website.sh -h</userinput>
-<![CDATA[Usage: publish_hbase_website.sh [-i | -a] [-g <dir>] [-s <dir>]]]>
- -h Show this message
- -i Prompts the user for input
- -a Does not prompt the user. Potentially dangerous.
- -g The local location of the HBase git repository
- -s The local location of the HBase svn checkout
- Either --interactive or --silent is required.
- Edit the script to set default Git and SVN directories.
- </screen>
- <note><para>The SVN commit takes a long time.</para></note>
- </section>
- </section>
- <section xml:id="hbase.tests">
- <title>Tests</title>
-
- <para> Developers, at a minimum, should familiarize themselves with the unit test detail;
- unit tests in HBase have a character not usually seen in other projects.</para>
- <para>This information is about unit tests for HBase itself. For developing unit tests for
- your HBase applications, see <xref linkend="unit.tests"/>.</para>
- <section xml:id="hbase.moduletests">
- <title>Apache HBase Modules</title>
- <para>As of 0.96, Apache HBase is split into multiple modules. This creates
- "interesting" rules for how and where tests are written. If you are writing code for
- <classname>hbase-server</classname>, see <xref linkend="hbase.unittests"/> for
- how to write your tests. These tests can spin up a minicluster and will need to be
- categorized. For any other module, for example <classname>hbase-common</classname>,
- the tests must be strict unit tests and just test the class under test - no use of
- the HBaseTestingUtility or minicluster is allowed (or even possible given the
- dependency tree).</para>
- <section xml:id="hbase.moduletest.shell">
- <title>Testing the HBase Shell</title>
- <para>
- The HBase shell and its tests are predominantly written in jruby. In order to make these
- tests run as a part of the standard build, there is a single JUnit test,
- <classname>TestShell</classname>, that takes care of loading the jruby implemented tests and
- running them. You can run all of these tests from the top level with:
- </para>
- <programlisting language="bourne">
- mvn clean test -Dtest=TestShell
- </programlisting>
- <para>
- Alternatively, you may limit the shell tests that run using the system variable
- <classname>shell.test</classname>. This value may specify a particular test case by name. For
- example, the tests that cover the shell commands for altering tables are contained in the test
- case <classname>AdminAlterTableTest</classname> and you can run them with:
- </para>
- <programlisting language="bourne">
- mvn clean test -Dtest=TestShell -Dshell.test=AdminAlterTableTest
- </programlisting>
- <para>
- You may also use a <link xlink:href=
- "http://docs.ruby-doc.com/docs/ProgrammingRuby/html/language.html#UJ">Ruby Regular Expression
- literal</link> (in the <classname>/pattern/</classname> style) to select a set of test cases.
- You can run all of the HBase admin related tests, including both the normal administration and
- the security administration, with the command:
- </para>
- <programlisting language="bourne">
- mvn clean test -Dtest=TestShell -Dshell.test=/.*Admin.*Test/
- </programlisting>
- <para>
- In the event of a test failure, you can see details by examining the XML version of the
- surefire report results
- </para>
- <programlisting language="bourne">
- vim hbase-shell/target/surefire-reports/TEST-org.apache.hadoop.hbase.client.TestShell.xml
- </programlisting>
- </section>
- <section xml:id="hbase.moduletest.run">
- <title>Running Tests in other Modules</title>
- <para>If the module you are developing in has no other dependencies on other HBase modules, then
- you can cd into that module and just run:</para>
- <programlisting language="bourne">mvn test</programlisting>
- <para>which will just run the tests IN THAT MODULE. If there are other dependencies on other modules,
- then you will have run the command from the ROOT HBASE DIRECTORY. This will run the tests in the other
- modules, unless you specify to skip the tests in that module. For instance, to skip the tests in the hbase-server module,
- you would run:</para>
- <programlisting language="bourne">mvn clean test -PskipServerTests</programlisting>
- <para>from the top level directory to run all the tests in modules other than hbase-server. Note that you
- can specify to skip tests in multiple modules as well as just for a single module. For example, to skip
- the tests in <classname>hbase-server</classname> and <classname>hbase-common</classname>, you would run:</para>
- <programlisting language="bourne">mvn clean test -PskipServerTests -PskipCommonTests</programlisting>
- <para>Also, keep in mind that if you are running tests in the <classname>hbase-server</classname> module you will need to
- apply the maven profiles discussed in <xref linkend="hbase.unittests.cmds"/> to get the tests to run properly.</para>
- </section>
-</section>
-
-<section xml:id="hbase.unittests">
-<title>Unit Tests</title>
-<para>Apache HBase unit tests are subdivided into four categories: small, medium, large, and
-integration with corresponding JUnit <link xlink:href="http://www.junit.org/node/581">categories</link>:
-<classname>SmallTests</classname>, <classname>MediumTests</classname>,
-<classname>LargeTests</classname>, <classname>IntegrationTests</classname>.
-JUnit categories are denoted using java annotations and look like this in your unit test code.</para>
-<programlisting language="java">...
-@Category(SmallTests.class)
-public class TestHRegionInfo {
- @Test
- public void testCreateHRegionInfoName() throws Exception {
- // ...
- }
-}</programlisting>
- <para>The above example shows how to mark a unit test as belonging to the
- <literal>small</literal> category. All unit tests in HBase have a
- categorization. </para>
- <para> The first three categories, <literal>small</literal>, <literal>medium</literal>,
- and <literal>large</literal>, are for tests run when you type <code>$ mvn
- test</code>. In other words, these three categorizations are for HBase unit
- tests. The <literal>integration</literal> category is not for unit tests, but for
- integration tests. These are run when you invoke <code>$ mvn verify</code>.
- Integration tests are described in <xref linkend="integration.tests"/>.</para>
- <para>HBase uses a patched maven surefire plugin and maven profiles to implement
- its unit test characterizations. </para>
- <para>Keep reading to figure which annotation of the set small, medium, and large to
- put on your new HBase unit test. </para>
-
- <variablelist>
- <title>Categorizing Tests</title>
- <varlistentry xml:id="hbase.unittests.small">
- <term>Small Tests<indexterm><primary>SmallTests</primary></indexterm></term>
- <listitem>
- <para>
- <emphasis>Small</emphasis> tests are executed in a shared JVM. We put in
- this category all the tests that can be executed quickly in a shared
- JVM. The maximum execution time for a small test is 15 seconds, and
- small tests should not use a (mini)cluster.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="hbase.unittests.medium">
- <term>Medium Tests<indexterm><primary>MediumTests</primary></indexterm></term>
- <listitem>
- <para><emphasis>Medium</emphasis> tests represent tests that must be
- executed before proposing a patch. They are designed to run in less than
- 30 minutes altogether, and are quite stable in their results. They are
- designed to last less than 50 seconds individually. They can use a
- cluster, and each of them is executed in a separate JVM. </para>
- </listitem>
- </varlistentry>
-
- <varlistentry xml:id="hbase.unittests.large">
- <term>Large Tests<indexterm><primary>LargeTests</primary></indexterm></term>
- <listitem>
- <para><emphasis>Large</emphasis> tests are everything else. They are
- typically large-scale tests, regression tests for specific bugs, timeout
- tests, performance tests. They are executed before a commit on the
- pre-integration machines. They can be run on the developer machine as
- well. </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="hbase.unittests.integration">
- <term>Integration
- Tests<indexterm><primary>IntegrationTests</primary></indexterm></term>
- <listitem>
- <para><emphasis>Integration</emphasis> tests are system level tests. See
- <xref linkend="integration.tests"/> for more info. </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section xml:id="hbase.unittests.cmds">
- <title>Running tests</title>
-
- <section xml:id="hbase.unittests.cmds.test">
- <title>Default: small and medium category tests </title>
- <para>Running <code language="bourne">mvn test</code> will
- execute all small tests in a single JVM (no fork) and then medium tests in a
- separate JVM for each test instance. Medium tests are NOT executed if there is
- an error in a small test. Large tests are NOT executed. There is one report for
- small tests, and one report for medium tests if they are executed. </para>
- </section>
-
- <section xml:id="hbase.unittests.cmds.test.runAllTests">
- <title>Running all tests</title>
- <para>Running
- <code language="bourne">mvn test -P runAllTests</code> will
- execute small tests in a single JVM then medium and large tests in a separate
- JVM for each test. Medium and large tests are NOT executed if there is an error
- in a small test. Large tests are NOT executed if there is an error in a small or
- medium test. There is one report for small tests, and one report for medium and
- large tests if they are executed. </para>
- </section>
-
- <section xml:id="hbase.unittests.cmds.test.localtests.mytest">
- <title>Running a single test or all tests in a package</title>
- <para>To run an individual test, e.g. <classname>MyTest</classname>, rum <code
- language="bourne">mvn test -Dtest=MyTest</code> You can also pass multiple,
- individual tests as a comma-delimited list: <code language="bourne">mvn test
- -Dtest=MyTest1,MyTest2,MyTest3</code> You can also pass a package, which
- will run all tests under the package: <code language="bourne">mvn test
- '-Dtest=org.apache.hadoop.hbase.client.*'</code>
- </para>
-
- <para> When <code>-Dtest</code> is specified, the <code>localTests</code> profile
- will be used. It will use the official release of maven surefire, rather than
- our custom surefire plugin, and the old connector (The HBase build uses a
- patched version of the maven surefire plugin). Each junit test is executed in a
- separate JVM (A fork per test class). There is no parallelization when tests are
- running in this mode. You will see a new message at the end of the -report:
- <literal>"[INFO] Tests are skipped"</literal>. It's harmless. However, you
- need to make sure the sum of <code>Tests run:</code> in the <code>Results
- :</code> section of test reports matching the number of tests you specified
- because no error will be reported when a non-existent test case is specified.
- </para>
- </section>
-
- <section xml:id="hbase.unittests.cmds.test.profiles">
- <title>Other test invocation permutations</title>
- <para>Running <command>mvn test -P runSmallTests</command> will execute "small"
- tests only, using a single JVM. </para>
- <para>Running <command>mvn test -P runMediumTests</command> will execute "medium"
- tests only, launching a new JVM for each test-class. </para>
- <para>Running <command>mvn test -P runLargeTests</command> will execute "large"
- tests only, launching a new JVM for each test-class. </para>
- <para>For convenience, you can run <command>mvn test -P runDevTests</command> to
- execute both small and medium tests, using a single JVM. </para>
- </section>
-
- <section xml:id="hbase.unittests.test.faster">
- <title>Running tests faster</title>
- <para> By default, <code>$ mvn test -P runAllTests</code> runs 5 tests in parallel.
- It can be increased on a developer's machine. Allowing that you can have 2 tests
- in parallel per core, and you need about 2GB of memory per test (at the
- extreme), if you have an 8 core, 24GB box, you can have 16 tests in parallel.
- but the memory available limits it to 12 (24/2), To run all tests with 12 tests
- in parallel, do this: <command>mvn test -P runAllTests
- -Dsurefire.secondPartForkCount=12</command>. If using a version earlier than
- 2.0, do: <command>mvn test -P runAllTests -Dsurefire.secondPartThreadCount=12
- </command>. To increase the speed, you can as well use a ramdisk. You will need 2GB
- of memory to run all tests. You will also need to delete the files between two
- test run. The typical way to configure a ramdisk on Linux is:</para>
- <screen language="bourne">$ sudo mkdir /ram2G
-sudo mount -t tmpfs -o size=2048M tmpfs /ram2G</screen>
- <para>You can then use it to run all HBase tests on 2.0 with the command: </para>
- <screen language="bourne">mvn test
- -P runAllTests -Dsurefire.secondPartForkCount=12
- -Dtest.build.data.basedirectory=/ram2G</screen>
- <para>On earlier versions, use: </para>
- <screen language="bourne">mvn test
- -P runAllTests -Dsurefire.secondPartThreadCount=12
- -Dtest.build.data.basedirectory=/ram2G</screen>
- </section>
-
- <section xml:id="hbase.unittests.cmds.test.hbasetests">
- <title><command>hbasetests.sh</command></title>
- <para>It's also possible to use the script <command>hbasetests.sh</command>. This
- script runs the medium and large tests in parallel with two maven instances, and
- provides a single report. This script does not use the hbase version of surefire
- so no parallelization is being done other than the two maven instances the
- script sets up. It must be executed from the directory which contains the
- <filename>pom.xml</filename>.</para>
- <para>For example running <command>./dev-support/hbasetests.sh</command> will
- execute small and medium tests. Running <command>./dev-support/hbasetests.sh
- runAllTests</command> will execute all tests. Running
- <command>./dev-support/hbasetests.sh replayFailed</command> will rerun the
- failed tests a second time, in a separate jvm and without parallelisation.
- </para>
- </section>
- <section xml:id="hbase.unittests.resource.checker">
- <title>Test Resource Checker<indexterm><primary>Test Resource
- Checker</primary></indexterm></title>
- <para> A custom Maven SureFire plugin listener checks a number of resources before
- and after each HBase unit test runs and logs its findings at the end of the test
- output files which can be found in <filename>target/surefire-reports</filename>
- per Maven module (Tests write test reports named for the test class into this
- directory. Check the <filename>*-out.txt</filename> files). The resources
- counted are the number of threads, the number of file descriptors, etc. If the
- number has increased, it adds a <emphasis>LEAK?</emphasis> comment in the logs.
- As you can have an HBase instance running in the background, some threads can be
- deleted/created without any specific action in the test. However, if the test
- does not work as expected, or if the test should not impact these resources,
- it's worth checking these log lines
- <computeroutput>...hbase.ResourceChecker(157): before...</computeroutput>
- and <computeroutput>...hbase.ResourceChecker(157): after...</computeroutput>.
- For example: </para>
- <screen>2012-09-26 09:22:15,315 INFO [pool-1-thread-1]
-hbase.ResourceChecker(157): after:
-regionserver.TestColumnSeeking#testReseeking Thread=65 (was 65),
-OpenFileDescriptor=107 (was 107), MaxFileDescriptor=10240 (was 10240),
-ConnectionCount=1 (was 1) </screen>
- </section>
- </section>
-
- <section xml:id="hbase.tests.writing">
- <title>Writing Tests</title>
- <section xml:id="hbase.tests.rules">
- <title>General rules</title>
- <itemizedlist>
- <listitem>
- <para>As much as possible, tests should be written as category small
- tests.</para>
- </listitem>
- <listitem>
- <para>All tests must be written to support parallel execution on the same
- machine, hence they should not use shared resources as fixed ports or
- fixed file names.</para>
- </listitem>
- <listitem>
- <para>Tests should not overlog. More than 100 lines/second makes the logs
- complex to read and use i/o that are hence not available for the other
- tests.</para>
- </listitem>
- <listitem>
- <para>Tests can be written with <classname>HBaseTestingUtility</classname>.
- This class offers helper functions to create a temp directory and do the
- cleanup, or to start a cluster.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section xml:id="hbase.tests.categories">
- <title>Categories and execution time</title>
- <itemizedlist>
- <listitem>
- <para>All tests must be categorized, if not they could be skipped.</para>
- </listitem>
- <listitem>
- <para>All tests should be written to be as fast as possible.</para>
- </listitem>
- <listitem>
- <para>Small category tests should last less than 15 seconds, and must not
- have any side effect.</para>
- </listitem>
- <listitem>
- <para>Medium category tests should last less than 50 seconds.</para>
- </listitem>
- <listitem>
- <para>Large category tests should last less than 3 minutes. This should
- ensure a good parallelization for people using it, and ease the analysis
- when the test fails.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section xml:id="hbase.tests.sleeps">
- <title>Sleeps in tests</title>
- <para>Whenever possible, tests should not use <methodname>Thread.sleep</methodname>,
- but rather waiting for the real event they need. This is faster and clearer for
- the reader. Tests should not do a <methodname>Thread.sleep</methodname> without
- testing an ending condition. This allows understanding what the test is waiting
- for. Moreover, the test will work whatever the machine performance is. Sleep
- should be minimal to be as fast as possible. Waiting for a variable should be
- done in a 40ms sleep loop. Waiting for a socket operation should be done in a
- 200 ms sleep loop. </para>
- </section>
-
- <section xml:id="hbase.tests.cluster">
- <title>Tests using a cluster </title>
-
- <para>Tests using a HRegion do not have to start a cluster: A region can use the
- local file system. Start/stopping a cluster cost around 10 seconds. They should
- not be started per test method but per test class. Started cluster must be
- shutdown using <methodname>HBaseTestingUtility#shutdownMiniCluster</methodname>,
- which cleans the directories. As most as possible, tests should use the default
- settings for the cluster. When they don't, they should document it. This will
- allow to share the cluster later. </para>
- </section>
- </section>
-
- <section xml:id="integration.tests">
- <title>Integration Tests</title>
- <para>HBase integration/system tests are tests that are beyond HBase unit tests. They
- are generally long-lasting, sizeable (the test can be asked to 1M rows or 1B rows),
- targetable (they can take configuration that will point them at the ready-made
- cluster they are to run against; integration tests do not include cluster start/stop
- code), and verifying success, integration tests rely on public APIs only; they do
- not attempt to examine server internals asserting success/fail. Integration tests
- are what you would run when you need to more elaborate proofing of a release
- candidate beyond what unit tests can do. They are not generally run on the Apache
- Continuous Integration build server, however, some sites opt to run integration
- tests as a part of their continuous testing on an actual cluster. </para>
- <para> Integration tests currently live under the <filename>src/test</filename>
- directory in the hbase-it submodule and will match the regex:
- <filename>**/IntegrationTest*.java</filename>. All integration tests are also
- annotated with <code>@Category(IntegrationTests.class)</code>. </para>
-
- <para> Integration tests can be run in two modes: using a mini cluster, or against an
- actual distributed cluster. Maven failsafe is used to run the tests using the mini
- cluster. IntegrationTestsDriver class is used for executing the tests against a
- distributed cluster. Integration tests SHOULD NOT assume that they are running
- against a mini cluster, and SHOULD NOT use private API's to access cluster state. To
- interact with the distributed or mini cluster uniformly,
- <code>IntegrationTestingUtility</code>, and <code>HBaseCluster</code> classes,
- and public client API's can be used. </para>
-
- <para> On a distributed cluster, integration tests that use ChaosMonkey or otherwise
- manipulate services thru cluster manager (e.g. restart regionservers) use SSH to do
- it. To run these, test process should be able to run commands on remote end, so ssh
- should be configured accordingly (for example, if HBase runs under hbase user in
- your cluster, you can set up passwordless ssh for that user and run the test also
- under it). To facilitate that, <code>hbase.it.clustermanager.ssh.user</code>,
- <code>hbase.it.clustermanager.ssh.opts</code> and
- <code>hbase.it.clustermanager.ssh.cmd</code> configuration settings can be used.
- "User" is the remote user that cluster manager should use to perform ssh commands.
- "Opts" contains additional options that are passed to SSH (for example, "-i
- /tmp/my-key"). Finally, if you have some custom environment setup, "cmd" is the
- override format for the entire tunnel (ssh) command. The default string is
- {<code>/usr/bin/ssh %1$s %2$s%3$s%4$s "%5$s"</code>} and is a good starting
- point. This is a standard Java format string with 5 arguments that is used to
- execute the remote command. The argument 1 (%1$s) is SSH options set the via opts
- setting or via environment variable, 2 is SSH user name, 3 is "@" if username is set
- or "" otherwise, 4 is the target host name, and 5 is the logical command to execute
- (that may include single quotes, so don't use them). For example, if you run the
- tests under non-hbase user and want to ssh as that user and change to hbase on
- remote machine, you can use {<code>/usr/bin/ssh %1$s %2$s%3$s%4$s "su hbase - -c
- \"%5$s\""</code>}. That way, to kill RS (for example) integration tests may run
- {<code>/usr/bin/ssh some-hostname "su hbase - -c \"ps aux | ... | kill
- ...\""</code>}. The command is logged in the test logs, so you can verify it is
- correct for your environment. </para>
- <para>To disable the running of Integration Tests, pass the following profile on the
- command line <code>-PskipIntegrationTests</code>. For example,
- <programlisting>$ mvn clean install test -Dtest=TestZooKeeper -PskipIntegrationTests</programlisting></para>
-
- <section xml:id="maven.build.commands.integration.tests.mini">
- <title>Running integration tests against mini cluster</title>
- <para>HBase 0.92 added a <varname>verify</varname> maven target. Invoking it, for
- example by doing <code>mvn verify</code>, will run all the phases up to and
- including the verify phase via the maven <link
- xlink:href="http://maven.apache.org/plugins/maven-failsafe-plugin/">failsafe
- plugin</link>, running all the above mentioned HBase unit tests as well as
- tests that are in the HBase integration test group. After you have completed
- <command>mvn install -DskipTests</command> You can run just the integration
- tests by invoking:</para>
- <programlisting language="bourne">
-cd hbase-it
-mvn verify</programlisting>
- <para>If you just want to run the integration tests in top-level, you need to run
- two commands. First: <command>mvn failsafe:integration-test</command> This
- actually runs ALL the integration tests. </para>
- <note>
- <para>This command will always output <code>BUILD SUCCESS</code> even if there
- are test failures. </para>
- </note>
- <para>At this point, you could grep the output by hand looking for failed tests.
- However, maven will do this for us; just use: <command>mvn
- failsafe:verify</command> The above command basically looks at all the test
- results (so don't remove the 'target' directory) for test failures and reports
- the results.</para>
-
- <section xml:id="maven.build.commands.integration.tests2">
- <title>Running a subset of Integration tests</title>
- <para>This is very similar to how you specify running a subset of unit tests
- (see above), but use the property <code>it.test</code> instead of
- <code>test</code>. To just run
- <classname>IntegrationTestClassXYZ.java</classname>, use: <command>mvn
- failsafe:integration-test -Dit.test=IntegrationTestClassXYZ</command>
- The next thing you might want to do is run groups of integration tests, say
- all integration tests that are named IntegrationTestClassX*.java:
- <command>mvn failsafe:integration-test -Dit.test=*ClassX*</command> This
- runs everything that is an integration test that matches *ClassX*. This
- means anything matching: "**/IntegrationTest*ClassX*". You can also run
- multiple groups of integration tests using comma-delimited lists (similar to
- unit tests). Using a list of matches still supports full regex matching for
- each of the groups.This would look something like: <command>mvn
- failsafe:integration-test -Dit.test=*ClassX*, *ClassY</command>
- </para>
- </section>
- </section>
- <section xml:id="maven.build.commands.integration.tests.distributed">
- <title>Running integration tests against distributed cluster</title>
- <para> If you have an already-setup HBase cluster, you can launch the integration
- tests by invoking the class <code>IntegrationTestsDriver</code>. You may have to
- run test-compile first. The configuration will be picked by the bin/hbase
- script. <programlisting language="bourne">mvn test-compile</programlisting> Then
- launch the tests with:</para>
- <programlisting language="bourne">bin/hbase [--config config_dir] org.apache.hadoop.hbase.IntegrationTestsDriver</programlisting>
- <para>Pass <code>-h</code> to get usage on this sweet tool. Running the
- IntegrationTestsDriver without any argument will launch tests found under
- <code>hbase-it/src/test</code>, having
- <code>@Category(IntegrationTests.class)</code> annotation, and a name
- starting with <code>IntegrationTests</code>. See the usage, by passing -h, to
- see how to filter test classes. You can pass a regex which is checked against
- the full class name; so, part of class name can be used. IntegrationTestsDriver
- uses Junit to run the tests. Currently there is no support for running
- integration tests against a distributed cluster using maven (see <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-6201"
- >HBASE-6201</link>). </para>
-
- <para> The tests interact with the distributed cluster by using the methods in the
- <code>DistributedHBaseCluster</code> (implementing
- <code>HBaseCluster</code>) class, which in turn uses a pluggable
- <code>ClusterManager</code>. Concrete implementations provide actual
- functionality for carrying out deployment-specific and environment-dependent
- tasks (SSH, etc). The default <code>ClusterManager</code> is
- <code>HBaseClusterManager</code>, which uses SSH to remotely execute
- start/stop/kill/signal commands, and assumes some posix commands (ps, etc). Also
-
<TRUNCATED>
[05/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/security.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/security.xml b/src/main/docbkx/security.xml
deleted file mode 100644
index d649f95..0000000
--- a/src/main/docbkx/security.xml
+++ /dev/null
@@ -1,1895 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="security"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Secure Apache HBase</title>
- <section
- xml:id="hbase.secure.configuration">
- <title>Secure Client Access to Apache HBase</title>
- <para>Newer releases of Apache HBase (>= 0.92) support optional SASL authentication of clients. See also Matteo Bertozzi's article on <link
- xlink:href="http://www.cloudera.com/blog/2012/09/understanding-user-authentication-and-authorization-in-apache-hbase/">Understanding
- User Authentication and Authorization in Apache HBase</link>.</para>
- <para>This describes how to set up Apache HBase and clients for connection to secure HBase
- resources.</para>
-
- <section xml:id="security.prerequisites">
- <title>Prerequisites</title>
- <variablelist>
- <varlistentry>
- <term>Hadoop Authentication Configuration</term>
- <listitem>
- <para>To run HBase RPC with strong authentication, you must set
- <code>hbase.security.authentication</code> to <literal>true</literal>. In this case,
- you must also set <code>hadoop.security.authentication</code> to
- <literal>true</literal>. Otherwise, you would be using strong authentication for
- HBase but not for the underlying HDFS, which would cancel out any benefit.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Kerberos KDC</term>
- <listitem>
- <para> You need to have a working Kerberos KDC. </para>
- <para> A HBase configured for secure client access is expected to be running on top of a
- secured HDFS cluster. HBase must be able to authenticate to HDFS services. HBase needs
- Kerberos credentials to interact with the Kerberos-enabled HDFS daemons.
- Authenticating a service should be done using a keytab file. The procedure for
- creating keytabs for HBase service is the same as for creating keytabs for Hadoop.
- Those steps are omitted here. Copy the resulting keytab files to wherever HBase Master
- and RegionServer processes are deployed and make them readable only to the user
- account under which the HBase daemons will run. </para>
- <para> A Kerberos principal has three parts, with the form
- <code>username/fully.qualified.domain.name@YOUR-REALM.COM</code>. We recommend using
- <code>hbase</code> as the username portion. </para>
- <para> The following is an example of the configuration properties for Kerberos
- operation that must be added to the <code>hbase-site.xml</code> file on every server
- machine in the cluster. Required for even the most basic interactions with a secure
- Hadoop configuration, independent of HBase security. </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.regionserver.kerberos.principal</name>
- <value>hbase/_HOST@YOUR-REALM.COM</value>
-</property>
-<property>
- <name>hbase.regionserver.keytab.file</name>
- <value>/etc/hbase/conf/keytab.krb5</value>
-</property>
-<property>
- <name>hbase.master.kerberos.principal</name>
- <value>hbase/_HOST@YOUR-REALM.COM</value>
-</property>
-<property>
- <name>hbase.master.keytab.file</name>
- <value>/etc/hbase/conf/keytab.krb5</value>
-</property>
- ]]></programlisting>
- <para> Each HBase client user should also be given a Kerberos principal. This principal
- should have a password assigned to it (as opposed to a keytab file). The client
- principal's <code>maxrenewlife</code> should be set so that it can be renewed enough
- times for the HBase client process to complete. For example, if a user runs a
- long-running HBase client process that takes at most 3 days, we might create this
- user's principal within <code>kadmin</code> with: <code>addprinc -maxrenewlife
- 3days</code>
- </para>
- <para> Long running daemons with indefinite lifetimes that require client access to
- HBase can instead be configured to log in from a keytab. For each host running such
- daemons, create a keytab with <code>kadmin</code> or <code>kadmin.local</code>. The
- procedure for creating keytabs for HBase service is the same as for creating keytabs
- for Hadoop. Those steps are omitted here. Copy the resulting keytab files to where the
- client daemon will execute and make them readable only to the user account under which
- the daemon will run. </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
- <section>
- <title>Server-side Configuration for Secure Operation</title>
- <para>First, refer to <xref linkend="security.prerequisites" /> and ensure that your
- underlying HDFS configuration is secure.</para>
- <para> Add the following to the <code>hbase-site.xml</code> file on every server machine in
- the cluster: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.security.authentication</name>
- <value>kerberos</value>
-</property>
-<property>
- <name>hbase.security.authorization</name>
- <value>true</value>
-</property>
-<property>
-<name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.security.token.TokenProvider</value>
-</property>
- ]]></programlisting>
- <para> A full shutdown and restart of HBase service is required when deploying these
- configuration changes. </para>
- </section>
-
- <section>
- <title>Client-side Configuration for Secure Operation</title>
- <para>First, refer to <xref linkend="security.prerequisites" /> and ensure that your
- underlying HDFS configuration is secure.</para>
- <para> Add the following to the <code>hbase-site.xml</code> file on every client: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.security.authentication</name>
- <value>kerberos</value>
-</property>
- ]]></programlisting>
- <para> The client environment must be logged in to Kerberos from KDC or keytab via the
- <code>kinit</code> command before communication with the HBase cluster will be possible. </para>
- <para> Be advised that if the <code>hbase.security.authentication</code> in the client- and
- server-side site files do not match, the client will not be able to communicate with the
- cluster. </para>
- <para> Once HBase is configured for secure RPC it is possible to optionally configure
- encrypted communication. To do so, add the following to the <code>hbase-site.xml</code> file
- on every client: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rpc.protection</name>
- <value>privacy</value>
-</property>
- ]]></programlisting>
- <para> This configuration property can also be set on a per connection basis. Set it in the
- <code>Configuration</code> supplied to <code>HTable</code>: </para>
- <programlisting language="java">
-Configuration conf = HBaseConfiguration.create();
-conf.set("hbase.rpc.protection", "privacy");
-HTable table = new HTable(conf, tablename);
- </programlisting>
- <para> Expect a ~10% performance penalty for encrypted communication. </para>
- </section>
-
-
- <section xml:id="security.client.thrift">
- <title>Client-side Configuration for Secure Operation - Thrift Gateway</title>
- <para> Add the following to the <code>hbase-site.xml</code> file for every Thrift gateway: <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.thrift.keytab.file</name>
- <value>/etc/hbase/conf/hbase.keytab</value>
-</property>
-<property>
- <name>hbase.thrift.kerberos.principal</name>
- <value>$USER/_HOST@HADOOP.LOCALDOMAIN</value>
- <!-- TODO: This may need to be HTTP/_HOST@<REALM> and _HOST may not work.
- You may have to put the concrete full hostname.
- -->
-</property>
- ]]></programlisting>
- </para>
- <para> Substitute the appropriate credential and keytab for <replaceable>$USER</replaceable>
- and <replaceable>$KEYTAB</replaceable> respectively. </para>
- <para>In order to use the Thrift API principal to interact with HBase, it is also necessary to
- add the <code>hbase.thrift.kerberos.principal</code> to the <code>_acl_</code> table. For
- example, to give the Thrift API principal, <code>thrift_server</code>, administrative
- access, a command such as this one will suffice: </para>
- <programlisting language="sql"><![CDATA[
-grant 'thrift_server', 'RWCA'
- ]]></programlisting>
- <para>For more information about ACLs, please see the <link
- linkend="hbase.accesscontrol.configuration">Access Control</link> section </para>
-
- <para> The Thrift gateway will authenticate with HBase using the supplied credential. No
- authentication will be performed by the Thrift gateway itself. All client access via the
- Thrift gateway will use the Thrift gateway's credential and have its privilege. </para>
- </section>
- <section xml:id="security.gateway.thrift">
- <title>Configure the Thrift Gateway to Authenticate on Behalf of the Client</title>
- <para><xref linkend="security.client.thrift"/> describes how to authenticate a Thrift client
- to HBase using a fixed user. As an alternative, you can configure the Thrift gateway to
- authenticate to HBase on the client's behalf, and to access HBase using a proxy user. This
- was implemented in <link xlink:href="https://issues.apache.org/jira/browse/HBASE-11349"
- >HBASE-11349</link> for Thrift 1, and <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11474">HBASE-11474</link> for
- Thrift 2.</para>
- <note>
- <title>Limitations with Thrift Framed Transport</title>
- <para>If you use framed transport, you cannot yet take advantage of this feature, because
- SASL does not work with Thrift framed transport at this time.</para>
- </note>
- <para>To enable it, do the following.</para>
- <procedure>
- <step>
- <para>Be sure Thrift is running in secure mode, by following the procedure described in
- <xref linkend="security.client.thrift"/>.</para>
- </step>
- <step>
- <para>Be sure that HBase is configured to allow proxy users, as described in <xref
- linkend="security.rest.gateway"/>.</para>
- </step>
- <step>
- <para>In <filename>hbase-site.xml</filename> for each cluster node running a Thrift
- gateway, set the property <code>hbase.thrift.security.qop</code> to one of the following
- three values:</para>
- <itemizedlist>
- <listitem>
- <para><literal>auth-conf</literal> - authentication, integrity, and confidentiality
- checking</para>
- </listitem>
- <listitem>
- <para><literal>auth-int</literal> - authentication and integrity checking</para>
- </listitem>
- <listitem>
- <para><literal>auth</literal> - authentication checking only</para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <para>Restart the Thrift gateway processes for the changes to take effect. If a node is
- running Thrift, the output of the <command>jps</command> command will list a
- <code>ThriftServer</code> process. To stop Thrift on a node, run the command
- <command>bin/hbase-daemon.sh stop thrift</command>. To start Thrift on a node, run the
- command <command>bin/hbase-daemon.sh start thrift</command>.</para>
- </step>
- </procedure>
- </section>
-
- <section>
- <title>Client-side Configuration for Secure Operation - REST Gateway</title>
- <para> Add the following to the <code>hbase-site.xml</code> file for every REST gateway: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rest.keytab.file</name>
- <value>$KEYTAB</value>
-</property>
-<property>
- <name>hbase.rest.kerberos.principal</name>
- <value>$USER/_HOST@HADOOP.LOCALDOMAIN</value>
-</property>
- ]]></programlisting>
- <para> Substitute the appropriate credential and keytab for <replaceable>$USER</replaceable>
- and <replaceable>$KEYTAB</replaceable> respectively. </para>
- <para> The REST gateway will authenticate with HBase using the supplied credential. No
- authentication will be performed by the REST gateway itself. All client access via the REST
- gateway will use the REST gateway's credential and have its privilege. </para>
- <para>In order to use the REST API principal to interact with HBase, it is also necessary to
- add the <code>hbase.rest.kerberos.principal</code> to the <code>_acl_</code> table. For
- example, to give the REST API principal, <code>rest_server</code>, administrative access, a
- command such as this one will suffice: </para>
- <programlisting language="sql"><![CDATA[
-grant 'rest_server', 'RWCA'
- ]]></programlisting>
- <para>For more information about ACLs, please see the <link
- linkend="hbase.accesscontrol.configuration">Access Control</link> section </para>
- <para> It should be possible for clients to authenticate with the HBase cluster through the
- REST gateway in a pass-through manner via SPEGNO HTTP authentication. This is future work.
- </para>
- </section>
-
- <section xml:id="security.rest.gateway">
- <title>REST Gateway Impersonation Configuration</title>
- <para> By default, the REST gateway doesn't support impersonation. It accesses the HBase on
- behalf of clients as the user configured as in the previous section. To the HBase server,
- all requests are from the REST gateway user. The actual users are unknown. You can turn on
- the impersonation support. With impersonation, the REST gateway user is a proxy user. The
- HBase server knows the acutal/real user of each request. So it can apply proper
- authorizations. </para>
- <para> To turn on REST gateway impersonation, we need to configure HBase servers (masters and
- region servers) to allow proxy users; configure REST gateway to enable impersonation. </para>
- <para> To allow proxy users, add the following to the <code>hbase-site.xml</code> file for
- every HBase server: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hadoop.security.authorization</name>
- <value>true</value>
-</property>
-<property>
- <name>hadoop.proxyuser.$USER.groups</name>
- <value>$GROUPS</value>
-</property>
-<property>
- <name>hadoop.proxyuser.$USER.hosts</name>
- <value>$GROUPS</value>
-</property>
- ]]></programlisting>
- <para> Substitute the REST gateway proxy user for $USER, and the allowed group list for
- $GROUPS. </para>
- <para> To enable REST gateway impersonation, add the following to the
- <code>hbase-site.xml</code> file for every REST gateway. </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rest.authentication.type</name>
- <value>kerberos</value>
-</property>
-<property>
- <name>hbase.rest.authentication.kerberos.principal</name>
- <value>HTTP/_HOST@HADOOP.LOCALDOMAIN</value>
-</property>
-<property>
- <name>hbase.rest.authentication.kerberos.keytab</name>
- <value>$KEYTAB</value>
-</property>
- ]]></programlisting>
- <para> Substitute the keytab for HTTP for $KEYTAB. </para>
- </section>
-
- </section>
- <!-- Secure Client Access to HBase -->
-
- <section
- xml:id="hbase.secure.simpleconfiguration">
- <title>Simple User Access to Apache HBase</title>
- <para>Newer releases of Apache HBase (>= 0.92) support optional SASL authentication of clients. See also Matteo Bertozzi's article on <link
- xlink:href="http://www.cloudera.com/blog/2012/09/understanding-user-authentication-and-authorization-in-apache-hbase/">Understanding
- User Authentication and Authorization in Apache HBase</link>.</para>
- <para>This describes how to set up Apache HBase and clients for simple user access to HBase
- resources.</para>
-
- <section>
- <title>Simple Versus Secure Access</title>
- <para> The following section shows how to set up simple user access. Simple user access is not
- a secure method of operating HBase. This method is used to prevent users from making
- mistakes. It can be used to mimic the Access Control using on a development system without
- having to set up Kerberos. </para>
- <para> This method is not used to prevent malicious or hacking attempts. To make HBase secure
- against these types of attacks, you must configure HBase for secure operation. Refer to the
- section <link
- linkend="hbase.accesscontrol.configuration">Secure Client Access to HBase</link> and
- complete all of the steps described there. </para>
-
- <section>
- <title>Prerequisites</title>
- <para> None </para>
-
- <section>
- <title>Server-side Configuration for Simple User Access Operation</title>
- <para> Add the following to the <code>hbase-site.xml</code> file on every server machine
- in the cluster: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.security.authentication</name>
- <value>simple</value>
-</property>
-<property>
- <name>hbase.security.authorization</name>
- <value>true</value>
-</property>
-<property>
- <name>hbase.coprocessor.master.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
-<property>
- <name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
-<property>
- <name>hbase.coprocessor.regionserver.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
- ]]></programlisting>
- <para> For 0.94, add the following to the <code>hbase-site.xml</code> file on every server
- machine in the cluster: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rpc.engine</name>
- <value>org.apache.hadoop.hbase.ipc.SecureRpcEngine</value>
-</property>
-<property>
- <name>hbase.coprocessor.master.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
-<property>
- <name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
- ]]></programlisting>
- <para> A full shutdown and restart of HBase service is required when deploying these
- configuration changes. </para>
- </section>
-
- <section>
- <title>Client-side Configuration for Simple User Access Operation</title>
- <para> Add the following to the <code>hbase-site.xml</code> file on every client: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.security.authentication</name>
- <value>simple</value>
-</property>
- ]]></programlisting>
- <para> For 0.94, add the following to the <code>hbase-site.xml</code> file on every server
- machine in the cluster: </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.rpc.engine</name>
- <value>org.apache.hadoop.hbase.ipc.SecureRpcEngine</value>
-</property>
- ]]></programlisting>
- <para> Be advised that if the <code>hbase.security.authentication</code> in the client-
- and server-side site files do not match, the client will not be able to communicate with
- the cluster. </para>
- </section>
-
- <section>
- <title>Client-side Configuration for Simple User Access Operation - Thrift Gateway</title>
- <para>The Thrift gateway user will need access. For example, to give the Thrift API user,
- <code>thrift_server</code>, administrative access, a command such as this one will
- suffice: </para>
- <programlisting language="sql"><![CDATA[
-grant 'thrift_server', 'RWCA'
- ]]></programlisting>
- <para>For more information about ACLs, please see the <link
- linkend="hbase.accesscontrol.configuration">Access Control</link> section </para>
-
- <para> The Thrift gateway will authenticate with HBase using the supplied credential. No
- authentication will be performed by the Thrift gateway itself. All client access via the
- Thrift gateway will use the Thrift gateway's credential and have its privilege. </para>
- </section>
-
- <section>
- <title>Client-side Configuration for Simple User Access Operation - REST Gateway</title>
-
- <para> The REST gateway will authenticate with HBase using the supplied credential. No
- authentication will be performed by the REST gateway itself. All client access via the
- REST gateway will use the REST gateway's credential and have its privilege. </para>
- <para>The REST gateway user will need access. For example, to give the REST API user,
- <code>rest_server</code>, administrative access, a command such as this one will
- suffice: </para>
- <programlisting language="sql"><![CDATA[
-grant 'rest_server', 'RWCA'
- ]]></programlisting>
- <para>For more information about ACLs, please see the <link
- linkend="hbase.accesscontrol.configuration">Access Control</link> section </para>
- <para> It should be possible for clients to authenticate with the HBase cluster through
- the REST gateway in a pass-through manner via SPEGNO HTTP authentication. This is future
- work. </para>
- </section>
- </section>
- </section>
-
- </section>
- <!-- Simple User Access to Apache HBase -->
-
- <section>
- <title>Securing Access To Your Data</title>
- <para>After you have configured secure authentication between HBase client and server processes
- and gateways, you need to consider the security of your data itself. HBase provides several
- strategies for securing your data:</para>
- <itemizedlist>
- <listitem>
- <para>Role-based Access Control (RBAC) controls which users or groups can read and write to
- a given HBase resource or execute a coprocessor endpoint, using the familiar paradigm of
- roles.</para>
- </listitem>
- <listitem>
- <para>Visibility Labels which allow you to label cells and control access to labelled cells,
- to further restrict who can read or write to certain subsets of your data. Visibility
- labels are stored as tags. See <xref linkend="hbase.tags"/> for more information.</para>
- </listitem>
- <listitem>
- <para>Transparent encryption of data at rest on the underlying filesystem, both in HFiles
- and in the WAL. This protects your data at rest from an attacker who has access to the
- underlying filesystem, without the need to change the implementation of the client. It can
- also protect against data leakage from improperly disposed disks, which can be important
- for legal and regulatory compliance.</para>
- </listitem>
- </itemizedlist>
- <para>Server-side configuration, administration, and implementation details of each of these
- features are discussed below, along with any performance trade-offs. An example security
- configuration is given at the end, to show these features all used together, as they might be
- in a real-world scenario.</para>
- <caution>
- <para>All aspects of security in HBase are in active development and evolving rapidly. Any
- strategy you employ for security of your data should be thoroughly tested. In addition, some
- of these features are still in the experimental stage of development. To take advantage of
- many of these features, you must be running HBase 0.98+ and using the HFile v3 file
- format.</para>
- </caution>
-
- <warning>
- <title>Protecting Sensitive Files</title>
- <para>Several procedures in this section require you to copy files between cluster nodes. When
- copying keys, configuration files, or other files containing sensitive strings, use a secure
- method, such as <code>ssh</code>, to avoid leaking sensitive data.</para>
- </warning>
-
- <procedure xml:id="security.data.basic.server.side">
- <title>Basic Server-Side Configuration</title>
- <step>
- <para>Enable HFile v3, by setting <option>hfile.format.version </option>to 3 in
- <filename>hbase-site.xml</filename>. This is the default for HBase 1.0 and
- newer.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hfile.format.version</name>
- <value>3</value>
-</property>
- ]]></programlisting>
- </step>
- <step>
- <para>Enable SASL and Kerberos authentication for RPC and ZooKeeper, as described in <xref
- linkend="security.prerequisites"/> and <xref linkend="zk.sasl.auth"/>.</para>
- </step>
- </procedure>
-
- <section xml:id="hbase.tags">
- <title>Tags</title>
- <para><firstterm>Tags</firstterm> are a feature of HFile v3. A tag is a piece of metadata
- which is part of a cell, separate from the key, value, and version. Tags are an
- implementation detail which provides a foundation for other security-related features such
- as cell-level ACLs and visibility labels. Tags are stored in the HFiles themselves. It is
- possible that in the future, tags will be used to implement other HBase features. You don't
- need to know a lot about tags in order to use the security features they enable.</para>
- <section>
- <title>Implementation Details</title>
- <para> Every cell can have zero or more tags. Every tag has a type and the actual tag byte
- array.</para>
- <para> Just as row keys, column families, qualifiers and values can be encoded (see <xref
- linkend="data.block.encoding.types"/>), tags can also be encoded as well. You can enable
- or disable tag encoding at the level of the column family, and it is enabled by default.
- Use the <code>HColumnDescriptor#setCompressionTags(boolean compressTags)</code> method to
- manage encoding settings on a column family. You also need to enable the DataBlockEncoder
- for the column family, for encoding of tags to take effect.</para>
- <para>You can enable compression of each tag in the WAL, if WAL compression is also enabled,
- by setting the value of <option>hbase.regionserver.wal.tags.enablecompression</option> to
- <literal>true</literal> in <filename>hbase-site.xml</filename>. Tag compression uses
- dictionary encoding.</para>
- <para>Tag compression is not supported when using WAL encryption.</para>
- </section>
- </section>
-
- <section xml:id="hbase.accesscontrol.configuration">
- <title>Access Control Labels (ACLs)</title>
- <section>
- <title>How It Works</title>
- <para>ACLs in HBase are based upon a user's membership in or exclusion from groups, and a
- given group's permissions to access a given resource. ACLs are implemented as a
- coprocessor called AccessController.</para>
- <para>HBase does not maintain a private group mapping, but relies on a <firstterm>Hadoop
- group mapper</firstterm>, which maps between entities in a directory such as LDAP or
- Active Directory, and HBase users. Any supported Hadoop group mapper will work. Users are
- then granted specific permissions (Read, Write, Execute, Create, Admin) against resources
- (global, namespaces, tables, cells, or endpoints).</para>
- <note>
- <para> With Kerberos and Access Control enabled, client access to HBase is authenticated
- and user data is private unless access has been explicitly granted.</para>
- </note>
- <para>HBase has a simpler security model than relational databases, especially in terms of
- client operations. No distinction is made between an insert (new record) and update (of
- existing record), for example, as both collapse down into a Put.</para>
- <section>
- <title>Understanding Access Levels</title>
- <para>HBase access levels are granted independently of each other and allow for different
- types of operations at a given scope.</para>
- <itemizedlist>
- <listitem>
- <para>Read (R) - can read data at the given scope</para>
- </listitem>
- <listitem>
- <para><command>Write (W)</command> - can write data at the given scope</para>
- </listitem>
- <listitem>
- <para><command>Execute (X)</command> - can execute coprocessor endpoints at the given
- scope</para>
- </listitem>
- <listitem>
- <para><command>Create (C)</command> - can create tables or drop tables (even those
- they did not create) at the given scope</para>
- </listitem>
- <listitem>
- <para><command>Admin (A)</command> - can perform cluster operations such as balancing
- the cluster or assigning regions at the given scope</para>
- </listitem>
- </itemizedlist>
- <para>The possible scopes are:</para>
- <itemizedlist>
- <listitem>
- <para><command>Superuser</command> - superusers can perform any operation available in
- HBase, to any resource. The user who runs HBase on your cluster is a superuser, as
- are any principals assigned to the configuration property
- <code>hbase.superuser</code> in <filename>hbase-site.xml</filename> on the
- HMaster.</para>
- </listitem>
- <listitem>
- <para><command>Global</command> - permissions granted at <filename>global</filename>
- scope allow the admin to operate on all tables of the cluster.</para>
- </listitem>
- <listitem>
- <para><command>Namespace</command> - permissions granted at
- <filename>namespace</filename> scope apply to all tables within a given
- namespace.</para>
- </listitem>
- <listitem>
- <para><command>Table</command> - permissions granted at <filename>table</filename>
- scope apply to data or metadata within a given table.</para>
- </listitem>
- <listitem>
- <para><command>ColumnFamily</command> - permissions granted at
- <filename>ColumnFamily</filename> scope apply to cells within that
- ColumnFamily.</para>
- </listitem>
- <listitem>
- <para><command>Cell</command> - permissions granted at <filename>cell</filename> scope
- apply to that exact cell coordinate (key, value, timestamp). This allows for policy
- evolution along with data.</para>
- <para>To change an ACL on a specific cell, write an updated cell with new ACL to the
- precise coordinates of the original.</para>
- <para>If you have a multi-versioned schema and want to update ACLs on all visible
- versions, you need to write new cells for all visible versions. The application
- has complete control over policy evolution.</para>
- <para>The exception to the above rule is <code>append</code> and
- <code>increment</code> processing. Appends and increments can carry an ACL in the
- operation. If one is included in the operation, then it will be applied to the
- result of the <code>append</code> or <code>increment</code>. Otherwise, the ACL of
- the existing cell you are appending to or incrementing is preserved.</para>
- </listitem>
- </itemizedlist>
- <para>The combination of access levels and scopes creates a matrix of possible access
- levels that can be granted to a user. In a production environment, it is useful to think
- of access levels in terms of what is needed to do a specific job. The following list
- describes appropriate access levels for some common types of HBase users. It is
- important not to grant more access than is required for a given user to perform their
- required tasks.</para>
- <itemizedlist>
- <listitem>
- <para>Superusers - In a production system, only the HBase user should have superuser
- access. In a development environment, an administrator may need superuser access in
- order to quickly control and manage the cluster. However, this type of administrator
- should usually be a Global Admin rather than a superuser.</para>
- </listitem>
- <listitem>
- <para>Global Admins - A global admin can perform tasks and access every table in
- HBase. In a typical production environment, an admin should not have Read or Write
- permissions to data within tables.</para>
- <itemizedlist>
- <listitem>
- <para>A global admin with Admin permissions can perform cluster-wide operations on
- the cluster, such as balancing, assigning or unassigning regions, or calling an
- explicit major compaction. This is an operations role.</para>
- </listitem>
- <listitem>
- <para>A global admin with Create permissions can create or drop any table within
- HBase. This is more of a DBA-type role.</para>
- </listitem>
- </itemizedlist>
- <para>In a production environment, it is likely that different users will have only
- one of Admin and Create permissions.</para>
- <warning>
- <para>In the current implementation, a Global Admin with <code>Admin</code>
- permission can grant himself <code>Read</code> and <code>Write</code> permissions
- on a table and gain access to that table's data. For this reason, only grant
- <code>Global Admin</code> permissions to trusted user who actually need
- them.</para>
- <para>Also be aware that a <code>Global Admin</code> with <code>Create</code>
- permission can perform a <code>Put</code> operation on the ACL table, simulating a
- <code>grant</code> or <code>revoke</code> and circumventing the authorization
- check for <code>Global Admin</code> permissions.</para>
- <para>Due to these issues, be cautious with granting <code>Global Admin</code>
- privileges.</para>
- </warning>
- </listitem>
- <listitem>
- <para><command>Namespace Admins</command> - a namespace admin with <code>Create</code>
- permissions can create or drop tables within that namespace, and take and restore
- snapshots. A namespace admin with <code>Admin</code> permissions can perform
- operations such as splits or major compactions on tables within that
- namespace.</para>
- </listitem>
- <listitem>
- <para><command>Table Admins</command> - A table admin can perform administrative
- operations only on that table. A table admin with <code>Create</code> permissions
- can create snapshots from that table or restore that table from a snapshot. A table
- admin with <code>Admin</code> permissions can perform operations such as splits or
- major compactions on that table.</para>
- </listitem>
- <listitem>
- <para><command>Users</command> - Users can read or write data, or both. Users can also
- execute coprocessor endpoints, if given <code>Executable</code> permissions.</para>
- </listitem>
- </itemizedlist>
- <table>
- <title>Real-World Example of Access Levels</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Job Title</entry>
- <entry>Scope</entry>
- <entry>Permissions</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Senior Administrator</para></entry>
- <entry><para>Global</para></entry>
- <entry><para>Access, Create</para></entry>
- <entry><para>Manages the cluster and gives access to Junior
- Administrators.</para></entry>
- </row>
- <row>
- <entry><para>Junior Administrator</para></entry>
- <entry><para>Global</para></entry>
- <entry><para>Create</para></entry>
- <entry><para>Creates tables and gives access to Table
- Administrators.</para></entry>
- </row>
- <row>
- <entry><para>Table Administrator</para></entry>
- <entry><para>Table</para></entry>
- <entry><para>Access</para></entry>
- <entry><para>Maintains a table from an operations point of view.</para></entry>
- </row>
- <row>
- <entry><para>Data Analyst</para></entry>
- <entry><para>Table</para></entry>
- <entry><para>Read</para></entry>
- <entry><para>Creates reports from HBase data.</para></entry>
- </row>
- <row>
- <entry><para>Web Application</para></entry>
- <entry><para>Table</para></entry>
- <entry><para>Read, Write</para></entry>
- <entry><para>Puts data into HBase and uses HBase data to perform
- operations.</para></entry>
- </row>
- </tbody>
- </tgroup>
- <caption><para>This table shows how real-world titles might map to HBase permissions in
- a hypothetical company.</para></caption>
-
- </table>
- <formalpara>
- <title>ACL Matrix</title>
- <para>For more details on how ACLs map to specific HBase operations and tasks, see <xref
- linkend="appendix_acl_matrix"/>.</para>
- </formalpara>
- </section>
- <section>
- <title>Implementation Details</title>
- <para>Cell-level ACLs are implemented using tags (see <xref linkend="hbase.tags"/>). In
- order to use cell-level ACLs, you must be using HFile v3 and HBase 0.98 or newer.</para>
- <orderedlist>
- <title>ACL Implementation Caveats</title>
- <listitem>
- <para>Files created by HBase are owned by the operating system user running the HBase
- process. To interact with HBase files, you should use the API or bulk load
- facility.</para>
- </listitem>
- <listitem>
- <para>HBase does not model "roles" internally in HBase. Instead, group names can be
- granted permissions. This allows external modeling of roles via group membership.
- Groups are created and manipulated externally to HBase, via the Hadoop group mapping
- service.</para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>Server-Side Configuration</title>
- <procedure>
- <step>
- <para>As a prerequisite, perform the steps in <xref
- linkend="security.data.basic.server.side"/>.</para>
- </step>
- <step>
- <para>Install and configure the AccessController coprocessor, by setting the following
- properties in <filename>hbase-site.xml</filename>. These properties take a list of
- classes. </para>
- <note>
- <para>If you use the AccessController along with the VisibilityController, the
- AccessController must come first in the list, because with both components active,
- the VisibilityController will delegate access control on its system tables to the
- AccessController. For an example of using both together, see <xref
- linkend="security.example.config"/>.</para>
- </note>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController, org.apache.hadoop.hbase.security.token.TokenProvider</value>
-</property>
-<property>
- <name>hbase.coprocessor.master.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
-<property>
- <name>hbase.coprocessor.regionserver.classes</name>
- <value>org.apache.hadoop.hbase.security.access.AccessController</value>
-</property>
-<property>
- <name>hbase.security.exec.permission.checks</name>
- <value>true</value>
-</property>
- ]]></programlisting>
- <para>Optionally, you can enable transport security, by setting
- <option>hbase.rpc.protection</option> to <literal>auth-conf</literal>. This
- requires HBase 0.98.4 or newer.</para>
- </step>
- <step>
- <para>Set up the Hadoop group mapper in the Hadoop namenode's
- <filename>core-site.xml</filename>. This is a Hadoop file, not an HBase file.
- Customize it to your site's needs. Following is an example.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hadoop.security.group.mapping</name>
- <value>org.apache.hadoop.security.LdapGroupsMapping</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.url</name>
- <value>ldap://server</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.bind.user</name>
- <value>Administrator@example-ad.local</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.bind.password</name>
- <value>****</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.base</name>
- <value>dc=example-ad,dc=local</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.search.filter.user</name>
- <value>(&(objectClass=user)(sAMAccountName={0}))</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.search.filter.group</name>
- <value>(objectClass=group)</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.search.attr.member</name>
- <value>member</value>
-</property>
-
-<property>
- <name>hadoop.security.group.mapping.ldap.search.attr.group.name</name>
- <value>cn</value>
-</property>]]>
- </programlisting>
- </step>
- <step>
- <para>Optionally, enable the early-out evaluation strategy. Prior to HBase 0.98.0, if
- a user was not granted access to a column family, or at least a column qualifier, an
- AccessDeniedException would be thrown. HBase 0.98.0 removed this exception in order
- to allow cell-level exceptional grants. To restore the old behavior in HBase
- 0.98.0-0.98.6, set <option>hbase.security.access.early_out</option> to
- <literal>true</literal> in <filename>hbase-site.xml</filename>. In HBase 0.98.6,
- the default has been returned to <literal>true</literal>.</para>
- </step>
- <step>
- <para>Distribute your configuration and restart your cluster for changes to take
- effect.</para>
- </step>
- <step>
- <para>To test your configuration, log into HBase Shell as a given user and use the
- <command>whoami</command> command to report the groups your user is part of. In
- this example, the user is reported as being a member of the <code>services</code>
- group.</para>
- <screen>
-hbase> <userinput>whoami</userinput>
-<computeroutput>service (auth:KERBEROS)
- groups: services</computeroutput>
- </screen>
- </step>
- </procedure>
- </section>
- <section>
- <title>Administration</title>
- <para>Administration tasks can be performed from HBase Shell or via an API.</para>
- <caution>
- <title>API Examples</title>
- <para>Many of the API examples below are taken from source files
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/access/TestAccessController.java</filename>
- and
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/access/SecureTestUtil.java</filename>.</para>
- <para>Neither the examples, nor the source files they are taken from, are part of the
- public HBase API, and are provided for illustration only. Refer to the official API
- for usage instructions.</para>
- </caution>
- <procedure>
- <step>
- <title>User and Group Administration</title>
- <para>Users and groups are maintained external to HBase, in your directory.</para>
- </step>
- <step>
- <title>Granting Access To A Namespace, Table, Column Family, or Cell</title>
- <para>There are a few different types of syntax for grant statements. The first, and
- most familiar, is as follows, with the table and column family being
- optional:</para>
- <screen>grant 'user', 'RWXCA', 'TABLE', 'CF', 'CQ'</screen>
- <para>Groups and users are granted access in the same way, but groups are prefixed
- with an <literal>@</literal> symbol. In the same way, tables and namespaces are
- specified in the same way, but namespaces are prefixed with an <literal>@</literal>
- symbol.</para>
- <para>It is also possible to grant multiple permissions against the same resource in a
- single statement, as in this example. The first sub-clause maps users to ACLs and
- the second sub-clause specifies the resource.</para>
- <note>
- <para>HBase Shell support for granting and revoking access at the cell level is for
- testing and verification support, and should not be employed for production use
- because it won't apply the permissions to cells that don't exist yet. The correct
- way to apply cell level permissions is to do so in the application code when
- storing the values.</para>
- </note>
- <formalpara>
- <title>ACL Granularity and Evaluation Order</title>
- <para>ACLs are evaluated from least granular to most granular, and when an ACL is
- reached that grants permission, evaluation stops. This means that cell ACLs do not
- override ACLs at less granularity.</para>
- </formalpara>
- <example>
- <title>HBase Shell</title>
- <itemizedlist>
- <listitem>
- <para>Global:</para>
- <screen>hbase> <userinput>grant '@admins', 'RWXCA'</userinput></screen>
- </listitem>
- <listitem>
- <para>Namespace:</para>
- <screen>hbase> <userinput>grant 'service', 'RWXCA', '@test-NS'</userinput></screen>
- </listitem>
- <listitem>
- <para>Table:</para>
- <screen>hbase> <userinput>grant 'service', 'RWXCA', 'user'</userinput></screen>
- </listitem>
- <listitem>
- <para>Column Family:</para>
- <screen>hbase> <userinput>grant '@developers', 'RW', 'user', 'i'</userinput></screen>
- </listitem>
- <listitem>
- <para>Column Qualifier:</para>
- <screen>hbase> <userinput>grant 'service, 'RW', 'user', 'i', 'foo'</userinput></screen>
- </listitem>
- <listitem>
- <para>Cell:</para>
- <para>The syntax for granting cell ACLs uses the following syntax:</para>
- <screen>grant <replaceable><table></replaceable>, \
- { '<replaceable><user-or-group></replaceable>' => \
- '<replaceable><permissions></replaceable>', ... }, \
- { <replaceable><scanner-specification></replaceable> }</screen>
- <itemizedlist>
- <listitem>
- <para><replaceable><user-or-group></replaceable> is the user or group
- name, prefixed with <literal>@</literal> in the case of a group.</para>
- </listitem>
- <listitem>
- <para><replaceable><permissions></replaceable> is a string containing
- any or all of "RWXCA", though only R and W are meaningful at cell
- scope.</para>
- </listitem>
- <listitem>
- <para><replaceable><scanner-specification></replaceable> is the
- scanner specification syntax and conventions used by the 'scan' shell
- command. For some examples of scanner specifications, issue the following
- HBase Shell command.</para>
- <screen>hbase> help "scan"</screen>
- </listitem>
- </itemizedlist>
- <para>This example grants read access to the 'testuser' user and read/write
- access to the 'developers' group, on cells in the 'pii' column which match the
- filter.</para>
- <screen>hbase> grant 'user', \
- { '@developers' => 'RW', 'testuser' => 'R' }, \
- { COLUMNS => 'pii', FILTER => "(PrefixFilter ('test'))" }</screen>
- <para>The shell will run a scanner with the given criteria, rewrite the found
- cells with new ACLs, and store them back to their exact coordinates.</para>
- </listitem>
- </itemizedlist>
- </example>
- <example>
- <title>API</title>
- <para>The following example shows how to grant access at the table level.</para>
- <programlisting language="java"><![CDATA[
-public static void grantOnTable(final HBaseTestingUtility util, final String user,
- final TableName table, final byte[] family, final byte[] qualifier,
- final Permission.Action... actions) throws Exception {
- SecureTestUtil.updateACLs(util, new Callable<Void>() {
- @Override
- public Void call() throws Exception {
- HTable acl = new HTable(util.getConfiguration(), AccessControlLists.ACL_TABLE_NAME);
- try {
- BlockingRpcChannel service = acl.coprocessorService(HConstants.EMPTY_START_ROW);
- AccessControlService.BlockingInterface protocol =
- AccessControlService.newBlockingStub(service);
- ProtobufUtil.grant(protocol, user, table, family, qualifier, actions);
- } finally {
- acl.close();
- }
- return null;
- }
- });
-} ]]>
- </programlisting>
- <para>To grant permissions at the cell level, you can use the
- <code>Mutation.setACL</code> method:</para>
- <programlisting language="java"><![CDATA[
-Mutation.setACL(String user, Permission perms)
-Mutation.setACL(Map<String, Permission> perms)
- ]]>
- </programlisting>
- <para>Specifically, this example provides read permission to a user called
- <literal>user1</literal> on any cells contained in a particular Put
- operation:</para>
- <programlisting language="java"><![CDATA[
-put.setACL(“user1”, new Permission(Permission.Action.READ))
- ]]></programlisting>
- </example>
- </step>
- <step>
- <title>Revoking Access Control From a Namespace, Table, Column Family, or Cell</title>
- <para>The <command>revoke</command> command and API are twins of the grant command and
- API, and the syntax is exactly the same. The only exception is that you cannot
- revoke permissions at the cell level. You can only revoke access that has previously
- been granted, and a <command>revoke</command> statement is not the same thing as
- explicit denial to a resource.</para>
- <note>
- <para>HBase Shell support for granting and revoking access is for testing and
- verification support, and should not be employed for production use because it
- won't apply the permissions to cells that don't exist yet. The correct way to
- apply cell-level permissions is to do so in the application code when storing the
- values.</para>
- </note>
- <example>
- <title>Revoking Access To a Table</title>
- <programlisting language="java">
-<![CDATA[public static void revokeFromTable(final HBaseTestingUtility util, final String user,
- final TableName table, final byte[] family, final byte[] qualifier,
- final Permission.Action... actions) throws Exception {
- SecureTestUtil.updateACLs(util, new Callable<Void>() {
- @Override
- public Void call() throws Exception {
- HTable acl = new HTable(util.getConfiguration(), AccessControlLists.ACL_TABLE_NAME);
- try {
- BlockingRpcChannel service = acl.coprocessorService(HConstants.EMPTY_START_ROW);
- AccessControlService.BlockingInterface protocol =
- AccessControlService.newBlockingStub(service);
- ProtobufUtil.revoke(protocol, user, table, family, qualifier, actions);
- } finally {
- acl.close();
- }
- return null;
- }
- });
-} ]]>
- </programlisting>
- </example>
- </step>
- <step>
- <title>Showing a User's Effective Permissions</title>
- <example>
- <title>HBase Shell</title>
- <screen>hbase> user_permission 'user'</screen>
- <screen>hbase> user_permission '.*'</screen>
- <screen>hbase> user_permission <replaceable>JAVA_REGEX</replaceable></screen>
- </example>
- <example>
- <title>API</title>
- <programlisting language="java"><![CDATA[
-public static void verifyAllowed(User user, AccessTestAction action, int count) throws Exception {
- try {
- Object obj = user.runAs(action);
- if (obj != null && obj instanceof List<?>) {
- List<?> results = (List<?>) obj;
- if (results != null && results.isEmpty()) {
- fail("Empty non null results from action for user '" + user.getShortName() + "'");
- }
- assertEquals(count, results.size());
- }
- } catch (AccessDeniedException ade) {
- fail("Expected action to pass for user '" + user.getShortName() + "' but was denied");
- }
-}]]>
- </programlisting>
- </example>
- </step>
- </procedure>
- </section>
- </section>
- </section>
-
- <section>
- <title>Visibility Labels</title>
- <para>Visibility labels control can be used to only permit users or principals associated with
- a given label to read or access cells with that label. For instance, you might label a cell
- <literal>top-secret</literal>, and only grant access to that label to the
- <literal>managers</literal> group. Visibility labels are implemented using Tags, which are
- a feature of HFile v3, and allow you to store metadata on a per-cell basis. A label is a
- string, and labels can be combined into expressions by using logical operators (&, |, or
- !), and using parentheses for grouping. HBase does not do any kind of validation of
- expressions beyond basic well-formedness. Visibility labels have no meaning on their own,
- and may be used to denote sensitivity level, privilege level, or any other arbitrary
- semantic meaning.</para>
- <para>If a user's labels do not match a cell's label or expression, the user is
- denied access to the cell.</para>
- <para>In HBase 0.98.6 and newer, UTF-8 encoding is supported for visibility labels and
- expressions. When creating labels using the <code>addLabels(conf, labels)</code> method
- provided by the <code>org.apache.hadoop.hbase.security.visibility.VisibilityClient</code>
- class and passing labels in Authorizations via Scan or Get, labels can contain UTF-8
- characters, as well as the logical operators normally used in visibility labels, with normal
- Java notations, without needing any escaping method. However, when you pass a CellVisibility
- expression via a Mutation, you must enclose the expression with the
- <code>CellVisibility.quote()</code> method if you use UTF-8 characters or logical
- operators. See <code>TestExpressionParser</code> and the source file
- <filename>hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestScan.java</filename>.
- </para>
- <para>A user adds visibility expressions to a cell during a Put operation. In the default
- configuration, the user does not need to access to a label in order to label cells with it.
- This behavior is controlled by the configuration option
- <option>hbase.security.visibility.mutations.checkauths</option>. If you set this option to
- <literal>true</literal>, the labels the user is modifying as part of the mutation must be
- associated with the user, or the mutation will fail. Whether a user is authorized to read a
- labelled cell is determined during a Get or Scan, and results which the user is not allowed
- to read are filtered out. This incurs the same I/O penalty as if the results were returned,
- but reduces load on the network.</para>
- <para>Visibility labels can also be specified during Delete operations. For details about
- visibility labels and Deletes, see <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10885">HBASE-10885</link>. </para>
- <para>The user's effective label set is built in the RPC context when a request is first
- received by the RegionServer. The way that users are associated with labels is pluggable.
- The default plugin passes through labels specified in Authorizations added to the Get or
- Scan and checks those against the calling user's authenticated labels list. When the client
- passes labels for which the user is not authenticated, the default plugin drops them. You
- can pass a subset of user authenticated labels via the
- <code>Get#setAuthorizations(Authorizations(String,...))</code> and
- <code>Scan#setAuthorizations(Authorizations(String,...));</code> methods. </para>
- <para>Visibility label access checking is performed by the VisibilityController coprocessor.
- You can use interface <code>VisibilityLabelService</code> to provide a custom implementation
- and/or control the way that visibility labels are stored with cells. See the source file
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/visibility/TestVisibilityLabelsWithCustomVisLabService.java</filename>
- for one example.</para>
-
- <para>Visibility labels can be used in conjunction with ACLs.</para>
- <table>
- <title>Examples of Visibility Expressions</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Expression</entry>
- <entry>Interpretation</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><screen>fulltime</screen></entry>
- <entry><para>Allow accesss to users associated with the
- <code>fulltime</code> label.</para></entry>
- </row>
- <row>
- <entry><screen>!public</screen></entry>
- <entry><para>Allow access to users not associated with the
- <code>public</code> label.</para></entry>
- </row>
- <row>
- <entry><screen>( secret | topsecret ) & !probationary</screen></entry>
- <entry><para>Allow access to users associated with either the
- <code>secret</code> or <code>topsecret</code> label and not
- associated with the <code>probationary</code> label.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <section>
- <title>Server-Side Configuration</title>
- <procedure>
- <step>
- <para>As a prerequisite, perform the steps in <xref
- linkend="security.data.basic.server.side"/>.</para></step>
- <step>
- <para>Install and configure the VisibilityController coprocessor by setting the
- following properties in <filename>hbase-site.xml</filename>. These properties take a
- list of class names.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.coprocessor.region.classes</name>
- <value>org.apache.hadoop.hbase.security.visibility.VisibilityController</value>
-</property>
-<property>
- <name>hbase.coprocessor.master.classes</name>
- <value>org.apache.hadoop.hbase.security.visibility.VisibilityController</value>
-</property>
- ]]></programlisting>
- <note>
- <para>If you use the AccessController and VisibilityController coprocessors together,
- the AccessController must come first in the list, because with both components
- active, the VisibilityController will delegate access control on its system tables
- to the AccessController.</para>
- </note>
- </step>
- <step>
- <title>Adjust Configuration</title>
- <para>By default, users can label cells with any label, including labels they are not
- associated with, which means that a user can Put data that he cannot read. For
- example, a user could label a cell with the (hypothetical) 'topsecret' label even if
- the user is not associated with that label. If you only want users to be able to label
- cells with labels they are associated with, set
- <property>hbase.security.visibility.mutations.checkauths</property> to
- <literal>true</literal>. In that case, the mutation will fail if it makes use of
- labels the user is not associated with.</para>
- </step>
- <step>
- <para>Distribute your configuration and restart your cluster for changes to take
- effect.</para>
- </step>
- </procedure>
- </section>
- <section>
- <title>Administration</title>
- <para>Administration tasks can be performed using the HBase Shell or the Java API. For
- defining the list of visibility labels and associating labels with users, the
- HBase Shell is probably simpler.</para>
- <caution>
- <title>API Examples</title>
- <para>Many of the Java API examples in this section are taken from the source file
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/visibility/TestVisibilityLabels.java</filename>.
- Refer to that file or the API documentation for more context.</para>
- <para>Neither these examples, nor the source file they were taken from, are part of the
- public HBase API, and are provided for illustration only. Refer to the official API
- for usage instructions.</para>
- </caution>
- <procedure>
- <step>
- <title>Define the List of Visibility Labels</title>
- <example>
- <title>HBase Shell</title>
- <screen>hbase< <userinput>add_labels [ 'admin', 'service', 'developer', 'test' ]</userinput></screen>
- </example>
- <example>
- <title>Java API</title>
- <programlisting language="java"><![CDATA[
-public static void addLabels() throws Exception {
- PrivilegedExceptionAction<VisibilityLabelsResponse> action =
- new PrivilegedExceptionAction<VisibilityLabelsResponse>() {
- public VisibilityLabelsResponse run() throws Exception {
- String[] labels = { SECRET, TOPSECRET, CONFIDENTIAL, PUBLIC, PRIVATE, COPYRIGHT, ACCENT,
- UNICODE_VIS_TAG, UC1, UC2 };
- try {
- VisibilityClient.addLabels(conf, labels);
- } catch (Throwable t) {
- throw new IOException(t);
- }
- return null;
- }
- };
- SUPERUSER.runAs(action);
-}
- ]]></programlisting>
- </example>
- </step>
- <step>
- <title>Associate Labels with Users</title>
- <example>
- <title>HBase Shell</title>
- <screen>hbase< <userinput>set_auths 'service', [ 'service' ]</userinput></screen>
- <screen>hbase< <userinput>set_auths 'testuser', [ 'test' ]</userinput></screen>
- <screen>hbase< <userinput>set_auths 'qa', [ 'test', 'developer' ]</userinput></screen>
- </example>
- <example>
- <title>Java API</title>
- <programlisting language="java"><![CDATA[
-public void testSetAndGetUserAuths() throws Throwable {
- final String user = "user1";
- PrivilegedExceptionAction<Void> action = new PrivilegedExceptionAction<Void>() {
- public Void run() throws Exception {
- String[] auths = { SECRET, CONFIDENTIAL };
- try {
- VisibilityClient.setAuths(conf, auths, user);
- } catch (Throwable e) {
- }
- return null;
- }
- ...
- ]]></programlisting>
- </example>
- </step>
- <step>
- <title>Clear Labels From Users</title>
- <example>
- <title>HBase Shell</title>
- <screen>hbase< <userinput>clear_auths 'service', [ 'service' ]</userinput></screen>
- <screen>hbase< <userinput>clear_auths 'testuser', [ 'test' ]</userinput></screen>
- <screen>hbase< <userinput>clear_auths 'qa', [ 'test', 'developer' ]</userinput></screen>
- </example>
- <example>
- <title>Java API</title>
- <programlisting language="java"><![CDATA[
-...
-auths = new String[] { SECRET, PUBLIC, CONFIDENTIAL };
-VisibilityLabelsResponse response = null;
-try {
- response = VisibilityClient.clearAuths(conf, auths, user);
-} catch (Throwable e) {
- fail("Should not have failed");
-...
- ]]></programlisting>
- </example>
- </step>
- <step>
- <title>Apply a Label or Expression to a Cell</title>
- <para>The label is only applied when data is written. The label is associated with a
- given version of the cell.</para>
- <example>
- <title>HBase Shell</title>
- <screen>hbase< <userinput>set_visibility 'user', 'admin|service|developer', \
- { COLUMNS => 'i' }</userinput></screen>
- <screen>hbase< <userinput>set_visibility 'user', 'admin|service', \
- { COLUMNS => ' pii' }</userinput></screen>
- <screen>hbase< <userinput>COLUMNS => [ 'i', 'pii' ], \
- FILTER => "(PrefixFilter ('test'))" }</userinput></screen>
- </example>
- <note>
- <para>HBase Shell support for applying labels or permissions to cells is for testing
- and verification support, and should not be employed for production use because it
- won't apply the labels to cells that don't exist yet. The correct way to apply cell
- level labels is to do so in the application code when storing the values.</para>
- </note>
- <example>
- <title>Java API</title>
- <programlisting language="java"><![CDATA[
-static HTable createTableAndWriteDataWithLabels(TableName tableName, String... labelExps)
- throws Exception {
- HTable table = null;
- try {
- table = TEST_UTIL.createTable(tableName, fam);
- int i = 1;
- List<Put> puts = new ArrayList<Put>();
- for (String labelExp : labelExps) {
- Put put = new Put(Bytes.toBytes("row" + i));
- put.add(fam, qual, HConstants.LATEST_TIMESTAMP, value);
- put.setCellVisibility(new CellVisibility(labelExp));
- puts.add(put);
- i++;
- }
- table.put(puts);
- } finally {
- if (table != null) {
- table.flushCommits();
- }
- }
- ]]></programlisting>
- </example>
- </step>
- </procedure>
- </section>
- <section>
- <title>Implementing Your Own Visibility Label Algorithm</title>
- <para>Interpreting the labels authenticated for a given get/scan request is a pluggable
- algorithm. You can specify a custom plugin by using the property
- <code>hbase.regionserver.scan.visibility.label.generator.class</code>. The default
- implementation class is
- <code>org.apache.hadoop.hbase.security.visibility.DefaultScanLabelGenerator</code>. You
- can also configure a set of <code>ScanLabelGenerators</code> to be used by the system, as
- a comma-separated list.</para>
- </section>
- </section>
-
- <section xml:id="hbase.encryption.server">
- <title>Transparent Encryption of Data At Rest</title>
- <para>HBase provides a mechanism for protecting your data at rest, in HFiles and the WAL, which
- reside within HDFS or another distributed filesystem. A two-tier architecture is used for
- flexible and non-intrusive key rotation. "Transparent" means that no implementation changes
- are needed on the client side. When data is written, it is encrypted. When it is read, it is
- decrypted on demand.</para>
- <section>
- <title>How It Works</title>
- <para>The administrator provisions a master key for the cluster, which is stored in a key
- provider accessible to every trusted HBase process, including the HMaster, RegionServers,
- and clients (such as HBase Shell) on administrative workstations. The default key provider
- is integrated with the Java KeyStore API and any key management systems with support for
- it. Other custom key provider implementations are possible. The key retrieval mechanism is
- configured in the <filename>hbase-site.xml</filename> configuration file. The master key
- may be stored on the cluster servers, protected by a secure KeyStore file, or on an
- external keyserver, or in a hardware security module. This master key is resolved as
- needed by HBase processes through the configured key provider.</para>
- <para>Next, encryption use can be specified in the schema, per column family, by creating
- or modifying a column descriptor to include two additional attributes: the name of the
- encryption algorithm to use (currently only "AES" is supported), and optionally, a data
- key wrapped (encrypted) with the cluster master key. If a data key is not explictly
- configured for a ColumnFamily, HBase will create a random data key per HFile. This
- provides an incremental improvement in security over the alternative. Unless you need to
- supply an explicit data key, such as in a case where you are generating encrypted HFiles
- for bulk import with a given data key, only specify the encryption algorithm in the
- ColumnFamily schema metadata and let HBase create data keys on demand. Per Column Family
- keys facilitate low impact incremental key rotation and reduce the scope of any external
- leak of key material. The wrapped data key is stored in the ColumnFamily schema metadata,
- and in each HFile for the Column Family, encrypted with the cluster master key. After the
- Column Family is configured for encryption, any new HFiles will be written encrypted. To
- ensure encryption of all HFiles, trigger a major compaction after enabling this
- feature.</para>
- <para>When the HFile is opened, the data key is extracted from the HFile, decrypted with the
- cluster master key, and used for decryption of the remainder of the HFile. The HFile will
- be unreadable if the master key is not available. If a remote user somehow acquires access
- to the HFile data because of some lapse in HDFS permissions, or from inappropriately
- discarded media, it will not be possible to decrypt either the data key or the file
- data.</para>
- <para>It is also possible to encrypt the WAL. Even though WALs are transient, it is
- necessary to encrypt the WALEdits to avoid circumventing HFile protections for encrypted
- column families, in the event that the underlying filesystem is compromised. When WAL
- encryption is enabled, all WALs are encrypted, regardless of whether the relevant HFiles
- are encrypted.</para>
- </section>
- <section>
- <title>Server-Side Configuration</title>
- <para>This procedure assumes you are using the default Java keystore implementation. If you
- are using a custom implementation, check its documentation and adjust accordingly.</para>
- <procedure>
- <step>
- <title>Create a secret key of appropriate length for AES encryption, using the
- <code>keytool</code> utility.</title>
- <screen>$ <userinput>keytool -keystore /path/to/hbase/conf/hbase.jks \
- -storetype jceks -storepass **** \
- -genseckey -keyalg AES -keysize 128 \
- -alias <alias></userinput></screen>
- <para>Replace <replaceable>****</replaceable> with the password for the keystore file
- and <alias> with the username of the HBase service account, or an arbitrary
- string. If you use an arbitrary string, you will need to configure HBase to use it,
- and that is covered below. Specify a keysize that is appropriate. Do not specify a
- separate password for the key, but press <keycap>Return</keycap> when prompted.</para>
- </step>
- <step>
- <title>Set appropriate permissions on the keyfile and distribute it to all the HBase
- servers.</title>
- <para>The previous command created a file called <filename>hbase.jks</filename> in the
- HBase <filename>conf/</filename> directory. Set the permissions and ownership on this
- file such that only the HBase service account user can read the file, and securely
- distribute the key to all HBase servers.</para>
- </step>
- <step>
- <title>Configure the HBase daemons.</title>
- <para>Set the following properties in <filename>hbase-site.xml</filename> on the region
- servers, to configure HBase daemons to use a key provider backed by the KeyStore file
- or retrieving the cluster master key. In the example below, replace
- <replaceable>****</replaceable> with the password.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.crypto.keyprovider</name>
- <value>org.apache.hadoop.hbase.io.crypto.KeyStoreKeyProvider</value>
-</property>
-<property>
- <name>hbase.crypto.keyprovider.parameters</name>
- <value>jceks:///path/to/hbase/conf/hbase.jks?password=****</value>
-</property>
- ]]></programlisting>
- <para>By default, the HBase service account name will be used to resolve the cluster
- master key. However, you can store it with an arbitrary alias (in the
- <command>keytool</command> command). In that case, set the following property to the
- alias you used.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.crypto.master.key.name</name>
- <value>my-alias</value>
-</property>]]>
- </programlisting>
- <para>You also need to be sure your HFiles use HFile v3, in order to use transparent
- encryption. This is the default configuration for HBase 1.0 onward. For previous
- versions, set the following property in your <filename>hbase-site.xml</filename>
- file.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hfile.format.version</name>
- <value>3</value>
-</property>]]>
- </programlisting>
- <para>Optionally, you can use a different cipher provider, either a Java Cryptography
- Encryption (JCE) algorithm provider or a custom HBase cipher implementation. </para>
- <substeps>
- <step>
- <title>JCE: </title>
- <itemizedlist>
- <listitem>
- <para>Install a signed JCE provider (supporting “AES/CTR/NoPadding” mode with
- 128 bit keys) </para>
- </listitem>
- <listitem>
- <para>Add it with highest preference to the JCE site configuration file
- <filename>$JAVA_HOME/lib/security/java.security</filename>.</para>
- </listitem>
- <listitem>
- <para>Update <option>hbase.crypto.algorithm.aes.provider</option> and
- <option>hbase.crypto.algorithm.rng.provider</option> options in
- <filename>hbase-site.xml</filename>. </para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <title>Custom HBase Cipher: </title>
- <itemizedlist>
- <listitem>
- <para>Implement
- <code>org.apache.hadoop.hbase.io.crypto.CipherProvider</code>.</para>
- </listitem>
- <listitem>
- <para>Add the implementation to the server classpath.</para>
- </listitem>
- <listitem>
- <para>Update <option>hbase.crypto.cipherprovider</option> in
- <filename>hbase-site.xml</filename>.</para>
- </listitem>
- </itemizedlist>
- </step>
- </substeps>
- </step>
- <step>
- <title>Configure WAL encryption.</title>
- <para>Configure WAL encryption in every RegionServer's
- <filename>hbase-site.xml</filename>, by setting the following properties. You can
- include these in the HMaster's <filename>hbase-site.xml</filename> as well, but the
- HMaster does not have a WAL and will not use them.</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.regionserver.hlog.reader.impl</name>
- <value>org.apache.hadoop.hbase.regionserver.wal.SecureProtobufLogReader</value>
-</property>
-<property>
- <name>hbase.regionserver.hlog.writer.impl</name>
- <value>org.apache.hadoop.hbase.regionserver.wal.SecureProtobufLogWriter</value>
-</property>
-<property>
- <name>hbase.regionserver.wal.encryption</name>
- <value>true</value>
-</property>
- ]]></programlisting>
- </step>
- <step>
- <title>Configure permissions on the <filename>hbase-site.xml</filename> file.</title>
- <para>Because the keystore password is stored in the hbase-site.xml, you need to ensure
- that only the HBase user can read the <filename>hbase-site.xml</filename> file, using
- file ownership and permissions.</para>
- </step>
- <step>
- <title>Restart your cluster.</title>
- <para>Distribute the new configuration file to all nodes and restart your
- cluster.</para>
- </step>
- </procedure>
- </section>
- <section>
- <title>Administration</title>
- <para>Administrative tasks can be performed in HBase Shell or the Java API.</para>
- <caution>
- <title>Java API</title>
- <para>Java API examples in this section are taken from the source file
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/util/TestHBaseFsckEncryption.java</filename>.
- .</para>
- <para>Neither these examples, nor the source files they are taken from, are part of the
- public HBase API, and are provided for illustration only. Refer to the official API
- for usage instructions.</para>
- </caution>
- <variablelist>
- <varlistentry>
- <term>Enable Encryption on a Column Family</term>
- <listitem>
- <para>To enable encryption on a column family, you can either use HBase Shell or the
- Java API. After enabling encryption, trigger a major compaction. When the major
- compaction completes, the HFiles will be encrypted.</para>
- <example>
- <title>HBase Shell</title>
- <screen>
-hbase> disable 'mytable'
-hbase> alter 'mytable', 'mycf', {ENCRYPTION => AES}
-hbase> enable 'mytable'
- </screen>
- </example>
- <example>
- <title>Java API</title>
- <para>You can use the <code>HBaseAdmin#modifyColumn</code> API to modify the
- <property>ENCRYPTION</property> attribute on a Column Family. Additionally, you
- can specify the specific key to use as the wrapper, by setting the
- <property>ENCRYPTION_KEY</property> attribute. This is only possible via the
- Java API, and not the HBase Shell. The default behavior if you do not specify an
- <property>ENCRYPTION_KEY</property> for a column family is for a random key to
- be generated for each encrypted column family (per HFile). This provides
- additional defense in the (unlikely, but theoretically possible) occurrence of
- storing the same data in multiple HFiles with exactly the same block layout, the
- same data key, and the same randomly-generated initialization vector.</para>
- <para>This example shows how to programmatically set the transparent encryption both
- in the server configuration and at the column family, as part of a test which uses
- the Minicluster configuration.</para>
- <programlisting language="java">
-@Before
-public void setUp() throws Exception {
- conf = TEST_UTIL.getConfiguration();
- conf.setInt("hfile.format.version", 3);
- conf.set(HConstants.CRYPTO_KEYPROVIDER_CONF_KEY, KeyProviderForTesting.class.getName());
- conf.set(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, "hbase");
-
- // Create the test encryption key
- SecureRandom rng = new SecureRandom();
- byte[] keyBytes = new byte[AES.KEY_LENGTH];
- rng.nextBytes(keyBytes);
- cfKey = new SecretKeySpec(keyBytes, "AES");
-
- // Start the minicluster
- TEST_UTIL.startMiniCluster(3);
-
- // Create the table
- htd = new HTableDescriptor(TableName.valueOf("default", "TestHBaseFsckEncryption"));
- HColumnDescriptor hcd = new HColumnDescriptor("cf");
- hcd.setEncryptionType("AES");
- hcd.setEncryptionKey(EncryptionUtil.wrapKey(conf,
- conf.get(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, User.getCurrent().getShortName()),
- cfKey));
- htd.addFamily(hcd);
- TEST_UTIL.getHBaseAdmin().createTable(htd);
- TEST_UTIL.waitTableAvailable(htd.getName(), 5000);
-}
- </programlisting>
- </example>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Rotate the Data Key</term>
- <listitem>
- <para>To rotate the data key, first change the ColumnFamily key in the column
- descriptor, then trigger a major compaction. When compaction is complete, all HFiles
- will be re-encrypted using the new data key. Until the compaction completes, the
- old HFiles will still be readable using the old key.</para>
- <para>If you rely on HBase's default behavior of generating a random key for each
- HFile, there is no need to rotate data keys. A major compaction will re-encrypt the
- HFile with a new key.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Switching Between Using a Random Data Key and Specifying A Key</term>
- <listitem>
- <para>If you configured a column family to use a specific key and you want to return
- to the default behavior of using a randomly-generated key for that column family,
- use the Java API to alter the <code>HColumnDescriptor</code> so that no value is
- sent with the key <literal>EN
<TRUNCATED>
[15/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
HBASE-14066 clean out old docbook docs from branch-1.
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo
Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/0acbff24
Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/0acbff24
Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/0acbff24
Branch: refs/heads/branch-1.1
Commit: 0acbff24cebe78dae37225d65e75f74c887a01d0
Parents: 48a3d10
Author: Sean Busbey <bu...@apache.org>
Authored: Mon Jul 13 14:44:00 2015 -0500
Committer: Nick Dimiduk <nd...@apache.org>
Committed: Tue Aug 18 15:28:48 2015 -0700
----------------------------------------------------------------------
src/main/docbkx/appendix_acl_matrix.xml | 662 --
.../appendix_contributing_to_documentation.xml | 426 --
src/main/docbkx/appendix_hfile_format.xml | 657 --
src/main/docbkx/book.xml | 6107 ------------------
src/main/docbkx/case_studies.xml | 239 -
src/main/docbkx/community.xml | 149 -
src/main/docbkx/configuration.xml | 1653 -----
src/main/docbkx/cp.xml | 431 --
src/main/docbkx/customization.xsl | 49 -
src/main/docbkx/developer.xml | 2343 -------
src/main/docbkx/external_apis.xml | 79 -
src/main/docbkx/getting_started.xml | 728 ---
src/main/docbkx/hbase_apis.xml | 133 -
src/main/docbkx/ops_mgt.xml | 2488 -------
src/main/docbkx/performance.xml | 1207 ----
src/main/docbkx/preface.xml | 83 -
src/main/docbkx/rpc.xml | 301 -
src/main/docbkx/schema_design.xml | 1247 ----
src/main/docbkx/security.xml | 1895 ------
src/main/docbkx/shell.xml | 386 --
src/main/docbkx/thrift_filter_language.xml | 757 ---
src/main/docbkx/tracing.xml | 187 -
src/main/docbkx/troubleshooting.xml | 1700 -----
src/main/docbkx/unit_testing.xml | 330 -
src/main/docbkx/upgrading.xml | 833 ---
src/main/docbkx/zookeeper.xml | 513 --
26 files changed, 25583 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/appendix_acl_matrix.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/appendix_acl_matrix.xml b/src/main/docbkx/appendix_acl_matrix.xml
deleted file mode 100644
index a0d4695..0000000
--- a/src/main/docbkx/appendix_acl_matrix.xml
+++ /dev/null
@@ -1,662 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix version="5.0" xml:id="appendix_acl_matrix"
- xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>Access Control Matrix</title>
- <para>The following matrix shows the minimum permission set required to perform operations in
- HBase. Before using the table, read through the information about how to interpret it.</para>
- <variablelist>
- <title>Interpreting the ACL Matrix Table</title>
- <para>The following conventions are used in the ACL Matrix table:</para>
- <varlistentry>
- <term>Scopes</term>
- <listitem>
- <para>Permissions are evaluated starting at the widest scope and working to the
- narrowest scope. A scope corresponds to a level of the data model. From broadest to
- narrowest, the scopes are as follows::</para>
- <itemizedlist>
- <listitem><para>Global</para></listitem>
- <listitem><para>Namespace (NS)</para></listitem>
- <listitem><para>Table</para></listitem>
- <listitem><para>Column Family (CF)</para></listitem>
- <listitem><para>Column Qualifier (CQ)</para></listitem>
- <listitem><para>Cell</para></listitem>
- </itemizedlist>
- <para>For instance, a permission granted at table level dominates any grants done at
- the Column Family, Column Qualifier, or cell level. The user can do what that
- grant implies at any location in the table. A permission granted at global scope
- dominates all: the user is always allowed to take that action everywhere.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Permissions</term>
- <listitem>
- <para>Possible permissions include the following:</para>
- <itemizedlist>
- <listitem><para>Superuser - a special user that belongs to group "supergroup" and has
- unlimited access</para></listitem>
- <listitem><para>Admin (A)</para></listitem>
- <listitem><para>Create (C)</para></listitem>
- <listitem><para>Write (W)</para></listitem>
- <listitem><para>Read (R)</para></listitem>
- <listitem><para>Execute (X)</para></listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>For the most part, permissions work in an expected way, with the following caveats:</para>
- <itemizedlist>
- <listitem>
- <para>Having Write permission does not imply Read permission. It is possible and sometimes
- desirable for a user to be able to write data that same user cannot read. One such example
- is a log-writing process.</para>
- </listitem>
- <listitem>
- <para>The <systemitem>hbase:meta</systemitem> table is readable by every user, regardless
- of the user's other grants or restrictions. This is a requirement for HBase to
- function correctly.</para>
- </listitem>
- <listitem>
- <para><code>CheckAndPut</code> and <code>CheckAndDelete</code> operations will fail if
- the user does not have both Write and Read permission.</para>
- </listitem>
- <listitem>
- <para><code>Increment</code> and <code>Append</code> operations do not require Read
- access.</para>
- </listitem>
- </itemizedlist>
-
- <para>The following table is sorted by the interface that provides each operation. In case the
- table goes out of date, the unit tests which check for accuracy of permissions can be found
- in
- <filename>hbase-server/src/test/java/org/apache/hadoop/hbase/security/access/TestAccessController.java</filename>,
- and the access controls themselves can be examined in
- <filename>hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java</filename>.</para>
-
- <table frame="all">
- <title>ACL Matrix</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Interface</entry>
- <entry>Operation</entry>
- <entry>Minimum Scope</entry>
- <entry>Minimum Permission</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry morerows="27">
- <!-- incrememt this if you add another "master" operation -->
- <para>Master</para>
- </entry>
- <entry>
- <para>createTable</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>modifyTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>deleteTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>truncateTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>addColumn</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>modifyColumn</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>deleteColumn</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>disableTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>disableAclTable</para>
- </entry>
- <entry>
- <para>None</para>
- </entry>
- <entry>
- <para>Not allowed</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>enableTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>move</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>assign</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>unassign</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>regionOffline</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>balance</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>balanceSwitch</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>shutdown</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>stopMaster</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>snapshot</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>clone</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>restore</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>deleteSnapshot</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>createNamespace</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>deleteNamespace</para>
- </entry>
- <entry>
- <para>Namespace</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>modifyNamespace</para>
- </entry>
- <entry>
- <para>Namespace</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>flushTable</para>
- </entry>
- <entry>
- <para>Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>getTableDescriptors</para>
- </entry>
- <entry>
- <para>Global|Table</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>mergeRegions</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry morerows="24">Region</entry>
- <!-- Incrememt this if you add any more Region
- operations -->
- <entry>open</entry>
- <entry>Global</entry>
- <entry>A</entry>
- </row>
- <row>
- <entry>
- <para>openRegion</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>close</entry>
- <entry>Global</entry>
- <entry>A</entry>
- </row>
- <row>
- <entry>
- <para>closeRegion</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>stopRegionServer</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>rollHLog</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>mergeRegions</para>
- </entry>
- <entry>
- <para>Global</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>append</entry>
- <entry>Table|CF|CQ</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>delete</entry>
- <entry>Table|CF|CQ|Cell (if the user has write permission for all cells)</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>exists</entry>
- <entry>Table|CF|CQ</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>get</entry>
- <entry>Table|CF|CQ</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>getClosestRowBefore</entry>
- <entry>Table|CF|CQ</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>increment</entry>
- <entry>Table|CF|CQ</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>put</entry>
- <entry>Table|CF|CQ</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>
- <para>flush</para>
- </entry>
- <entry>
- <para>Global|Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>split</para>
- </entry>
- <entry>
- <para>Global|Table</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>compact</para>
- </entry>
- <entry>
- <para>Global|Table</para>
- </entry>
- <entry>
- <para>A|C</para>
- </entry>
- </row>
- <row>
- <entry>bulkLoadHFile</entry>
- <entry>Table</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>prepareBulkLoad</entry>
- <entry>Table</entry>
- <entry>C</entry>
- </row>
- <row>
- <entry>cleanupBulkLoad</entry>
- <entry>Table</entry>
- <entry>W</entry>
- </row>
- <row>
- <entry>checkAndDelete</entry>
- <entry>Table|CF|CQ</entry>
- <entry>RW</entry>
- </row>
- <row>
- <entry>checkAndPut</entry>
- <entry>Table|CF|CQ</entry>
- <entry>RW</entry>
- </row>
- <row>
- <entry>incrementColumnValue</entry>
- <entry>Table|CF|CQ</entry>
- <entry>RW</entry>
- </row>
- <row>
- <entry>scannerClose</entry>
- <entry>Table</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>scannerNext</entry>
- <entry>Table</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>scannerOpen</entry>
- <entry>Table|CQ|CF</entry>
- <entry>R</entry>
- </row>
- <row>
- <entry>
- <para>Endpoint</para>
- </entry>
- <entry>
- <para>invoke</para>
- </entry>
- <entry>Endpoint</entry>
- <entry>
- <para>X</para>
- </entry>
- </row>
- <row>
- <entry morerows="3">
- <para>AccessController</para>
- </entry>
- <entry>
- <para>grant</para>
- </entry>
- <entry>Global|Table|NS</entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>revoke</para>
- </entry>
- <entry>Global|Table|NS</entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>getUserPermissions</para>
- </entry>
- <entry>
- <para>Global|Table|NS</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>checkPermissions</para>
- </entry>
- <entry>
- <para>Global|Table|NS</para>
- </entry>
- <entry>
- <para>A</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-</appendix>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/appendix_contributing_to_documentation.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/appendix_contributing_to_documentation.xml b/src/main/docbkx/appendix_contributing_to_documentation.xml
deleted file mode 100644
index 2f19c7b..0000000
--- a/src/main/docbkx/appendix_contributing_to_documentation.xml
+++ /dev/null
@@ -1,426 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix version="5.0" xml:id="appendix_contributing_to_documentation"
- xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>Contributing to Documentation</title>
- <para>The Apache HBase project welcomes contributions to all aspects of the project, including
- the documentation. In HBase, documentation includes the following areas, and probably some
- others:</para>
- <itemizedlist>
- <listitem>
- <para>The <link xlink:href="http://hbase.apache.org/book.html">HBase Reference
- Guide</link> (this book)</para>
- </listitem>
- <listitem>
- <para>The <link xlink:href="http://hbase.apache.org/">HBase website</link>e</para>
- </listitem>
- <listitem>
- <para>The <link xlink:href="http://wiki.apache.org/hadoop/Hbase">HBase
- Wiki</link></para>
- </listitem>
- <listitem>
- <para>API documentation</para>
- </listitem>
- <listitem>
- <para>Command-line utility output and help text</para>
- </listitem>
- <listitem>
- <para>Web UI strings, explicit help text, context-sensitive strings, and others</para>
- </listitem>
- <listitem>
- <para>Log messages</para>
- </listitem>
- <listitem>
- <para>Comments in source files, configuration files, and others</para>
- </listitem>
- <listitem>
- <para>Localization of any of the above into target languages other than English</para>
- </listitem>
- </itemizedlist>
- <para>No matter which area you want to help out with, the first step is almost always to
- download (typically by cloning the Git repository) and familiarize yourself with the HBase
- source code. The only exception in the list above is the HBase Wiki, which is edited online.
- For information on downloading and building the source, see <xref linkend="developer"
- />.</para>
-
- <section>
- <title>Getting Access to the Wiki</title>
- <para>The HBase Wiki is not well-maintained and much of its content has been moved into the
- HBase Reference Guide (this guide). However, some pages on the Wiki are well maintained,
- and it would be great to have some volunteers willing to help out with the Wiki. To
- request access to the Wiki, register a new account at <link
- xlink:href="https://wiki.apache.org/hadoop/Hbase?action=newaccount"
- >https://wiki.apache.org/hadoop/Hbase?action=newaccount</link>. Contact one of the
- HBase committers, who can either give you access or refer you to someone who can.</para>
- </section>
- <section>
- <title>Contributing to Documentation or Other Strings</title>
- <para> If you spot an error in a string in a UI, utility, script, log message, or elsewhere,
- or you think something could be made more clear, or you think text needs to be added
- where it doesn't currently exist, the first step is to file a JIRA. Be sure to set the
- component to <literal>Documentation</literal> in addition any other involved components.
- Most components have one or more default owners, who monitor new issues which come into
- those queues. Regardless of whether you feel able to fix the bug, you should still file
- bugs where you see them.</para>
- <para>If you want to try your hand at fixing your newly-filed bug, assign it to yourself.
- You will need to clone the HBase Git repository to your local system and work on the
- issue there. When you have developed a potential fix, submit it for review. If it
- addresses the issue and is seen as an improvement, one of the HBase committers will
- commit it to one or more branches, as appropriate.</para>
- <procedure xml:id="submit_doc_patch_procedure">
- <title>Suggested Work flow for Submitting Patches</title>
- <para>This procedure goes into more detail than Git pros will need, but is included in
- this appendix so that people unfamiliar with Git can feel confident contributing to
- HBase while they learn.</para>
- <step>
- <para>If you have not already done so, clone the Git repository locally. You only
- need to do this once.</para>
- </step>
- <step>
- <para>Fairly often, pull remote changes into your local repository by using the
- <code>git pull</code> command, while your master branch is checked
- out.</para>
- </step>
- <step>
- <para>For each issue you work on, create a new branch. One convention that works
- well for naming the branches is to name a given branch the same as the JIRA it
- relates to:</para>
- <screen language="bourne">$ git checkout -b HBASE-123456</screen>
- </step>
- <step>
- <para>Make your suggested changes on your branch, committing your changes to your
- local repository often. If you need to switch to working on a different issue,
- remember to check out the appropriate branch.</para>
- </step>
- <step>
- <para>When you are ready to submit your patch, first be sure that HBase builds
- cleanly and behaves as expected in your modified branch. If you have made
- documentation changes, be sure the documentation and website builds.</para>
- <note>
- <para>Before you use the <literal>site</literal> target the very first time, be
- sure you have built HBase at least once, in order to fetch all the Maven
- dependencies you need.</para>
- </note>
- <screen language="bourne">$ mvn clean install -DskipTests # Builds HBase</screen>
- <screen language="bourne">$ mvn clean site -DskipTests # Builds the website and documentation</screen>
- <para>If any errors occur, address them.</para>
- </step>
- <step>
- <para>If it takes you several days or weeks to implement your fix, or you know that
- the area of the code you are working in has had a lot of changes lately, make
- sure you rebase your branch against the remote master and take care of any
- conflicts before submitting your patch.</para>
- <screen language="bourne">
-$ git checkout HBASE-123456
-$ git rebase origin/master
- </screen>
- </step>
- <step>
- <para>Generate your patch against the remote master. Run the following command from
- the top level of your git repository (usually called
- <literal>hbase</literal>):</para>
- <screen language="bourne">$ git diff --no-prefix origin/master > HBASE-123456.patch</screen>
- <para>The name of the patch should contain the JIRA ID. Look over the patch file to
- be sure that you did not change any additional files by accident and that there
- are no other surprises. When you are satisfied, attach the patch to the JIRA and
- click the <guibutton>Patch Available</guibutton> button. A reviewer
- will review your patch. If you need to submit a new version of the patch, leave
- the old one on the JIRA and add a version number to the name of the new
- patch.</para>
- </step>
- <step>
- <para>After a change has been committed, there is no need to keep your local branch
- around. Instead you should run <command>git pull</command> to get the new change
- into your master branch.</para>
- </step>
- </procedure>
- </section>
-
- <section>
- <title>Editing the HBase Website</title>
- <para>The source for the HBase website is in the HBase source, in the
- <filename>src/main/site/</filename> directory. Within this directory, source for the
- individual pages is in the <filename>xdocs/</filename> directory, and images referenced
- in those pages are in the <filename>images/</filename> directory. This directory also
- stores images used in the HBase Reference Guide.</para>
- <para>The website's pages are written in an HTML-like XML dialect called xdoc, which has a
- reference guide at <link
- xlink:href="http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html"
- >http://maven.apache.org/archives/maven-1.x/plugins/xdoc/reference/xdocs.html</link>.
- You can edit these files in a plain-text editor, an IDE, or an XML editor such as
- XML Mind XML Editor (XXE) or Oxygen XML Author. </para>
- <para>To preview your changes, build the website using the <command>mvn clean site
- -DskipTests</command> command. The HTML output resides in the
- <filename>target/site/</filename> directory. When you are satisfied with your
- changes, follow the procedure in <xref linkend="submit_doc_patch_procedure"/> to submit
- your patch.</para>
- </section>
-
- <section>
- <title>Editing the HBase Reference Guide</title>
- <para>The source for the HBase Reference Guide is in the HBase source, in the
- <filename>src/main/docbkx/</filename> directory. It is written in <link
- xlink:href="http://www.docbook.org/">Docbook</link> XML. Docbook can be
- intimidating, but you can typically follow the formatting of the surrounding file to get
- an idea of the mark-up. You can edit Docbook XML files using a plain-text editor, an
- XML-aware IDE, or a specialized XML editor.</para>
- <para>Docbook's syntax can be picky. Before submitting a patch, be sure to build the output
- locally using the <command>mvn site</command> command. If you do not get any build
- errors, that means that the XML is well-formed, which means that each opening tag is
- balanced by a closing tag. Well-formedness is not exactly the same as validity. Check
- the output in <filename>target/docbkx/</filename> for any surprises before submitting a
- patch.</para>
- </section>
-
- <section>
- <title>Auto-Generated Content</title>
- <para>Some parts of the HBase Reference Guide, most notably <xref linkend="config.files"/>,
- are generated automatically, so that this area of the documentation stays in sync with
- the code. This is done by means of an XSLT transform, which you can examine in the
- source at <filename>src/main/xslt/configuration_to_docbook_section.xsl</filename>. This
- transforms the <filename>hbase-common/src/main/resources/hbase-default.xml</filename>
- file into a Docbook output which can be included in the Reference Guide. Sometimes, it
- is necessary to add configuration parameters or modify their descriptions. Make the
- modifications to the source file, and they will be included in the Reference Guide when
- it is rebuilt.</para>
- <para>It is possible that other types of content can and will be automatically generated
- from HBase source files in the future.</para>
- </section>
-
- <section>
- <title>Multi-Page and Single-Page Output</title>
- <para>You can examine the <literal>site</literal> target in the Maven
- <filename>pom.xml</filename> file included at the top level of the HBase source for
- details on the process of building the website and documentation. The Reference Guide is
- built twice, once as a single-page output and once with one HTML file per chapter. The
- single-page output is located in <filename>target/docbkx/book.html</filename>, while the
- multi-page output's index page is at <filename>target/docbkx/book/book.html</filename>.
- Each of these outputs has its own <filename>images/</filename> and
- <filename>css/</filename> directories, which are created at build time.</para>
- </section>
-
- <section>
- <title>Images in the HBase Reference Guide</title>
- <para>You can include images in the HBase Reference Guide. For accessibility reasons, it is
- recommended that you use a <figure> Docbook element for an image. This allows
- screen readers to navigate to the image and also provides alternative text for the
- image. The following is an example of a <figure> element.</para>
- <programlisting language="xml"><![CDATA[<figure>
- <title>HFile Version 1</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="timeline_consistency.png" />
- </imageobject>
- <textobject>
- <phrase>HFile Version 1</phrase>
- </textobject>
- </mediaobject>
-</figure>]]>
- </programlisting>
- <para>The <textobject> can contain a few sentences describing the image, rather than
- simply reiterating the title. You can optionally specify alignment and size options in
- the <imagedata> element.</para>
- <para>When doing a local build, save the image to the
- <filename>src/main/site/resources/images/</filename> directory. In the
- <imagedata> element, refer to the image as above, with no directory component. The
- image will be copied to the appropriate target location during the build of the
- output.</para>
- <para>When you submit a patch which includes adding an image to the HBase Reference Guide,
- attach the image to the JIRA. If the committer asks where the image should be committed,
- it should go into the above directory.</para>
- </section>
-
- <section>
- <title>Adding a New Chapter to the HBase Reference Guide</title>
- <para>If you want to add a new chapter to the HBase Reference Guide, the easiest way is to
- copy an existing chapter file, rename it, and change the ID and title elements near the
- top of the file. Delete the existing content and create the new content. Then open the
- <filename>book.xml</filename> file, which is the main file for the HBase Reference
- Guide, and use an <xi:include> element to include your new chapter in the
- appropriate location. Be sure to add your new file to your Git repository before
- creating your patch. Note that the <filename>book.xml</filename> file currently contains
- many chapters. You can only include a chapter at the same nesting levels as the other
- chapters in the file. When in doubt, check to see how other files have been
- included.</para>
- </section>
-
- <section>
- <title>Docbook Common Issues</title>
- <para>The following Docbook issues come up often. Some of these are preferences, but others
- can create mysterious build errors or other problems.</para>
- <qandaset>
- <qandaentry>
- <question>
- <para>What can go where?</para>
- </question>
- <answer>
- <para>There is often confusion about which child elements are valid in a given
- context. When in doubt, <link
- xlink:href="http://docbook.org/tdg/en/html/docbook.html">Docbook: The
- Definitive Guide</link> is the best resource. It has an appendix which
- is indexed by element and contains all valid child and parent elements of
- any given element. If you edit Docbook often, a schema-aware XML editor
- makes things easier.</para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Paragraphs and Admonitions</para>
- </question>
- <answer>
- <para>It is a common pattern, and it is technically valid, to put an admonition
- such as a <note> inside a <para> element. Because admonitions
- render as block-level elements (they take the whole width of the page), it
- is better to mark them up as siblings to the paragraphs around them, like
- this:</para>
- <programlisting language="xml"><![CDATA[<para>This is the paragraph.</para>
-<note>
- <para>This is an admonition which occurs after the paragraph.</para>
-</note>]]></programlisting>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Wrap textual <listitem> and <entry> contents in <para>
- elements.</para>
- </question>
- <answer>
- <para>Because the contents of a <listitem> (an element in an itemized,
- ordered, or variable list) or an <entry> (a cell in a table) can
- consist of things other than plain text, they need to be wrapped in some
- element. If they are plain text, they need to be inclosed in <para>
- tags. This is tedious but necessary for validity.</para>
- <programlisting language="xml"><![CDATA[<itemizedlist>
- <listitem>
- <para>This is a paragraph.</para>
- </listitem>
- <listitem>
- <screen>This is screen output.</screen>
- </listitem>
-</itemizedlist>]]></programlisting>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>When to use <command>, <code>, <programlisting>,
- <screen></para>
- </question>
- <answer>
- <para>The first two are in-line tags, which can occur within the flow of
- paragraphs or titles. The second two are block elements.</para>
- <para>Use <command> to mention a command such as <command>hbase
- shell</command> in the flow of a sentence. Use <code> for other
- inline text referring to code. Incidentally, use <literal> to specify
- literal strings that should be typed or entered exactly as shown. Within a
- <screen> listing, it can be helpful to use the <userinput> and
- <computeroutput> elements to mark up the text further.</para>
- <para>Use <screen> to display input and output as the user would
- <emphasis>see</emphasis> it on the screen, in a log file, etc. Use
- <programlisting> only for blocks of code that occur within a file,
- such as Java or XML code, or a Bash shell script.</para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>How to escape XML elements so that they show up as XML</para>
- </question>
- <answer>
- <para>For one-off instances or short in-line mentions, use the &lt; and
- &gt; encoded characters. For longer mentions, or blocks of code, enclose
- it with <![CDATA[<![CDATA[]]>]]>, which is much easier to maintain and
- parse in the source files..</para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Tips and tricks for making screen output look good</para>
- </question>
- <answer>
- <para>Text within <screen> and <programlisting> elements is shown
- exactly as it appears in the source, including indentation, tabs, and line
- wrap.</para>
- <itemizedlist>
- <listitem>
- <para>Indent the starting and closing XML elements, but do not indent
- the content. Also, to avoid having an extra blank line at the
- beginning of the programlisting output, do not put the CDATA
- element on its own line. For example:</para>
- <programlisting language="bourne"><![CDATA[ <programlisting>
-case $1 in
- --cleanZk|--cleanHdfs|--cleanAll)
- matches="yes" ;;
- *) ;;
-esac
- </programlisting>]]></programlisting>
- </listitem>
- <listitem>
- <para>After pasting code into a programlisting, fix the indentation
- manually, using two <emphasis>spaces</emphasis> per desired
- indentation. For screen output, be sure to include line breaks so
- that the text is no longer than 100 characters.</para>
- </listitem>
- </itemizedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Isolate Changes for Easy Diff Review.</para>
- </question>
- <answer>
- <para>Be careful with pretty-printing or re-formatting an entire XML file, even
- if the formatting has degraded over time. If you need to reformat a file, do
- that in a separate JIRA where you do not change any content. Be careful
- because some XML editors do a bulk-reformat when you open a new file,
- especially if you use GUI mode in the editor.</para>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Syntax Highlighting</para>
- </question>
- <answer>
- <para>The HBase Reference Guide uses the <link
- xlink:href="http://sourceforge.net/projects/xslthl/files/xslthl/2.1.0/"
- >XSLT Syntax Highlighting</link> Maven module for syntax highlighting.
- To enable syntax highlighting for a given <programlisting> or
- <screen> (or possibly other elements), add the attribute
- <literal>language=<replaceable>LANGUAGE_OF_CHOICE</replaceable></literal>
- to the element, as in the following example:</para>
- <programlisting language="xml"><![CDATA[
-<programlisting language="xml">
- <foo>bar</foo>
- <bar>foo</bar>
-</programlisting>]]></programlisting>
- <para>Several syntax types are supported. The most interesting ones for the
- HBase Reference Guide are <literal>java</literal>, <literal>xml</literal>,
- <literal>sql</literal>, and <literal>bourne</literal> (for BASH shell
- output or Linux command-line examples).</para>
- </answer>
- </qandaentry>
- </qandaset>
- </section>
-</appendix>
-
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/appendix_hfile_format.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/appendix_hfile_format.xml b/src/main/docbkx/appendix_hfile_format.xml
deleted file mode 100644
index ee43031..0000000
--- a/src/main/docbkx/appendix_hfile_format.xml
+++ /dev/null
@@ -1,657 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix version="5.0" xml:id="hfile_format"
- xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>HFile format</title>
- <para>This appendix describes the evolution of the HFile format.</para>
-
- <section xml:id="hfilev1">
- <title>HBase File Format (version 1)</title>
- <para>As we will be discussing changes to the HFile format, it is useful to give a short overview of the original (HFile version 1) format.</para>
- <section xml:id="hfilev1.overview">
- <title>Overview of Version 1</title>
- <para>An HFile in version 1 format is structured as follows:</para>
- <figure>
- <title>HFile V1 Format</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle" fileref="hfile.png"/>
- </imageobject>
- <textobject>
- <phrase>HFile Version 1</phrase>
- </textobject>
- <caption><para>Image courtesy of Lars George, <link
- xlink:href="http://www.larsgeorge.com/2009/10/hbase-architecture-101-storage.html"
- >hbase-architecture-101-storage.html</link>.</para></caption>
- </mediaobject>
- </figure>
-
- </section>
- <section><title> Block index format in version 1 </title>
- <para>The block index in version 1 is very straightforward. For each entry, it contains: </para>
- <orderedlist>
- <listitem>
- <para>Offset (long)</para>
- </listitem>
- <listitem>
- <para>Uncompressed size (int)</para>
- </listitem>
- <listitem>
- <para>Key (a serialized byte array written using Bytes.writeByteArray) </para>
- <orderedlist>
- <listitem>
- <para>Key length as a variable-length integer (VInt)
- </para>
- </listitem>
- <listitem>
- <para>
- Key bytes
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- <para>The number of entries in the block index is stored in the fixed file trailer, and has to be passed in to the method that reads the block index. One of the limitations of the block index in version 1 is that it does not provide the compressed size of a block, which turns out to be necessary for decompression. Therefore, the HFile reader has to infer this compressed size from the offset difference between blocks. We fix this limitation in version 2, where we store on-disk block size instead of uncompressed size, and get uncompressed size from the block header.</para>
- </section>
- </section>
- <section xml:id="hfilev2"><title>
- HBase file format with inline blocks (version 2)
- </title>
- <para>Note: this feature was introduced in HBase 0.92</para>
- <section><title>Motivation </title>
- <para>We found it necessary to revise the HFile format after encountering high memory usage and slow startup times caused by large Bloom filters and block indexes in the region server. Bloom filters can get as large as 100 MB per HFile, which adds up to 2 GB when aggregated over 20 regions. Block indexes can grow as large as 6 GB in aggregate size over the same set of regions. A region is not considered opened until all of its block index data is loaded. Large Bloom filters produce a different performance problem: the first get request that requires a Bloom filter lookup will incur the latency of loading the entire Bloom filter bit array.</para>
- <para>To speed up region server startup we break Bloom filters and block indexes into multiple blocks and write those blocks out as they fill up, which also reduces the HFile writer’s memory footprint. In the Bloom filter case, “filling up a block” means accumulating enough keys to efficiently utilize a fixed-size bit array, and in the block index case we accumulate an “index block” of the desired size. Bloom filter blocks and index blocks (we call these “inline blocks”) become interspersed with data blocks, and as a side effect we can no longer rely on the difference between block offsets to determine data block length, as it was done in version 1.</para>
- <para>HFile is a low-level file format by design, and it should not deal with application-specific details such as Bloom filters, which are handled at StoreFile level. Therefore, we call Bloom filter blocks in an HFile "inline" blocks. We also supply HFile with an interface to write those inline blocks. </para>
- <para>Another format modification aimed at reducing the region server startup time is to use a contiguous “load-on-open” section that has to be loaded in memory at the time an HFile is being opened. Currently, as an HFile opens, there are separate seek operations to read the trailer, data/meta indexes, and file info. To read the Bloom filter, there are two more seek operations for its “data” and “meta” portions. In version 2, we seek once to read the trailer and seek again to read everything else we need to open the file from a contiguous block.</para></section>
- <section xml:id="hfilev2.overview">
- <title>Overview of Version 2</title>
- <para>The version of HBase introducing the above features reads both version 1 and 2 HFiles, but only writes version 2 HFiles. A version 2 HFile is structured as follows:
- <inlinemediaobject>
- <imageobject>
- <imagedata align="center" valign="middle" fileref="hfilev2.png" />
- </imageobject>
- <textobject>
- <phrase>HFile Version 2</phrase>
- </textobject>
- </inlinemediaobject>
-
- </para>
- </section>
- <section><title>Unified version 2 block format</title>
- <para>In the version 2 every block in the data section contains the following fields: </para>
- <orderedlist>
- <listitem>
- <para>8 bytes: Block type, a sequence of bytes equivalent to version 1's "magic records". Supported block types are: </para>
- <orderedlist>
- <listitem>
- <para>DATA – data blocks
- </para>
- </listitem>
- <listitem>
- <para>
- LEAF_INDEX – leaf-level index blocks in a multi-level-block-index
- </para>
- </listitem>
- <listitem>
- <para>
- BLOOM_CHUNK – Bloom filter chunks
- </para>
- </listitem>
- <listitem>
- <para>
- META – meta blocks (not used for Bloom filters in version 2 anymore)
- </para>
- </listitem>
- <listitem>
- <para>
- INTERMEDIATE_INDEX – intermediate-level index blocks in a multi-level blockindex
- </para>
- </listitem>
- <listitem>
- <para>
- ROOT_INDEX – root>level index blocks in a multi>level block index
- </para>
- </listitem>
- <listitem>
- <para>
- FILE_INFO – the “file info” block, a small key>value map of metadata
- </para>
- </listitem>
- <listitem>
- <para>
- BLOOM_META – a Bloom filter metadata block in the load>on>open section
- </para>
- </listitem>
- <listitem>
- <para>
- TRAILER – a fixed>size file trailer. As opposed to the above, this is not an
- HFile v2 block but a fixed>size (for each HFile version) data structure
- </para>
- </listitem>
- <listitem>
- <para>
- INDEX_V1 – this block type is only used for legacy HFile v1 block
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Compressed size of the block's data, not including the header (int).
- </para>
- <para>
-Can be used for skipping the current data block when scanning HFile data.
- </para>
- </listitem>
- <listitem>
- <para>Uncompressed size of the block's data, not including the header (int)</para>
- <para>
- This is equal to the compressed size if the compression algorithm is NONE
- </para>
- </listitem>
- <listitem>
- <para>File offset of the previous block of the same type (long)</para>
- <para>
- Can be used for seeking to the previous data/index block
- </para>
- </listitem>
- <listitem>
- <para>Compressed data (or uncompressed data if the compression algorithm is NONE).</para>
- </listitem>
- </orderedlist>
- <para>The above format of blocks is used in the following HFile sections:</para>
- <orderedlist>
- <listitem>
- <para>Scanned block section. The section is named so because it contains all data blocks that need to be read when an HFile is scanned sequentially. Also contains leaf block index and Bloom chunk blocks. </para>
- </listitem>
- <listitem>
- <para>Non-scanned block section. This section still contains unified-format v2 blocks but it does not have to be read when doing a sequential scan. This section contains “meta” blocks and intermediate-level index blocks.
- </para>
- </listitem>
- </orderedlist>
- <para>We are supporting “meta” blocks in version 2 the same way they were supported in version 1, even though we do not store Bloom filter data in these blocks anymore. </para></section>
-
-<section><title> Block index in version 2</title>
- <para>There are three types of block indexes in HFile version 2, stored in two different formats (root and non-root): </para>
- <orderedlist>
- <listitem>
- <para>Data index — version 2 multi-level block index, consisting of:</para>
- <orderedlist>
- <listitem>
- <para>
- Version 2 root index, stored in the data block index section of the file
- </para>
- </listitem>
- <listitem>
- <para>
-Optionally, version 2 intermediate levels, stored in the non%root format in the data index section of the file. Intermediate levels can only be present if leaf level blocks are present
- </para>
- </listitem>
- <listitem>
- <para>
-Optionally, version 2 leaf levels, stored in the non%root format inline with data blocks
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Meta index — version 2 root index format only, stored in the meta index section of the file</para>
- </listitem>
- <listitem>
- <para>Bloom index — version 2 root index format only, stored in the “load-on-open” section as part of Bloom filter metadata.</para>
- </listitem>
- </orderedlist></section>
-<section><title>
- Root block index format in version 2</title>
- <para>This format applies to:</para>
- <orderedlist>
- <listitem>
- <para>Root level of the version 2 data index</para>
- </listitem>
- <listitem>
- <para>Entire meta and Bloom indexes in version 2, which are always single-level. </para>
- </listitem>
- </orderedlist>
- <para>A version 2 root index block is a sequence of entries of the following format, similar to entries of a version 1 block index, but storing on-disk size instead of uncompressed size. </para>
- <orderedlist>
- <listitem>
- <para>Offset (long) </para>
- <para>
-This offset may point to a data block or to a deeper>level index block.
- </para>
- </listitem>
- <listitem>
- <para>On-disk size (int) </para>
- </listitem>
- <listitem>
- <para>Key (a serialized byte array stored using Bytes.writeByteArray) </para>
- <orderedlist>
- <listitem>
- <para>Key (VInt)
- </para>
- </listitem>
- <listitem>
- <para>Key bytes
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- <para>A single-level version 2 block index consists of just a single root index block. To read a root index block of version 2, one needs to know the number of entries. For the data index and the meta index the number of entries is stored in the trailer, and for the Bloom index it is stored in the compound Bloom filter metadata.</para>
-
- <para>For a multi-level block index we also store the following fields in the root index block in the load-on-open section of the HFile, in addition to the data structure described above:</para>
- <orderedlist>
- <listitem>
- <para>Middle leaf index block offset</para>
- </listitem>
- <listitem>
- <para>Middle leaf block on-disk size (meaning the leaf index block containing the reference to the “middle” data block of the file) </para>
- </listitem>
- <listitem>
- <para>The index of the mid-key (defined below) in the middle leaf-level block.</para>
- </listitem>
- </orderedlist>
- <para/>
- <para>These additional fields are used to efficiently retrieve the mid-key of the HFile used in HFile splits, which we define as the first key of the block with a zero-based index of (n – 1) / 2, if the total number of blocks in the HFile is n. This definition is consistent with how the mid-key was determined in HFile version 1, and is reasonable in general, because blocks are likely to be the same size on average, but we don’t have any estimates on individual key/value pair sizes. </para>
- <para/>
- <para>When writing a version 2 HFile, the total number of data blocks pointed to by every leaf-level index block is kept track of. When we finish writing and the total number of leaf-level blocks is determined, it is clear which leaf-level block contains the mid-key, and the fields listed above are computed. When reading the HFile and the mid-key is requested, we retrieve the middle leaf index block (potentially from the block cache) and get the mid-key value from the appropriate position inside that leaf block.</para></section>
-<section><title>
- Non-root block index format in version 2</title>
- <para>This format applies to intermediate-level and leaf index blocks of a version 2 multi-level data block index. Every non-root index block is structured as follows. </para>
- <orderedlist>
- <listitem>
- <para>numEntries: the number of entries (int). </para>
- </listitem>
- <listitem>
- <para>entryOffsets: the “secondary index” of offsets of entries in the block, to facilitate a quick binary search on the key (numEntries + 1 int values). The last value is the total length of all entries in this index block. For example, in a non-root index block with entry sizes 60, 80, 50 the “secondary index” will contain the following int array: {0, 60, 140, 190}.</para>
- </listitem>
- <listitem>
- <para>Entries. Each entry contains: </para>
- <orderedlist>
- <listitem>
- <para>
-Offset of the block referenced by this entry in the file (long)
- </para>
- </listitem>
- <listitem>
- <para>
-On>disk size of the referenced block (int)
- </para>
- </listitem>
- <listitem>
- <para>
-Key. The length can be calculated from entryOffsets.
- </para>
- </listitem>
- </orderedlist>
-
- </listitem>
- </orderedlist></section><section><title>
- Bloom filters in version 2</title>
- <para>In contrast with version 1, in a version 2 HFile Bloom filter metadata is stored in the load-on-open section of the HFile for quick startup. </para>
- <orderedlist>
- <listitem>
- <para>A compound Bloom filter. </para>
- <orderedlist>
- <listitem>
- <para>
- Bloom filter version = 3 (int). There used to be a DynamicByteBloomFilter class that had the Bloom filter version number 2
- </para>
- </listitem>
- <listitem>
- <para>
-The total byte size of all compound Bloom filter chunks (long)
- </para>
- </listitem>
- <listitem>
- <para>
- Number of hash functions (int
- </para>
- </listitem>
- <listitem>
- <para>
-Type of hash functions (int)
- </para>
- </listitem>
- <listitem>
- <para>
-The total key count inserted into the Bloom filter (long)
- </para>
- </listitem>
- <listitem>
- <para>
-The maximum total number of keys in the Bloom filter (long)
- </para>
- </listitem>
- <listitem>
- <para>
-The number of chunks (int)
- </para>
- </listitem>
- <listitem>
- <para>
-Comparator class used for Bloom filter keys, a UTF>8 encoded string stored using Bytes.writeByteArray
- </para>
- </listitem>
- <listitem>
- <para>
- Bloom block index in the version 2 root block index format
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist></section><section><title>File Info format in versions 1 and 2</title>
- <para>The file info block is a serialized <link xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/io/HbaseMapWritable.html">HbaseMapWritable</link> (essentially a map from byte arrays to byte arrays) with the following keys, among others. StoreFile-level logic adds more keys to this.</para>
- <informaltable frame="all">
- <tgroup cols="2"><tbody><row>
- <entry>
- <para>hfile.LASTKEY </para>
- </entry>
- <entry>
- <para>The last key of the file (byte array) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>hfile.AVG_KEY_LEN </para>
- </entry>
- <entry>
- <para>The average key length in the file (int) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>hfile.AVG_VALUE_LEN </para>
- </entry>
- <entry>
- <para>The average value length in the file (int) </para>
- </entry>
- </row></tbody></tgroup>
- </informaltable>
- <para>File info format did not change in version 2. However, we moved the file info to the final section of the file, which can be loaded as one block at the time the HFile is being opened. Also, we do not store comparator in the version 2 file info anymore. Instead, we store it in the fixed file trailer. This is because we need to know the comparator at the time of parsing the load-on-open section of the HFile.</para></section><section><title>
- Fixed file trailer format differences between versions 1 and 2</title>
- <para>The following table shows common and different fields between fixed file trailers in versions 1 and 2. Note that the size of the trailer is different depending on the version, so it is “fixed” only within one version. However, the version is always stored as the last four-byte integer in the file. </para>
- <para/>
- <informaltable frame="all">
- <tgroup cols="2">
-<colspec colname='c1'/>
-<colspec colname='c2'/>
-<tbody>
- <row>
- <entry>
- <para>Version 1 </para>
- </entry>
- <entry>
- <para>Version 2 </para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>File info offset (long) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Data index offset (long) </para>
- </entry>
- <entry>
- <para>loadOnOpenOffset (long)</para>
- <para><emphasis>The offset of the section that we need toload when opening the file.</emphasis></para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>Number of data index entries (int) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>metaIndexOffset (long)</para>
- <para>This field is not being used by the version 1 reader, so we removed it from version 2.</para>
- </entry>
- <entry>
- <para>uncompressedDataIndexSize (long)</para>
- <para>The total uncompressed size of the whole data block index, including root-level, intermediate-level, and leaf-level blocks.</para>
- </entry>
- </row>
- <row>
- <entry namest="c1" nameend="c2" align="center">
- <para>Number of meta index entries (int) </para>
- </entry>
- </row>
- <row>
- <entry namest="c1" nameend="c2" align="center">
- <para>Total uncompressed bytes (long) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>numEntries (int) </para>
- </entry>
- <entry>
- <para>numEntries (long) </para>
- </entry>
- </row>
- <row>
- <entry namest="c1" nameend="c2" align="center">
- <para>Compression codec: 0 = LZO, 1 = GZ, 2 = NONE (int) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para></para>
- </entry>
- <entry>
- <para>The number of levels in the data block index (int) </para>
- </entry>
- </row>
- <row>
- <entry>
- <para></para>
- </entry>
- <entry>
- <para>firstDataBlockOffset (long)</para>
- <para>The offset of the first first data block. Used when scanning. </para>
- </entry>
- </row>
- <row>
- <entry>
- <para></para>
- </entry>
- <entry>
- <para>lastDataBlockEnd (long)</para>
- <para>The offset of the first byte after the last key/value data block. We don't need to go beyond this offset when scanning. </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Version: 1 (int) </para>
- </entry>
- <entry>
- <para>Version: 2 (int) </para>
- </entry>
- </row></tbody></tgroup>
- </informaltable>
- <para/></section>
- <section><title>getShortMidpointKey(an optimization for data index block)</title>
- <para>Note: this optimization was introduced in HBase 0.95+</para>
- <para>HFiles contain many blocks that contain a range of sorted Cells. Each cell has a key. To save IO when reading Cells, the HFile also has an index that maps a Cell's start key to the offset of the beginning of a particular block. Prior to this optimization, HBase would use the key of the first cell in each data block as the index key.</para>
- <para>In HBASE-7845, we generate a new key that is lexicographically larger than the last key of the previous block and lexicographically equal or smaller than the start key of the current block. While actual keys can potentially be very long, this "fake key" or "virtual key" can be much shorter. For example, if the stop key of previous block is "the quick brown fox", the start key of current block is "the who", we could use "the r" as our virtual key in our hfile index.</para>
- <para>There are two benefits to this:</para>
- <itemizedlist>
- <listitem><para>having shorter keys reduces the hfile index size, (allowing us to keep more indexes in memory), and</para></listitem>
- <listitem><para>using something closer to the end key of the previous block allows us to avoid a potential extra IO when the target key lives in between the "virtual key" and the key of the first element in the target block.</para></listitem>
- </itemizedlist>
- <para>This optimization (implemented by the getShortMidpointKey method) is inspired by LevelDB's ByteWiseComparatorImpl::FindShortestSeparator() and FindShortSuccessor().</para>
- </section>
- </section>
- <section xml:id="hfilev3">
- <title>HBase File Format with Security Enhancements (version 3)</title>
- <para>Note: this feature was introduced in HBase 0.98</para>
- <section xml:id="hfilev3.motivation">
- <title>Motivation </title>
- <para>
- Version 3 of HFile makes changes needed to ease management of encryption at rest and
- cell-level metadata (which in turn is needed for cell-level ACLs and cell-level visibility
- labels). For more information see <xref linkend="hbase.encryption.server"/>,
- <xref linkend="hbase.tags"/>, <xref linkend="hbase.accesscontrol.configuration"/>, and
- <xref linkend="hbase.visibility.labels"/>.
- </para>
- </section>
- <section xml:id="hfilev3.overview">
- <title>Overview</title>
- <para>
- The version of HBase introducing the above features reads HFiles in versions 1, 2, and 3 but
- only writes version 3 HFiles. Version 3 HFiles are structured the same as version 2 HFiles.
- For more information see <xref linkend="hfilev2.overview"/>.
- </para>
- </section>
- <section xml:id="hvilev3.infoblock">
- <title>File Info Block in Version 3</title>
- <para>
- Version 3 added two additional pieces of information to the reserved keys in the file info
- block.
- <informaltable frame="all">
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>
- <para>hfile.MAX_TAGS_LEN</para>
- </entry>
- <entry>
- <para>
- The maximum number of bytes needed to store the serialized tags for any single
- cell in this hfile (int)
- </para>
- </entry>
- </row>
- <row>
- <entry>
- <para>hfile.TAGS_COMPRESSED</para>
- </entry>
- <entry>
- <para>Does the block encoder for this hfile compress tags? (boolean)</para>
- <para>
- Should only be present if <classname>hfile.MAX_TAGS_LEN</classname> is also
- present.
- </para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- <para>
- When reading a Version 3 HFile the presence of <classname>MAX_TAGS_LEN</classname> is used
- to determine how to deserialize the cells within a data block. Therefore, consumers must
- read the file's info block prior to reading any data blocks.
- </para>
- <para>
- When writing a Version 3 HFile, HBase will always include <classname>MAX_TAGS_LEN
- </classname> when flushing the memstore to underlying filesystem and when using prefix tree
- encoding for data blocks, as described in <xref linkend="compression"/>. When compacting
- extant files, the default writer will omit <classname>MAX_TAGS_LEN</classname> if all of the
- files selected do not themselves contain any cells with tags. See
- <xref linkend="compaction"/> for details on the compaction file selection algorithm.
- </para>
- </section>
- <section xml:id="hfilev3.datablock">
- <title>Data Blocks in Version 3</title>
- <para>
- Within an HFile, HBase cells are stored in data blocks as a sequence of KeyValues (see <xref
- linkend="hfilev1.overview"/>, or <link xlink:href=
- "http://www.larsgeorge.com/2009/10/hbase-architecture-101-storage.html">Lars George's
- excellent introduction to HBase Storage</link>). In version 3, these KeyValue optionally
- will include a set of 0 or more tags:
- <informaltable frame="all">
- <tgroup cols="2">
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry>
- <para>Version 1 & 2</para>
- <para>Version 3 without MAX_TAGS_LEN</para>
- </entry>
- <entry><para>Version 3 with MAX_TAGS_LEN</para></entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>Key Length (4 bytes)</para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>Value Length (4 bytes)</para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>Key bytes (variable)</para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c1" nameend="c2">
- <para>Value bytes (variable)</para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c2" nameend="c2">
- <para>Tags Length (2 bytes)</para>
- </entry>
- </row>
- <row>
- <entry align="center" namest="c2" nameend="c2">
- <para>Tags bytes (variable)</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- <para>
- If the info block for a given HFile contains an entry for
- <classname>MAX_TAGS_LEN</classname> each cell will have the length of that cell's tags
- included, even if that length is zero. The actual tags are stored as a sequence of tag
- length (2 bytes), tag type (1 byte), tag bytes (variable). The format an individual tag's
- bytes depends on the tag type.
- </para>
- <para>
- Note that the dependence on the contents of the info block implies that prior to reading
- any data blocks you must first process a file's info block. It also implies that prior to
- writing a data block you must know if the file's info block will include
- <classname>MAX_TAGS_LEN</classname>.
- </para>
- </section>
- <section xml:id="hfilev3.fixedtrailer">
- <title>Fixed File Trailer in Version 3</title>
- <para>
- The fixed file trailers written with HFile version 3 are always serialized with protocol
- buffers. Additionally, it adds an optional field to the version 2 protocol buffer named
- encryption_key. If HBase is configured to encrypt HFiles this field will store a data
- encryption key for this particular HFile, encrypted with the current cluster master key
- using AES. For more information see <xref linkend="hbase.encryption.server"/>.
- </para>
- </section>
- </section>
-</appendix>
[12/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/configuration.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/configuration.xml b/src/main/docbkx/configuration.xml
deleted file mode 100644
index 74b8e52..0000000
--- a/src/main/docbkx/configuration.xml
+++ /dev/null
@@ -1,1653 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="configuration"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase Configuration</title>
- <para>This chapter expands upon the <xref linkend="getting_started" /> chapter to further explain
- configuration of Apache HBase. Please read this chapter carefully, especially <xref
- linkend="basic.prerequisites" /> to ensure that your HBase testing and deployment goes
- smoothly, and prevent data loss.</para>
-
- <para> Apache HBase uses the same configuration system as Apache Hadoop. All configuration files
- are located in the <filename>conf/</filename> directory, which needs to be kept in sync for each
- node on your cluster.</para>
-
- <variablelist>
- <title>HBase Configuration Files</title>
- <varlistentry>
- <term><filename>backup-masters</filename></term>
- <listitem>
- <para>Not present by default. A plain-text file which lists hosts on which the Master should
- start a backup Master process, one host per line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>hadoop-metrics2-hbase.properties</filename></term>
- <listitem>
- <para>Used to connect HBase Hadoop's Metrics2 framework. See the <link
- xlink:href="http://wiki.apache.org/hadoop/HADOOP-6728-MetricsV2">Hadoop Wiki
- entry</link> for more information on Metrics2. Contains only commented-out examples by
- default.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>hbase-env.cmd</filename> and <filename>hbase-env.sh</filename></term>
- <listitem>
- <para>Script for Windows and Linux / Unix environments to set up the working environment for
- HBase, including the location of Java, Java options, and other environment variables. The
- file contains many commented-out examples to provide guidance.</para>
- <note>
- <para>In HBase 0.98.5 and newer, you must set <envar>JAVA_HOME</envar> on each node of
- your cluster. <filename>hbase-env.sh</filename> provides a handy mechanism to do
- this.</para>
- </note>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>hbase-policy.xml</filename></term>
- <listitem>
- <para>The default policy configuration file used by RPC servers to make authorization
- decisions on client requests. Only used if HBase security (<xref
- linkend="security" />) is enabled.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>hbase-site.xml</filename></term>
- <listitem>
- <para>The main HBase configuration file. This file specifies configuration options which
- override HBase's default configuration. You can view (but do not edit) the default
- configuration file at <filename>docs/hbase-default.xml</filename>. You can also view the
- entire effective configuration for your cluster (defaults and overrides) in the
- <guilabel>HBase Configuration</guilabel> tab of the HBase Web UI.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>log4j.properties</filename></term>
- <listitem>
- <para>Configuration file for HBase logging via <code>log4j</code>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>regionservers</filename></term>
- <listitem>
- <para>A plain-text file containing a list of hosts which should run a RegionServer in your
- HBase cluster. By default this file contains the single entry
- <literal>localhost</literal>. It should contain a list of hostnames or IP addresses, one
- per line, and should only contain <literal>localhost</literal> if each node in your
- cluster will run a RegionServer on its <literal>localhost</literal> interface.</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <tip>
- <title>Checking XML Validity</title>
- <para>When you edit XML, it is a good idea to use an XML-aware editor to be sure that your
- syntax is correct and your XML is well-formed. You can also use the <command>xmllint</command>
- utility to check that your XML is well-formed. By default, <command>xmllint</command> re-flows
- and prints the XML to standard output. To check for well-formedness and only print output if
- errors exist, use the command <command>xmllint -noout
- <replaceable>filename.xml</replaceable></command>.</para>
- </tip>
-
- <warning>
- <title>Keep Configuration In Sync Across the Cluster</title>
- <para>When running in distributed mode, after you make an edit to an HBase configuration, make
- sure you copy the content of the <filename>conf/</filename> directory to all nodes of the
- cluster. HBase will not do this for you. Use <command>rsync</command>, <command>scp</command>,
- or another secure mechanism for copying the configuration files to your nodes. For most
- configuration, a restart is needed for servers to pick up changes An exception is dynamic
- configuration. to be described later below.</para>
- </warning>
-
- <section
- xml:id="basic.prerequisites">
- <title>Basic Prerequisites</title>
- <para>This section lists required services and some required system configuration. </para>
-
- <table
- xml:id="java">
- <title>Java</title>
- <textobject>
- <para>HBase requires at least Java 6 from <link
- xlink:href="http://www.java.com/download/">Oracle</link>. The following table lists
- which JDK version are compatible with each version of HBase.</para>
- </textobject>
- <tgroup
- cols="4">
- <thead>
- <row>
- <entry>HBase Version</entry>
- <entry>JDK 6</entry>
- <entry>JDK 7</entry>
- <entry>JDK 8</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>1.0</entry>
- <entry><link
- xlink:href="http://search-hadoop.com/m/DHED4Zlz0R1">Not Supported</link></entry>
- <entry>yes</entry>
- <entry><para>Running with JDK 8 will work but is not well tested.</para></entry>
- </row>
- <row>
- <entry>0.98</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- <entry><para>Running with JDK 8 works but is not well tested. Building with JDK 8 would
- require removal of the deprecated remove() method of the PoolMap class and is under
- consideration. See ee <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-7608">HBASE-7608</link>
- for more information about JDK 8 support.</para></entry>
- </row>
- <row>
- <entry>0.96</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- <entry />
- </row>
- <row>
- <entry>0.94</entry>
- <entry>yes</entry>
- <entry>yes</entry>
- <entry />
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <note>
- <para>In HBase 0.98.5 and newer, you must set <envar>JAVA_HOME</envar> on each node of
- your cluster. <filename>hbase-env.sh</filename> provides a handy mechanism to do
- this.</para>
- </note>
-
- <variablelist
- xml:id="os">
- <title>Operating System Utilities</title>
- <varlistentry
- xml:id="ssh">
- <term>ssh</term>
- <listitem>
- <para>HBase uses the Secure Shell (ssh) command and utilities extensively to communicate
- between cluster nodes. Each server in the cluster must be running <command>ssh</command>
- so that the Hadoop and HBase daemons can be managed. You must be able to connect to all
- nodes via SSH, including the local node, from the Master as well as any backup Master,
- using a shared key rather than a password. You can see the basic methodology for such a
- set-up in Linux or Unix systems at <xref
- linkend="passwordless.ssh.quickstart" />. If your cluster nodes use OS X, see the
- section, <link
- xlink:href="http://wiki.apache.org/hadoop/Running_Hadoop_On_OS_X_10.5_64-bit_%28Single-Node_Cluster%29">SSH:
- Setting up Remote Desktop and Enabling Self-Login</link> on the Hadoop wiki.</para>
- </listitem>
- </varlistentry>
- <varlistentry
- xml:id="dns">
- <term>DNS</term>
- <listitem>
- <para>HBase uses the local hostname to self-report its IP address. Both forward and
- reverse DNS resolving must work in versions of HBase previous to 0.92.0. The <link
- xlink:href="https://github.com/sujee/hadoop-dns-checker">hadoop-dns-checker</link>
- tool can be used to verify DNS is working correctly on the cluster. The project
- README file provides detailed instructions on usage. </para>
-
- <para>If your server has multiple network interfaces, HBase defaults to using the
- interface that the primary hostname resolves to. To override this behavior, set the
- <code>hbase.regionserver.dns.interface</code> property to a different interface. This
- will only work if each server in your cluster uses the same network interface
- configuration.</para>
-
- <para>To choose a different DNS nameserver than the system default, set the
- <varname>hbase.regionserver.dns.nameserver</varname> property to the IP address of
- that nameserver.</para>
- </listitem>
- </varlistentry>
- <varlistentry
- xml:id="loopback.ip">
- <term>Loopback IP</term>
- <listitem>
- <para>Prior to hbase-0.96.0, HBase only used the IP address
- <systemitem>127.0.0.1</systemitem> to refer to <code>localhost</code>, and this could
- not be configured. See <xref
- linkend="loopback.ip" />.</para>
- </listitem>
- </varlistentry>
- <varlistentry
- xml:id="ntp">
- <term>NTP</term>
- <listitem>
- <para>The clocks on cluster nodes should be synchronized. A small amount of variation is
- acceptable, but larger amounts of skew can cause erratic and unexpected behavior. Time
- synchronization is one of the first things to check if you see unexplained problems in
- your cluster. It is recommended that you run a Network Time Protocol (NTP) service, or
- another time-synchronization mechanism, on your cluster, and that all nodes look to the
- same service for time synchronization. See the <link
- xlink:href="http://www.tldp.org/LDP/sag/html/basic-ntp-config.html">Basic NTP
- Configuration</link> at <citetitle>The Linux Documentation Project (TLDP)</citetitle>
- to set up NTP.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry
- xml:id="ulimit">
- <term>Limits on Number of Files and Processes (<command>ulimit</command>)
- <indexterm>
- <primary>ulimit</primary>
- </indexterm><indexterm>
- <primary>nproc</primary>
- </indexterm>
- </term>
-
- <listitem>
- <para>Apache HBase is a database. It requires the ability to open a large number of files
- at once. Many Linux distributions limit the number of files a single user is allowed to
- open to <literal>1024</literal> (or <literal>256</literal> on older versions of OS X).
- You can check this limit on your servers by running the command <command>ulimit
- -n</command> when logged in as the user which runs HBase. See <xref
- linkend="trouble.rs.runtime.filehandles" /> for some of the problems you may
- experience if the limit is too low. You may also notice errors such as the
- following:</para>
- <screen>
-2010-04-06 03:04:37,542 INFO org.apache.hadoop.hdfs.DFSClient: Exception increateBlockOutputStream java.io.EOFException
-2010-04-06 03:04:37,542 INFO org.apache.hadoop.hdfs.DFSClient: Abandoning block blk_-6935524980745310745_1391901
- </screen>
- <para>It is recommended to raise the ulimit to at least 10,000, but more likely 10,240,
- because the value is usually expressed in multiples of 1024. Each ColumnFamily has at
- least one StoreFile, and possibly more than 6 StoreFiles if the region is under load.
- The number of open files required depends upon the number of ColumnFamilies and the
- number of regions. The following is a rough formula for calculating the potential number
- of open files on a RegionServer. </para>
- <example>
- <title>Calculate the Potential Number of Open Files</title>
- <screen>(StoreFiles per ColumnFamily) x (regions per RegionServer)</screen>
- </example>
- <para>For example, assuming that a schema had 3 ColumnFamilies per region with an average
- of 3 StoreFiles per ColumnFamily, and there are 100 regions per RegionServer, the JVM
- will open 3 * 3 * 100 = 900 file descriptors, not counting open JAR files, configuration
- files, and others. Opening a file does not take many resources, and the risk of allowing
- a user to open too many files is minimal.</para>
- <para>Another related setting is the number of processes a user is allowed to run at once.
- In Linux and Unix, the number of processes is set using the <command>ulimit -u</command>
- command. This should not be confused with the <command>nproc</command> command, which
- controls the number of CPUs available to a given user. Under load, a
- <varname>nproc</varname> that is too low can cause OutOfMemoryError exceptions. See
- Jack Levin's <link
- xlink:href="http://thread.gmane.org/gmane.comp.java.hadoop.hbase.user/16374">major
- hdfs issues</link> thread on the hbase-users mailing list, from 2011.</para>
- <para>Configuring the fmaximum number of ile descriptors and processes for the user who is
- running the HBase process is an operating system configuration, rather than an HBase
- configuration. It is also important to be sure that the settings are changed for the
- user that actually runs HBase. To see which user started HBase, and that user's ulimit
- configuration, look at the first line of the HBase log for that instance. A useful read
- setting config on you hadoop cluster is Aaron Kimballs' <link
- xlink:href="http://www.cloudera.com/blog/2009/03/configuration-parameters-what-can-you-just-ignore/"
- >Configuration Parameters: What can you just ignore?</link></para>
- <formalpara xml:id="ulimit_ubuntu">
- <title><command>ulimit</command> Settings on Ubuntu</title>
- <para>To configure <command>ulimit</command> settings on Ubuntu, edit
- <filename>/etc/security/limits.conf</filename>, which is a space-delimited file with
- four columns. Refer to the <link
- xlink:href="http://manpages.ubuntu.com/manpages/lucid/man5/limits.conf.5.html">man
- page for limits.conf</link> for details about the format of this file. In the
- following example, the first line sets both soft and hard limits for the number of
- open files (<literal>nofile</literal>) to <literal>32768</literal> for the operating
- system user with the username <literal>hadoop</literal>. The second line sets the
- number of processes to 32000 for the same user.</para>
- </formalpara>
- <screen>
-hadoop - nofile 32768
-hadoop - nproc 32000
- </screen>
- <para>The settings are only applied if the Pluggable Authentication Module (PAM)
- environment is directed to use them. To configure PAM to use these limits, be sure that
- the <filename>/etc/pam.d/common-session</filename> file contains the following line:</para>
- <screen>session required pam_limits.so</screen>
- </listitem>
- </varlistentry>
-
- <varlistentry
- xml:id="windows">
- <term>Windows</term>
-
- <listitem>
- <para>Prior to HBase 0.96, testing for running HBase on Microsoft Windows was limited.
- Running a on Windows nodes is not recommended for production systems.</para>
-
- <para>To run versions of HBase prior to 0.96 on Microsoft Windows, you must install <link
- xlink:href="http://cygwin.com/">Cygwin</link> and run HBase within the Cygwin
- environment. This provides support for Linux/Unix commands and scripts. The full details are explained in the <link
- xlink:href="http://hbase.apache.org/cygwin.html">Windows Installation</link> guide. Also <link
- xlink:href="http://search-hadoop.com/?q=hbase+windows&fc_project=HBase&fc_type=mail+_hash_+dev">search
- our user mailing list</link> to pick up latest fixes figured by Windows users.</para>
- <para>Post-hbase-0.96.0, hbase runs natively on windows with supporting
- <command>*.cmd</command> scripts bundled. </para></listitem>
- </varlistentry>
-
- </variablelist>
- <!-- OS -->
-
- <section
- xml:id="hadoop">
- <title><link
- xlink:href="http://hadoop.apache.org">Hadoop</link><indexterm>
- <primary>Hadoop</primary>
- </indexterm></title>
- <para>The following table summarizes the versions of Hadoop supported with each version of
- HBase. Based on the version of HBase, you should select the most
- appropriate version of Hadoop. You can use Apache Hadoop, or a vendor's distribution of
- Hadoop. No distinction is made here. See <link
- xlink:href="http://wiki.apache.org/hadoop/Distributions%20and%20Commercial%20Support" />
- for information about vendors of Hadoop.</para>
- <tip>
- <title>Hadoop 2.x is recommended.</title>
- <para>Hadoop 2.x is faster and includes features, such as short-circuit reads, which will
- help improve your HBase random read profile. Hadoop 2.x also includes important bug fixes
- that will improve your overall HBase experience. HBase 0.98 drops support for Hadoop 1.0, deprecates use of Hadoop 1.1+,
- and HBase 1.0 will not support Hadoop 1.x.</para>
- </tip>
- <para>Use the following legend to interpret this table:</para>
- <simplelist
- type="vert"
- columns="1">
- <member>S = supported and tested,</member>
- <member>X = not supported,</member>
- <member>NT = it should run, but not tested enough.</member>
- </simplelist>
-
- <table>
- <title>Hadoop version support matrix</title>
- <tgroup
- cols="6"
- align="left"
- colsep="1"
- rowsep="1">
- <colspec
- colname="c1"
- align="left" />
- <colspec
- colname="c2"
- align="center" />
- <colspec
- colname="c3"
- align="center" />
- <colspec
- colname="c4"
- align="center" />
- <colspec
- colname="c5"
- align="center" />
- <colspec
- colname="c6"
- align="center" />
- <thead>
- <row>
- <entry> </entry>
- <entry>HBase-0.92.x</entry>
- <entry>HBase-0.94.x</entry>
- <entry>HBase-0.96.x</entry>
- <entry><para>HBase-0.98.x (Support for Hadoop 1.1+ is deprecated.)</para></entry>
- <entry><para>HBase-1.0.x (Hadoop 1.x is NOT supported)</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Hadoop-0.20.205</entry>
- <entry>S</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-0.22.x </entry>
- <entry>S</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-1.0.x</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-1.1.x </entry>
- <entry>NT</entry>
- <entry>S</entry>
- <entry>S</entry>
- <entry>NT</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-0.23.x </entry>
- <entry>X</entry>
- <entry>S</entry>
- <entry>NT</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-2.0.x-alpha </entry>
- <entry>X</entry>
- <entry>NT</entry>
- <entry>X</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-2.1.0-beta </entry>
- <entry>X</entry>
- <entry>NT</entry>
- <entry>S</entry>
- <entry>X</entry>
- <entry>X</entry>
- </row>
- <row>
- <entry>Hadoop-2.2.0 </entry>
- <entry>X</entry>
- <entry><link linkend="hadoop2.hbase-0.94">NT</link></entry>
- <entry>S</entry>
- <entry>S</entry>
- <entry>NT</entry>
- </row>
- <row>
- <entry>Hadoop-2.3.x</entry>
- <entry>X</entry>
- <entry>NT</entry>
- <entry>S</entry>
- <entry>S</entry>
- <entry>NT</entry>
- </row>
- <row>
- <entry>Hadoop-2.4.x</entry>
- <entry>X</entry>
- <entry>NT</entry>
- <entry>S</entry>
- <entry>S</entry>
- <entry>S</entry>
- </row>
- <row>
- <entry>Hadoop-2.5.x</entry>
- <entry>X</entry>
- <entry>NT</entry>
- <entry>S</entry>
- <entry>S</entry>
- <entry>S</entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <note
- xml:id="replace.hadoop">
- <title>Replace the Hadoop Bundled With HBase!</title>
- <para> Because HBase depends on Hadoop, it bundles an instance of the Hadoop jar under its
- <filename>lib</filename> directory. The bundled jar is ONLY for use in standalone mode.
- In distributed mode, it is <emphasis>critical</emphasis> that the version of Hadoop that
- is out on your cluster match what is under HBase. Replace the hadoop jar found in the
- HBase lib directory with the hadoop jar you are running on your cluster to avoid version
- mismatch issues. Make sure you replace the jar in HBase everywhere on your cluster. Hadoop
- version mismatch issues have various manifestations but often all looks like its hung up.
- </para>
- </note>
- <section
- xml:id="hadoop2.hbase-0.94">
- <title>Apache HBase 0.94 with Hadoop 2</title>
- <para>To get 0.94.x to run on hadoop 2.2.0, you need to change the hadoop
- 2 and protobuf versions in the <filename>pom.xml</filename>: Here is a diff with
- pom.xml changes: </para>
- <programlisting><![CDATA[$ svn diff pom.xml
-Index: pom.xml
-===================================================================
---- pom.xml (revision 1545157)
-+++ pom.xml (working copy)
-@@ -1034,7 +1034,7 @@
- <slf4j.version>1.4.3</slf4j.version>
- <log4j.version>1.2.16</log4j.version>
- <mockito-all.version>1.8.5</mockito-all.version>
-- <protobuf.version>2.4.0a</protobuf.version>
-+ <protobuf.version>2.5.0</protobuf.version>
- <stax-api.version>1.0.1</stax-api.version>
- <thrift.version>0.8.0</thrift.version>
- <zookeeper.version>3.4.5</zookeeper.version>
-@@ -2241,7 +2241,7 @@
- </property>
- </activation>
- <properties>
-- <hadoop.version>2.0.0-alpha</hadoop.version>
-+ <hadoop.version>2.2.0</hadoop.version>
- <slf4j.version>1.6.1</slf4j.version>
- </properties>
- <dependencies>]]>
- </programlisting>
- <para>The next step is to regenerate Protobuf files and assuming that the Protobuf
- has been installed:</para>
- <itemizedlist>
- <listitem>
- <para>Go to the hbase root folder, using the command line;</para>
- </listitem>
- <listitem>
- <para>Type the following commands:</para>
- <para>
- <programlisting language="bourne"><![CDATA[$ protoc -Isrc/main/protobuf --java_out=src/main/java src/main/protobuf/hbase.proto]]></programlisting>
- </para>
- <para>
- <programlisting language="bourne"><![CDATA[$ protoc -Isrc/main/protobuf --java_out=src/main/java src/main/protobuf/ErrorHandling.proto]]></programlisting>
- </para>
- </listitem>
- </itemizedlist>
- <para> Building against the hadoop 2 profile by running something like the
- following command: </para>
- <screen language="bourne">$ mvn clean install assembly:single -Dhadoop.profile=2.0 -DskipTests</screen>
- </section>
- <section
- xml:id="hadoop.hbase-0.94">
- <title>Apache HBase 0.92 and 0.94</title>
- <para>HBase 0.92 and 0.94 versions can work with Hadoop versions, 0.20.205, 0.22.x, 1.0.x,
- and 1.1.x. HBase-0.94 can additionally work with Hadoop-0.23.x and 2.x, but you may have
- to recompile the code using the specific maven profile (see top level pom.xml)</para>
- </section>
-
- <section
- xml:id="hadoop.hbase-0.96">
- <title>Apache HBase 0.96</title>
- <para> As of Apache HBase 0.96.x, Apache Hadoop 1.0.x at least is required. Hadoop 2 is
- strongly encouraged (faster but also has fixes that help MTTR). We will no longer run
- properly on older Hadoops such as 0.20.205 or branch-0.20-append. Do not move to Apache
- HBase 0.96.x if you cannot upgrade your Hadoop.. See <link
- xlink:href="http://search-hadoop.com/m/7vFVx4EsUb2">HBase, mail # dev - DISCUSS:
- Have hbase require at least hadoop 1.0.0 in hbase 0.96.0?</link></para>
- </section>
-
- <section
- xml:id="hadoop.older.versions">
- <title>Hadoop versions 0.20.x - 1.x</title>
- <para> HBase will lose data unless it is running on an HDFS that has a durable
- <code>sync</code> implementation. DO NOT use Hadoop 0.20.2, Hadoop 0.20.203.0, and
- Hadoop 0.20.204.0 which DO NOT have this attribute. Currently only Hadoop versions
- 0.20.205.x or any release in excess of this version -- this includes hadoop-1.0.0 -- have
- a working, durable sync. The Cloudera blog post <link
- xlink:href="http://www.cloudera.com/blog/2012/01/an-update-on-apache-hadoop-1-0/">An
- update on Apache Hadoop 1.0</link> by Charles Zedlweski has a nice exposition on how all
- the Hadoop versions relate. Its worth checking out if you are having trouble making sense
- of the Hadoop version morass. </para>
- <para>Sync has to be explicitly enabled by setting
- <varname>dfs.support.append</varname> equal to true on both the client side -- in
- <filename>hbase-site.xml</filename> -- and on the serverside in
- <filename>hdfs-site.xml</filename> (The sync facility HBase needs is a subset of the
- append code path).</para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>dfs.support.append</name>
- <value>true</value>
-</property>]]></programlisting>
- <para> You will have to restart your cluster after making this edit. Ignore the
- chicken-little comment you'll find in the <filename>hdfs-default.xml</filename> in the
- description for the <varname>dfs.support.append</varname> configuration. </para>
- </section>
- <section
- xml:id="hadoop.security">
- <title>Apache HBase on Secure Hadoop</title>
- <para>Apache HBase will run on any Hadoop 0.20.x that incorporates Hadoop security features
- as long as you do as suggested above and replace the Hadoop jar that ships with HBase with
- the secure version. If you want to read more about how to setup Secure HBase, see <xref
- linkend="hbase.secure.configuration" />.</para>
- </section>
-
- <section
- xml:id="dfs.datanode.max.transfer.threads">
- <title><varname>dfs.datanode.max.transfer.threads</varname><indexterm>
- <primary>dfs.datanode.max.transfer.threads</primary>
- </indexterm></title>
-
- <para>An HDFS datanode has an upper bound on the number of files that it will serve
- at any one time. Before doing any loading, make sure you have configured
- Hadoop's <filename>conf/hdfs-site.xml</filename>, setting the
- <varname>dfs.datanode.max.transfer.threads</varname> value to at least the following:
- </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>dfs.datanode.max.transfer.threads</name>
- <value>4096</value>
-</property>
- ]]></programlisting>
-
- <para>Be sure to restart your HDFS after making the above configuration.</para>
-
- <para>Not having this configuration in place makes for strange-looking failures. One
- manifestation is a complaint about missing blocks. For example:</para>
- <screen>10/12/08 20:10:31 INFO hdfs.DFSClient: Could not obtain block
- blk_XXXXXXXXXXXXXXXXXXXXXX_YYYYYYYY from any node: java.io.IOException: No live nodes
- contain current block. Will get new block locations from namenode and retry...</screen>
- <para>See also <xref linkend="casestudies.max.transfer.threads" /> and note that this
- property was previously known as <varname>dfs.datanode.max.xcievers</varname> (e.g.
- <link
- xlink:href="http://ccgtech.blogspot.com/2010/02/hadoop-hdfs-deceived-by-xciever.html">
- Hadoop HDFS: Deceived by Xciever</link>).
- </para>
-
-
- </section>
- </section>
- <!-- hadoop -->
- <section xml:id="zookeeper.requirements">
- <title>ZooKeeper Requirements</title>
- <para>ZooKeeper 3.4.x is required as of HBase 1.0.0. HBase makes use of the
- <methodname>multi</methodname> functionality that is only available since 3.4.0
- (The <property>useMulti</property> is defaulted true in HBase 1.0.0).
- See <link href="https://issues.apache.org/jira/browse/HBASE-12241">HBASE-12241 The crash of regionServer when taking deadserver's replication queue breaks replication</link>
- and <link href="https://issues.apache.org/jira/browse/HBASE-6775">Use ZK.multi when available for HBASE-6710 0.92/0.94 compatibility fix</link> for background.</para>
- </section>
- </section>
-
- <section
- xml:id="standalone_dist">
- <title>HBase run modes: Standalone and Distributed</title>
-
- <para>HBase has two run modes: <xref
- linkend="standalone" /> and <xref
- linkend="distributed" />. Out of the box, HBase runs in standalone mode. Whatever your mode,
- you will need to configure HBase by editing files in the HBase <filename>conf</filename>
- directory. At a minimum, you must edit <code>conf/hbase-env.sh</code> to tell HBase which
- <command>java</command> to use. In this file you set HBase environment variables such as the
- heapsize and other options for the <application>JVM</application>, the preferred location for
- log files, etc. Set <varname>JAVA_HOME</varname> to point at the root of your
- <command>java</command> install.</para>
-
- <section
- xml:id="standalone">
- <title>Standalone HBase</title>
-
- <para>This is the default mode. Standalone mode is what is described in the <xref
- linkend="quickstart" /> section. In standalone mode, HBase does not use HDFS -- it uses
- the local filesystem instead -- and it runs all HBase daemons and a local ZooKeeper all up
- in the same JVM. Zookeeper binds to a well known port so clients may talk to HBase.</para>
- </section>
-
- <section
- xml:id="distributed">
- <title>Distributed</title>
-
- <para>Distributed mode can be subdivided into distributed but all daemons run on a single node
- -- a.k.a <emphasis>pseudo-distributed</emphasis>-- and
- <emphasis>fully-distributed</emphasis> where the daemons are spread across all nodes in
- the cluster. The pseudo-distributed vs fully-distributed nomenclature comes from Hadoop.</para>
-
- <para>Pseudo-distributed mode can run against the local filesystem or it can run against an
- instance of the <emphasis>Hadoop Distributed File System</emphasis> (HDFS).
- Fully-distributed mode can ONLY run on HDFS. See the Hadoop <link
- xlink:href="http://hadoop.apache.org/common/docs/r1.1.1/api/overview-summary.html#overview_description">
- requirements and instructions</link> for how to set up HDFS for Hadoop 1.x. A good
- walk-through for setting up HDFS on Hadoop 2 is at <link
- xlink:href="http://www.alexjf.net/blog/distributed-systems/hadoop-yarn-installation-definitive-guide">http://www.alexjf.net/blog/distributed-systems/hadoop-yarn-installation-definitive-guide</link>.</para>
-
- <para>Below we describe the different distributed setups. Starting, verification and
- exploration of your install, whether a <emphasis>pseudo-distributed</emphasis> or
- <emphasis>fully-distributed</emphasis> configuration is described in a section that
- follows, <xref
- linkend="confirm" />. The same verification script applies to both deploy types.</para>
- <section
- xml:id="pseudo">
- <title>Pseudo-distributed</title>
- <note>
- <title>Pseudo-Distributed Quickstart</title>
- <para>A quickstart has been added to the <xref
- linkend="quickstart" /> chapter. See <xref
- linkend="quickstart-pseudo" />. Some of the information that was originally in this
- section has been moved there.</para>
- </note>
-
- <para>A pseudo-distributed mode is simply a fully-distributed mode run on a single host. Use
- this configuration testing and prototyping on HBase. Do not use this configuration for
- production nor for evaluating HBase performance.</para>
-
- </section>
-
- </section>
-
- <section
- xml:id="fully_dist">
- <title>Fully-distributed</title>
- <para>By default, HBase runs in standalone mode. Both standalone mode and pseudo-distributed
- mode are provided for the purposes of small-scale testing. For a production environment,
- distributed mode is appropriate. In distributed mode, multiple instances of HBase daemons
- run on multiple servers in the cluster.</para>
- <para>Just as in pseudo-distributed mode, a fully distributed configuration requires that you
- set the <code>hbase-cluster.distributed</code> property to <literal>true</literal>.
- Typically, the <code>hbase.rootdir</code> is configured to point to a highly-available HDFS
- filesystem. </para>
- <para>In addition, the cluster is configured so that multiple cluster nodes enlist as
- RegionServers, ZooKeeper QuorumPeers, and backup HMaster servers. These configuration basics
- are all demonstrated in <xref
- linkend="quickstart-fully-distributed" />.</para>
-
- <formalpara
- xml:id="regionserver">
- <title>Distributed RegionServers</title>
- <para>Typically, your cluster will contain multiple RegionServers all running on different
- servers, as well as primary and backup Master and Zookeeper daemons. The
- <filename>conf/regionservers</filename> file on the master server contains a list of
- hosts whose RegionServers are associated with this cluster. Each host is on a separate
- line. All hosts listed in this file will have their RegionServer processes started and
- stopped when the master server starts or stops.</para>
- </formalpara>
-
- <formalpara
- xml:id="hbase.zookeeper">
- <title>ZooKeeper and HBase</title>
- <para>See section <xref
- linkend="zookeeper" /> for ZooKeeper setup for HBase.</para>
- </formalpara>
-
- <example>
- <title>Example Distributed HBase Cluster</title>
- <para>This is a bare-bones <filename>conf/hbase-site.xml</filename> for a distributed HBase
- cluster. A cluster that is used for real-world work would contain more custom
- configuration parameters. Most HBase configuration directives have default values, which
- are used unless the value is overridden in the <filename>hbase-site.xml</filename>. See <xref
- linkend="config.files" /> for more information.</para>
- <programlisting language="xml"><![CDATA[
-<configuration>
- <property>
- <name>hbase.rootdir</name>
- <value>hdfs://namenode.example.org:8020/hbase</value>
- </property>
- <property>
- <name>hbase.cluster.distributed</name>
- <value>true</value>
- </property>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>node-a.example.com,node-b.example.com,node-c.example.com</value>
- </property>
-</configuration>
-]]>
- </programlisting>
- <para>This is an example <filename>conf/regionservers</filename> file, which contains a list
- of each node that should run a RegionServer in the cluster. These nodes need HBase
- installed and they need to use the same contents of the <filename>conf/</filename>
- directory as the Master server..</para>
- <programlisting>
-node-a.example.com
-node-b.example.com
-node-c.example.com
- </programlisting>
- <para>This is an example <filename>conf/backup-masters</filename> file, which contains a
- list of each node that should run a backup Master instance. The backup Master instances
- will sit idle unless the main Master becomes unavailable.</para>
- <programlisting>
-node-b.example.com
-node-c.example.com
- </programlisting>
- </example>
- <formalpara>
- <title>Distributed HBase Quickstart</title>
- <para>See <xref
- linkend="quickstart-fully-distributed" /> for a walk-through of a simple three-node
- cluster configuration with multiple ZooKeeper, backup HMaster, and RegionServer
- instances.</para>
- </formalpara>
-
- <procedure
- xml:id="hdfs_client_conf">
- <title>HDFS Client Configuration</title>
- <step>
- <para>Of note, if you have made HDFS client configuration on your Hadoop cluster, such as
- configuration directives for HDFS clients, as opposed to server-side configurations, you
- must use one of the following methods to enable HBase to see and use these configuration
- changes:</para>
- <stepalternatives>
- <step>
- <para>Add a pointer to your <varname>HADOOP_CONF_DIR</varname> to the
- <varname>HBASE_CLASSPATH</varname> environment variable in
- <filename>hbase-env.sh</filename>.</para>
- </step>
-
- <step>
- <para>Add a copy of <filename>hdfs-site.xml</filename> (or
- <filename>hadoop-site.xml</filename>) or, better, symlinks, under
- <filename>${HBASE_HOME}/conf</filename>, or</para>
- </step>
-
- <step>
- <para>if only a small set of HDFS client configurations, add them to
- <filename>hbase-site.xml</filename>.</para>
- </step>
- </stepalternatives>
- </step>
- </procedure>
- <para>An example of such an HDFS client configuration is <varname>dfs.replication</varname>.
- If for example, you want to run with a replication factor of 5, hbase will create files with
- the default of 3 unless you do the above to make the configuration available to
- HBase.</para>
- </section>
- </section>
-
- <section
- xml:id="confirm">
- <title>Running and Confirming Your Installation</title>
-
-
-
- <para>Make sure HDFS is running first. Start and stop the Hadoop HDFS daemons by running
- <filename>bin/start-hdfs.sh</filename> over in the <varname>HADOOP_HOME</varname>
- directory. You can ensure it started properly by testing the <command>put</command> and
- <command>get</command> of files into the Hadoop filesystem. HBase does not normally use
- the mapreduce daemons. These do not need to be started.</para>
- <para><emphasis>If</emphasis> you are managing your own ZooKeeper, start it and confirm its
- running else, HBase will start up ZooKeeper for you as part of its start process.</para>
- <para>Start HBase with the following command:</para>
- <screen>bin/start-hbase.sh</screen>
- <para>Run the above from the <varname>HBASE_HOME</varname> directory.</para>
- <para>You should now have a running HBase instance. HBase logs can be found in the
- <filename>logs</filename> subdirectory. Check them out especially if HBase had trouble
- starting.</para>
-
- <para>HBase also puts up a UI listing vital attributes. By default its deployed on the Master
- host at port 16010 (HBase RegionServers listen on port 16020 by default and put up an
- informational http server at 16030). If the Master were running on a host named
- <varname>master.example.org</varname> on the default port, to see the Master's homepage
- you'd point your browser at <filename>http://master.example.org:16010</filename>.</para>
-
- <para>Prior to HBase 0.98, the default ports the master ui was deployed on port 16010, and the
- HBase RegionServers would listen on port 16020 by default and put up an informational http
- server at 16030. </para>
-
- <para>Once HBase has started, see the <xref
- linkend="shell_exercises" /> for how to create tables, add data, scan your insertions, and
- finally disable and drop your tables.</para>
-
- <para>To stop HBase after exiting the HBase shell enter</para>
- <screen language="bourne">$ ./bin/stop-hbase.sh
-stopping hbase...............</screen>
- <para>Shutdown can take a moment to complete. It can take longer if your cluster is comprised
- of many machines. If you are running a distributed operation, be sure to wait until HBase
- has shut down completely before stopping the Hadoop daemons.</para>
- </section>
-
- <!-- run modes -->
-
-
-
- <section
- xml:id="config.files">
- <title>Configuration Files</title>
-
- <section
- xml:id="hbase.site">
- <title><filename>hbase-site.xml</filename> and <filename>hbase-default.xml</filename></title>
- <para>Just as in Hadoop where you add site-specific HDFS configuration to the
- <filename>hdfs-site.xml</filename> file, for HBase, site specific customizations go into
- the file <filename>conf/hbase-site.xml</filename>. For the list of configurable properties,
- see <xref
- linkend="hbase_default_configurations" /> below or view the raw
- <filename>hbase-default.xml</filename> source file in the HBase source code at
- <filename>src/main/resources</filename>. </para>
- <para> Not all configuration options make it out to <filename>hbase-default.xml</filename>.
- Configuration that it is thought rare anyone would change can exist only in code; the only
- way to turn up such configurations is via a reading of the source code itself. </para>
- <para> Currently, changes here will require a cluster restart for HBase to notice the change. </para>
- <!--The file hbase-default.xml is generated as part of
- the build of the hbase site. See the hbase pom.xml.
- The generated file is a docbook section with a glossary
- in it-->
- <!--presumes the pre-site target has put the hbase-default.xml at this location-->
- <xi:include
- xmlns:xi="http://www.w3.org/2001/XInclude"
- href="../../../target/docbkx/hbase-default.xml">
- <xi:fallback>
- <section
- xml:id="hbase_default_configurations">
- <title />
- <para>
- <emphasis>This file is fallback content</emphasis>. If you are seeing this, something
- is wrong with the build of the HBase documentation or you are doing pre-build
- verification. </para>
- <para> The file hbase-default.xml is generated as part of the build of the hbase site.
- See the hbase <filename>pom.xml</filename>. The generated file is a docbook glossary. </para>
- <section>
- <title>IDs that are auto-generated and cause validation errors if not present</title>
- <para> Each of these is a reference to a configuration file parameter which will cause
- an error if you are using the fallback content here. This is a dirty dirty hack. </para>
- <section
- xml:id="fail.fast.expired.active.master">
- <title>fail.fast.expired.active.master</title>
- <para />
- </section>
- <section
- xml:id="hbase.hregion.memstore.flush.size">
- <title>"hbase.hregion.memstore.flush.size"</title>
- <para />
- </section>
- <section
- xml:id="hbase.hstore.bytes.per.checksum">
- <title>hbase.hstore.bytes.per.checksum</title>
- <para />
- </section>
- <section
- xml:id="hbase.online.schema.update.enable">
- <title>hbase.online.schema.update.enable</title>
- <para />
- </section>
- <section
- xml:id="hbase.regionserver.global.memstore.size">
- <title>hbase.regionserver.global.memstore.size</title>
- <para />
- </section>
- <section
- xml:id="hbase.hregion.max.filesize">
- <title>hbase.hregion.max.filesize</title>
- <para />
- </section>
- <section
- xml:id="hbase.hstore.blockingStoreFiles">
- <title>hbase.hstore.BlockingStoreFiles</title>
- <para />
- </section>
- <section
- xml:id="hfile.block.cache.size">
- <title>hfile.block.cache.size</title>
- <para />
- </section>
- <section
- xml:id="copy.table">
- <title>copy.table</title>
- <para />
- </section>
- <section
- xml:id="hbase.hstore.checksum.algorithm">
- <title>hbase.hstore.checksum.algorithm</title>
- <para />
- </section>
- <section
- xml:id="hbase.zookeeper.useMulti">
- <title>hbase.zookeeper.useMulti</title>
- <para />
- </section>
- <section
- xml:id="hbase.hregion.memstore.block.multiplier">
- <title>hbase.hregion.memstore.block.multiplier</title>
- <para />
- </section>
- <section
- xml:id="hbase.regionserver.global.memstore.size.lower.limit">
- <title>hbase.regionserver.global.memstore.size.lower.limit</title>
- <para />
- </section>
- </section>
- </section>
- </xi:fallback>
- </xi:include>
- </section>
-
- <section
- xml:id="hbase.env.sh">
- <title><filename>hbase-env.sh</filename></title>
- <para>Set HBase environment variables in this file. Examples include options to pass the JVM
- on start of an HBase daemon such as heap size and garbage collector configs. You can also
- set configurations for HBase configuration, log directories, niceness, ssh options, where to
- locate process pid files, etc. Open the file at <filename>conf/hbase-env.sh</filename> and
- peruse its content. Each option is fairly well documented. Add your own environment
- variables here if you want them read by HBase daemons on startup.</para>
- <para> Changes here will require a cluster restart for HBase to notice the change. </para>
- </section>
-
- <section
- xml:id="log4j">
- <title><filename>log4j.properties</filename></title>
- <para>Edit this file to change rate at which HBase files are rolled and to change the level at
- which HBase logs messages. </para>
- <para> Changes here will require a cluster restart for HBase to notice the change though log
- levels can be changed for particular daemons via the HBase UI. </para>
- </section>
-
- <section
- xml:id="client_dependencies">
- <title>Client configuration and dependencies connecting to an HBase cluster</title>
- <para>If you are running HBase in standalone mode, you don't need to configure anything for
- your client to work provided that they are all on the same machine.</para>
- <para> Since the HBase Master may move around, clients bootstrap by looking to ZooKeeper for
- current critical locations. ZooKeeper is where all these values are kept. Thus clients
- require the location of the ZooKeeper ensemble information before they can do anything else.
- Usually this the ensemble location is kept out in the <filename>hbase-site.xml</filename>
- and is picked up by the client from the <varname>CLASSPATH</varname>.</para>
-
- <para>If you are configuring an IDE to run a HBase client, you should include the
- <filename>conf/</filename> directory on your classpath so
- <filename>hbase-site.xml</filename> settings can be found (or add
- <filename>src/test/resources</filename> to pick up the hbase-site.xml used by tests). </para>
- <para> Minimally, a client of HBase needs several libraries in its
- <varname>CLASSPATH</varname> when connecting to a cluster, including:
- <programlisting>
-commons-configuration (commons-configuration-1.6.jar)
-commons-lang (commons-lang-2.5.jar)
-commons-logging (commons-logging-1.1.1.jar)
-hadoop-core (hadoop-core-1.0.0.jar)
-hbase (hbase-0.92.0.jar)
-log4j (log4j-1.2.16.jar)
-slf4j-api (slf4j-api-1.5.8.jar)
-slf4j-log4j (slf4j-log4j12-1.5.8.jar)
-zookeeper (zookeeper-3.4.2.jar)</programlisting>
- </para>
- <para> An example basic <filename>hbase-site.xml</filename> for client only might look as
- follows: <programlisting language="xml"><![CDATA[
-<?xml version="1.0"?>
-<?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
-<configuration>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>example1,example2,example3</value>
- <description>The directory shared by region servers.
- </description>
- </property>
-</configuration>
-]]></programlisting>
- </para>
-
- <section
- xml:id="java.client.config">
- <title>Java client configuration</title>
- <para>The configuration used by a Java client is kept in an <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HBaseConfiguration">HBaseConfiguration</link>
- instance. The factory method on HBaseConfiguration,
- <code>HBaseConfiguration.create();</code>, on invocation, will read in the content of
- the first <filename>hbase-site.xml</filename> found on the client's
- <varname>CLASSPATH</varname>, if one is present (Invocation will also factor in any
- <filename>hbase-default.xml</filename> found; an hbase-default.xml ships inside the
- <filename>hbase.X.X.X.jar</filename>). It is also possible to specify configuration
- directly without having to read from a <filename>hbase-site.xml</filename>. For example,
- to set the ZooKeeper ensemble for the cluster programmatically do as follows:
- <programlisting language="java">Configuration config = HBaseConfiguration.create();
-config.set("hbase.zookeeper.quorum", "localhost"); // Here we are running zookeeper locally</programlisting>
- If multiple ZooKeeper instances make up your ZooKeeper ensemble, they may be specified in
- a comma-separated list (just as in the <filename>hbase-site.xml</filename> file). This
- populated <classname>Configuration</classname> instance can then be passed to an <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html">HTable</link>,
- and so on. </para>
- </section>
- </section>
-
- </section>
- <!-- config files -->
-
- <section
- xml:id="example_config">
- <title>Example Configurations</title>
-
- <section>
- <title>Basic Distributed HBase Install</title>
-
- <para>Here is an example basic configuration for a distributed ten node cluster. The nodes are
- named <varname>example0</varname>, <varname>example1</varname>, etc., through node
- <varname>example9</varname> in this example. The HBase Master and the HDFS namenode are
- running on the node <varname>example0</varname>. RegionServers run on nodes
- <varname>example1</varname>-<varname>example9</varname>. A 3-node ZooKeeper ensemble runs
- on <varname>example1</varname>, <varname>example2</varname>, and <varname>example3</varname>
- on the default ports. ZooKeeper data is persisted to the directory
- <filename>/export/zookeeper</filename>. Below we show what the main configuration files --
- <filename>hbase-site.xml</filename>, <filename>regionservers</filename>, and
- <filename>hbase-env.sh</filename> -- found in the HBase <filename>conf</filename>
- directory might look like.</para>
-
- <section
- xml:id="hbase_site">
- <title><filename>hbase-site.xml</filename></title>
-
- <programlisting language="bourne">
-<![CDATA[
-<?xml version="1.0"?>
-<?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
-<configuration>
- <property>
- <name>hbase.zookeeper.quorum</name>
- <value>example1,example2,example3</value>
- <description>The directory shared by RegionServers.
- </description>
- </property>
- <property>
- <name>hbase.zookeeper.property.dataDir</name>
- <value>/export/zookeeper</value>
- <description>Property from ZooKeeper config zoo.cfg.
- The directory where the snapshot is stored.
- </description>
- </property>
- <property>
- <name>hbase.rootdir</name>
- <value>hdfs://example0:8020/hbase</value>
- <description>The directory shared by RegionServers.
- </description>
- </property>
- <property>
- <name>hbase.cluster.distributed</name>
- <value>true</value>
- <description>The mode the cluster will be in. Possible values are
- false: standalone and pseudo-distributed setups with managed Zookeeper
- true: fully-distributed with unmanaged Zookeeper Quorum (see hbase-env.sh)
- </description>
- </property>
-</configuration>
-]]>
- </programlisting>
- </section>
-
- <section
- xml:id="regionservers">
- <title><filename>regionservers</filename></title>
-
- <para>In this file you list the nodes that will run RegionServers. In our case, these nodes
- are <varname>example1</varname>-<varname>example9</varname>. </para>
-
- <programlisting>
-example1
-example2
-example3
-example4
-example5
-example6
-example7
-example8
-example9
- </programlisting>
- </section>
-
- <section
- xml:id="hbase_env">
- <title><filename>hbase-env.sh</filename></title>
-
- <para>The following lines in the <filename>hbase-env.sh</filename> file show how to set the
- <envar>JAVA_HOME</envar> environment variable (required for HBase 0.98.5 and newer) and
- set the heap to 4 GB (rather than the default value of 1 GB). If you copy and paste this
- example, be sure to adjust the <envar>JAVA_HOME</envar> to suit your environment.</para>
-
- <screen language="bourne">
-# The java implementation to use.
-export JAVA_HOME=/usr/java/jdk1.7.0/
-
-# The maximum amount of heap to use, in MB. Default is 1000.
-export HBASE_HEAPSIZE=4096
- </screen>
-
- <para>Use <command>rsync</command> to copy the content of the <filename>conf</filename>
- directory to all nodes of the cluster.</para>
- </section>
- </section>
- </section>
- <!-- example config -->
-
-
- <section
- xml:id="important_configurations">
- <title>The Important Configurations</title>
- <para>Below we list what the <emphasis>important</emphasis> Configurations. We've divided this
- section into required configuration and worth-a-look recommended configs. </para>
-
-
- <section
- xml:id="required_configuration">
- <title>Required Configurations</title>
- <para>Review the <xref
- linkend="os" /> and <xref
- linkend="hadoop" /> sections. </para>
- <section
- xml:id="big.cluster.config">
- <title>Big Cluster Configurations</title>
- <para>If a cluster with a lot of regions, it is possible if an eager beaver regionserver
- checks in soon after master start while all the rest in the cluster are laggardly, this
- first server to checkin will be assigned all regions. If lots of regions, this first
- server could buckle under the load. To prevent the above scenario happening up the
- <varname>hbase.master.wait.on.regionservers.mintostart</varname> from its default value
- of 1. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-6389">HBASE-6389 Modify the
- conditions to ensure that Master waits for sufficient number of Region Servers before
- starting region assignments</link> for more detail. </para>
- </section>
- <section
- xml:id="backup.master.fail.fast">
- <title>If a backup Master, making primary Master fail fast</title>
- <para>If the primary Master loses its connection with ZooKeeper, it will fall into a loop
- where it keeps trying to reconnect. Disable this functionality if you are running more
- than one Master: i.e. a backup Master. Failing to do so, the dying Master may continue to
- receive RPCs though another Master has assumed the role of primary. See the configuration <xref
- linkend="fail.fast.expired.active.master" />. </para>
- </section>
- </section>
-
- <section
- xml:id="recommended_configurations">
- <title>Recommended Configurations</title>
- <section
- xml:id="recommended_configurations.zk">
- <title>ZooKeeper Configuration</title>
- <section
- xml:id="sect.zookeeper.session.timeout">
- <title><varname>zookeeper.session.timeout</varname></title>
- <para>The default timeout is three minutes (specified in milliseconds). This means that if
- a server crashes, it will be three minutes before the Master notices the crash and
- starts recovery. You might like to tune the timeout down to a minute or even less so the
- Master notices failures the sooner. Before changing this value, be sure you have your
- JVM garbage collection configuration under control otherwise, a long garbage collection
- that lasts beyond the ZooKeeper session timeout will take out your RegionServer (You
- might be fine with this -- you probably want recovery to start on the server if a
- RegionServer has been in GC for a long period of time).</para>
-
- <para>To change this configuration, edit <filename>hbase-site.xml</filename>, copy the
- changed file around the cluster and restart.</para>
-
- <para>We set this value high to save our having to field noob questions up on the mailing
- lists asking why a RegionServer went down during a massive import. The usual cause is
- that their JVM is untuned and they are running into long GC pauses. Our thinking is that
- while users are getting familiar with HBase, we'd save them having to know all of its
- intricacies. Later when they've built some confidence, then they can play with
- configuration such as this. </para>
- </section>
- <section
- xml:id="zookeeper.instances">
- <title>Number of ZooKeeper Instances</title>
- <para>See <xref
- linkend="zookeeper" />. </para>
- </section>
- </section>
- <section
- xml:id="recommended.configurations.hdfs">
- <title>HDFS Configurations</title>
- <section
- xml:id="dfs.datanode.failed.volumes.tolerated">
- <title>dfs.datanode.failed.volumes.tolerated</title>
- <para>This is the "...number of volumes that are allowed to fail before a datanode stops
- offering service. By default any volume failure will cause a datanode to shutdown" from
- the <filename>hdfs-default.xml</filename> description. If you have > three or four
- disks, you might want to set this to 1 or if you have many disks, two or more. </para>
- </section>
- </section>
- <section
- xml:id="hbase.regionserver.handler.count-description">
- <title><varname>hbase.regionserver.handler.count</varname></title>
- <para> This setting defines the number of threads that are kept open to answer incoming
- requests to user tables. The rule of thumb is to keep this number low when the payload per
- request approaches the MB (big puts, scans using a large cache) and high when the payload
- is small (gets, small puts, ICVs, deletes). The total size of the queries in progress is
- limited by the setting "hbase.ipc.server.max.callqueue.size". </para>
- <para> It is safe to set that number to the maximum number of incoming clients if their
- payload is small, the typical example being a cluster that serves a website since puts
- aren't typically buffered and most of the operations are gets. </para>
- <para> The reason why it is dangerous to keep this setting high is that the aggregate size
- of all the puts that are currently happening in a region server may impose too much
- pressure on its memory, or even trigger an OutOfMemoryError. A region server running on
- low memory will trigger its JVM's garbage collector to run more frequently up to a point
- where GC pauses become noticeable (the reason being that all the memory used to keep all
- the requests' payloads cannot be trashed, no matter how hard the garbage collector tries).
- After some time, the overall cluster throughput is affected since every request that hits
- that region server will take longer, which exacerbates the problem even more. </para>
- <para>You can get a sense of whether you have too little or too many handlers by <xref
- linkend="rpc.logging" /> on an individual RegionServer then tailing its logs (Queued
- requests consume memory). </para>
- </section>
- <section
- xml:id="big_memory">
- <title>Configuration for large memory machines</title>
- <para> HBase ships with a reasonable, conservative configuration that will work on nearly
- all machine types that people might want to test with. If you have larger machines --
- HBase has 8G and larger heap -- you might the following configuration options helpful.
- TODO. </para>
-
- </section>
-
- <section
- xml:id="config.compression">
- <title>Compression</title>
- <para>You should consider enabling ColumnFamily compression. There are several options that
- are near-frictionless and in most all cases boost performance by reducing the size of
- StoreFiles and thus reducing I/O. </para>
- <para>See <xref
- linkend="compression" /> for more information.</para>
- </section>
- <section
- xml:id="config.wals">
- <title>Configuring the size and number of WAL files</title>
- <para>HBase uses <xref
- linkend="wal" /> to recover the memstore data that has not been flushed to disk in case
- of an RS failure. These WAL files should be configured to be slightly smaller than HDFS
- block (by default, HDFS block is 64Mb and WAL file is ~60Mb).</para>
- <para>HBase also has a limit on number of WAL files, designed to ensure there's never too
- much data that needs to be replayed during recovery. This limit needs to be set according
- to memstore configuration, so that all the necessary data would fit. It is recommended to
- allocated enough WAL files to store at least that much data (when all memstores are close
- to full). For example, with 16Gb RS heap, default memstore settings (0.4), and default WAL
- file size (~60Mb), 16Gb*0.4/60, the starting point for WAL file count is ~109. However, as
- all memstores are not expected to be full all the time, less WAL files can be
- allocated.</para>
- </section>
- <section
- xml:id="disable.splitting">
- <title>Managed Splitting</title>
- <para>HBase generally handles splitting your regions, based upon the settings in your
- <filename>hbase-default.xml</filename> and <filename>hbase-site.xml</filename>
- configuration files. Important settings include
- <varname>hbase.regionserver.region.split.policy</varname>,
- <varname>hbase.hregion.max.filesize</varname>,
- <varname>hbase.regionserver.regionSplitLimit</varname>. A simplistic view of splitting
- is that when a region grows to <varname>hbase.hregion.max.filesize</varname>, it is split.
- For most use patterns, most of the time, you should use automatic splitting. See <xref
- linkend="manual_region_splitting_decisions"/> for more information about manual region
- splitting.</para>
- <para>Instead of allowing HBase to split your regions automatically, you can choose to
- manage the splitting yourself. This feature was added in HBase 0.90.0. Manually managing
- splits works if you know your keyspace well, otherwise let HBase figure where to split for you.
- Manual splitting can mitigate region creation and movement under load. It also makes it so
- region boundaries are known and invariant (if you disable region splitting). If you use manual
- splits, it is easier doing staggered, time-based major compactions spread out your network IO
- load.</para>
-
- <formalpara>
- <title>Disable Automatic Splitting</title>
- <para>To disable automatic splitting, set <varname>hbase.hregion.max.filesize</varname> to
- a very large value, such as <literal>100 GB</literal> It is not recommended to set it to
- its absolute maximum value of <literal>Long.MAX_VALUE</literal>.</para>
- </formalpara>
- <note>
- <title>Automatic Splitting Is Recommended</title>
- <para>If you disable automatic splits to diagnose a problem or during a period of fast
- data growth, it is recommended to re-enable them when your situation becomes more
- stable. The potential benefits of managing region splits yourself are not
- undisputed.</para>
- </note>
- <formalpara>
- <title>Determine the Optimal Number of Pre-Split Regions</title>
- <para>The optimal number of pre-split regions depends on your application and environment.
- A good rule of thumb is to start with 10 pre-split regions per server and watch as data
- grows over time. It is better to err on the side of too few regions and perform rolling
- splits later. The optimal number of regions depends upon the largest StoreFile in your
- region. The size of the largest StoreFile will increase with time if the amount of data
- grows. The goal is for the largest region to be just large enough that the compaction
- selection algorithm only compacts it during a timed major compaction. Otherwise, the
- cluster can be prone to compaction storms where a large number of regions under
- compaction at the same time. It is important to understand that the data growth causes
- compaction storms, and not the manual split decision.</para>
- </formalpara>
- <para>If the regions are split into too many large regions, you can increase the major
- compaction interval by configuring <varname>HConstants.MAJOR_COMPACTION_PERIOD</varname>.
- HBase 0.90 introduced <classname>org.apache.hadoop.hbase.util.RegionSplitter</classname>,
- which provides a network-IO-safe rolling split of all regions.</para>
- </section>
- <section
- xml:id="managed.compactions">
- <title>Managed Compactions</title>
- <para>By default, major compactions are scheduled to run once in a 7-day period. Prior to HBase 0.96.x, major
- compactions were scheduled to happen once per day by default.</para>
- <para>If you need to control exactly when and how often major compaction runs, you can
- disable managed major compactions. See the entry for
- <varname>hbase.hregion.majorcompaction</varname> in the <xref
- linkend="compaction.parameters" /> table for details.</para>
- <warning>
- <title>Do Not Disable Major Compactions</title>
- <para>Major compactions are absolutely necessary for StoreFile clean-up. Do not disable
- them altogether. You can run major compactions manually via the HBase shell or via the <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HBaseAdmin.html#majorCompact%28java.lang.String%29">HBaseAdmin
- API</link>.</para>
- </warning>
- <para>For more information about compactions and the compaction file selection process, see <xref
- linkend="compaction" /></para>
- </section>
-
- <section
- xml:id="spec.ex">
- <title>Speculative Execution</title>
- <para>Speculative Execution of MapReduce tasks is on by default, and for HBase clusters it
- is generally advised to turn off Speculative Execution at a system-level unless you need
- it for a specific case, where it can be configured per-job. Set the properties
- <varname>mapreduce.map.speculative</varname> and
- <varname>mapreduce.reduce.speculative</varname> to false. </para>
- </section>
- </section>
- <section xml:id="other_configuration"><title>Other Configurations</title>
- <section xml:id="balancer_config"><title>Balancer</title>
- <para>The balancer is a periodic operation which is run on the master to redistribute regions on the cluster. It is configured via
- <varname>hbase.balancer.period</varname> and defaults to 300000 (5 minutes). </para>
- <para>See <xref linkend="master.processes.loadbalancer" /> for more information on the LoadBalancer.
- </para>
- </section>
- <section xml:id="disabling.blockcache"><title>Disabling Blockcache</title>
- <para>Do not turn off block cache (You'd do it by setting <varname>hbase.block.cache.size</varname> to zero).
- Currently we do not do well if you do this because the regionserver will spend all its time loading hfile
- indices over and over again. If your working set it such that block cache does you no good, at least
- size the block cache such that hfile indices will stay up in the cache (you can get a rough idea
- on the size you need by surveying regionserver UIs; you'll see index block size accounted near the
- top of the webpage).</para>
- </section>
- <section xml:id="nagles">
- <title><link xlink:href="http://en.wikipedia.org/wiki/Nagle's_algorithm">Nagle's</link> or the small package problem</title>
- <para>If a big 40ms or so occasional delay is seen in operations against HBase,
- try the Nagles' setting. For example, see the user mailing list thread,
- <link xlink:href="http://search-hadoop.com/m/pduLg2fydtE/Inconsistent+scan+performance+with+caching+set+&subj=Re+Inconsistent+scan+performance+with+caching+set+to+1">Inconsistent scan performance with caching set to 1</link>
- and the issue cited therein where setting notcpdelay improved scan speeds. You might also
- see the graphs on the tail of <link xlink:href="https://issues.apache.org/jira/browse/HBASE-7008">HBASE-7008 Set scanner caching to a better default</link>
- where our Lars Hofhansl tries various data sizes w/ Nagle's on and off measuring the effect.</para>
- </section>
- <section xml:id="mttr">
- <title>Better Mean Time to Recover (MTTR)</title>
- <para>This section is about configurations that will make servers come back faster after a fail.
- See the Deveraj Das an Nicolas Liochon blog post
- <link xlink:href="http://hortonworks.com/blog/introduction-to-hbase-mean-time-to-recover-mttr/">Introduction to HBase Mean Time to Recover (MTTR)</link>
- for a brief introduction.</para>
- <para>The issue <link xlink:href="https://issues.apache.org/jira/browse/HBASE-8389">HBASE-8354 forces Namenode into loop with lease recovery requests</link>
- is messy but has a bunch of good discussion toward the end on low timeouts and how to effect faster recovery including citation of fixes
- added to HDFS. Read the Varun Sharma comments. The below suggested configurations are Varun's suggestions distilled and tested. Make sure you are
- running on a late-version HDFS so you have the fixes he refers too and himself adds to HDFS that help HBase MTTR
- (e.g. HDFS-3703, HDFS-3712, and HDFS-4791 -- hadoop 2 for sure has them and late hadoop 1 has some).
- Set the following in the RegionServer.</para>
- <programlisting language="xml">
-<![CDATA[<property>
-<property>
- <name>hbase.lease.recovery.dfs.timeout</name>
- <value>23000</value>
- <description>How much time we allow elapse between calls to recover lease.
- Should be larger than the dfs timeout.</description>
-</property>
-<property>
- <name>dfs.client.socket-timeout</name>
- <value>10000</value>
- <description>Down the DFS timeout from 60 to 10 seconds.</description>
-</property>
-]]></programlisting>
-
- <para>And on the namenode/datanode side, set the following to enable 'staleness' introduced
- in HDFS-3703, HDFS-3912. </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>dfs.client.socket-timeout</name>
- <value>10000</value>
- <description>Down the DFS timeout from 60 to 10 seconds.</description>
-</property>
-<property>
- <name>dfs.datanode.socket.write.timeout</name>
- <value>10000</value>
- <description>Down the DFS timeout from 8 * 60 to 10 seconds.</description>
-</property>
-<property>
- <name>ipc.client.connect.timeout</name>
- <value>3000</value>
- <description>Down from 60 seconds to 3.</description>
-</property>
-<property>
- <name>ipc.client.connect.max.retries.on.timeouts</name>
- <value>2</value>
- <description>Down from 45 seconds to 3 (2 == 3 retries).</description>
-</property>
-<property>
- <name>dfs.namenode.avoid.read.stale.datanode</name>
- <value>true</value>
- <description>Enable stale state in hdfs</description>
-</property>
-<property>
- <name>dfs.namenode.stale.datanode.interval</name>
- <value>20000</value>
- <description>Down from default 30 seconds</description>
-</property>
-<property>
- <name>dfs.namenode.avoid.write.stale.datanode</name>
- <value>true</value>
- <description>Enable stale state in hdfs</description>
-</property>
-]]></programlisting>
- </section>
-
- <section
- xml:id="JMX_config">
- <title>JMX</title>
- <para>JMX(Java Management Extensions) provides built-in instrumentation that enables you
- to monitor and manage the Java VM. To enable monitoring and management from remote
- systems, you need to set system property com.sun.management.jmxremote.port(the port
- number through which you want to enable JMX RMI connections) when you start the Java VM.
- See <link
- xlink:href="http://docs.oracle.com/javase/6/docs/technotes/guides/management/agent.html">
- official document</link> for more information. Historically, besides above port mentioned,
- JMX opens 2 additional random TCP listening ports, which could lead to port conflict
- problem.(See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10289">HBASE-10289</link>
- for details)
- </para>
- <para>As an alternative, You can use the coprocessor-based JMX implementation provided
- by HBase. To enable it in 0.99 or above, add below property in
- <filename>hbase-site.xml</filename>:
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.coprocessor.regionserver.classes</name>
- <value>org.apache.hadoop.hbase.JMXListener</value>
-</property>
-]]></programlisting>
- NOTE: DO NOT set com.sun.management.jmxremote.port for Java VM at the same time.
- </para>
- <para>Currently it supports Master and RegionServer Java VM. The reason why you only
- configure coprocessor for 'regionserver' is that, starting from HBase 0.99,
- a Master IS also a RegionServer. (See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10569">HBASE-10569</link>
- for more information.)
- By default, the JMX listens on TCP port 10102, you can further configure the port
- using below properties:
-
- <programlisting language="xml"><![CDATA[
-<property>
- <name>regionserver.rmi.registry.port</name>
- <value>61130</value>
-</property>
-<property>
- <name>regionserver.rmi.connector.port</name>
- <value>61140</value>
-</property>
-]]></programlisting>
- The registry port can be shared with connector port in most cases, so you only
- need to configure regionserver.rmi.registry.port. However if you want to use SSL
- communication, the 2 ports must be configured to different values.
- </para>
-
- <para>By default the password authentication and SSL communication is disabled.
- To enable password authentication, you need to update <filename>hbase-env.sh</filename>
- like below:
- <screen language="bourne">
-export HBASE_JMX_BASE="-Dcom.sun.management.jmxremote.authenticate=true \
- -Dcom.sun.management.jmxremote.password.file=your_password_file \
- -Dcom.sun.management.jmxremote.access.file=your_access_file"
-
-export HBASE_MASTER_OPTS="$HBASE_MASTER_OPTS $HBASE_JMX_BASE "
-export HBASE_REGIONSERVER_OPTS="$HBASE_REGIONSERVER_OPTS $HBASE_JMX_BASE "
- </screen>
- See example password/access file under $JRE_HOME/lib/management.
- </para>
-
- <para>To enable SSL communication with password authentication, follow below steps:
- <screen language="bourne">
-#1. generate a key pair, stored in myKeyStore
-keytool -genkey -alias jconsole -keystore myKeyStore
-
-#2. export it to file jconsole.cert
-keytool -export -alias jconsole -keystore myKeyStore -file jconsole.cert
-
-#3. copy jconsole.cert to jconsole client machine, import it to jconsoleKeyStore
-keytool -import -alias jconsole -keystore jconsoleKeyStore -file jconsole.cert
- </screen>
- And then update <filename>hbase-env.sh</filename> like below:
- <screen language="bourne">
-export HBASE_JMX_BASE="-Dcom.sun.management.jmxremote.ssl=true \
- -Djavax.net.ssl.keyStore=/home/tianq/myKeyStore \
- -Djavax.net.ssl.keyStorePassword=your_password_in_step_1 \
- -Dcom.sun.management.jmxremote.authenticate=true \
- -Dcom.sun.management.jmxremote.password.file=your_password file \
- -Dcom.sun.management.jmxremote.access.file=your_access_file"
-
-export HBASE_MASTER_OPTS="$HBASE_MASTER_OPTS $HBASE_JMX_BASE "
-export HBASE_REGIONSERVER_OPTS="$HBASE_REGIONSERVER_OPTS $HBASE_JMX_BASE "
- </screen>
-
- Finally start jconsole on client using the key store:
- <screen language="bourne">
-jconsole -J-Djavax.net.ssl.trustStore=/home/tianq/jconsoleKeyStore
- </screen>
- </para>
- <para>NOTE: for HBase 0.98, To enable the HBase JMX implementation on Master, you also
- need to add below property in <filename>hbase-site.xml</filename>:
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.coprocessor.master.classes</name>
- <value>org.apache.hadoop.hbase.JMXListener</value>
-</property>
-]]></programlisting>
- The corresponding properties for port configuration are master.rmi.registry.port
- (by default 10101) and master.rmi.connector.port(by default the same as registry.port)
- </para>
- </section>
-
- </section>
-
- </section>
- <!-- important config -->
- <section xml:id="dyn_config">
- <title>Dynamic Configuration</title>
- <subtitle>Changing Configuration Without Restarting Servers</subtitle>
- <para>Since HBase 1.0.0, it is possible to change a subset of the configuration without
- requiring a server restart. In the hbase shell, there are new operators,
- <command>update_config</command> and <command>update_all_config</command> that
- will prompt a server or all servers to reload configuration.</para>
- <para>Only a subset of all configurations can currently be changed in the running server.
- Here is an incomplete list:
- <property>hbase.regionserver.thread.compaction.large</property>,
- <property>hbase.regionserver.thread.compaction.small</property>,
- <property>hbase.regionserver.thread.split</property>,
- <property>hbase.regionserver.thread.merge</property>, as well as compaction
- policy and configurations and adjustment to offpeak hours.
- For the full list consult the patch attached to
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-12147">HBASE-12147 Porting Online Config Change from 89-fb</link>.
- </para>
-
- </section>
-</chapter>
[13/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/case_studies.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/case_studies.xml b/src/main/docbkx/case_studies.xml
deleted file mode 100644
index 332caf8..0000000
--- a/src/main/docbkx/case_studies.xml
+++ /dev/null
@@ -1,239 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="casestudies"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase Case Studies</title>
- <section
- xml:id="casestudies.overview">
- <title>Overview</title>
- <para> This chapter will describe a variety of performance and troubleshooting case studies that
- can provide a useful blueprint on diagnosing Apache HBase cluster issues. </para>
- <para> For more information on Performance and Troubleshooting, see <xref
- linkend="performance" /> and <xref
- linkend="trouble" />. </para>
- </section>
-
- <section
- xml:id="casestudies.schema">
- <title>Schema Design</title>
- <para>See the schema design case studies here: <xref
- linkend="schema.casestudies" />
- </para>
-
- </section>
- <!-- schema design -->
-
- <section
- xml:id="casestudies.perftroub">
- <title>Performance/Troubleshooting</title>
-
- <section
- xml:id="casestudies.slownode">
- <title>Case Study #1 (Performance Issue On A Single Node)</title>
- <section>
- <title>Scenario</title>
- <para> Following a scheduled reboot, one data node began exhibiting unusual behavior.
- Routine MapReduce jobs run against HBase tables which regularly completed in five or six
- minutes began taking 30 or 40 minutes to finish. These jobs were consistently found to be
- waiting on map and reduce tasks assigned to the troubled data node (e.g., the slow map
- tasks all had the same Input Split). The situation came to a head during a distributed
- copy, when the copy was severely prolonged by the lagging node. </para>
- </section>
- <section>
- <title>Hardware</title>
- <itemizedlist>
- <title>Datanodes:</title>
- <listitem>
- <para>Two 12-core processors</para>
- </listitem>
- <listitem>
- <para>Six Enerprise SATA disks</para>
- </listitem>
- <listitem>
- <para>24GB of RAM</para>
- </listitem>
- <listitem>
- <para>Two bonded gigabit NICs</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Network:</title>
- <listitem>
- <para>10 Gigabit top-of-rack switches</para>
- </listitem>
- <listitem>
- <para>20 Gigabit bonded interconnects between racks.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Hypotheses</title>
- <section>
- <title>HBase "Hot Spot" Region</title>
- <para> We hypothesized that we were experiencing a familiar point of pain: a "hot spot"
- region in an HBase table, where uneven key-space distribution can funnel a huge number
- of requests to a single HBase region, bombarding the RegionServer process and cause slow
- response time. Examination of the HBase Master status page showed that the number of
- HBase requests to the troubled node was almost zero. Further, examination of the HBase
- logs showed that there were no region splits, compactions, or other region transitions
- in progress. This effectively ruled out a "hot spot" as the root cause of the observed
- slowness. </para>
- </section>
- <section>
- <title>HBase Region With Non-Local Data</title>
- <para> Our next hypothesis was that one of the MapReduce tasks was requesting data from
- HBase that was not local to the datanode, thus forcing HDFS to request data blocks from
- other servers over the network. Examination of the datanode logs showed that there were
- very few blocks being requested over the network, indicating that the HBase region was
- correctly assigned, and that the majority of the necessary data was located on the node.
- This ruled out the possibility of non-local data causing a slowdown. </para>
- </section>
- <section>
- <title>Excessive I/O Wait Due To Swapping Or An Over-Worked Or Failing Hard Disk</title>
- <para> After concluding that the Hadoop and HBase were not likely to be the culprits, we
- moved on to troubleshooting the datanode's hardware. Java, by design, will periodically
- scan its entire memory space to do garbage collection. If system memory is heavily
- overcommitted, the Linux kernel may enter a vicious cycle, using up all of its resources
- swapping Java heap back and forth from disk to RAM as Java tries to run garbage
- collection. Further, a failing hard disk will often retry reads and/or writes many times
- before giving up and returning an error. This can manifest as high iowait, as running
- processes wait for reads and writes to complete. Finally, a disk nearing the upper edge
- of its performance envelope will begin to cause iowait as it informs the kernel that it
- cannot accept any more data, and the kernel queues incoming data into the dirty write
- pool in memory. However, using <code>vmstat(1)</code> and <code>free(1)</code>, we could
- see that no swap was being used, and the amount of disk IO was only a few kilobytes per
- second. </para>
- </section>
- <section>
- <title>Slowness Due To High Processor Usage</title>
- <para> Next, we checked to see whether the system was performing slowly simply due to very
- high computational load. <code>top(1)</code> showed that the system load was higher than
- normal, but <code>vmstat(1)</code> and <code>mpstat(1)</code> showed that the amount of
- processor being used for actual computation was low. </para>
- </section>
- <section>
- <title>Network Saturation (The Winner)</title>
- <para> Since neither the disks nor the processors were being utilized heavily, we moved on
- to the performance of the network interfaces. The datanode had two gigabit ethernet
- adapters, bonded to form an active-standby interface. <code>ifconfig(8)</code> showed
- some unusual anomalies, namely interface errors, overruns, framing errors. While not
- unheard of, these kinds of errors are exceedingly rare on modern hardware which is
- operating as it should: </para>
- <screen language="bourne">
-$ /sbin/ifconfig bond0
-bond0 Link encap:Ethernet HWaddr 00:00:00:00:00:00
-inet addr:10.x.x.x Bcast:10.x.x.255 Mask:255.255.255.0
-UP BROADCAST RUNNING MASTER MULTICAST MTU:1500 Metric:1
-RX packets:2990700159 errors:12 dropped:0 overruns:1 frame:6 <--- Look Here! Errors!
-TX packets:3443518196 errors:0 dropped:0 overruns:0 carrier:0
-collisions:0 txqueuelen:0
-RX bytes:2416328868676 (2.4 TB) TX bytes:3464991094001 (3.4 TB)
- </screen>
- <para> These errors immediately lead us to suspect that one or more of the ethernet
- interfaces might have negotiated the wrong line speed. This was confirmed both by
- running an ICMP ping from an external host and observing round-trip-time in excess of
- 700ms, and by running <code>ethtool(8)</code> on the members of the bond interface and
- discovering that the active interface was operating at 100Mbs/, full duplex. </para>
- <screen language="bourne">
-$ sudo ethtool eth0
-Settings for eth0:
-Supported ports: [ TP ]
-Supported link modes: 10baseT/Half 10baseT/Full
- 100baseT/Half 100baseT/Full
- 1000baseT/Full
-Supports auto-negotiation: Yes
-Advertised link modes: 10baseT/Half 10baseT/Full
- 100baseT/Half 100baseT/Full
- 1000baseT/Full
-Advertised pause frame use: No
-Advertised auto-negotiation: Yes
-Link partner advertised link modes: Not reported
-Link partner advertised pause frame use: No
-Link partner advertised auto-negotiation: No
-Speed: 100Mb/s <--- Look Here! Should say 1000Mb/s!
-Duplex: Full
-Port: Twisted Pair
-PHYAD: 1
-Transceiver: internal
-Auto-negotiation: on
-MDI-X: Unknown
-Supports Wake-on: umbg
-Wake-on: g
-Current message level: 0x00000003 (3)
-Link detected: yes
- </screen>
- <para> In normal operation, the ICMP ping round trip time should be around 20ms, and the
- interface speed and duplex should read, "1000MB/s", and, "Full", respectively. </para>
- </section>
- </section>
- <section>
- <title>Resolution</title>
- <para> After determining that the active ethernet adapter was at the incorrect speed, we
- used the <code>ifenslave(8)</code> command to make the standby interface the active
- interface, which yielded an immediate improvement in MapReduce performance, and a 10 times
- improvement in network throughput: </para>
- <para> On the next trip to the datacenter, we determined that the line speed issue was
- ultimately caused by a bad network cable, which was replaced. </para>
- </section>
- </section>
- <!-- case study -->
- <section
- xml:id="casestudies.perf.1">
- <title>Case Study #2 (Performance Research 2012)</title>
- <para> Investigation results of a self-described "we're not sure what's wrong, but it seems
- slow" problem. <link
- xlink:href="http://gbif.blogspot.com/2012/03/hbase-performance-evaluation-continued.html">http://gbif.blogspot.com/2012/03/hbase-performance-evaluation-continued.html</link>
- </para>
- </section>
-
- <section
- xml:id="casestudies.perf.2">
- <title>Case Study #3 (Performance Research 2010))</title>
- <para> Investigation results of general cluster performance from 2010. Although this research
- is on an older version of the codebase, this writeup is still very useful in terms of
- approach. <link
- xlink:href="http://hstack.org/hbase-performance-testing/">http://hstack.org/hbase-performance-testing/</link>
- </para>
- </section>
-
- <section
- xml:id="casestudies.max.transfer.threads">
- <title>Case Study #4 (max.transfer.threads Config)</title>
- <para> Case study of configuring <code>max.transfer.threads</code> (previously known as
- <code>xcievers</code>) and diagnosing errors from misconfigurations. <link
- xlink:href="http://www.larsgeorge.com/2012/03/hadoop-hbase-and-xceivers.html">http://www.larsgeorge.com/2012/03/hadoop-hbase-and-xceivers.html</link>
- </para>
- <para> See also <xref
- linkend="dfs.datanode.max.transfer.threads" />. </para>
- </section>
-
- </section>
- <!-- performance/troubleshooting -->
-
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/community.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/community.xml b/src/main/docbkx/community.xml
deleted file mode 100644
index 813f356..0000000
--- a/src/main/docbkx/community.xml
+++ /dev/null
@@ -1,149 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="community"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Community</title>
- <section
- xml:id="decisions">
- <title>Decisions</title>
- <section
- xml:id="feature_branches">
- <title>Feature Branches</title>
- <para>Feature Branches are easy to make. You do not have to be a committer to make one. Just
- request the name of your branch be added to JIRA up on the developer's mailing list and a
- committer will add it for you. Thereafter you can file issues against your feature branch in
- Apache HBase JIRA. Your code you keep elsewhere -- it should be public so it can be observed
- -- and you can update dev mailing list on progress. When the feature is ready for commit, 3
- +1s from committers will get your feature merged. See <link
- xlink:href="http://search-hadoop.com/m/asM982C5FkS1">HBase, mail # dev - Thoughts
- about large feature dev branches</link></para>
- </section>
- <section
- xml:id="patchplusonepolicy">
- <title>Patch +1 Policy</title>
- <para> The below policy is something we put in place 09/2012. It is a suggested policy rather
- than a hard requirement. We want to try it first to see if it works before we cast it in
- stone. </para>
- <para> Apache HBase is made of <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponents-panel">components</link>.
- Components have one or more <xref
- linkend="OWNER" />s. See the 'Description' field on the <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponents-panel">components</link>
- JIRA page for who the current owners are by component. </para>
- <para> Patches that fit within the scope of a single Apache HBase component require, at least,
- a +1 by one of the component's owners before commit. If owners are absent -- busy or
- otherwise -- two +1s by non-owners will suffice. </para>
- <para> Patches that span components need at least two +1s before they can be committed,
- preferably +1s by owners of components touched by the x-component patch (TODO: This needs
- tightening up but I think fine for first pass). </para>
- <para> Any -1 on a patch by anyone vetos a patch; it cannot be committed until the
- justification for the -1 is addressed. </para>
- </section>
- <section
- xml:id="hbase.fix.version.in.JIRA">
- <title>How to set fix version in JIRA on issue resolve</title>
- <para>Here is how <link
- xlink:href="http://search-hadoop.com/m/azemIi5RCJ1">we agreed</link> to set versions in
- JIRA when we resolve an issue. If trunk is going to be 0.98.0 then: </para>
- <itemizedlist>
- <listitem>
- <para> Commit only to trunk: Mark with 0.98 </para>
- </listitem>
- <listitem>
- <para> Commit to 0.95 and trunk : Mark with 0.98, and 0.95.x </para>
- </listitem>
- <listitem>
- <para> Commit to 0.94.x and 0.95, and trunk: Mark with 0.98, 0.95.x, and 0.94.x </para>
- </listitem>
- <listitem>
- <para> Commit to 89-fb: Mark with 89-fb. </para>
- </listitem>
- <listitem>
- <para> Commit site fixes: no version </para>
- </listitem>
- </itemizedlist>
- </section>
- <section
- xml:id="hbase.when.to.close.JIRA">
- <title>Policy on when to set a RESOLVED JIRA as CLOSED</title>
- <para>We <link
- xlink:href="http://search-hadoop.com/m/4cIKs1iwXMS1">agreed</link> that for issues that
- list multiple releases in their <emphasis>Fix Version/s</emphasis> field, CLOSE the issue on
- the release of any of the versions listed; subsequent change to the issue must happen in a
- new JIRA. </para>
- </section>
- <section
- xml:id="no.permanent.state.in.zk">
- <title>Only transient state in ZooKeeper!</title>
- <para> You should be able to kill the data in zookeeper and hbase should ride over it
- recreating the zk content as it goes. This is an old adage around these parts. We just made
- note of it now. We also are currently in violation of this basic tenet -- replication at
- least keeps permanent state in zk -- but we are working to undo this breaking of a golden
- rule. </para>
- </section>
- </section>
- <section
- xml:id="community.roles">
- <title>Community Roles</title>
- <section
- xml:id="OWNER">
- <title>Component Owner/Lieutenant</title>
- <para> Component owners are listed in the description field on this Apache HBase JIRA <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponents-panel">components</link>
- page. The owners are listed in the 'Description' field rather than in the 'Component Lead'
- field because the latter only allows us list one individual whereas it is encouraged that
- components have multiple owners. </para>
- <para> Owners or component lieutenants are volunteers who are (usually, but not necessarily)
- expert in their component domain and may have an agenda on how they think their Apache HBase
- component should evolve. </para>
- <orderedlist>
- <title>Component Owner Duties</title>
- <listitem>
- <para> Owners will try and review patches that land within their component's scope.
- </para>
- </listitem>
- <listitem>
- <para> If applicable, if an owner has an agenda, they will publish their goals or the
- design toward which they are driving their component </para>
- </listitem>
- </orderedlist>
- <para> If you would like to be volunteer as a component owner, just write the dev list and
- we'll sign you up. Owners do not need to be committers. </para>
- </section>
- </section>
- <section
- xml:id="hbase.commit.msg.format">
- <title>Commit Message format</title>
- <para>We <link
- xlink:href="http://search-hadoop.com/m/Gwxwl10cFHa1">agreed</link> to the following SVN
- commit message format:
- <programlisting>HBASE-xxxxx <title>. (<contributor>)</programlisting> If the person
- making the commit is the contributor, leave off the '(<contributor>)' element. </para>
- </section>
-</chapter>
[03/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/troubleshooting.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/troubleshooting.xml b/src/main/docbkx/troubleshooting.xml
deleted file mode 100644
index d57bb08..0000000
--- a/src/main/docbkx/troubleshooting.xml
+++ /dev/null
@@ -1,1700 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="trouble"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Troubleshooting and Debugging Apache HBase</title>
- <section
- xml:id="trouble.general">
- <title>General Guidelines</title>
- <para> Always start with the master log (TODO: Which lines?). Normally it’s just printing the
- same lines over and over again. If not, then there’s an issue. Google or <link
- xlink:href="http://search-hadoop.com">search-hadoop.com</link> should return some hits for
- those exceptions you’re seeing. </para>
- <para> An error rarely comes alone in Apache HBase, usually when something gets screwed up what
- will follow may be hundreds of exceptions and stack traces coming from all over the place. The
- best way to approach this type of problem is to walk the log up to where it all began, for
- example one trick with RegionServers is that they will print some metrics when aborting so
- grepping for <emphasis>Dump</emphasis> should get you around the start of the problem. </para>
- <para> RegionServer suicides are “normal”, as this is what they do when something goes wrong.
- For example, if ulimit and max transfer threads (the two most important initial settings, see
- <xref linkend="ulimit" /> and <xref linkend="dfs.datanode.max.transfer.threads" />) aren’t
- changed, it will make it impossible at some point for DataNodes
- to create new threads that from the HBase point of view is seen as if HDFS was gone. Think
- about what would happen if your MySQL database was suddenly unable to access files on your
- local file system, well it’s the same with HBase and HDFS. Another very common reason to see
- RegionServers committing seppuku is when they enter prolonged garbage collection pauses that
- last longer than the default ZooKeeper session timeout. For more information on GC pauses, see
- the <link
- xlink:href="http://www.cloudera.com/blog/2011/02/avoiding-full-gcs-in-hbase-with-memstore-local-allocation-buffers-part-1/">3
- part blog post</link> by Todd Lipcon and <xref
- linkend="gcpause" /> above. </para>
- </section>
- <section
- xml:id="trouble.log">
- <title>Logs</title>
- <para> The key process logs are as follows... (replace <user> with the user that started
- the service, and <hostname> for the machine name) </para>
- <para> NameNode:
- <filename>$HADOOP_HOME/logs/hadoop-<user>-namenode-<hostname>.log</filename>
- </para>
- <para> DataNode:
- <filename>$HADOOP_HOME/logs/hadoop-<user>-datanode-<hostname>.log</filename>
- </para>
- <para> JobTracker:
- <filename>$HADOOP_HOME/logs/hadoop-<user>-jobtracker-<hostname>.log</filename>
- </para>
- <para> TaskTracker:
- <filename>$HADOOP_HOME/logs/hadoop-<user>-tasktracker-<hostname>.log</filename>
- </para>
- <para> HMaster:
- <filename>$HBASE_HOME/logs/hbase-<user>-master-<hostname>.log</filename>
- </para>
- <para> RegionServer:
- <filename>$HBASE_HOME/logs/hbase-<user>-regionserver-<hostname>.log</filename>
- </para>
- <para> ZooKeeper: <filename>TODO</filename>
- </para>
- <section
- xml:id="trouble.log.locations">
- <title>Log Locations</title>
- <para>For stand-alone deployments the logs are obviously going to be on a single machine,
- however this is a development configuration only. Production deployments need to run on a
- cluster.</para>
- <section
- xml:id="trouble.log.locations.namenode">
- <title>NameNode</title>
- <para>The NameNode log is on the NameNode server. The HBase Master is typically run on the
- NameNode server, and well as ZooKeeper.</para>
- <para>For smaller clusters the JobTracker is typically run on the NameNode server as
- well.</para>
- </section>
- <section
- xml:id="trouble.log.locations.datanode">
- <title>DataNode</title>
- <para>Each DataNode server will have a DataNode log for HDFS, as well as a RegionServer log
- for HBase.</para>
- <para>Additionally, each DataNode server will also have a TaskTracker log for MapReduce task
- execution.</para>
- </section>
- </section>
- <section
- xml:id="trouble.log.levels">
- <title>Log Levels</title>
- <section
- xml:id="rpc.logging">
- <title>Enabling RPC-level logging</title>
- <para>Enabling the RPC-level logging on a RegionServer can often given insight on timings at
- the server. Once enabled, the amount of log spewed is voluminous. It is not recommended
- that you leave this logging on for more than short bursts of time. To enable RPC-level
- logging, browse to the RegionServer UI and click on <emphasis>Log Level</emphasis>. Set
- the log level to <varname>DEBUG</varname> for the package
- <classname>org.apache.hadoop.ipc</classname> (Thats right, for
- <classname>hadoop.ipc</classname>, NOT, <classname>hbase.ipc</classname>). Then tail the
- RegionServers log. Analyze.</para>
- <para>To disable, set the logging level back to <varname>INFO</varname> level. </para>
- </section>
- </section>
- <section
- xml:id="trouble.log.gc">
- <title>JVM Garbage Collection Logs</title>
- <para>HBase is memory intensive, and using the default GC you can see long pauses in all
- threads including the <emphasis>Juliet Pause</emphasis> aka "GC of Death". To help debug
- this or confirm this is happening GC logging can be turned on in the Java virtual machine. </para>
- <para> To enable, in <filename>hbase-env.sh</filename>, uncomment one of the below lines
- :</para>
- <programlisting language="bourne">
-# This enables basic gc logging to the .out file.
-# export SERVER_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps"
-
-# This enables basic gc logging to its own file.
-# export SERVER_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:<FILE-PATH>"
-
-# This enables basic GC logging to its own file with automatic log rolling. Only applies to jdk 1.6.0_34+ and 1.7.0_2+.
-# export SERVER_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:<FILE-PATH> -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=1 -XX:GCLogFileSize=512M"
-
-# If <FILE-PATH> is not replaced, the log file(.gc) would be generated in the HBASE_LOG_DIR.
- </programlisting>
- <para> At this point you should see logs like so:</para>
- <programlisting>
-64898.952: [GC [1 CMS-initial-mark: 2811538K(3055704K)] 2812179K(3061272K), 0.0007360 secs] [Times: user=0.00 sys=0.00, real=0.00 secs]
-64898.953: [CMS-concurrent-mark-start]
-64898.971: [GC 64898.971: [ParNew: 5567K->576K(5568K), 0.0101110 secs] 2817105K->2812715K(3061272K), 0.0102200 secs] [Times: user=0.07 sys=0.00, real=0.01 secs]
- </programlisting>
- <para> In this section, the first line indicates a 0.0007360 second pause for the CMS to
- initially mark. This pauses the entire VM, all threads for that period of time. </para>
- <para> The third line indicates a "minor GC", which pauses the VM for 0.0101110 seconds - aka
- 10 milliseconds. It has reduced the "ParNew" from about 5.5m to 576k. Later on in this cycle
- we see:</para>
- <programlisting>
-64901.445: [CMS-concurrent-mark: 1.542/2.492 secs] [Times: user=10.49 sys=0.33, real=2.49 secs]
-64901.445: [CMS-concurrent-preclean-start]
-64901.453: [GC 64901.453: [ParNew: 5505K->573K(5568K), 0.0062440 secs] 2868746K->2864292K(3061272K), 0.0063360 secs] [Times: user=0.05 sys=0.00, real=0.01 secs]
-64901.476: [GC 64901.476: [ParNew: 5563K->575K(5568K), 0.0072510 secs] 2869283K->2864837K(3061272K), 0.0073320 secs] [Times: user=0.05 sys=0.01, real=0.01 secs]
-64901.500: [GC 64901.500: [ParNew: 5517K->573K(5568K), 0.0120390 secs] 2869780K->2865267K(3061272K), 0.0121150 secs] [Times: user=0.09 sys=0.00, real=0.01 secs]
-64901.529: [GC 64901.529: [ParNew: 5507K->569K(5568K), 0.0086240 secs] 2870200K->2865742K(3061272K), 0.0087180 secs] [Times: user=0.05 sys=0.00, real=0.01 secs]
-64901.554: [GC 64901.555: [ParNew: 5516K->575K(5568K), 0.0107130 secs] 2870689K->2866291K(3061272K), 0.0107820 secs] [Times: user=0.06 sys=0.00, real=0.01 secs]
-64901.578: [CMS-concurrent-preclean: 0.070/0.133 secs] [Times: user=0.48 sys=0.01, real=0.14 secs]
-64901.578: [CMS-concurrent-abortable-preclean-start]
-64901.584: [GC 64901.584: [ParNew: 5504K->571K(5568K), 0.0087270 secs] 2871220K->2866830K(3061272K), 0.0088220 secs] [Times: user=0.05 sys=0.00, real=0.01 secs]
-64901.609: [GC 64901.609: [ParNew: 5512K->569K(5568K), 0.0063370 secs] 2871771K->2867322K(3061272K), 0.0064230 secs] [Times: user=0.06 sys=0.00, real=0.01 secs]
-64901.615: [CMS-concurrent-abortable-preclean: 0.007/0.037 secs] [Times: user=0.13 sys=0.00, real=0.03 secs]
-64901.616: [GC[YG occupancy: 645 K (5568 K)]64901.616: [Rescan (parallel) , 0.0020210 secs]64901.618: [weak refs processing, 0.0027950 secs] [1 CMS-remark: 2866753K(3055704K)] 2867399K(3061272K), 0.0049380 secs] [Times: user=0.00 sys=0.01, real=0.01 secs]
-64901.621: [CMS-concurrent-sweep-start]
- </programlisting>
- <para> The first line indicates that the CMS concurrent mark (finding garbage) has taken 2.4
- seconds. But this is a _concurrent_ 2.4 seconds, Java has not been paused at any point in
- time. </para>
- <para> There are a few more minor GCs, then there is a pause at the 2nd last line:
- <programlisting>
-64901.616: [GC[YG occupancy: 645 K (5568 K)]64901.616: [Rescan (parallel) , 0.0020210 secs]64901.618: [weak refs processing, 0.0027950 secs] [1 CMS-remark: 2866753K(3055704K)] 2867399K(3061272K), 0.0049380 secs] [Times: user=0.00 sys=0.01, real=0.01 secs]
- </programlisting>
- </para>
- <para> The pause here is 0.0049380 seconds (aka 4.9 milliseconds) to 'remark' the heap. </para>
- <para> At this point the sweep starts, and you can watch the heap size go down:</para>
- <programlisting>
-64901.637: [GC 64901.637: [ParNew: 5501K->569K(5568K), 0.0097350 secs] 2871958K->2867441K(3061272K), 0.0098370 secs] [Times: user=0.05 sys=0.00, real=0.01 secs]
-... lines removed ...
-64904.936: [GC 64904.936: [ParNew: 5532K->568K(5568K), 0.0070720 secs] 1365024K->1360689K(3061272K), 0.0071930 secs] [Times: user=0.05 sys=0.00, real=0.01 secs]
-64904.953: [CMS-concurrent-sweep: 2.030/3.332 secs] [Times: user=9.57 sys=0.26, real=3.33 secs]
- </programlisting>
- <para>At this point, the CMS sweep took 3.332 seconds, and heap went from about ~ 2.8 GB to
- 1.3 GB (approximate). </para>
- <para> The key points here is to keep all these pauses low. CMS pauses are always low, but if
- your ParNew starts growing, you can see minor GC pauses approach 100ms, exceed 100ms and hit
- as high at 400ms. </para>
- <para> This can be due to the size of the ParNew, which should be relatively small. If your
- ParNew is very large after running HBase for a while, in one example a ParNew was about
- 150MB, then you might have to constrain the size of ParNew (The larger it is, the longer the
- collections take but if its too small, objects are promoted to old gen too quickly). In the
- below we constrain new gen size to 64m. </para>
- <para> Add the below line in <filename>hbase-env.sh</filename>:
- <programlisting language="bourne">
-export SERVER_GC_OPTS="$SERVER_GC_OPTS -XX:NewSize=64m -XX:MaxNewSize=64m"
- </programlisting>
- </para>
- <para> Similarly, to enable GC logging for client processes, uncomment one of the below lines
- in <filename>hbase-env.sh</filename>:</para>
- <programlisting language="bourne">
-# This enables basic gc logging to the .out file.
-# export CLIENT_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps"
-
-# This enables basic gc logging to its own file.
-# export CLIENT_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:<FILE-PATH>"
-
-# This enables basic GC logging to its own file with automatic log rolling. Only applies to jdk 1.6.0_34+ and 1.7.0_2+.
-# export CLIENT_GC_OPTS="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:<FILE-PATH> -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=1 -XX:GCLogFileSize=512M"
-
-# If <FILE-PATH> is not replaced, the log file(.gc) would be generated in the HBASE_LOG_DIR .
- </programlisting>
- <para> For more information on GC pauses, see the <link
- xlink:href="http://www.cloudera.com/blog/2011/02/avoiding-full-gcs-in-hbase-with-memstore-local-allocation-buffers-part-1/">3
- part blog post</link> by Todd Lipcon and <xref
- linkend="gcpause" /> above. </para>
- </section>
- </section>
- <section
- xml:id="trouble.resources">
- <title>Resources</title>
- <section
- xml:id="trouble.resources.searchhadoop">
- <title>search-hadoop.com</title>
- <para>
- <link
- xlink:href="http://search-hadoop.com">search-hadoop.com</link> indexes all the mailing
- lists and is great for historical searches. Search here first when you have an issue as its
- more than likely someone has already had your problem. </para>
- </section>
- <section
- xml:id="trouble.resources.lists">
- <title>Mailing Lists</title>
- <para>Ask a question on the <link xlink:href="http://hbase.apache.org/mail-lists.html">Apache
- HBase mailing lists</link>. The 'dev' mailing list is aimed at the community of developers
- actually building Apache HBase and for features currently under development, and 'user' is
- generally used for questions on released versions of Apache HBase. Before going to the
- mailing list, make sure your question has not already been answered by searching the mailing
- list archives first. Use <xref linkend="trouble.resources.searchhadoop"/>. Take some time
- crafting your question. See <link xlink:href="http://www.mikeash.com/getting_answers.html"
- >Getting Answers</link> for ideas on crafting good questions. A quality question that
- includes all context and exhibits evidence the author has tried to find answers in the
- manual and out on lists is more likely to get a prompt response. </para>
- </section>
- <section
- xml:id="trouble.resources.irc">
- <title>IRC</title>
- <para>#hbase on irc.freenode.net</para>
- </section>
- <section
- xml:id="trouble.resources.jira">
- <title>JIRA</title>
- <para>
- <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE">JIRA</link> is also really
- helpful when looking for Hadoop/HBase-specific issues. </para>
- </section>
- </section>
- <section
- xml:id="trouble.tools">
- <title>Tools</title>
- <section
- xml:id="trouble.tools.builtin">
- <title>Builtin Tools</title>
- <section
- xml:id="trouble.tools.builtin.webmaster">
- <title>Master Web Interface</title>
- <para>The Master starts a web-interface on port 16010 by default. (Up to and including 0.98
- this was port 60010) </para>
- <para>The Master web UI lists created tables and their definition (e.g., ColumnFamilies,
- blocksize, etc.). Additionally, the available RegionServers in the cluster are listed
- along with selected high-level metrics (requests, number of regions, usedHeap, maxHeap).
- The Master web UI allows navigation to each RegionServer's web UI. </para>
- </section>
- <section
- xml:id="trouble.tools.builtin.webregion">
- <title>RegionServer Web Interface</title>
- <para>RegionServers starts a web-interface on port 16030 by default. (Up to an including
- 0.98 this was port 60030) </para>
- <para>The RegionServer web UI lists online regions and their start/end keys, as well as
- point-in-time RegionServer metrics (requests, regions, storeFileIndexSize,
- compactionQueueSize, etc.). </para>
- <para>See <xref
- linkend="hbase_metrics" /> for more information in metric definitions. </para>
- </section>
- <section
- xml:id="trouble.tools.builtin.zkcli">
- <title>zkcli</title>
- <para><code>zkcli</code> is a very useful tool for investigating ZooKeeper-related issues.
- To invoke:
- <programlisting language="bourne">
-./hbase zkcli -server host:port <cmd> <args>
-</programlisting>
- The commands (and arguments) are:</para>
- <programlisting>
- connect host:port
- get path [watch]
- ls path [watch]
- set path data [version]
- delquota [-n|-b] path
- quit
- printwatches on|off
- create [-s] [-e] path data acl
- stat path [watch]
- close
- ls2 path [watch]
- history
- listquota path
- setAcl path acl
- getAcl path
- sync path
- redo cmdno
- addauth scheme auth
- delete path [version]
- setquota -n|-b val path
-</programlisting>
- </section>
- </section>
- <section
- xml:id="trouble.tools.external">
- <title>External Tools</title>
- <section
- xml:id="trouble.tools.tail">
- <title>tail</title>
- <para>
- <code>tail</code> is the command line tool that lets you look at the end of a file. Add
- the “-f” option and it will refresh when new data is available. It’s useful when you are
- wondering what’s happening, for example, when a cluster is taking a long time to shutdown
- or startup as you can just fire a new terminal and tail the master log (and maybe a few
- RegionServers). </para>
- </section>
- <section
- xml:id="trouble.tools.top">
- <title>top</title>
- <para>
- <code>top</code> is probably one of the most important tool when first trying to see
- what’s running on a machine and how the resources are consumed. Here’s an example from
- production system:</para>
- <programlisting>
-top - 14:46:59 up 39 days, 11:55, 1 user, load average: 3.75, 3.57, 3.84
-Tasks: 309 total, 1 running, 308 sleeping, 0 stopped, 0 zombie
-Cpu(s): 4.5%us, 1.6%sy, 0.0%ni, 91.7%id, 1.4%wa, 0.1%hi, 0.6%si, 0.0%st
-Mem: 24414432k total, 24296956k used, 117476k free, 7196k buffers
-Swap: 16008732k total, 14348k used, 15994384k free, 11106908k cached
-
- PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
-15558 hadoop 18 -2 3292m 2.4g 3556 S 79 10.4 6523:52 java
-13268 hadoop 18 -2 8967m 8.2g 4104 S 21 35.1 5170:30 java
- 8895 hadoop 18 -2 1581m 497m 3420 S 11 2.1 4002:32 java
-…
- </programlisting>
- <para> Here we can see that the system load average during the last five minutes is 3.75,
- which very roughly means that on average 3.75 threads were waiting for CPU time during
- these 5 minutes. In general, the “perfect” utilization equals to the number of cores,
- under that number the machine is under utilized and over that the machine is over
- utilized. This is an important concept, see this article to understand it more: <link
- xlink:href="http://www.linuxjournal.com/article/9001">http://www.linuxjournal.com/article/9001</link>. </para>
- <para> Apart from load, we can see that the system is using almost all its available RAM but
- most of it is used for the OS cache (which is good). The swap only has a few KBs in it and
- this is wanted, high numbers would indicate swapping activity which is the nemesis of
- performance of Java systems. Another way to detect swapping is when the load average goes
- through the roof (although this could also be caused by things like a dying disk, among
- others). </para>
- <para> The list of processes isn’t super useful by default, all we know is that 3 java
- processes are using about 111% of the CPUs. To know which is which, simply type “c” and
- each line will be expanded. Typing “1” will give you the detail of how each CPU is used
- instead of the average for all of them like shown here. </para>
- </section>
- <section
- xml:id="trouble.tools.jps">
- <title>jps</title>
- <para>
- <code>jps</code> is shipped with every JDK and gives the java process ids for the current
- user (if root, then it gives the ids for all users). Example:</para>
- <programlisting language="bourne">
-hadoop@sv4borg12:~$ jps
-1322 TaskTracker
-17789 HRegionServer
-27862 Child
-1158 DataNode
-25115 HQuorumPeer
-2950 Jps
-19750 ThriftServer
-18776 jmx
- </programlisting>
- <para>In order, we see a: </para>
- <itemizedlist>
- <listitem>
- <para>Hadoop TaskTracker, manages the local Childs</para>
- </listitem>
- <listitem>
- <para>HBase RegionServer, serves regions</para>
- </listitem>
- <listitem>
- <para>Child, its MapReduce task, cannot tell which type exactly</para>
- </listitem>
- <listitem>
- <para>Hadoop TaskTracker, manages the local Childs</para>
- </listitem>
- <listitem>
- <para>Hadoop DataNode, serves blocks</para>
- </listitem>
- <listitem>
- <para>HQuorumPeer, a ZooKeeper ensemble member</para>
- </listitem>
- <listitem>
- <para>Jps, well… it’s the current process</para>
- </listitem>
- <listitem>
- <para>ThriftServer, it’s a special one will be running only if thrift was started</para>
- </listitem>
- <listitem>
- <para>jmx, this is a local process that’s part of our monitoring platform ( poorly named
- maybe). You probably don’t have that.</para>
- </listitem>
- </itemizedlist>
- <para> You can then do stuff like checking out the full command line that started the
- process:</para>
- <programlisting language="bourne">
-hadoop@sv4borg12:~$ ps aux | grep HRegionServer
-hadoop 17789 155 35.2 9067824 8604364 ? S<l Mar04 9855:48 /usr/java/jdk1.6.0_14/bin/java -Xmx8000m -XX:+DoEscapeAnalysis -XX:+AggressiveOpts -XX:+UseConcMarkSweepGC -XX:NewSize=64m -XX:MaxNewSize=64m -XX:CMSInitiatingOccupancyFraction=88 -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -Xloggc:/export1/hadoop/logs/gc-hbase.log -Dcom.sun.management.jmxremote.port=10102 -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.password.file=/home/hadoop/hbase/conf/jmxremote.password -Dcom.sun.management.jmxremote -Dhbase.log.dir=/export1/hadoop/logs -Dhbase.log.file=hbase-hadoop-regionserver-sv4borg12.log -Dhbase.home.dir=/home/hadoop/hbase -Dhbase.id.str=hadoop -Dhbase.root.logger=INFO,DRFA -Djava.library.path=/home/hadoop/hbase/lib/native/Linux-amd64-64 -classpath /home/hadoop/hbase/bin/../conf:[many jars]:/home/hadoop/hadoop/conf org.apache.hadoop.hbase.regionserver.HRegionServer start
- </programlisting>
- </section>
- <section
- xml:id="trouble.tools.jstack">
- <title>jstack</title>
- <para>
- <code>jstack</code> is one of the most important tools when trying to figure out what a
- java process is doing apart from looking at the logs. It has to be used in conjunction
- with jps in order to give it a process id. It shows a list of threads, each one has a
- name, and they appear in the order that they were created (so the top ones are the most
- recent threads). Here’s a few example: </para>
- <para> The main thread of a RegionServer that’s waiting for something to do from the
- master:</para>
- <programlisting>
-"regionserver60020" prio=10 tid=0x0000000040ab4000 nid=0x45cf waiting on condition [0x00007f16b6a96000..0x00007f16b6a96a70]
-java.lang.Thread.State: TIMED_WAITING (parking)
- at sun.misc.Unsafe.park(Native Method)
- - parking to wait for <0x00007f16cd5c2f30> (a java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject)
- at java.util.concurrent.locks.LockSupport.parkNanos(LockSupport.java:198)
- at java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.awaitNanos(AbstractQueuedSynchronizer.java:1963)
- at java.util.concurrent.LinkedBlockingQueue.poll(LinkedBlockingQueue.java:395)
- at org.apache.hadoop.hbase.regionserver.HRegionServer.run(HRegionServer.java:647)
- at java.lang.Thread.run(Thread.java:619)
-
- The MemStore flusher thread that is currently flushing to a file:
-"regionserver60020.cacheFlusher" daemon prio=10 tid=0x0000000040f4e000 nid=0x45eb in Object.wait() [0x00007f16b5b86000..0x00007f16b5b87af0]
-java.lang.Thread.State: WAITING (on object monitor)
- at java.lang.Object.wait(Native Method)
- at java.lang.Object.wait(Object.java:485)
- at org.apache.hadoop.ipc.Client.call(Client.java:803)
- - locked <0x00007f16cb14b3a8> (a org.apache.hadoop.ipc.Client$Call)
- at org.apache.hadoop.ipc.RPC$Invoker.invoke(RPC.java:221)
- at $Proxy1.complete(Unknown Source)
- at sun.reflect.GeneratedMethodAccessor38.invoke(Unknown Source)
- at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
- at java.lang.reflect.Method.invoke(Method.java:597)
- at org.apache.hadoop.io.retry.RetryInvocationHandler.invokeMethod(RetryInvocationHandler.java:82)
- at org.apache.hadoop.io.retry.RetryInvocationHandler.invoke(RetryInvocationHandler.java:59)
- at $Proxy1.complete(Unknown Source)
- at org.apache.hadoop.hdfs.DFSClient$DFSOutputStream.closeInternal(DFSClient.java:3390)
- - locked <0x00007f16cb14b470> (a org.apache.hadoop.hdfs.DFSClient$DFSOutputStream)
- at org.apache.hadoop.hdfs.DFSClient$DFSOutputStream.close(DFSClient.java:3304)
- at org.apache.hadoop.fs.FSDataOutputStream$PositionCache.close(FSDataOutputStream.java:61)
- at org.apache.hadoop.fs.FSDataOutputStream.close(FSDataOutputStream.java:86)
- at org.apache.hadoop.hbase.io.hfile.HFile$Writer.close(HFile.java:650)
- at org.apache.hadoop.hbase.regionserver.StoreFile$Writer.close(StoreFile.java:853)
- at org.apache.hadoop.hbase.regionserver.Store.internalFlushCache(Store.java:467)
- - locked <0x00007f16d00e6f08> (a java.lang.Object)
- at org.apache.hadoop.hbase.regionserver.Store.flushCache(Store.java:427)
- at org.apache.hadoop.hbase.regionserver.Store.access$100(Store.java:80)
- at org.apache.hadoop.hbase.regionserver.Store$StoreFlusherImpl.flushCache(Store.java:1359)
- at org.apache.hadoop.hbase.regionserver.HRegion.internalFlushcache(HRegion.java:907)
- at org.apache.hadoop.hbase.regionserver.HRegion.internalFlushcache(HRegion.java:834)
- at org.apache.hadoop.hbase.regionserver.HRegion.flushcache(HRegion.java:786)
- at org.apache.hadoop.hbase.regionserver.MemStoreFlusher.flushRegion(MemStoreFlusher.java:250)
- at org.apache.hadoop.hbase.regionserver.MemStoreFlusher.flushRegion(MemStoreFlusher.java:224)
- at org.apache.hadoop.hbase.regionserver.MemStoreFlusher.run(MemStoreFlusher.java:146)
- </programlisting>
- <para> A handler thread that’s waiting for stuff to do (like put, delete, scan, etc):</para>
- <programlisting>
-"IPC Server handler 16 on 60020" daemon prio=10 tid=0x00007f16b011d800 nid=0x4a5e waiting on condition [0x00007f16afefd000..0x00007f16afefd9f0]
- java.lang.Thread.State: WAITING (parking)
- at sun.misc.Unsafe.park(Native Method)
- - parking to wait for <0x00007f16cd3f8dd8> (a java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject)
- at java.util.concurrent.locks.LockSupport.park(LockSupport.java:158)
- at java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:1925)
- at java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:358)
- at org.apache.hadoop.hbase.ipc.HBaseServer$Handler.run(HBaseServer.java:1013)
- </programlisting>
- <para> And one that’s busy doing an increment of a counter (it’s in the phase where it’s
- trying to create a scanner in order to read the last value):</para>
- <programlisting>
-"IPC Server handler 66 on 60020" daemon prio=10 tid=0x00007f16b006e800 nid=0x4a90 runnable [0x00007f16acb77000..0x00007f16acb77cf0]
- java.lang.Thread.State: RUNNABLE
- at org.apache.hadoop.hbase.regionserver.KeyValueHeap.<init>(KeyValueHeap.java:56)
- at org.apache.hadoop.hbase.regionserver.StoreScanner.<init>(StoreScanner.java:79)
- at org.apache.hadoop.hbase.regionserver.Store.getScanner(Store.java:1202)
- at org.apache.hadoop.hbase.regionserver.HRegion$RegionScanner.<init>(HRegion.java:2209)
- at org.apache.hadoop.hbase.regionserver.HRegion.instantiateInternalScanner(HRegion.java:1063)
- at org.apache.hadoop.hbase.regionserver.HRegion.getScanner(HRegion.java:1055)
- at org.apache.hadoop.hbase.regionserver.HRegion.getScanner(HRegion.java:1039)
- at org.apache.hadoop.hbase.regionserver.HRegion.getLastIncrement(HRegion.java:2875)
- at org.apache.hadoop.hbase.regionserver.HRegion.incrementColumnValue(HRegion.java:2978)
- at org.apache.hadoop.hbase.regionserver.HRegionServer.incrementColumnValue(HRegionServer.java:2433)
- at sun.reflect.GeneratedMethodAccessor20.invoke(Unknown Source)
- at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
- at java.lang.reflect.Method.invoke(Method.java:597)
- at org.apache.hadoop.hbase.ipc.HBaseRPC$Server.call(HBaseRPC.java:560)
- at org.apache.hadoop.hbase.ipc.HBaseServer$Handler.run(HBaseServer.java:1027)
- </programlisting>
- <para> A thread that receives data from HDFS:</para>
- <programlisting>
-"IPC Client (47) connection to sv4borg9/10.4.24.40:9000 from hadoop" daemon prio=10 tid=0x00007f16a02d0000 nid=0x4fa3 runnable [0x00007f16b517d000..0x00007f16b517dbf0]
- java.lang.Thread.State: RUNNABLE
- at sun.nio.ch.EPollArrayWrapper.epollWait(Native Method)
- at sun.nio.ch.EPollArrayWrapper.poll(EPollArrayWrapper.java:215)
- at sun.nio.ch.EPollSelectorImpl.doSelect(EPollSelectorImpl.java:65)
- at sun.nio.ch.SelectorImpl.lockAndDoSelect(SelectorImpl.java:69)
- - locked <0x00007f17d5b68c00> (a sun.nio.ch.Util$1)
- - locked <0x00007f17d5b68be8> (a java.util.Collections$UnmodifiableSet)
- - locked <0x00007f1877959b50> (a sun.nio.ch.EPollSelectorImpl)
- at sun.nio.ch.SelectorImpl.select(SelectorImpl.java:80)
- at org.apache.hadoop.net.SocketIOWithTimeout$SelectorPool.select(SocketIOWithTimeout.java:332)
- at org.apache.hadoop.net.SocketIOWithTimeout.doIO(SocketIOWithTimeout.java:157)
- at org.apache.hadoop.net.SocketInputStream.read(SocketInputStream.java:155)
- at org.apache.hadoop.net.SocketInputStream.read(SocketInputStream.java:128)
- at java.io.FilterInputStream.read(FilterInputStream.java:116)
- at org.apache.hadoop.ipc.Client$Connection$PingInputStream.read(Client.java:304)
- at java.io.BufferedInputStream.fill(BufferedInputStream.java:218)
- at java.io.BufferedInputStream.read(BufferedInputStream.java:237)
- - locked <0x00007f1808539178> (a java.io.BufferedInputStream)
- at java.io.DataInputStream.readInt(DataInputStream.java:370)
- at org.apache.hadoop.ipc.Client$Connection.receiveResponse(Client.java:569)
- at org.apache.hadoop.ipc.Client$Connection.run(Client.java:477)
- </programlisting>
- <para> And here is a master trying to recover a lease after a RegionServer died:</para>
- <programlisting>
-"LeaseChecker" daemon prio=10 tid=0x00000000407ef800 nid=0x76cd waiting on condition [0x00007f6d0eae2000..0x00007f6d0eae2a70]
---
- java.lang.Thread.State: WAITING (on object monitor)
- at java.lang.Object.wait(Native Method)
- at java.lang.Object.wait(Object.java:485)
- at org.apache.hadoop.ipc.Client.call(Client.java:726)
- - locked <0x00007f6d1cd28f80> (a org.apache.hadoop.ipc.Client$Call)
- at org.apache.hadoop.ipc.RPC$Invoker.invoke(RPC.java:220)
- at $Proxy1.recoverBlock(Unknown Source)
- at org.apache.hadoop.hdfs.DFSClient$DFSOutputStream.processDatanodeError(DFSClient.java:2636)
- at org.apache.hadoop.hdfs.DFSClient$DFSOutputStream.<init>(DFSClient.java:2832)
- at org.apache.hadoop.hdfs.DFSClient.append(DFSClient.java:529)
- at org.apache.hadoop.hdfs.DistributedFileSystem.append(DistributedFileSystem.java:186)
- at org.apache.hadoop.fs.FileSystem.append(FileSystem.java:530)
- at org.apache.hadoop.hbase.util.FSUtils.recoverFileLease(FSUtils.java:619)
- at org.apache.hadoop.hbase.regionserver.wal.HLog.splitLog(HLog.java:1322)
- at org.apache.hadoop.hbase.regionserver.wal.HLog.splitLog(HLog.java:1210)
- at org.apache.hadoop.hbase.master.HMaster.splitLogAfterStartup(HMaster.java:648)
- at org.apache.hadoop.hbase.master.HMaster.joinCluster(HMaster.java:572)
- at org.apache.hadoop.hbase.master.HMaster.run(HMaster.java:503)
- </programlisting>
- </section>
- <section
- xml:id="trouble.tools.opentsdb">
- <title>OpenTSDB</title>
- <para>
- <link
- xlink:href="http://opentsdb.net">OpenTSDB</link> is an excellent alternative to Ganglia
- as it uses Apache HBase to store all the time series and doesn’t have to downsample.
- Monitoring your own HBase cluster that hosts OpenTSDB is a good exercise. </para>
- <para> Here’s an example of a cluster that’s suffering from hundreds of compactions launched
- almost all around the same time, which severely affects the IO performance: (TODO: insert
- graph plotting compactionQueueSize) </para>
- <para> It’s a good practice to build dashboards with all the important graphs per machine
- and per cluster so that debugging issues can be done with a single quick look. For
- example, at StumbleUpon there’s one dashboard per cluster with the most important metrics
- from both the OS and Apache HBase. You can then go down at the machine level and get even
- more detailed metrics. </para>
- </section>
- <section
- xml:id="trouble.tools.clustersshtop">
- <title>clusterssh+top</title>
- <para> clusterssh+top, it’s like a poor man’s monitoring system and it can be quite useful
- when you have only a few machines as it’s very easy to setup. Starting clusterssh will
- give you one terminal per machine and another terminal in which whatever you type will be
- retyped in every window. This means that you can type “top” once and it will start it for
- all of your machines at the same time giving you full view of the current state of your
- cluster. You can also tail all the logs at the same time, edit files, etc. </para>
- </section>
- </section>
- </section>
-
- <section
- xml:id="trouble.client">
- <title>Client</title>
- <para>For more information on the HBase client, see <xref
- linkend="client" />. </para>
- <section
- xml:id="trouble.client.scantimeout">
- <title>ScannerTimeoutException or UnknownScannerException</title>
- <para>This is thrown if the time between RPC calls from the client to RegionServer exceeds the
- scan timeout. For example, if <code>Scan.setCaching</code> is set to 500, then there will be
- an RPC call to fetch the next batch of rows every 500 <code>.next()</code> calls on the
- ResultScanner because data is being transferred in blocks of 500 rows to the client.
- Reducing the setCaching value may be an option, but setting this value too low makes for
- inefficient processing on numbers of rows. </para>
- <para>See <xref
- linkend="perf.hbase.client.caching" />. </para>
- </section>
- <section>
- <title>Performance Differences in Thrift and Java APIs</title>
- <para>Poor performance, or even <code>ScannerTimeoutExceptions</code>, can occur if
- <code>Scan.setCaching</code> is too high, as discussed in <xref
- linkend="trouble.client.scantimeout"/>. If the Thrift client uses the wrong caching
- settings for a given workload, performance can suffer compared to the Java API. To set
- caching for a given scan in the Thrift client, use the <code>scannerGetList(scannerId,
- numRows)</code> method, where <code>numRows</code> is an integer representing the number
- of rows to cache. In one case, it was found that reducing the cache for Thrift scans from
- 1000 to 100 increased performance to near parity with the Java API given the same
- queries.</para>
- <para>See also Jesse Andersen's <link xlink:href="http://blog.cloudera.com/blog/2014/04/how-to-use-the-hbase-thrift-interface-part-3-using-scans/">blog post</link>
- about using Scans with Thrift.</para>
- </section>
- <section
- xml:id="trouble.client.lease.exception">
- <title><classname>LeaseException</classname> when calling
- <classname>Scanner.next</classname></title>
- <para> In some situations clients that fetch data from a RegionServer get a LeaseException
- instead of the usual <xref
- linkend="trouble.client.scantimeout" />. Usually the source of the exception is
- <classname>org.apache.hadoop.hbase.regionserver.Leases.removeLease(Leases.java:230)</classname>
- (line number may vary). It tends to happen in the context of a slow/freezing
- RegionServer#next call. It can be prevented by having <varname>hbase.rpc.timeout</varname> >
- <varname>hbase.regionserver.lease.period</varname>. Harsh J investigated the issue as part
- of the mailing list thread <link
- xlink:href="http://mail-archives.apache.org/mod_mbox/hbase-user/201209.mbox/%3CCAOcnVr3R-LqtKhFsk8Bhrm-YW2i9O6J6Fhjz2h7q6_sxvwd2yw%40mail.gmail.com%3E">HBase,
- mail # user - Lease does not exist exceptions</link>
- </para>
- </section>
- <section
- xml:id="trouble.client.scarylogs">
- <title>Shell or client application throws lots of scary exceptions during normal
- operation</title>
- <para>Since 0.20.0 the default log level for <code>org.apache.hadoop.hbase.*</code>is DEBUG. </para>
- <para> On your clients, edit <filename>$HBASE_HOME/conf/log4j.properties</filename> and change
- this: <code>log4j.logger.org.apache.hadoop.hbase=DEBUG</code> to this:
- <code>log4j.logger.org.apache.hadoop.hbase=INFO</code>, or even
- <code>log4j.logger.org.apache.hadoop.hbase=WARN</code>. </para>
- </section>
- <section
- xml:id="trouble.client.longpauseswithcompression">
- <title>Long Client Pauses With Compression</title>
- <para>This is a fairly frequent question on the Apache HBase dist-list. The scenario is that a
- client is typically inserting a lot of data into a relatively un-optimized HBase cluster.
- Compression can exacerbate the pauses, although it is not the source of the problem.</para>
- <para>See <xref
- linkend="precreate.regions" /> on the pattern for pre-creating regions and confirm that
- the table isn't starting with a single region.</para>
- <para>See <xref
- linkend="perf.configurations" /> for cluster configuration, particularly
- <code>hbase.hstore.blockingStoreFiles</code>,
- <code>hbase.hregion.memstore.block.multiplier</code>, <code>MAX_FILESIZE</code> (region
- size), and <code>MEMSTORE_FLUSHSIZE.</code>
- </para>
- <para>A slightly longer explanation of why pauses can happen is as follows: Puts are sometimes
- blocked on the MemStores which are blocked by the flusher thread which is blocked because
- there are too many files to compact because the compactor is given too many small files to
- compact and has to compact the same data repeatedly. This situation can occur even with
- minor compactions. Compounding this situation, Apache HBase doesn't compress data in memory.
- Thus, the 64MB that lives in the MemStore could become a 6MB file after compression - which
- results in a smaller StoreFile. The upside is that more data is packed into the same region,
- but performance is achieved by being able to write larger files - which is why HBase waits
- until the flushize before writing a new StoreFile. And smaller StoreFiles become targets for
- compaction. Without compression the files are much bigger and don't need as much compaction,
- however this is at the expense of I/O. </para>
- <para> For additional information, see this thread on <link
- xlink:href="http://search-hadoop.com/m/WUnLM6ojHm1/Long+client+pauses+with+compression&subj=Long+client+pauses+with+compression">Long
- client pauses with compression</link>. </para>
- </section>
- <section xml:id="trouble.client.security.rpc.krb">
- <title>Secure Client Connect ([Caused by GSSException: No valid credentials provided...])</title>
- <para>You may encounter the following error:</para>
- <screen>Secure Client Connect ([Caused by GSSException: No valid credentials provided
- (Mechanism level: Request is a replay (34) V PROCESS_TGS)])</screen>
- <para> This issue is caused by bugs in the MIT Kerberos replay_cache component, <link
- xlink:href="http://krbdev.mit.edu/rt/Ticket/Display.html?id=1201">#1201</link> and <link
- xlink:href="http://krbdev.mit.edu/rt/Ticket/Display.html?id=5924">#5924</link>. These bugs
- caused the old version of krb5-server to erroneously block subsequent requests sent from a
- Principal. This caused krb5-server to block the connections sent from one Client (one HTable
- instance with multi-threading connection instances for each regionserver); Messages, such as
- <literal>Request is a replay (34)</literal>, are logged in the client log You can ignore
- the messages, because HTable will retry 5 * 10 (50) times for each failed connection by
- default. HTable will throw IOException if any connection to the regionserver fails after the
- retries, so that the user client code for HTable instance can handle it further. </para>
- <para> Alternatively, update krb5-server to a version which solves these issues, such as
- krb5-server-1.10.3. See JIRA <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-10379">HBASE-10379</link> for more
- details. </para>
- </section>
- <section
- xml:id="trouble.client.zookeeper">
- <title>ZooKeeper Client Connection Errors</title>
- <para>Errors like this...</para>
- <programlisting>
-11/07/05 11:26:41 WARN zookeeper.ClientCnxn: Session 0x0 for server null,
- unexpected error, closing socket connection and attempting reconnect
- java.net.ConnectException: Connection refused: no further information
- at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)
- at sun.nio.ch.SocketChannelImpl.finishConnect(Unknown Source)
- at org.apache.zookeeper.ClientCnxn$SendThread.run(ClientCnxn.java:1078)
- 11/07/05 11:26:43 INFO zookeeper.ClientCnxn: Opening socket connection to
- server localhost/127.0.0.1:2181
- 11/07/05 11:26:44 WARN zookeeper.ClientCnxn: Session 0x0 for server null,
- unexpected error, closing socket connection and attempting reconnect
- java.net.ConnectException: Connection refused: no further information
- at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)
- at sun.nio.ch.SocketChannelImpl.finishConnect(Unknown Source)
- at org.apache.zookeeper.ClientCnxn$SendThread.run(ClientCnxn.java:1078)
- 11/07/05 11:26:45 INFO zookeeper.ClientCnxn: Opening socket connection to
- server localhost/127.0.0.1:2181
-</programlisting>
- <para>... are either due to ZooKeeper being down, or unreachable due to network issues. </para>
- <para>The utility <xref
- linkend="trouble.tools.builtin.zkcli" /> may help investigate ZooKeeper issues. </para>
- </section>
- <section
- xml:id="trouble.client.oome.directmemory.leak">
- <title>Client running out of memory though heap size seems to be stable (but the
- off-heap/direct heap keeps growing)</title>
- <para> You are likely running into the issue that is described and worked through in the mail
- thread <link
- xlink:href="http://search-hadoop.com/m/ubhrX8KvcH/Suspected+memory+leak&subj=Re+Suspected+memory+leak">HBase,
- mail # user - Suspected memory leak</link> and continued over in <link
- xlink:href="http://search-hadoop.com/m/p2Agc1Zy7Va/MaxDirectMemorySize+Was%253A+Suspected+memory+leak&subj=Re+FeedbackRe+Suspected+memory+leak">HBase,
- mail # dev - FeedbackRe: Suspected memory leak</link>. A workaround is passing your
- client-side JVM a reasonable value for <code>-XX:MaxDirectMemorySize</code>. By default, the
- <varname>MaxDirectMemorySize</varname> is equal to your <code>-Xmx</code> max heapsize
- setting (if <code>-Xmx</code> is set). Try seting it to something smaller (for example, one
- user had success setting it to <code>1g</code> when they had a client-side heap of
- <code>12g</code>). If you set it too small, it will bring on <code>FullGCs</code> so keep
- it a bit hefty. You want to make this setting client-side only especially if you are running
- the new experiemental server-side off-heap cache since this feature depends on being able to
- use big direct buffers (You may have to keep separate client-side and server-side config
- dirs). </para>
-
- </section>
- <section
- xml:id="trouble.client.slowdown.admin">
- <title>Client Slowdown When Calling Admin Methods (flush, compact, etc.)</title>
- <para> This is a client issue fixed by <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-5073">HBASE-5073</link> in 0.90.6.
- There was a ZooKeeper leak in the client and the client was getting pummeled by ZooKeeper
- events with each additional invocation of the admin API. </para>
- </section>
-
- <section
- xml:id="trouble.client.security.rpc">
- <title>Secure Client Cannot Connect ([Caused by GSSException: No valid credentials provided
- (Mechanism level: Failed to find any Kerberos tgt)])</title>
- <para> There can be several causes that produce this symptom. </para>
- <para> First, check that you have a valid Kerberos ticket. One is required in order to set up
- communication with a secure Apache HBase cluster. Examine the ticket currently in the
- credential cache, if any, by running the klist command line utility. If no ticket is listed,
- you must obtain a ticket by running the kinit command with either a keytab specified, or by
- interactively entering a password for the desired principal. </para>
- <para> Then, consult the <link
- xlink:href="http://docs.oracle.com/javase/1.5.0/docs/guide/security/jgss/tutorials/Troubleshooting.html">Java
- Security Guide troubleshooting section</link>. The most common problem addressed there is
- resolved by setting javax.security.auth.useSubjectCredsOnly system property value to false. </para>
- <para> Because of a change in the format in which MIT Kerberos writes its credentials cache,
- there is a bug in the Oracle JDK 6 Update 26 and earlier that causes Java to be unable to
- read the Kerberos credentials cache created by versions of MIT Kerberos 1.8.1 or higher. If
- you have this problematic combination of components in your environment, to work around this
- problem, first log in with kinit and then immediately refresh the credential cache with
- kinit -R. The refresh will rewrite the credential cache without the problematic formatting. </para>
- <para> Finally, depending on your Kerberos configuration, you may need to install the <link
- xlink:href="http://docs.oracle.com/javase/1.4.2/docs/guide/security/jce/JCERefGuide.html">Java
- Cryptography Extension</link>, or JCE. Insure the JCE jars are on the classpath on both
- server and client systems. </para>
- <para> You may also need to download the <link
- xlink:href="http://www.oracle.com/technetwork/java/javase/downloads/jce-6-download-429243.html">unlimited
- strength JCE policy files</link>. Uncompress and extract the downloaded file, and install
- the policy jars into <java-home>/lib/security. </para>
- </section>
-
- </section>
-
- <section
- xml:id="trouble.mapreduce">
- <title>MapReduce</title>
- <section
- xml:id="trouble.mapreduce.local">
- <title>You Think You're On The Cluster, But You're Actually Local</title>
- <para>This following stacktrace happened using <code>ImportTsv</code>, but things like this
- can happen on any job with a mis-configuration.</para>
- <programlisting>
- WARN mapred.LocalJobRunner: job_local_0001
-java.lang.IllegalArgumentException: Can't read partitions file
- at org.apache.hadoop.hbase.mapreduce.hadoopbackport.TotalOrderPartitioner.setConf(TotalOrderPartitioner.java:111)
- at org.apache.hadoop.util.ReflectionUtils.setConf(ReflectionUtils.java:62)
- at org.apache.hadoop.util.ReflectionUtils.newInstance(ReflectionUtils.java:117)
- at org.apache.hadoop.mapred.MapTask$NewOutputCollector.<init>(MapTask.java:560)
- at org.apache.hadoop.mapred.MapTask.runNewMapper(MapTask.java:639)
- at org.apache.hadoop.mapred.MapTask.run(MapTask.java:323)
- at org.apache.hadoop.mapred.LocalJobRunner$Job.run(LocalJobRunner.java:210)
-Caused by: java.io.FileNotFoundException: File _partition.lst does not exist.
- at org.apache.hadoop.fs.RawLocalFileSystem.getFileStatus(RawLocalFileSystem.java:383)
- at org.apache.hadoop.fs.FilterFileSystem.getFileStatus(FilterFileSystem.java:251)
- at org.apache.hadoop.fs.FileSystem.getLength(FileSystem.java:776)
- at org.apache.hadoop.io.SequenceFile$Reader.<init>(SequenceFile.java:1424)
- at org.apache.hadoop.io.SequenceFile$Reader.<init>(SequenceFile.java:1419)
- at org.apache.hadoop.hbase.mapreduce.hadoopbackport.TotalOrderPartitioner.readPartitions(TotalOrderPartitioner.java:296)
-</programlisting>
- <para>.. see the critical portion of the stack? It's...</para>
- <programlisting>
-at org.apache.hadoop.mapred.LocalJobRunner$Job.run(LocalJobRunner.java:210)
-</programlisting>
- <para>LocalJobRunner means the job is running locally, not on the cluster. </para>
-
- <para>To solve this problem, you should run your MR job with your
- <code>HADOOP_CLASSPATH</code> set to include the HBase dependencies. The "hbase classpath"
- utility can be used to do this easily. For example (substitute VERSION with your HBase
- version):</para>
- <programlisting language="bourne">
- HADOOP_CLASSPATH=`hbase classpath` hadoop jar $HBASE_HOME/hbase-server-VERSION.jar rowcounter usertable
- </programlisting>
- <para>See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/package-summary.html#classpath">
- http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/package-summary.html#classpath</link>
- for more information on HBase MapReduce jobs and classpaths. </para>
- </section>
- <section xml:id="trouble.hbasezerocopybytestring">
- <title>Launching a job, you get java.lang.IllegalAccessError: com/google/protobuf/HBaseZeroCopyByteString or class com.google.protobuf.ZeroCopyLiteralByteString cannot access its superclass com.google.protobuf.LiteralByteString</title>
- <para>See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-10304">HBASE-10304 Running an hbase job jar: IllegalAccessError: class com.google.protobuf.ZeroCopyLiteralByteString cannot access its superclass com.google.protobuf.LiteralByteString</link> and <link xlink:href="https://issues.apache.org/jira/browse/HBASE-11118">HBASE-11118 non environment variable solution for "IllegalAccessError: class com.google.protobuf.ZeroCopyLiteralByteString cannot access its superclass com.google.protobuf.LiteralByteString"</link>. The issue can also show up
- when trying to run spark jobs. See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-10877">HBASE-10877 HBase non-retriable exception list should be expanded</link>.
- </para>
- </section>
- </section>
-
- <section
- xml:id="trouble.namenode">
- <title>NameNode</title>
- <para>For more information on the NameNode, see <xref
- linkend="arch.hdfs" />. </para>
- <section
- xml:id="trouble.namenode.disk">
- <title>HDFS Utilization of Tables and Regions</title>
- <para>To determine how much space HBase is using on HDFS use the <code>hadoop</code> shell
- commands from the NameNode. For example... </para>
- <para><programlisting language="bourne">hadoop fs -dus /hbase/</programlisting> ...returns the summarized disk
- utilization for all HBase objects. </para>
- <para><programlisting language="bourne">hadoop fs -dus /hbase/myTable</programlisting> ...returns the summarized
- disk utilization for the HBase table 'myTable'. </para>
- <para><programlisting language="bourne">hadoop fs -du /hbase/myTable</programlisting> ...returns a list of the
- regions under the HBase table 'myTable' and their disk utilization. </para>
- <para>For more information on HDFS shell commands, see the <link
- xlink:href="http://hadoop.apache.org/common/docs/current/file_system_shell.html">HDFS
- FileSystem Shell documentation</link>. </para>
- </section>
- <section
- xml:id="trouble.namenode.hbase.objects">
- <title>Browsing HDFS for HBase Objects</title>
- <para>Sometimes it will be necessary to explore the HBase objects that exist on HDFS. These
- objects could include the WALs (Write Ahead Logs), tables, regions, StoreFiles, etc. The
- easiest way to do this is with the NameNode web application that runs on port 50070. The
- NameNode web application will provide links to the all the DataNodes in the cluster so that
- they can be browsed seamlessly. </para>
- <para>The HDFS directory structure of HBase tables in the cluster is...
- <programlisting>
-<filename>/hbase</filename>
- <filename>/<Table></filename> (Tables in the cluster)
- <filename>/<Region></filename> (Regions for the table)
- <filename>/<ColumnFamily></filename> (ColumnFamilies for the Region for the table)
- <filename>/<StoreFile></filename> (StoreFiles for the ColumnFamily for the Regions for the table)
- </programlisting>
- </para>
- <para>The HDFS directory structure of HBase WAL is..
- <programlisting>
-<filename>/hbase</filename>
- <filename>/.logs</filename>
- <filename>/<RegionServer></filename> (RegionServers)
- <filename>/<WAL></filename> (WAL files for the RegionServer)
- </programlisting>
- </para>
- <para>See the <link
- xlink:href="http://hadoop.apache.org/common/docs/current/hdfs_user_guide.html">HDFS User
- Guide</link> for other non-shell diagnostic utilities like <code>fsck</code>. </para>
- <section
- xml:id="trouble.namenode.0size.hlogs">
- <title>Zero size WALs with data in them</title>
- <para>Problem: when getting a listing of all the files in a region server's .logs directory,
- one file has a size of 0 but it contains data.</para>
- <para>Answer: It's an HDFS quirk. A file that's currently being written to will appear to
- have a size of 0 but once it's closed it will show its true size</para>
- </section>
- <section
- xml:id="trouble.namenode.uncompaction">
- <title>Use Cases</title>
- <para>Two common use-cases for querying HDFS for HBase objects is research the degree of
- uncompaction of a table. If there are a large number of StoreFiles for each ColumnFamily
- it could indicate the need for a major compaction. Additionally, after a major compaction
- if the resulting StoreFile is "small" it could indicate the need for a reduction of
- ColumnFamilies for the table. </para>
- </section>
-
- </section>
- </section>
-
- <section
- xml:id="trouble.network">
- <title>Network</title>
- <section
- xml:id="trouble.network.spikes">
- <title>Network Spikes</title>
- <para>If you are seeing periodic network spikes you might want to check the
- <code>compactionQueues</code> to see if major compactions are happening. </para>
- <para>See <xref
- linkend="managed.compactions" /> for more information on managing compactions. </para>
- </section>
- <section
- xml:id="trouble.network.loopback">
- <title>Loopback IP</title>
- <para>HBase expects the loopback IP Address to be 127.0.0.1. See the Getting Started section
- on <xref
- linkend="loopback.ip" />. </para>
- </section>
- <section
- xml:id="trouble.network.ints">
- <title>Network Interfaces</title>
- <para>Are all the network interfaces functioning correctly? Are you sure? See the
- Troubleshooting Case Study in <xref
- linkend="trouble.casestudy" />. </para>
- </section>
-
- </section>
-
- <section
- xml:id="trouble.rs">
- <title>RegionServer</title>
- <para>For more information on the RegionServers, see <xref
- linkend="regionserver.arch" />. </para>
- <section
- xml:id="trouble.rs.startup">
- <title>Startup Errors</title>
- <section
- xml:id="trouble.rs.startup.master-no-region">
- <title>Master Starts, But RegionServers Do Not</title>
- <para>The Master believes the RegionServers have the IP of 127.0.0.1 - which is localhost
- and resolves to the master's own localhost. </para>
- <para>The RegionServers are erroneously informing the Master that their IP addresses are
- 127.0.0.1. </para>
- <para>Modify <filename>/etc/hosts</filename> on the region servers, from...</para>
- <programlisting>
-# Do not remove the following line, or various programs
-# that require network functionality will fail.
-127.0.0.1 fully.qualified.regionservername regionservername localhost.localdomain localhost
-::1 localhost6.localdomain6 localhost6
- </programlisting>
- <para>... to (removing the master node's name from localhost)...</para>
- <programlisting>
-# Do not remove the following line, or various programs
-# that require network functionality will fail.
-127.0.0.1 localhost.localdomain localhost
-::1 localhost6.localdomain6 localhost6
- </programlisting>
- </section>
-
- <section
- xml:id="trouble.rs.startup.compression">
- <title>Compression Link Errors</title>
- <para> Since compression algorithms such as LZO need to be installed and configured on each
- cluster this is a frequent source of startup error. If you see messages like
- this...</para>
- <programlisting>
-11/02/20 01:32:15 ERROR lzo.GPLNativeCodeLoader: Could not load native gpl library
-java.lang.UnsatisfiedLinkError: no gplcompression in java.library.path
- at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1734)
- at java.lang.Runtime.loadLibrary0(Runtime.java:823)
- at java.lang.System.loadLibrary(System.java:1028)
- </programlisting>
- <para>.. then there is a path issue with the compression libraries. See the Configuration
- section on <link
- linkend="lzo.compression">LZO compression configuration</link>. </para>
- </section>
- </section>
- <section
- xml:id="trouble.rs.runtime">
- <title>Runtime Errors</title>
-
- <section
- xml:id="trouble.rs.runtime.hang">
- <title>RegionServer Hanging</title>
- <para> Are you running an old JVM (< 1.6.0_u21?)? When you look at a thread dump, does it
- look like threads are BLOCKED but no one holds the lock all are blocked on? See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-3622">HBASE 3622 Deadlock in
- HBaseServer (JVM bug?)</link>. Adding <code>-XX:+UseMembar</code> to the HBase
- <varname>HBASE_OPTS</varname> in <filename>conf/hbase-env.sh</filename> may fix it.
- </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.filehandles">
- <title>java.io.IOException...(Too many open files)</title>
- <para> If you see log messages like this...</para>
- <programlisting>
-2010-09-13 01:24:17,336 WARN org.apache.hadoop.hdfs.server.datanode.DataNode:
-Disk-related IOException in BlockReceiver constructor. Cause is java.io.IOException: Too many open files
- at java.io.UnixFileSystem.createFileExclusively(Native Method)
- at java.io.File.createNewFile(File.java:883)
-</programlisting>
- <para>... see the Getting Started section on <link
- linkend="ulimit">ulimit and nproc configuration</link>. </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.xceivers">
- <title>xceiverCount 258 exceeds the limit of concurrent xcievers 256</title>
- <para> This typically shows up in the DataNode logs. </para>
- <para> See the Getting Started section on <link
- linkend="dfs.datanode.max.transfer.threads">xceivers configuration</link>. </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.oom-nt">
- <title>System instability, and the presence of "java.lang.OutOfMemoryError: unable to create
- new native thread in exceptions" HDFS DataNode logs or that of any system daemon</title>
- <para> See the Getting Started section on <link
- linkend="ulimit">ulimit and nproc configuration</link>. The default on recent Linux
- distributions is 1024 - which is far too low for HBase. </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.gc">
- <title>DFS instability and/or RegionServer lease timeouts</title>
- <para> If you see warning messages like this...</para>
- <programlisting>
-2009-02-24 10:01:33,516 WARN org.apache.hadoop.hbase.util.Sleeper: We slept xxx ms, ten times longer than scheduled: 10000
-2009-02-24 10:01:33,516 WARN org.apache.hadoop.hbase.util.Sleeper: We slept xxx ms, ten times longer than scheduled: 15000
-2009-02-24 10:01:36,472 WARN org.apache.hadoop.hbase.regionserver.HRegionServer: unable to report to master for xxx milliseconds - retrying
- </programlisting>
- <para>... or see full GC compactions then you may be experiencing full GC's. </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.nolivenodes">
- <title>"No live nodes contain current block" and/or YouAreDeadException</title>
- <para> These errors can happen either when running out of OS file handles or in periods of
- severe network problems where the nodes are unreachable. </para>
- <para> See the Getting Started section on <link
- linkend="ulimit">ulimit and nproc configuration</link> and check your network. </para>
- </section>
- <section
- xml:id="trouble.rs.runtime.zkexpired">
- <title>ZooKeeper SessionExpired events</title>
- <para>Master or RegionServers shutting down with messages like those in the logs: </para>
- <programlisting>
-WARN org.apache.zookeeper.ClientCnxn: Exception
-closing session 0x278bd16a96000f to sun.nio.ch.SelectionKeyImpl@355811ec
-java.io.IOException: TIMED OUT
- at org.apache.zookeeper.ClientCnxn$SendThread.run(ClientCnxn.java:906)
-WARN org.apache.hadoop.hbase.util.Sleeper: We slept 79410ms, ten times longer than scheduled: 5000
-INFO org.apache.zookeeper.ClientCnxn: Attempting connection to server hostname/IP:PORT
-INFO org.apache.zookeeper.ClientCnxn: Priming connection to java.nio.channels.SocketChannel[connected local=/IP:PORT remote=hostname/IP:PORT]
-INFO org.apache.zookeeper.ClientCnxn: Server connection successful
-WARN org.apache.zookeeper.ClientCnxn: Exception closing session 0x278bd16a96000d to sun.nio.ch.SelectionKeyImpl@3544d65e
-java.io.IOException: Session Expired
- at org.apache.zookeeper.ClientCnxn$SendThread.readConnectResult(ClientCnxn.java:589)
- at org.apache.zookeeper.ClientCnxn$SendThread.doIO(ClientCnxn.java:709)
- at org.apache.zookeeper.ClientCnxn$SendThread.run(ClientCnxn.java:945)
-ERROR org.apache.hadoop.hbase.regionserver.HRegionServer: ZooKeeper session expired
- </programlisting>
- <para> The JVM is doing a long running garbage collecting which is pausing every threads
- (aka "stop the world"). Since the RegionServer's local ZooKeeper client cannot send
- heartbeats, the session times out. By design, we shut down any node that isn't able to
- contact the ZooKeeper ensemble after getting a timeout so that it stops serving data that
- may already be assigned elsewhere. </para>
-
- <itemizedlist>
- <listitem>
- <para>Make sure you give plenty of RAM (in <filename>hbase-env.sh</filename>), the
- default of 1GB won't be able to sustain long running imports.</para>
- </listitem>
- <listitem>
- <para>Make sure you don't swap, the JVM never behaves well under swapping.</para>
- </listitem>
- <listitem>
- <para>Make sure you are not CPU starving the RegionServer thread. For example, if you
- are running a MapReduce job using 6 CPU-intensive tasks on a machine with 4 cores, you
- are probably starving the RegionServer enough to create longer garbage collection
- pauses.</para>
- </listitem>
- <listitem>
- <para>Increase the ZooKeeper session timeout</para>
- </listitem>
- </itemizedlist>
- <para>If you wish to increase the session timeout, add the following to your
- <filename>hbase-site.xml</filename> to increase the timeout from the default of 60
- seconds to 120 seconds. </para>
- <programlisting language="xml">
-<![CDATA[<property>
- <name>zookeeper.session.timeout</name>
- <value>1200000</value>
-</property>
-<property>
- <name>hbase.zookeeper.property.tickTime</name>
- <value>6000</value>
-</property>]]>
- </programlisting>
-
- <para>
- Be aware that setting a higher timeout means that the regions served by a failed RegionServer will take at least
- that amount of time to be transfered to another RegionServer. For a production system serving live requests, we would instead
- recommend setting it lower than 1 minute and over-provision your cluster in order the lower the memory load on each machines (hence having
- less garbage to collect per machine).
- </para>
- <para>
- If this is happening during an upload which only happens once (like initially loading all your data into HBase), consider bulk loading.
- </para>
-<para>See <xref linkend="trouble.zookeeper.general"/> for other general information about ZooKeeper troubleshooting.
-</para> </section>
- <section xml:id="trouble.rs.runtime.notservingregion">
- <title>NotServingRegionException</title>
- <para>This exception is "normal" when found in the RegionServer logs at DEBUG level. This exception is returned back to the client
- and then the client goes back to hbase:meta to find the new location of the moved region.</para>
- <para>However, if the NotServingRegionException is logged ERROR, then the client ran out of retries and something probably wrong.</para>
- </section>
- <section xml:id="trouble.rs.runtime.double_listed_regions">
- <title>Regions listed by domain name, then IP</title>
- <para>
- Fix your DNS. In versions of Apache HBase before 0.92.x, reverse DNS needs to give same answer
- as forward lookup. See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-3431">HBASE 3431
- RegionServer is not using the name given it by the master; double entry in master listing of servers</link> for gorey details.
- </para>
- </section>
- <section xml:id="brand.new.compressor">
- <title>Logs flooded with '2011-01-10 12:40:48,407 INFO org.apache.hadoop.io.compress.CodecPool: Got
- brand-new compressor' messages</title>
- <para>We are not using the native versions of compression
- libraries. See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-1900">HBASE-1900 Put back native support when hadoop 0.21 is released</link>.
- Copy the native libs from hadoop under hbase lib dir or
- symlink them into place and the message should go away.
- </para>
- </section>
- <section xml:id="trouble.rs.runtime.client_went_away">
- <title>Server handler X on 60020 caught: java.nio.channels.ClosedChannelException</title>
- <para>
- If you see this type of message it means that the region server was trying to read/send data from/to a client but
- it already went away. Typical causes for this are if the client was killed (you see a storm of messages like this when a MapReduce
- job is killed or fails) or if the client receives a SocketTimeoutException. It's harmless, but you should consider digging in
- a bit more if you aren't doing something to trigger them.
- </para>
- </section>
-
- </section>
- <section>
- <title>Snapshot Errors Due to Reverse DNS</title>
- <para>Several operations within HBase, including snapshots, rely on properly configured
- reverse DNS. Some environments, such as Amazon EC2, have trouble with reverse DNS. If you
- see errors like the following on your RegionServers, check your reverse DNS configuration:</para>
- <screen>
-2013-05-01 00:04:56,356 DEBUG org.apache.hadoop.hbase.procedure.Subprocedure: Subprocedure 'backup1'
-coordinator notified of 'acquire', waiting on 'reached' or 'abort' from coordinator.
- </screen>
- <para>In general, the hostname reported by the RegionServer needs to be the same as the
- hostname the Master is trying to reach. You can see a hostname mismatch by looking for the
- following type of message in the RegionServer's logs at start-up.</para>
- <screen>
-2013-05-01 00:03:00,614 INFO org.apache.hadoop.hbase.regionserver.HRegionServer: Master passed us hostname
-to use. Was=myhost-1234, Now=ip-10-55-88-99.ec2.internal
- </screen>
- </section>
- <section xml:id="trouble.rs.shutdown">
- <title>Shutdown Errors</title>
- <para />
- </section>
-
- </section>
-
- <section xml:id="trouble.master">
- <title>Master</title>
- <para>For more information on the Master, see <xref linkend="master"/>.
- </para>
- <section xml:id="trouble.master.startup">
- <title>Startup Errors</title>
- <section xml:id="trouble.master.startup.migration">
- <title>Master says that you need to run the hbase migrations script</title>
- <para>Upon running that, the hbase migrations script says no files in root directory.</para>
- <para>HBase expects the root directory to either not exist, or to have already been initialized by hbase running a previous time. If you create a new directory for HBase using Hadoop DFS, this error will occur.
- Make sure the HBase root directory does not currently exist or has been initialized by a previous run of HBase. Sure fire solution is to just use Hadoop dfs to delete the HBase root and let HBase create and initialize the directory itself.
- </para>
- </section>
- <section xml:id="trouble.master.startup.zk.buffer">
- <title>Packet len6080218 is out of range!</title>
- <para>If you have many regions on your cluster and you see an error
- like that reported above in this sections title in your logs, see
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-4246">HBASE-4246 Cluster with too many regions cannot withstand some master failover scenarios</link>.</para>
- </section>
-
- </section>
- <section xml:id="trouble.master.shutdown">
- <title>Shutdown Errors</title>
- <para/>
- </section>
-
- </section>
-
- <section xml:id="trouble.zookeeper">
- <title>ZooKeeper</title>
- <section xml:id="trouble.zookeeper.startup">
- <title>Startup Errors</title>
- <section xml:id="trouble.zookeeper.startup.address">
- <title>Could not find my address: xyz in list of ZooKeeper quorum servers</title>
- <para>A ZooKeeper server wasn't able to start, throws that error. xyz is the name of your server.</para>
- <para>This is a name lookup problem. HBase tries to start a ZooKeeper server on some machine but that machine isn't able to find itself in the <varname>hbase.zookeeper.quorum</varname> configuration.
- </para>
- <para>Use the hostname presented in the error message instead of the value you used. If you have a DNS server, you can set <varname>hbase.zookeeper.dns.interface</varname> and <varname>hbase.zookeeper.dns.nameserver</varname> in <filename>hbase-site.xml</filename> to make sure it resolves to the correct FQDN.
- </para>
- </section>
-
- </section>
- <section xml:id="trouble.zookeeper.general">
- <title>ZooKeeper, The Cluster Canary</title>
- <para>ZooKeeper is the cluster's "canary in the mineshaft". It'll be the first to notice issues if any so making sure its happy is the short-cut to a humming cluster.
- </para>
- <para>
- See the <link xlink:href="http://wiki.apache.org/hadoop/ZooKeeper/Troubleshooting">ZooKeeper Operating Environment Troubleshooting</link> page. It has suggestions and tools for checking disk and networking performance; i.e. the operating environment your ZooKeeper and HBase are running in.
- </para>
- <para>Additionally, the utility <xref linkend="trouble.tools.builtin.zkcli"/> may help investigate ZooKeeper issues.
- </para>
- </section>
-
- </section>
-
- <section xml:id="trouble.ec2">
- <title>Amazon EC2</title>
- <section xml:id="trouble.ec2.zookeeper">
- <title>ZooKeeper does not seem to work on Amazon EC2</title>
- <para>HBase does not start when deployed as Amazon EC2 instances. Exceptions like the below appear in the Master and/or RegionServer logs: </para>
- <programlisting>
- 2009-10-19 11:52:27,030 INFO org.apache.zookeeper.ClientCnxn: Attempting
- connection to server ec2-174-129-15-236.compute-1.amazonaws.com/10.244.9.171:2181
- 2009-10-19 11:52:27,032 WARN org.apache.zookeeper.ClientCnxn: Exception
- closing session 0x0 to sun.nio.ch.SelectionKeyImpl@656dc861
- java.net.ConnectException: Connection refused
- </programlisting>
- <para>
- Security group policy is blocking the ZooKeeper port on a public address.
- Use the internal EC2 host names when configuring the ZooKeeper quorum peer list.
- </para>
- </section>
- <section xml:id="trouble.ec2.instability">
- <title>Instability on Amazon EC2</title>
- <para>Questions on HBase and Amazon EC2 come up frequently on the HBase dist-list. Search for old threads using <link xlink:href="http://search-hadoop.com/">Search Hadoop</link>
- </para>
- </section>
- <section xml:id="trouble.ec2.connection">
- <title>Remote Java Connection into EC2 Cluster Not Working</title>
- <para>
- See Andrew's answer here, up on the user list: <link xlink:href="http://search-hadoop.com/m/sPdqNFAwyg2">Remote Java client connection into EC2 instance</link>.
- </para>
- </section>
-
- </section>
-
- <section xml:id="trouble.versions">
- <title>HBase and Hadoop version issues</title>
- <section xml:id="trouble.versions.205">
- <title><code>NoClassDefFoundError</code> when trying to run 0.90.x on hadoop-0.20.205.x (or hadoop-1.0.x)</title>
- <para>Apache HBase 0.90.x does not ship with hadoop-0.20.205.x, etc. To make it run, you need to replace the hadoop
- jars that Apache HBase shipped with in its <filename>lib</filename> directory with those of the Hadoop you want to
- run HBase on. If even after replacing Hadoop jars you get the below exception:</para>
-<programlisting>
-sv4r6s38: Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/configuration/Configuration
-sv4r6s38: at org.apache.hadoop.metrics2.lib.DefaultMetricsSystem.<init>(DefaultMetricsSystem.java:37)
-sv4r6s38: at org.apache.hadoop.metrics2.lib.DefaultMetricsSystem.<clinit>(DefaultMetricsSystem.java:34)
-sv4r6s38: at org.apache.hadoop.security.UgiInstrumentation.create(UgiInstrumentation.java:51)
-sv4r6s38: at org.apache.hadoop.security.UserGroupInformation.initialize(UserGroupInformation.java:209)
-sv4r6s38: at org.apache.hadoop.security.UserGroupInformation.ensureInitialized(UserGroupInformation.java:177)
-sv4r6s38: at org.apache.hadoop.security.UserGroupInformation.isSecurityEnabled(UserGroupInformation.java:229)
-sv4r6s38: at org.apache.hadoop.security.KerberosName.<clinit>(KerberosName.java:83)
-sv4r6s38: at org.apache.hadoop.security.UserGroupInformation.initialize(UserGroupInformation.java:202)
-sv4r6s38: at org.apache.hadoop.security.UserGroupInformation.ensureInitialized(UserGroupInformation.java:177)
-</programlisting>
- <para>you need to copy under <filename>hbase/lib</filename>, the
- <filename>commons-configuration-X.jar</filename> you find in your Hadoop's
- <filename>lib</filename> directory. That should fix the above complaint. </para>
- </section>
-
- <section
- xml:id="trouble.wrong.version">
- <title>...cannot communicate with client version...</title>
- <para>If you see something like the following in your logs <computeroutput>... 2012-09-24
- 10:20:52,168 FATAL org.apache.hadoop.hbase.master.HMaster: Unhandled exception. Starting
- shutdown. org.apache.hadoop.ipc.RemoteException: Server IPC version 7 cannot communicate
- with client version 4 ...</computeroutput> ...are you trying to talk to an Hadoop 2.0.x
- from an HBase that has an Hadoop 1.0.x client? Use the HBase built against Hadoop 2.0 or
- rebuild your HBase passing the <command>-Dhadoop.profile=2.0</command> attribute to Maven
- (See <xref
- linkend="maven.build.hadoop" /> for more). </para>
-
- </section>
- </section>
- <section>
- <title>IPC Configuration Conflicts with Hadoop</title>
- <para>If the Hadoop configuration is loaded after the HBase configuration, and you have
- configured custom IPC settings in both HBase and Hadoop, the Hadoop values may overwrite the
- HBase values. There is normally no need to change these settings for HBase, so this problem is
- an edge case. However, <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11492">HBASE-11492</link> renames
- these settings for HBase to remove the chance of a conflict. Each of the setting names have
- been prefixed with <literal>hbase.</literal>, as shown in the following table. No action is
- required related to these changes unless you are already experiencing a conflict.</para>
- <para>These changes were backported to HBase 0.98.x and apply to all newer versions.</para>
- <informaltable>
- <tgroup
- cols="2">
- <thead>
- <row>
- <entry>Pre-0.98.x</entry>
- <entry>0.98-x And Newer</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para><code>ipc.server.listen.queue.size</code></para></entry>
- <entry><para><code>hbase.ipc.server.listen.queue.size</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.max.callqueue.size</code></para></entry>
- <entry><para><code>hbase.ipc.server.max.callqueue.size</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.callqueue.handler.factor</code></para></entry>
- <entry><para><code>hbase.ipc.server.callqueue.handler.factor</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.callqueue.read.share</code></para></entry>
- <entry><para><code>hbase.ipc.server.callqueue.read.share</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.callqueue.type</code></para></entry>
- <entry><para><code>hbase.ipc.server.callqueue.type</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.queue.max.call.delay</code></para></entry>
- <entry><para><code>hbase.ipc.server.queue.max.call.delay</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.max.callqueue.length</code></para></entry>
- <entry><para><code>hbase.ipc.server.max.callqueue.length</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.read.threadpool.size</code></para></entry>
- <entry><para><code>hbase.ipc.server.read.threadpool.size</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.tcpkeepalive</code></para></entry>
- <entry><para><code>hbase.ipc.server.tcpkeepalive</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.tcpnodelay</code></para></entry>
- <entry><para><code>hbase.ipc.server.tcpnodelay</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.client.call.purge.timeout</code></para></entry>
- <entry><para><code>hbase.ipc.client.call.purge.timeout</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.client.connection.maxidletime</code></para></entry>
- <entry><para><code>hbase.ipc.client.connection.maxidletime</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.client.idlethreshold</code></para></entry>
- <entry><para><code>hbase.ipc.client.idlethreshold</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.client.kill.max</code></para></entry>
- <entry><para><code>hbase.ipc.client.kill.max</code></para></entry>
- </row>
- <row>
- <entry><para><code>ipc.server.scan.vtime.weight </code></para></entry>
- <entry><para><code>hbase.ipc.server.scan.vtime.weight </code></para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
-
- <section>
- <title>HBase and HDFS</title>
- <para>General configuration guidance for Apache HDFS is out of the scope of this guide. Refer to
- the documentation available at <link
- xlink:href="http://hadoop.apache.org/">http://hadoop.apache.org/</link> for extensive
- information about configuring HDFS. This section deals with HDFS in terms of HBase. </para>
-
- <para>In most cases, HBase stores its data in Apache HDFS. This includes the HFiles containing
- the data, as well as the write-ahead logs (WALs) which store data before it is written to the
- HFiles and protect against RegionServer crashes. HDFS provides reliability and protection to
- data in HBase because it is distributed. To operate with the most efficiency, HBase needs data
- to be available locally. Therefore, it is a good practice to run an HDFS datanode on each
- RegionServer.</para>
- <variablelist>
- <title>Important Information and Guidelines for HBase and HDFS</title>
- <varlistentry>
- <term>HBase is a client of HDFS.</term>
- <listitem>
- <para>HBase is an HDFS client, using the HDFS <code>DFSClient</code> class, and references
- to this class appear in HBase logs with other HDFS client log messages.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Configuration is necessary in multiple places.</term>
- <listitem>
- <para>Some HDFS configurations relating to HBase need to be done at the HDFS (server) side.
- Others must be done within HBase (at the client side). Other settings need
- to be set at both the server and client side.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Write errors which affect HBase may be logged in the HDFS logs rather than HBase logs.</term>
- <listitem>
- <para>When writing, HDFS pipelines communications from one datanode to another. HBase
- communicates to both the HDFS namenode and datanode, using the HDFS client classes.
- Communication problems between datanodes are logged in the HDFS logs, not the HBase
- logs.</para>
- <para>HDFS writes are always local when possible. HBase RegionServers should not
- experience many write errors, because they write the local datanode. If the datanode
- cannot replicate the blocks, the errors are logged in HDFS, not in the HBase
- RegionServer logs.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>HBase communicates with HDFS using two different ports.</term>
-
<TRUNCATED>
[07/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/performance.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/performance.xml b/src/main/docbkx/performance.xml
deleted file mode 100644
index 1757d3f..0000000
--- a/src/main/docbkx/performance.xml
+++ /dev/null
@@ -1,1207 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter
- version="5.0"
- xml:id="performance"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Apache HBase Performance Tuning</title>
-
- <section
- xml:id="perf.os">
- <title>Operating System</title>
- <section
- xml:id="perf.os.ram">
- <title>Memory</title>
- <para>RAM, RAM, RAM. Don't starve HBase.</para>
- </section>
- <section
- xml:id="perf.os.64">
- <title>64-bit</title>
- <para>Use a 64-bit platform (and 64-bit JVM).</para>
- </section>
- <section
- xml:id="perf.os.swap">
- <title>Swapping</title>
- <para>Watch out for swapping. Set swappiness to 0.</para>
- </section>
- </section>
- <section
- xml:id="perf.network">
- <title>Network</title>
- <para> Perhaps the most important factor in avoiding network issues degrading Hadoop and HBase
- performance is the switching hardware that is used, decisions made early in the scope of the
- project can cause major problems when you double or triple the size of your cluster (or more). </para>
- <para> Important items to consider: <itemizedlist>
- <listitem>
- <para>Switching capacity of the device</para>
- </listitem>
- <listitem>
- <para>Number of systems connected</para>
- </listitem>
- <listitem>
- <para>Uplink capacity</para>
- </listitem>
- </itemizedlist>
- </para>
- <section
- xml:id="perf.network.1switch">
- <title>Single Switch</title>
- <para>The single most important factor in this configuration is that the switching capacity of
- the hardware is capable of handling the traffic which can be generated by all systems
- connected to the switch. Some lower priced commodity hardware can have a slower switching
- capacity than could be utilized by a full switch. </para>
- </section>
- <section
- xml:id="perf.network.2switch">
- <title>Multiple Switches</title>
- <para>Multiple switches are a potential pitfall in the architecture. The most common
- configuration of lower priced hardware is a simple 1Gbps uplink from one switch to another.
- This often overlooked pinch point can easily become a bottleneck for cluster communication.
- Especially with MapReduce jobs that are both reading and writing a lot of data the
- communication across this uplink could be saturated. </para>
- <para>Mitigation of this issue is fairly simple and can be accomplished in multiple ways: </para>
- <itemizedlist>
- <listitem>
- <para>Use appropriate hardware for the scale of the cluster which you're attempting to
- build.</para>
- </listitem>
- <listitem>
- <para>Use larger single switch configurations i.e. single 48 port as opposed to 2x 24
- port</para>
- </listitem>
- <listitem>
- <para>Configure port trunking for uplinks to utilize multiple interfaces to increase cross
- switch bandwidth.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section
- xml:id="perf.network.multirack">
- <title>Multiple Racks</title>
- <para>Multiple rack configurations carry the same potential issues as multiple switches, and
- can suffer performance degradation from two main areas: </para>
- <itemizedlist>
- <listitem>
- <para>Poor switch capacity performance</para>
- </listitem>
- <listitem>
- <para>Insufficient uplink to another rack</para>
- </listitem>
- </itemizedlist>
- <para>If the the switches in your rack have appropriate switching capacity to handle all the
- hosts at full speed, the next most likely issue will be caused by homing more of your
- cluster across racks. The easiest way to avoid issues when spanning multiple racks is to use
- port trunking to create a bonded uplink to other racks. The downside of this method however,
- is in the overhead of ports that could potentially be used. An example of this is, creating
- an 8Gbps port channel from rack A to rack B, using 8 of your 24 ports to communicate between
- racks gives you a poor ROI, using too few however can mean you're not getting the most out
- of your cluster. </para>
- <para>Using 10Gbe links between racks will greatly increase performance, and assuming your
- switches support a 10Gbe uplink or allow for an expansion card will allow you to save your
- ports for machines as opposed to uplinks. </para>
- </section>
- <section
- xml:id="perf.network.ints">
- <title>Network Interfaces</title>
- <para>Are all the network interfaces functioning correctly? Are you sure? See the
- Troubleshooting Case Study in <xref
- linkend="casestudies.slownode" />. </para>
- </section>
- </section>
- <!-- network -->
-
- <section
- xml:id="jvm">
- <title>Java</title>
-
- <section
- xml:id="gc">
- <title>The Garbage Collector and Apache HBase</title>
-
- <section
- xml:id="gcpause">
- <title>Long GC pauses</title>
-
- <para xml:id="mslab">In his presentation, <link
- xlink:href="http://www.slideshare.net/cloudera/hbase-hug-presentation">Avoiding Full GCs
- with MemStore-Local Allocation Buffers</link>, Todd Lipcon describes two cases of
- stop-the-world garbage collections common in HBase, especially during loading; CMS failure
- modes and old generation heap fragmentation brought. To address the first, start the CMS
- earlier than default by adding <code>-XX:CMSInitiatingOccupancyFraction</code> and setting
- it down from defaults. Start at 60 or 70 percent (The lower you bring down the threshold,
- the more GCing is done, the more CPU used). To address the second fragmentation issue,
- Todd added an experimental facility, <indexterm><primary>MSLAB</primary></indexterm>, that
- must be explicitly enabled in Apache HBase 0.90.x (Its defaulted to be on in Apache 0.92.x
- HBase). See <code>hbase.hregion.memstore.mslab.enabled</code> to true in your
- <classname>Configuration</classname>. See the cited slides for background and detail.
- The latest jvms do better regards fragmentation so make sure you are running a recent
- release. Read down in the message, <link
- xlink:href="http://osdir.com/ml/hotspot-gc-use/2011-11/msg00002.html">Identifying
- concurrent mode failures caused by fragmentation</link>. Be aware that when enabled,
- each MemStore instance will occupy at least an MSLAB instance of memory. If you have
- thousands of regions or lots of regions each with many column families, this allocation of
- MSLAB may be responsible for a good portion of your heap allocation and in an extreme case
- cause you to OOME. Disable MSLAB in this case, or lower the amount of memory it uses or
- float less regions per server. </para>
- <para>If you have a write-heavy workload, check out <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-8163">HBASE-8163
- MemStoreChunkPool: An improvement for JAVA GC when using MSLAB</link>. It describes
- configurations to lower the amount of young GC during write-heavy loadings. If you do not
- have HBASE-8163 installed, and you are trying to improve your young GC times, one trick to
- consider -- courtesy of our Liang Xie -- is to set the GC config
- <varname>-XX:PretenureSizeThreshold</varname> in <filename>hbase-env.sh</filename> to be
- just smaller than the size of <varname>hbase.hregion.memstore.mslab.chunksize</varname> so
- MSLAB allocations happen in the tenured space directly rather than first in the young gen.
- You'd do this because these MSLAB allocations are going to likely make it to the old gen
- anyways and rather than pay the price of a copies between s0 and s1 in eden space followed
- by the copy up from young to old gen after the MSLABs have achieved sufficient tenure,
- save a bit of YGC churn and allocate in the old gen directly. </para>
- <para>For more information about GC logs, see <xref
- linkend="trouble.log.gc" />. </para>
- <para>Consider also enabling the offheap Block Cache. This has been shown to mitigate
- GC pause times. See <xref linkend="block.cache" /></para>
- </section>
- </section>
- </section>
-
- <section
- xml:id="perf.configurations">
- <title>HBase Configurations</title>
-
- <para>See <xref
- linkend="recommended_configurations" />.</para>
-
- <section
- xml:id="perf.compactions.and.splits">
- <title>Managing Compactions</title>
-
- <para>For larger systems, managing <link
- linkend="disable.splitting">compactions and splits</link> may be
- something you want to consider.</para>
- </section>
-
- <section xml:id="perf.handlers">
- <title><varname>hbase.regionserver.handler.count</varname></title>
- <para>See <xref linkend="hbase.regionserver.handler.count"/>.
- </para>
- </section>
-
-
-
- <section xml:id="perf.hfile.block.cache.size">
- <title><varname>hfile.block.cache.size</varname></title>
- <para>See <xref linkend="hfile.block.cache.size"/>.
- A memory setting for the RegionServer process.
- </para>
- </section>
- <section xml:id="blockcache.prefetch">
- <title>Prefetch Option for Blockcache</title>
- <para><link xlink:href="https://issues.apache.org/jira/browse/HBASE-9857">HBASE-9857</link>
- adds a new option to prefetch HFile contents when opening the blockcache, if a columnfamily
- or regionserver property is set. This option is available for HBase 0.98.3 and later. The
- purpose is to warm the blockcache as rapidly as possible after the cache is opened, using
- in-memory table data, and not counting the prefetching as cache misses. This is great for
- fast reads, but is not a good idea if the data to be preloaded will not fit into the
- blockcache. It is useful for tuning the IO impact of prefetching versus the time before all
- data blocks are in cache. </para>
- <para>To enable prefetching on a given column family, you can use HBase Shell or use the
- API.</para>
- <example>
- <title>Enable Prefetch Using HBase Shell</title>
- <screen>hbase> create 'MyTable', { NAME => 'myCF', PREFETCH_BLOCKS_ON_OPEN => 'true' }</screen>
- </example>
- <example>
- <title>Enable Prefetch Using the API</title>
- <programlisting language="java">
-// ...
-HTableDescriptor tableDesc = new HTableDescriptor("myTable");
-HColumnDescriptor cfDesc = new HColumnDescriptor("myCF");
-cfDesc.setPrefetchBlocksOnOpen(true);
-tableDesc.addFamily(cfDesc);
-// ...
- </programlisting>
- </example>
- <para>See the API documentation for <link
- xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/io/hfile/CacheConfig.html"
- >CacheConfig</link>.</para>
- </section>
- <section xml:id="perf.rs.memstore.size">
- <title><varname>hbase.regionserver.global.memstore.size</varname></title>
- <para>See <xref linkend="hbase.regionserver.global.memstore.size"/>.
- This memory setting is often adjusted for the RegionServer process depending on needs.
- </para>
- </section>
- <section xml:id="perf.rs.memstore.size.lower.limit">
- <title><varname>hbase.regionserver.global.memstore.size.lower.limit</varname></title>
- <para>See <xref linkend="hbase.regionserver.global.memstore.size.lower.limit"/>.
- This memory setting is often adjusted for the RegionServer process depending on needs.
- </para>
- </section>
- <section xml:id="perf.hstore.blockingstorefiles">
- <title><varname>hbase.hstore.blockingStoreFiles</varname></title>
- <para>See <xref linkend="hbase.hstore.blockingStoreFiles"/>.
- If there is blocking in the RegionServer logs, increasing this can help.
- </para>
- </section>
- <section xml:id="perf.hregion.memstore.block.multiplier">
- <title><varname>hbase.hregion.memstore.block.multiplier</varname></title>
- <para>See <xref linkend="hbase.hregion.memstore.block.multiplier"/>.
- If there is enough RAM, increasing this can help.
- </para>
- </section>
- <section xml:id="hbase.regionserver.checksum.verify">
- <title><varname>hbase.regionserver.checksum.verify</varname></title>
- <para>Have HBase write the checksum into the datablock and save
- having to do the checksum seek whenever you read.</para>
-
- <para>See <xref linkend="hbase.regionserver.checksum.verify"/>,
- <xref linkend="hbase.hstore.bytes.per.checksum"/> and <xref linkend="hbase.hstore.checksum.algorithm"/>
- For more information see the
- release note on <link xlink:href="https://issues.apache.org/jira/browse/HBASE-5074">HBASE-5074 support checksums in HBase block cache</link>.
- </para>
- </section>
- <section>
- <title>Tuning <code>callQueue</code> Options</title>
- <para><link xlink:href="https://issues.apache.org/jira/browse/HBASE-11355">HBASE-11355</link>
- introduces several callQueue tuning mechanisms which can increase performance. See the JIRA
- for some benchmarking information.</para>
- <itemizedlist>
- <listitem>
- <para>To increase the number of callqueues, set
- <option>hbase.ipc.server.num.callqueue</option> to a value greater than
- <literal>1</literal>.</para>
- </listitem>
- <listitem>
- <para>To split the callqueue into separate read and write queues, set
- <code>hbase.ipc.server.callqueue.read.ratio</code> to a value between
- <literal>0</literal> and <literal>1</literal>. This factor weights the queues toward
- writes (if below .5) or reads (if above .5). Another way to say this is that the factor
- determines what percentage of the split queues are used for reads. The following
- examples illustrate some of the possibilities. Note that you always have at least one
- write queue, no matter what setting you use.</para>
- <itemizedlist>
- <listitem>
- <para>The default value of <literal>0</literal> does not split the queue.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.3</literal> uses 30% of the queues for reading and 60% for
- writing. Given a value of <literal>10</literal> for
- <option>hbase.ipc.server.num.callqueue</option>, 3 queues would be used for reads
- and 7 for writes.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.5</literal> uses the same number of read queues and write
- queues. Given a value of <literal>10</literal> for
- <option>hbase.ipc.server.num.callqueue</option>, 5 queues would be used for reads
- and 5 for writes.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.6</literal> uses 60% of the queues for reading and 30% for
- reading. Given a value of <literal>10</literal> for
- <option>hbase.ipc.server.num.callqueue</option>, 7 queues would be used for reads
- and 3 for writes.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>1.0</literal> uses one queue to process write requests, and
- all other queues process read requests. A value higher than <literal>1.0</literal>
- has the same effect as a value of <literal>1.0</literal>. Given a value of
- <literal>10</literal> for <option>hbase.ipc.server.num.callqueue</option>, 9
- queues would be used for reads and 1 for writes.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>You can also split the read queues so that separate queues are used for short reads
- (from Get operations) and long reads (from Scan operations), by setting the
- <option>hbase.ipc.server.callqueue.scan.ratio</option> option. This option is a factor
- between 0 and 1, which determine the ratio of read queues used for Gets and Scans. More
- queues are used for Gets if the value is below <literal>.5</literal> and more are used
- for scans if the value is above <literal>.5</literal>. No matter what setting you use,
- at least one read queue is used for Get operations.</para>
- <itemizedlist>
- <listitem>
- <para>A value of <literal>0</literal> does not split the read queue.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.3</literal> uses 60% of the read queues for Gets and 30%
- for Scans. Given a value of <literal>20</literal> for
- <option>hbase.ipc.server.num.callqueue</option> and a value of <literal>.5
- </literal> for <option>hbase.ipc.server.callqueue.read.ratio</option>, 10 queues
- would be used for reads, out of those 10, 7 would be used for Gets and 3 for
- Scans.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.5</literal> uses half the read queues for Gets and half for
- Scans. Given a value of <literal>20</literal> for
- <option>hbase.ipc.server.num.callqueue</option> and a value of <literal>.5
- </literal> for <option>hbase.ipc.server.callqueue.read.ratio</option>, 10 queues
- would be used for reads, out of those 10, 5 would be used for Gets and 5 for
- Scans.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>.6</literal> uses 30% of the read queues for Gets and 60%
- for Scans. Given a value of <literal>20</literal> for
- <option>hbase.ipc.server.num.callqueue</option> and a value of <literal>.5
- </literal> for <option>hbase.ipc.server.callqueue.read.ratio</option>, 10 queues
- would be used for reads, out of those 10, 3 would be used for Gets and 7 for
- Scans.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>1.0</literal> uses all but one of the read queues for Scans.
- Given a value of <literal>20</literal> for
- <option>hbase.ipc.server.num.callqueue</option> and a value of <literal>.5
- </literal> for <option>hbase.ipc.server.callqueue.read.ratio</option>, 10 queues
- would be used for reads, out of those 10, 1 would be used for Gets and 9 for
- Scans.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>You can use the new option
- <option>hbase.ipc.server.callqueue.handler.factor</option> to programmatically tune
- the number of queues:</para>
- <itemizedlist>
- <listitem>
- <para>A value of <literal>0</literal> uses a single shared queue between all the
- handlers.</para>
- </listitem>
- <listitem>
- <para>A value of <literal>1</literal> uses a separate queue for each handler.</para>
- </listitem>
- <listitem>
- <para>A value between <literal>0</literal> and <literal>1</literal> tunes the number
- of queues against the number of handlers. For instance, a value of
- <literal>.5</literal> shares one queue between each two handlers.</para>
- </listitem>
- </itemizedlist>
- <para>Having more queues, such as in a situation where you have one queue per handler,
- reduces contention when adding a task to a queue or selecting it from a queue. The
- trade-off is that if you have some queues with long-running tasks, a handler may end up
- waiting to execute from that queue rather than processing another queue which has
- waiting tasks.</para>
- </listitem>
- </itemizedlist>
- <para>For these values to take effect on a given Region Server, the Region Server must be
- restarted. These parameters are intended for testing purposes and should be used
- carefully.</para>
- </section>
- </section>
-
-
-
-
- <section
- xml:id="perf.zookeeper">
- <title>ZooKeeper</title>
- <para>See <xref
- linkend="zookeeper" /> for information on configuring ZooKeeper, and see the part about
- having a dedicated disk. </para>
- </section>
- <section
- xml:id="perf.schema">
- <title>Schema Design</title>
-
- <section
- xml:id="perf.number.of.cfs">
- <title>Number of Column Families</title>
- <para>See <xref
- linkend="number.of.cfs" />.</para>
- </section>
- <section
- xml:id="perf.schema.keys">
- <title>Key and Attribute Lengths</title>
- <para>See <xref
- linkend="keysize" />. See also <xref
- linkend="perf.compression.however" /> for compression caveats.</para>
- </section>
- <section
- xml:id="schema.regionsize">
- <title>Table RegionSize</title>
- <para>The regionsize can be set on a per-table basis via <code>setFileSize</code> on <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html">HTableDescriptor</link>
- in the event where certain tables require different regionsizes than the configured default
- regionsize. </para>
- <para>See <xref
- linkend="ops.capacity.regions" /> for more information. </para>
- </section>
- <section
- xml:id="schema.bloom">
- <title>Bloom Filters</title>
- <para>A Bloom filter, named for its creator, Burton Howard Bloom, is a data structure which is
- designed to predict whether a given element is a member of a set of data. A positive result
- from a Bloom filter is not always accurate, but a negative result is guaranteed to be
- accurate. Bloom filters are designed to be "accurate enough" for sets of data which are so
- large that conventional hashing mechanisms would be impractical. For more information about
- Bloom filters in general, refer to <link
- xlink:href="http://en.wikipedia.org/wiki/Bloom_filter" />.</para>
- <para>In terms of HBase, Bloom filters provide a lightweight in-memory structure to reduce the
- number of disk reads for a given Get operation (Bloom filters do not work with Scans) to only the StoreFiles likely to
- contain the desired Row. The potential performance gain increases with the number of
- parallel reads. </para>
- <para>The Bloom filters themselves are stored in the metadata of each HFile and never need to
- be updated. When an HFile is opened because a region is deployed to a RegionServer, the
- Bloom filter is loaded into memory. </para>
- <para>HBase includes some tuning mechanisms for folding the Bloom filter to reduce the size
- and keep the false positive rate within a desired range.</para>
- <para>Bloom filters were introduced in <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-1200">HBASE-1200</link>. Since
- HBase 0.96, row-based Bloom filters are enabled by default. (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-8450">HBASE-</link>)</para>
- <para>For more information on Bloom filters in relation to HBase, see <xref
- linkend="blooms" /> for more information, or the following Quora discussion: <link
- xlink:href="http://www.quora.com/How-are-bloom-filters-used-in-HBase">How are bloom
- filters used in HBase?</link>. </para>
-
- <section xml:id="bloom.filters.when">
- <title>When To Use Bloom Filters</title>
- <para>Since HBase 0.96, row-based Bloom filters are enabled by default. You may choose to
- disable them or to change some tables to use row+column Bloom filters, depending on the
- characteristics of your data and how it is loaded into HBase.</para>
-
- <para>To determine whether Bloom filters could have a positive impact, check the value of
- <code>blockCacheHitRatio</code> in the RegionServer metrics. If Bloom filters are enabled, the value of
- <code>blockCacheHitRatio</code> should increase, because the Bloom filter is filtering out blocks that
- are definitely not needed. </para>
- <para>You can choose to enable Bloom filters for a row or for a row+column combination. If
- you generally scan entire rows, the row+column combination will not provide any benefit. A
- row-based Bloom filter can operate on a row+column Get, but not the other way around.
- However, if you have a large number of column-level Puts, such that a row may be present
- in every StoreFile, a row-based filter will always return a positive result and provide no
- benefit. Unless you have one column per row, row+column Bloom filters require more space,
- in order to store more keys. Bloom filters work best when the size of each data entry is
- at least a few kilobytes in size. </para>
- <para>Overhead will be reduced when your data is stored in a few larger StoreFiles, to avoid
- extra disk IO during low-level scans to find a specific row. </para>
- <para>Bloom filters need to be rebuilt upon deletion, so may not be appropriate in
- environments with a large number of deletions.</para>
- </section>
-
- <section>
- <title>Enabling Bloom Filters</title>
- <para>Bloom filters are enabled on a Column Family. You can do this by using the
- setBloomFilterType method of HColumnDescriptor or using the HBase API. Valid values are
- <literal>NONE</literal> (the default), <literal>ROW</literal>, or
- <literal>ROWCOL</literal>. See <xref
- linkend="bloom.filters.when" /> for more information on <literal>ROW</literal> versus
- <literal>ROWCOL</literal>. See also the API documentation for <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html">HColumnDescriptor</link>.</para>
- <para>The following example creates a table and enables a ROWCOL Bloom filter on the
- <literal>colfam1</literal> column family.</para>
- <screen>
-hbase> <userinput>create 'mytable',{NAME => 'colfam1', BLOOMFILTER => 'ROWCOL'}</userinput>
- </screen>
- </section>
-
- <section>
- <title>Configuring Server-Wide Behavior of Bloom Filters</title>
- <para>You can configure the following settings in the <filename>hbase-site.xml</filename>.
- </para>
- <informaltable>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Parameter</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para><code>io.hfile.bloom.enabled</code></para></entry>
- <entry><para><literal>yes</literal></para></entry>
- <entry><para>Set to <literal>no</literal> to kill bloom filters server-wide if
- something goes wrong</para></entry>
- </row>
- <row>
- <entry><para><code>io.hfile.bloom.error.rate</code></para></entry>
- <entry><para><literal>.01</literal></para></entry>
- <entry><para>The average false positive rate for bloom filters. Folding is used to
- maintain the false positive rate. Expressed as a decimal representation of a
- percentage.</para></entry>
- </row>
- <row>
- <entry><para><code>io.hfile.bloom.max.fold</code></para></entry>
- <entry><para><literal>7</literal></para></entry>
- <entry><para>The guaranteed maximum fold rate. Changing this setting should not be
- necessary and is not recommended.</para></entry>
- </row>
- <row>
- <entry><para><code>io.storefile.bloom.max.keys</code></para></entry>
- <entry><para><literal>128000000</literal></para></entry>
- <entry><para>For default (single-block) Bloom filters, this specifies the maximum
- number of keys.</para></entry>
- </row>
- <row>
- <entry><para><code>io.storefile.delete.family.bloom.enabled</code></para></entry>
- <entry><para><literal>true</literal></para></entry>
- <entry><para>Master switch to enable Delete Family Bloom filters and store them in
- the StoreFile.</para></entry>
- </row>
- <row>
- <entry><para><code>io.storefile.bloom.block.size</code></para></entry>
- <entry><para><literal>65536</literal></para></entry>
- <entry><para>Target Bloom block size. Bloom filter blocks of approximately this size
- are interleaved with data blocks.</para></entry>
- </row>
- <row>
- <entry><para><code>hfile.block.bloom.cacheonwrite</code></para></entry>
- <entry><para><literal>false</literal></para></entry>
- <entry><para>Enables cache-on-write for inline blocks of a compound Bloom filter.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- </section>
- <section
- xml:id="schema.cf.blocksize">
- <title>ColumnFamily BlockSize</title>
- <para>The blocksize can be configured for each ColumnFamily in a table, and this defaults to
- 64k. Larger cell values require larger blocksizes. There is an inverse relationship between
- blocksize and the resulting StoreFile indexes (i.e., if the blocksize is doubled then the
- resulting indexes should be roughly halved). </para>
- <para>See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html">HColumnDescriptor</link>
- and <xref
- linkend="store" />for more information. </para>
- </section>
- <section
- xml:id="cf.in.memory">
- <title>In-Memory ColumnFamilies</title>
- <para>ColumnFamilies can optionally be defined as in-memory. Data is still persisted to disk,
- just like any other ColumnFamily. In-memory blocks have the highest priority in the <xref
- linkend="block.cache" />, but it is not a guarantee that the entire table will be in
- memory. </para>
- <para>See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HColumnDescriptor.html">HColumnDescriptor</link>
- for more information. </para>
- </section>
- <section
- xml:id="perf.compression">
- <title>Compression</title>
- <para>Production systems should use compression with their ColumnFamily definitions. See <xref
- linkend="compression" /> for more information. </para>
- <section
- xml:id="perf.compression.however">
- <title>However...</title>
- <para>Compression deflates data <emphasis>on disk</emphasis>. When it's in-memory (e.g., in
- the MemStore) or on the wire (e.g., transferring between RegionServer and Client) it's
- inflated. So while using ColumnFamily compression is a best practice, but it's not going
- to completely eliminate the impact of over-sized Keys, over-sized ColumnFamily names, or
- over-sized Column names. </para>
- <para>See <xref
- linkend="keysize" /> on for schema design tips, and <xref
- linkend="keyvalue" /> for more information on HBase stores data internally. </para>
- </section>
- </section>
- </section>
- <!-- perf schema -->
-
- <section
- xml:id="perf.general">
- <title>HBase General Patterns</title>
- <section
- xml:id="perf.general.constants">
- <title>Constants</title>
- <para>When people get started with HBase they have a tendency to write code that looks like
- this:</para>
- <programlisting language="java">
-Get get = new Get(rowkey);
-Result r = htable.get(get);
-byte[] b = r.getValue(Bytes.toBytes("cf"), Bytes.toBytes("attr")); // returns current version of value
- </programlisting>
- <para>But especially when inside loops (and MapReduce jobs), converting the columnFamily and
- column-names to byte-arrays repeatedly is surprisingly expensive. It's better to use
- constants for the byte-arrays, like this:</para>
- <programlisting language="java">
-public static final byte[] CF = "cf".getBytes();
-public static final byte[] ATTR = "attr".getBytes();
-...
-Get get = new Get(rowkey);
-Result r = htable.get(get);
-byte[] b = r.getValue(CF, ATTR); // returns current version of value
- </programlisting>
- </section>
-
- </section>
- <section
- xml:id="perf.writing">
- <title>Writing to HBase</title>
-
- <section
- xml:id="perf.batch.loading">
- <title>Batch Loading</title>
- <para>Use the bulk load tool if you can. See <xref
- linkend="arch.bulk.load" />. Otherwise, pay attention to the below. </para>
- </section>
- <!-- batch loading -->
-
- <section
- xml:id="precreate.regions">
- <title> Table Creation: Pre-Creating Regions </title>
- <para> Tables in HBase are initially created with one region by default. For bulk imports,
- this means that all clients will write to the same region until it is large enough to split
- and become distributed across the cluster. A useful pattern to speed up the bulk import
- process is to pre-create empty regions. Be somewhat conservative in this, because too-many
- regions can actually degrade performance. </para>
- <para>There are two different approaches to pre-creating splits. The first approach is to rely
- on the default <code>HBaseAdmin</code> strategy (which is implemented in
- <code>Bytes.split</code>)... </para>
- <programlisting language="java">
-byte[] startKey = ...; // your lowest key
-byte[] endKey = ...; // your highest key
-int numberOfRegions = ...; // # of regions to create
-admin.createTable(table, startKey, endKey, numberOfRegions);
- </programlisting>
- <para>And the other approach is to define the splits yourself... </para>
- <programlisting language="java">
-byte[][] splits = ...; // create your own splits
-admin.createTable(table, splits);
-</programlisting>
- <para> See <xref linkend="rowkey.regionsplits"/> for issues related to understanding your
- keyspace and pre-creating regions. See <xref linkend="manual_region_splitting_decisions"/>
- for discussion on manually pre-splitting regions.</para>
- </section>
- <section
- xml:id="def.log.flush">
- <title> Table Creation: Deferred Log Flush </title>
- <para> The default behavior for Puts using the Write Ahead Log (WAL) is that
- <classname>WAL</classname> edits will be written immediately. If deferred log flush is
- used, WAL edits are kept in memory until the flush period. The benefit is aggregated and
- asynchronous <classname>WAL</classname>- writes, but the potential downside is that if the
- RegionServer goes down the yet-to-be-flushed edits are lost. This is safer, however, than
- not using WAL at all with Puts. </para>
- <para> Deferred log flush can be configured on tables via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html">HTableDescriptor</link>.
- The default value of <varname>hbase.regionserver.optionallogflushinterval</varname> is
- 1000ms. </para>
- </section>
-
- <section
- xml:id="perf.hbase.client.autoflush">
- <title>HBase Client: AutoFlush</title>
-
- <para>When performing a lot of Puts, make sure that setAutoFlush is set to false on your <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html">HTable</link>
- instance. Otherwise, the Puts will be sent one at a time to the RegionServer. Puts added via
- <code> htable.add(Put)</code> and <code> htable.add( <List> Put)</code> wind up in
- the same write buffer. If <code>autoFlush = false</code>, these messages are not sent until
- the write-buffer is filled. To explicitly flush the messages, call
- <methodname>flushCommits</methodname>. Calling <methodname>close</methodname> on the
- <classname>HTable</classname> instance will invoke
- <methodname>flushCommits</methodname>.</para>
- </section>
- <section
- xml:id="perf.hbase.client.putwal">
- <title>HBase Client: Turn off WAL on Puts</title>
- <para>A frequent request is to disable the WAL to increase performance of Puts. This is only
- appropriate for bulk loads, as it puts your data at risk by removing the protection of the
- WAL in the event of a region server crash. Bulk loads can be re-run in the event of a crash,
- with little risk of data loss.</para>
- <warning>
- <para>If you disable the WAL for anything other than bulk loads, your data is at
- risk.</para></warning>
- <para>In general, it is best to use WAL for Puts, and where loading throughput is a concern to
- use <link linkend="perf.batch.loading">bulk loading</link> techniques instead. For normal
- Puts, you are not likely to see a performance improvement which would outweigh the risk. To
- disable the WAL, see <xref linkend="wal.disable"/>.</para>
- </section>
- <section
- xml:id="perf.hbase.client.regiongroup">
- <title>HBase Client: Group Puts by RegionServer</title>
- <para>In addition to using the writeBuffer, grouping <classname>Put</classname>s by
- RegionServer can reduce the number of client RPC calls per writeBuffer flush. There is a
- utility <classname>HTableUtil</classname> currently on TRUNK that does this, but you can
- either copy that or implement your own version for those still on 0.90.x or earlier. </para>
- </section>
- <section
- xml:id="perf.hbase.write.mr.reducer">
- <title>MapReduce: Skip The Reducer</title>
- <para>When writing a lot of data to an HBase table from a MR job (e.g., with <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.html">TableOutputFormat</link>),
- and specifically where Puts are being emitted from the Mapper, skip the Reducer step. When a
- Reducer step is used, all of the output (Puts) from the Mapper will get spooled to disk,
- then sorted/shuffled to other Reducers that will most likely be off-node. It's far more
- efficient to just write directly to HBase. </para>
- <para>For summary jobs where HBase is used as a source and a sink, then writes will be coming
- from the Reducer step (e.g., summarize values then write out result). This is a different
- processing problem than from the the above case. </para>
- </section>
-
- <section
- xml:id="perf.one.region">
- <title>Anti-Pattern: One Hot Region</title>
- <para>If all your data is being written to one region at a time, then re-read the section on
- processing <link
- linkend="timeseries">timeseries</link> data.</para>
- <para>Also, if you are pre-splitting regions and all your data is <emphasis>still</emphasis>
- winding up in a single region even though your keys aren't monotonically increasing, confirm
- that your keyspace actually works with the split strategy. There are a variety of reasons
- that regions may appear "well split" but won't work with your data. As the HBase client
- communicates directly with the RegionServers, this can be obtained via <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html#getRegionLocation%28byte[]%29">HTable.getRegionLocation</link>. </para>
- <para>See <xref
- linkend="precreate.regions" />, as well as <xref
- linkend="perf.configurations" />
- </para>
- </section>
-
- </section>
- <!-- writing -->
-
- <section
- xml:id="perf.reading">
- <title>Reading from HBase</title>
- <para>The mailing list can help if you are having performance issues. For example, here is a
- good general thread on what to look at addressing read-time issues: <link
- xlink:href="http://search-hadoop.com/m/qOo2yyHtCC1">HBase Random Read latency >
- 100ms</link></para>
- <section
- xml:id="perf.hbase.client.caching">
- <title>Scan Caching</title>
-
- <para>If HBase is used as an input source for a MapReduce job, for example, make sure that the
- input <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">Scan</link>
- instance to the MapReduce job has <methodname>setCaching</methodname> set to something
- greater than the default (which is 1). Using the default value means that the map-task will
- make call back to the region-server for every record processed. Setting this value to 500,
- for example, will transfer 500 rows at a time to the client to be processed. There is a
- cost/benefit to have the cache value be large because it costs more in memory for both
- client and RegionServer, so bigger isn't always better.</para>
- <section
- xml:id="perf.hbase.client.caching.mr">
- <title>Scan Caching in MapReduce Jobs</title>
- <para>Scan settings in MapReduce jobs deserve special attention. Timeouts can result (e.g.,
- UnknownScannerException) in Map tasks if it takes longer to process a batch of records
- before the client goes back to the RegionServer for the next set of data. This problem can
- occur because there is non-trivial processing occuring per row. If you process rows
- quickly, set caching higher. If you process rows more slowly (e.g., lots of
- transformations per row, writes), then set caching lower. </para>
- <para>Timeouts can also happen in a non-MapReduce use case (i.e., single threaded HBase
- client doing a Scan), but the processing that is often performed in MapReduce jobs tends
- to exacerbate this issue. </para>
- </section>
- </section>
- <section
- xml:id="perf.hbase.client.selection">
- <title>Scan Attribute Selection</title>
-
- <para>Whenever a Scan is used to process large numbers of rows (and especially when used as a
- MapReduce source), be aware of which attributes are selected. If <code>scan.addFamily</code>
- is called then <emphasis>all</emphasis> of the attributes in the specified ColumnFamily will
- be returned to the client. If only a small number of the available attributes are to be
- processed, then only those attributes should be specified in the input scan because
- attribute over-selection is a non-trivial performance penalty over large datasets. </para>
- </section>
- <section
- xml:id="perf.hbase.client.seek">
- <title>Avoid scan seeks</title>
- <para>When columns are selected explicitly with <code>scan.addColumn</code>, HBase will
- schedule seek operations to seek between the selected columns. When rows have few columns
- and each column has only a few versions this can be inefficient. A seek operation is
- generally slower if does not seek at least past 5-10 columns/versions or 512-1024
- bytes.</para>
- <para>In order to opportunistically look ahead a few columns/versions to see if the next
- column/version can be found that way before a seek operation is scheduled, a new attribute
- <code>Scan.HINT_LOOKAHEAD</code> can be set the on Scan object. The following code
- instructs the RegionServer to attempt two iterations of next before a seek is
- scheduled:</para>
- <programlisting language="java">
-Scan scan = new Scan();
-scan.addColumn(...);
-scan.setAttribute(Scan.HINT_LOOKAHEAD, Bytes.toBytes(2));
-table.getScanner(scan);
- </programlisting>
- </section>
- <section
- xml:id="perf.hbase.mr.input">
- <title>MapReduce - Input Splits</title>
- <para>For MapReduce jobs that use HBase tables as a source, if there a pattern where the
- "slow" map tasks seem to have the same Input Split (i.e., the RegionServer serving the
- data), see the Troubleshooting Case Study in <xref
- linkend="casestudies.slownode" />. </para>
- </section>
-
- <section
- xml:id="perf.hbase.client.scannerclose">
- <title>Close ResultScanners</title>
-
- <para>This isn't so much about improving performance but rather <emphasis>avoiding</emphasis>
- performance problems. If you forget to close <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/ResultScanner.html">ResultScanners</link>
- you can cause problems on the RegionServers. Always have ResultScanner processing enclosed
- in try/catch blocks...</para>
- <programlisting language="java">
-Scan scan = new Scan();
-// set attrs...
-ResultScanner rs = htable.getScanner(scan);
-try {
- for (Result r = rs.next(); r != null; r = rs.next()) {
- // process result...
-} finally {
- rs.close(); // always close the ResultScanner!
-}
-htable.close();
- </programlisting>
- </section>
-
- <section
- xml:id="perf.hbase.client.blockcache">
- <title>Block Cache</title>
-
- <para><link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">Scan</link>
- instances can be set to use the block cache in the RegionServer via the
- <methodname>setCacheBlocks</methodname> method. For input Scans to MapReduce jobs, this
- should be <varname>false</varname>. For frequently accessed rows, it is advisable to use the
- block cache.</para>
-
- <para>Cache more data by moving your Block Cache offheap. See <xref linkend="offheap.blockcache" /></para>
- </section>
- <section
- xml:id="perf.hbase.client.rowkeyonly">
- <title>Optimal Loading of Row Keys</title>
- <para>When performing a table <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html">scan</link>
- where only the row keys are needed (no families, qualifiers, values or timestamps), add a
- FilterList with a <varname>MUST_PASS_ALL</varname> operator to the scanner using
- <methodname>setFilter</methodname>. The filter list should include both a <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html">FirstKeyOnlyFilter</link>
- and a <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html">KeyOnlyFilter</link>.
- Using this filter combination will result in a worst case scenario of a RegionServer reading
- a single value from disk and minimal network traffic to the client for a single row. </para>
- </section>
- <section
- xml:id="perf.hbase.read.dist">
- <title>Concurrency: Monitor Data Spread</title>
- <para>When performing a high number of concurrent reads, monitor the data spread of the target
- tables. If the target table(s) have too few regions then the reads could likely be served
- from too few nodes. </para>
- <para>See <xref
- linkend="precreate.regions" />, as well as <xref
- linkend="perf.configurations" />
- </para>
- </section>
- <section
- xml:id="blooms">
- <title>Bloom Filters</title>
- <para>Enabling Bloom Filters can save your having to go to disk and can help improve read
- latencies.</para>
- <para><link
- xlink:href="http://en.wikipedia.org/wiki/Bloom_filter">Bloom filters</link> were developed
- over in <link xlink:href="https://issues.apache.org/jira/browse/HBASE-1200">HBase-1200 Add
- bloomfilters</link>. For description of the development process -- why static blooms rather than dynamic
- -- and for an overview of the unique properties that pertain to blooms in HBase, as well
- as possible future directions, see the <emphasis>Development Process</emphasis> section
- of the document <link
- xlink:href="https://issues.apache.org/jira/secure/attachment/12444007/Bloom_Filters_in_HBase.pdf">BloomFilters
- in HBase</link> attached to <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-1200">HBase-1200</link>. The bloom filters described here are actually version two of blooms in HBase. In
- versions up to 0.19.x, HBase had a dynamic bloom option based on work done by the <link
- xlink:href="http://www.one-lab.org">European Commission One-Lab Project 034819</link>.
- The core of the HBase bloom work was later pulled up into Hadoop to implement
- org.apache.hadoop.io.BloomMapFile. Version 1 of HBase blooms never worked that well.
- Version 2 is a rewrite from scratch though again it starts with the one-lab work.</para>
-
- <para>See also <xref
- linkend="schema.bloom" />. </para>
-
- <section
- xml:id="bloom_footprint">
- <title>Bloom StoreFile footprint</title>
-
- <para>Bloom filters add an entry to the <classname>StoreFile</classname> general
- <classname>FileInfo</classname> data structure and then two extra entries to the
- <classname>StoreFile</classname> metadata section.</para>
-
- <section>
- <title>BloomFilter in the <classname>StoreFile</classname>
- <classname>FileInfo</classname> data structure</title>
-
- <para><classname>FileInfo</classname> has a <varname>BLOOM_FILTER_TYPE</varname> entry
- which is set to <varname>NONE</varname>, <varname>ROW</varname> or
- <varname>ROWCOL.</varname></para>
- </section>
-
- <section>
- <title>BloomFilter entries in <classname>StoreFile</classname> metadata</title>
-
- <para><varname>BLOOM_FILTER_META</varname> holds Bloom Size, Hash Function used, etc. Its
- small in size and is cached on <classname>StoreFile.Reader</classname> load</para>
- <para><varname>BLOOM_FILTER_DATA</varname> is the actual bloomfilter data. Obtained
- on-demand. Stored in the LRU cache, if it is enabled (Its enabled by default).</para>
- </section>
- </section>
- <section
- xml:id="config.bloom">
- <title>Bloom Filter Configuration</title>
- <section>
- <title><varname>io.hfile.bloom.enabled</varname> global kill switch</title>
-
- <para><code>io.hfile.bloom.enabled</code> in <classname>Configuration</classname> serves
- as the kill switch in case something goes wrong. Default =
- <varname>true</varname>.</para>
- </section>
-
- <section>
- <title><varname>io.hfile.bloom.error.rate</varname></title>
-
- <para><varname>io.hfile.bloom.error.rate</varname> = average false positive rate. Default
- = 1%. Decrease rate by ½ (e.g. to .5%) == +1 bit per bloom entry.</para>
- </section>
-
- <section>
- <title><varname>io.hfile.bloom.max.fold</varname></title>
-
- <para><varname>io.hfile.bloom.max.fold</varname> = guaranteed minimum fold rate. Most
- people should leave this alone. Default = 7, or can collapse to at least 1/128th of
- original size. See the <emphasis>Development Process</emphasis> section of the document <link
- xlink:href="https://issues.apache.org/jira/secure/attachment/12444007/Bloom_Filters_in_HBase.pdf">BloomFilters
- in HBase</link> for more on what this option means.</para>
- </section>
- </section>
- </section>
- <!-- bloom -->
- <section>
- <title>Hedged Reads</title>
- <para>Hedged reads are a feature of HDFS, introduced in <link
- xlink:href="https://issues.apache.org/jira/browse/HDFS-5776">HDFS-5776</link>. Normally, a
- single thread is spawned for each read request. However, if hedged reads are enabled, the
- client waits some configurable amount of time, and if the read does not return, the client
- spawns a second read request, against a different block replica of the same data. Whichever
- read returns first is used, and the other read request is discarded. Hedged reads can be
- helpful for times where a rare slow read is caused by a transient error such as a failing
- disk or flaky network connection.</para>
- <para> Because a HBase RegionServer is a HDFS client, you can enable hedged reads in HBase, by
- adding the following properties to the RegionServer's hbase-site.xml and tuning the values
- to suit your environment.</para>
- <itemizedlist>
- <title>Configuration for Hedged Reads</title>
- <listitem>
- <para><code>dfs.client.hedged.read.threadpool.size</code> - the number of threads
- dedicated to servicing hedged reads. If this is set to 0 (the default), hedged reads are
- disabled.</para>
- </listitem>
- <listitem>
- <para><code>dfs.client.hedged.read.threshold.millis</code> - the number of milliseconds to
- wait before spawning a second read thread.</para>
- </listitem>
- </itemizedlist>
- <example>
- <title>Hedged Reads Configuration Example</title>
- <screen><![CDATA[<property>
- <name>dfs.client.hedged.read.threadpool.size</name>
- <value>20</value> <!-- 20 threads -->
-</property>
-<property>
- <name>dfs.client.hedged.read.threshold.millis</name>
- <value>10</value> <!-- 10 milliseconds -->
-</property>]]></screen>
- </example>
- <para>Use the following metrics to tune the settings for hedged reads on
- your cluster. See <xref linkend="hbase_metrics"/> for more information.</para>
- <itemizedlist>
- <title>Metrics for Hedged Reads</title>
- <listitem>
- <para>hedgedReadOps - the number of times hedged read threads have been triggered. This
- could indicate that read requests are often slow, or that hedged reads are triggered too
- quickly.</para>
- </listitem>
- <listitem>
- <para>hedgeReadOpsWin - the number of times the hedged read thread was faster than the
- original thread. This could indicate that a given RegionServer is having trouble
- servicing requests.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- </section>
- <!-- reading -->
-
- <section
- xml:id="perf.deleting">
- <title>Deleting from HBase</title>
- <section
- xml:id="perf.deleting.queue">
- <title>Using HBase Tables as Queues</title>
- <para>HBase tables are sometimes used as queues. In this case, special care must be taken to
- regularly perform major compactions on tables used in this manner. As is documented in <xref
- linkend="datamodel" />, marking rows as deleted creates additional StoreFiles which then
- need to be processed on reads. Tombstones only get cleaned up with major compactions. </para>
- <para>See also <xref
- linkend="compaction" /> and <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HBaseAdmin.html#majorCompact%28java.lang.String%29">HBaseAdmin.majorCompact</link>.
- </para>
- </section>
- <section
- xml:id="perf.deleting.rpc">
- <title>Delete RPC Behavior</title>
- <para>Be aware that <code>htable.delete(Delete)</code> doesn't use the writeBuffer. It will
- execute an RegionServer RPC with each invocation. For a large number of deletes, consider
- <code>htable.delete(List)</code>. </para>
- <para>See <link
- xlink:href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/HTable.html#delete%28org.apache.hadoop.hbase.client.Delete%29" />
- </para>
- </section>
- </section>
- <!-- deleting -->
-
- <section
- xml:id="perf.hdfs">
- <title>HDFS</title>
- <para>Because HBase runs on <xref
- linkend="arch.hdfs" /> it is important to understand how it works and how it affects HBase. </para>
- <section
- xml:id="perf.hdfs.curr">
- <title>Current Issues With Low-Latency Reads</title>
- <para>The original use-case for HDFS was batch processing. As such, there low-latency reads
- were historically not a priority. With the increased adoption of Apache HBase this is
- changing, and several improvements are already in development. See the <link
- xlink:href="https://issues.apache.org/jira/browse/HDFS-1599">Umbrella Jira Ticket for HDFS
- Improvements for HBase</link>. </para>
- </section>
- <section
- xml:id="perf.hdfs.configs.localread">
- <title>Leveraging local data</title>
- <para>Since Hadoop 1.0.0 (also 0.22.1, 0.23.1, CDH3u3 and HDP 1.0) via <link
- xlink:href="https://issues.apache.org/jira/browse/HDFS-2246">HDFS-2246</link>, it is
- possible for the DFSClient to take a "short circuit" and read directly from the disk instead
- of going through the DataNode when the data is local. What this means for HBase is that the
- RegionServers can read directly off their machine's disks instead of having to open a socket
- to talk to the DataNode, the former being generally much faster. See JD's <link
- xlink:href="http://files.meetup.com/1350427/hug_ebay_jdcryans.pdf">Performance
- Talk</link>. Also see <link
- xlink:href="http://search-hadoop.com/m/zV6dKrLCVh1">HBase, mail # dev - read short
- circuit</link> thread for more discussion around short circuit reads. </para>
- <para>To enable "short circuit" reads, it will depend on your version of Hadoop. The original
- shortcircuit read patch was much improved upon in Hadoop 2 in <link
- xlink:href="https://issues.apache.org/jira/browse/HDFS-347">HDFS-347</link>. See <link
- xlink:href="http://blog.cloudera.com/blog/2013/08/how-improved-short-circuit-local-reads-bring-better-performance-and-security-to-hadoop/" />
- for details on the difference between the old and new implementations. See <link
- xlink:href="http://archive.cloudera.com/cdh4/cdh/4/hadoop/hadoop-project-dist/hadoop-hdfs/ShortCircuitLocalReads.html">Hadoop
- shortcircuit reads configuration page</link> for how to enable the latter, better version
- of shortcircuit. For example, here is a minimal config. enabling short-circuit reads added
- to <filename>hbase-site.xml</filename>: </para>
- <programlisting language="xml"><![CDATA[<property>
- <name>dfs.client.read.shortcircuit</name>
- <value>true</value>
- <description>
- This configuration parameter turns on short-circuit local reads.
- </description>
-</property>
-<property>
- <name>dfs.domain.socket.path</name>
- <value>/home/stack/sockets/short_circuit_read_socket_PORT</value>
- <description>
- Optional. This is a path to a UNIX domain socket that will be used for
- communication between the DataNode and local HDFS clients.
- If the string "_PORT" is present in this path, it will be replaced by the
- TCP port of the DataNode.
- </description>
-</property>]]></programlisting>
- <para>Be careful about permissions for the directory that hosts the shared domain socket;
- dfsclient will complain if open to other than the hbase user. </para>
- <para>If you are running on an old Hadoop, one that is without <link
- xlink:href="https://issues.apache.org/jira/browse/HDFS-347">HDFS-347</link> but that has
- <link xlink:href="https://issues.apache.org/jira/browse/HDFS-2246">HDFS-2246</link>, you
- must set two configurations. First, the hdfs-site.xml needs to be amended. Set the property
- <varname>dfs.block.local-path-access.user</varname> to be the <emphasis>only</emphasis>
- user that can use the shortcut. This has to be the user that started HBase. Then in
- hbase-site.xml, set <varname>dfs.client.read.shortcircuit</varname> to be
- <varname>true</varname>
- </para>
-
- <para> Services -- at least the HBase RegionServers -- will need to be restarted in order to
- pick up the new configurations. </para>
- <note
- xml:id="dfs.client.read.shortcircuit.buffer.size">
- <title>dfs.client.read.shortcircuit.buffer.size</title>
- <para>The default for this value is too high when running on a highly trafficed HBase. In
- HBase, if this value has not been set, we set it down from the default of 1M to 128k
- (Since HBase 0.98.0 and 0.96.1). See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-8143">HBASE-8143 HBase on Hadoop
- 2 with local short circuit reads (ssr) causes OOM</link>). The Hadoop DFSClient in HBase
- will allocate a direct byte buffer of this size for <emphasis>each</emphasis> block it has
- open; given HBase keeps its HDFS files open all the time, this can add up quickly.</para>
- </note>
- </section>
-
- <section
- xml:id="perf.hdfs.comp">
- <title>Performance Comparisons of HBase vs. HDFS</title>
- <para>A fairly common question on the dist-list is why HBase isn't as performant as HDFS files
- in a batch context (e.g., as a MapReduce source or sink). The short answer is that HBase is
- doing a lot more than HDFS (e.g., reading the KeyValues, returning the most current row or
- specified timestamps, etc.), and as such HBase is 4-5 times slower than HDFS in this
- processing context. There is room for improvement and this gap will, over time, be reduced,
- but HDFS will always be faster in this use-case. </para>
- </section>
- </section>
-
- <section
- xml:id="perf.ec2">
- <title>Amazon EC2</title>
- <para>Performance questions are common on Amazon EC2 environments because it is a shared
- environment. You will not see the same throughput as a dedicated server. In terms of running
- tests on EC2, run them several times for the same reason (i.e., it's a shared environment and
- you don't know what else is happening on the server). </para>
- <para>If you are running on EC2 and post performance questions on the dist-list, please state
- this fact up-front that because EC2 issues are practically a separate class of performance
- issues. </para>
- </section>
-
- <section
- xml:id="perf.hbase.mr.cluster">
- <title>Collocating HBase and MapReduce</title>
- <para>It is often recommended to have different clusters for HBase and MapReduce. A better
- qualification of this is: don't collocate a HBase that serves live requests with a heavy MR
- workload. OLTP and OLAP-optimized systems have conflicting requirements and one will lose to
- the other, usually the former. For example, short latency-sensitive disk reads will have to
- wait in line behind longer reads that are trying to squeeze out as much throughput as
- possible. MR jobs that write to HBase will also generate flushes and compactions, which will
- in turn invalidate blocks in the <xref
- linkend="block.cache" />. </para>
- <para>If you need to process the data from your live HBase cluster in MR, you can ship the
- deltas with <xref
- linkend="copy.table" /> or use replication to get the new data in real time on the OLAP
- cluster. In the worst case, if you really need to collocate both, set MR to use less Map and
- Reduce slots than you'd normally configure, possibly just one. </para>
- <para>When HBase is used for OLAP operations, it's preferable to set it up in a hardened way
- like configuring the ZooKeeper session timeout higher and giving more memory to the MemStores
- (the argument being that the Block Cache won't be used much since the workloads are usually
- long scans). </para>
- </section>
-
- <section
- xml:id="perf.casestudy">
- <title>Case Studies</title>
- <para>For Performance and Troubleshooting Case Studies, see <xref
- linkend="casestudies" />. </para>
- </section>
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/preface.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/preface.xml b/src/main/docbkx/preface.xml
deleted file mode 100644
index a8f6895..0000000
--- a/src/main/docbkx/preface.xml
+++ /dev/null
@@ -1,83 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<preface
- version="5.0"
- xml:id="preface"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Preface</title>
-
- <para>This is the official reference guide for the <link
- xlink:href="http://hbase.apache.org/">HBase</link> version it ships with. Herein you
- will find either the definitive documentation on an HBase topic as of its standing when the
- referenced HBase version shipped, or it will point to the location in <link
- xlink:href="http://hbase.apache.org/apidocs/index.html">javadoc</link>, <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE">JIRA</link> or <link
- xlink:href="http://wiki.apache.org/hadoop/Hbase">wiki</link> where the pertinent
- information can be found.</para>
-
- <formalpara>
- <title>About This Guide</title>
- <para>This reference guide is a work in progress. The source for this guide can be found in
- the <filename>src/main/docbkx</filename> directory of the HBase source. This reference
- guide is marked up using <link xlink:href="http://www.docbook.org/">DocBook</link> from
- which the the finished guide is generated as part of the 'site' build target. Run
- <programlisting language="bourne">mvn site</programlisting> to generate this documentation. Amendments and
- improvements to the documentation are welcomed. Click <link
- xlink:href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310753&issuetype=1&components=12312132&summary=SHORT+DESCRIPTION"
- >this link</link> to file a new documentation bug against Apache HBase with some
- values pre-selected.</para>
- </formalpara>
- <formalpara>
- <title>Contributing to the Documentation</title>
- <para>For an overview of Docbook and suggestions to get started contributing to the documentation, see <xref linkend="appendix_contributing_to_documentation" />.</para>
- </formalpara>
- <formalpara>
- <title>Providing Feedback</title>
- <para>This guide allows you to leave comments or questions on any page, using Disqus. Look
- for the Comments area at the bottom of the page. Answering these questions is a
- volunteer effort, and may be delayed.</para>
- </formalpara>
-
- <note
- xml:id="headsup">
- <title>Heads-up if this is your first foray into the world of distributed
- computing...</title>
- <para> If this is your first foray into the wonderful world of Distributed Computing, then
- you are in for some interesting times. First off, distributed systems are hard; making a
- distributed system hum requires a disparate skillset that spans systems (hardware and
- software) and networking. Your cluster' operation can hiccup because of any of a myriad
- set of reasons from bugs in HBase itself through misconfigurations -- misconfiguration
- of HBase but also operating system misconfigurations -- through to hardware problems
- whether it be a bug in your network card drivers or an underprovisioned RAM bus (to
- mention two recent examples of hardware issues that manifested as "HBase is slow"). You
- will also need to do a recalibration if up to this your computing has been bound to a
- single box. Here is one good starting point: <link
- xlink:href="http://en.wikipedia.org/wiki/Fallacies_of_Distributed_Computing">Fallacies
- of Distributed Computing</link>. That said, you are welcome. Its a fun place to be.
- Yours, the HBase Community. </para>
- </note>
-</preface>
[02/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/unit_testing.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/unit_testing.xml b/src/main/docbkx/unit_testing.xml
deleted file mode 100644
index 8d8c756..0000000
--- a/src/main/docbkx/unit_testing.xml
+++ /dev/null
@@ -1,330 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter version="5.0" xml:id="unit.tests" xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml" xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>Unit Testing HBase Applications</title>
- <para>This chapter discusses unit testing your HBase application using JUnit, Mockito, MRUnit,
- and HBaseTestingUtility. Much of the information comes from <link
- xlink:href="http://blog.cloudera.com/blog/2013/09/how-to-test-hbase-applications-using-popular-tools/"
- >a community blog post about testing HBase applications</link>. For information on unit
- tests for HBase itself, see <xref linkend="hbase.tests"/>.</para>
-
- <section>
- <title>JUnit</title>
- <para>HBase uses <link xlink:href="http://junit.org">JUnit</link> 4 for unit tests</para>
- <para>This example will add unit tests to the following example class:</para>
- <programlisting language="java">
-public class MyHBaseDAO {
-
- public static void insertRecord(HTableInterface table, HBaseTestObj obj)
- throws Exception {
- Put put = createPut(obj);
- table.put(put);
- }
-
- private static Put createPut(HBaseTestObj obj) {
- Put put = new Put(Bytes.toBytes(obj.getRowKey()));
- put.add(Bytes.toBytes("CF"), Bytes.toBytes("CQ-1"),
- Bytes.toBytes(obj.getData1()));
- put.add(Bytes.toBytes("CF"), Bytes.toBytes("CQ-2"),
- Bytes.toBytes(obj.getData2()));
- return put;
- }
-}
- </programlisting>
- <para>The first step is to add JUnit dependencies to your Maven POM file:</para>
- <programlisting language="xml"><![CDATA[
-<dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>4.11</version>
- <scope>test</scope>
-</dependency>
- ]]></programlisting>
- <para>Next, add some unit tests to your code. Tests are annotated with
- <literal>@Test</literal>. Here, the unit tests are in bold.</para>
- <programlisting language="java">
-public class TestMyHbaseDAOData {
- @Test
- public void testCreatePut() throws Exception {
- HBaseTestObj obj = new HBaseTestObj();
- obj.setRowKey("ROWKEY-1");
- obj.setData1("DATA-1");
- obj.setData2("DATA-2");
- Put put = MyHBaseDAO.createPut(obj);
- <userinput>assertEquals(obj.getRowKey(), Bytes.toString(put.getRow()));
- assertEquals(obj.getData1(), Bytes.toString(put.get(Bytes.toBytes("CF"), Bytes.toBytes("CQ-1")).get(0).getValue()));
- assertEquals(obj.getData2(), Bytes.toString(put.get(Bytes.toBytes("CF"), Bytes.toBytes("CQ-2")).get(0).getValue()));</userinput>
- }
-}
- </programlisting>
- <para>These tests ensure that your <code>createPut</code> method creates, populates, and
- returns a <code>Put</code> object with expected values. Of course, JUnit can do much
- more than this. For an introduction to JUnit, see <link
- xlink:href="https://github.com/junit-team/junit/wiki/Getting-started"
- >https://github.com/junit-team/junit/wiki/Getting-started</link>. </para>
- </section>
-
- <section xml:id="mockito">
- <title>Mockito</title>
- <para>Mockito is a mocking framework. It goes further than JUnit by allowing you to test the
- interactions between objects without having to replicate the entire environment. You can
- read more about Mockito at its project site, <link
- xlink:href="https://code.google.com/p/mockito/"
- >https://code.google.com/p/mockito/</link>.</para>
- <para>You can use Mockito to do unit testing on smaller units. For instance, you can mock a
- <classname>org.apache.hadoop.hbase.Server</classname> instance or a
- <classname>org.apache.hadoop.hbase.master.MasterServices</classname> interface
- reference rather than a full-blown
- <classname>org.apache.hadoop.hbase.master.HMaster</classname>.</para>
- <para>This example builds upon the example code in <xref linkend="unit.tests"/>, to test the
- <code>insertRecord</code> method.</para>
- <para>First, add a dependency for Mockito to your Maven POM file.</para>
- <programlisting language="xml"><![CDATA[
-<dependency>
- <groupId>org.mockito</groupId>
- <artifactId>mockito-all</artifactId>
- <version>1.9.5</version>
- <scope>test</scope>
-</dependency>
- ]]></programlisting>
- <para>Next, add a <code>@RunWith</code> annotation to your test class, to direct it to use
- Mockito.</para>
- <programlisting language="java">
-<userinput>@RunWith(MockitoJUnitRunner.class)</userinput>
-public class TestMyHBaseDAO{
- @Mock
- private HTableInterface table;
- @Mock
- private HTablePool hTablePool;
- @Captor
- private ArgumentCaptor putCaptor;
-
- @Test
- public void testInsertRecord() throws Exception {
- //return mock table when getTable is called
- when(hTablePool.getTable("tablename")).thenReturn(table);
- //create test object and make a call to the DAO that needs testing
- HBaseTestObj obj = new HBaseTestObj();
- obj.setRowKey("ROWKEY-1");
- obj.setData1("DATA-1");
- obj.setData2("DATA-2");
- MyHBaseDAO.insertRecord(table, obj);
- verify(table).put(putCaptor.capture());
- Put put = putCaptor.getValue();
-
- assertEquals(Bytes.toString(put.getRow()), obj.getRowKey());
- assert(put.has(Bytes.toBytes("CF"), Bytes.toBytes("CQ-1")));
- assert(put.has(Bytes.toBytes("CF"), Bytes.toBytes("CQ-2")));
- assertEquals(Bytes.toString(put.get(Bytes.toBytes("CF"),Bytes.toBytes("CQ-1")).get(0).getValue()), "DATA-1");
- assertEquals(Bytes.toString(put.get(Bytes.toBytes("CF"),Bytes.toBytes("CQ-2")).get(0).getValue()), "DATA-2");
- }
-}
- </programlisting>
- <para>This code populates <code>HBaseTestObj</code> with “ROWKEY-1”, “DATA-1”, “DATA-2” as
- values. It then inserts the record into the mocked table. The Put that the DAO would
- have inserted is captured, and values are tested to verify that they are what you
- expected them to be.</para>
- <para>The key here is to manage htable pool and htable instance creation outside the DAO.
- This allows you to mock them cleanly and test Puts as shown above. Similarly, you can
- now expand into other operations such as Get, Scan, or Delete.</para>
-
- </section>
- <section>
- <title>MRUnit</title>
- <para><link xlink:href="http://mrunit.apache.org/">Apache MRUnit</link> is a library that
- allows you to unit-test MapReduce jobs. You can use it to test HBase jobs in the same
- way as other MapReduce jobs.</para>
- <para>Given a MapReduce job that writes to an HBase table called <literal>MyTest</literal>,
- which has one column family called <literal>CF</literal>, the reducer of such a job
- could look like the following:</para>
- <programlisting language="java"><![CDATA[
-public class MyReducer extends TableReducer<Text, Text, ImmutableBytesWritable> {
- public static final byte[] CF = "CF".getBytes();
- public static final byte[] QUALIFIER = "CQ-1".getBytes();
- public void reduce(Text key, Iterable<Text> values, Context context) throws IOException, InterruptedException {
- //bunch of processing to extract data to be inserted, in our case, lets say we are simply
- //appending all the records we receive from the mapper for this particular
- //key and insert one record into HBase
- StringBuffer data = new StringBuffer();
- Put put = new Put(Bytes.toBytes(key.toString()));
- for (Text val : values) {
- data = data.append(val);
- }
- put.add(CF, QUALIFIER, Bytes.toBytes(data.toString()));
- //write to HBase
- context.write(new ImmutableBytesWritable(Bytes.toBytes(key.toString())), put);
- }
- } ]]>
- </programlisting>
- <para>To test this code, the first step is to add a dependency to MRUnit to your Maven POM
- file. </para>
- <programlisting language="xml"><![CDATA[
-<dependency>
- <groupId>org.apache.mrunit</groupId>
- <artifactId>mrunit</artifactId>
- <version>1.0.0 </version>
- <scope>test</scope>
-</dependency>
- ]]></programlisting>
- <para>Next, use the ReducerDriver provided by MRUnit, in your Reducer job.</para>
- <programlisting language="java"><![CDATA[
-public class MyReducerTest {
- ReduceDriver<Text, Text, ImmutableBytesWritable, Writable> reduceDriver;
- byte[] CF = "CF".getBytes();
- byte[] QUALIFIER = "CQ-1".getBytes();
-
- @Before
- public void setUp() {
- MyReducer reducer = new MyReducer();
- reduceDriver = ReduceDriver.newReduceDriver(reducer);
- }
-
- @Test
- public void testHBaseInsert() throws IOException {
- String strKey = "RowKey-1", strValue = "DATA", strValue1 = "DATA1",
-strValue2 = "DATA2";
- List<Text> list = new ArrayList<Text>();
- list.add(new Text(strValue));
- list.add(new Text(strValue1));
- list.add(new Text(strValue2));
- //since in our case all that the reducer is doing is appending the records that the mapper
- //sends it, we should get the following back
- String expectedOutput = strValue + strValue1 + strValue2;
- //Setup Input, mimic what mapper would have passed
- //to the reducer and run test
- reduceDriver.withInput(new Text(strKey), list);
- //run the reducer and get its output
- List<Pair<ImmutableBytesWritable, Writable>> result = reduceDriver.run();
-
- //extract key from result and verify
- assertEquals(Bytes.toString(result.get(0).getFirst().get()), strKey);
-
- //extract value for CF/QUALIFIER and verify
- Put a = (Put)result.get(0).getSecond();
- String c = Bytes.toString(a.get(CF, QUALIFIER).get(0).getValue());
- assertEquals(expectedOutput,c );
- }
-
-}
- ]]></programlisting>
- <para>Your MRUnit test verifies that the output is as expected, the Put that is inserted
- into HBase has the correct value, and the ColumnFamily and ColumnQualifier have the
- correct values.</para>
- <para>MRUnit includes a MapperDriver to test mapping jobs, and you can use MRUnit to test
- other operations, including reading from HBase, processing data, or writing to
- HDFS,</para>
- </section>
-
- <section>
- <title>Integration Testing with a HBase Mini-Cluster</title>
- <para>HBase ships with HBaseTestingUtility, which makes it easy to write integration tests
- using a <firstterm>mini-cluster</firstterm>. The first step is to add some dependencies
- to your Maven POM file. Check the versions to be sure they are appropriate.</para>
- <programlisting language="xml"><![CDATA[
-<dependency>
- <groupId>org.apache.hadoop</groupId>
- <artifactId>hadoop-common</artifactId>
- <version>2.0.0</version>
- <type>test-jar</type>
- <scope>test</scope>
-</dependency>
-
-<dependency>
- <groupId>org.apache.hbase</groupId>
- <artifactId>hbase</artifactId>
- <version>0.98.3</version>
- <type>test-jar</type>
- <scope>test</scope>
-</dependency>
-
-<dependency>
- <groupId>org.apache.hadoop</groupId>
- <artifactId>hadoop-hdfs</artifactId>
- <version>2.0.0</version>
- <type>test-jar</type>
- <scope>test</scope>
-</dependency>
-
-<dependency>
- <groupId>org.apache.hadoop</groupId>
- <artifactId>hadoop-hdfs</artifactId>
- <version>2.0.0</version>
- <scope>test</scope>
-</dependency>
- ]]></programlisting>
- <para>This code represents an integration test for the MyDAO insert shown in <xref
- linkend="unit.tests"/>.</para>
- <programlisting language="java">
-public class MyHBaseIntegrationTest {
- private static HBaseTestingUtility utility;
- byte[] CF = "CF".getBytes();
- byte[] QUALIFIER = "CQ-1".getBytes();
-
- @Before
- public void setup() throws Exception {
- utility = new HBaseTestingUtility();
- utility.startMiniCluster();
- }
-
- @Test
- public void testInsert() throws Exception {
- HTableInterface table = utility.createTable(Bytes.toBytes("MyTest"),
- Bytes.toBytes("CF"));
- HBaseTestObj obj = new HBaseTestObj();
- obj.setRowKey("ROWKEY-1");
- obj.setData1("DATA-1");
- obj.setData2("DATA-2");
- MyHBaseDAO.insertRecord(table, obj);
- Get get1 = new Get(Bytes.toBytes(obj.getRowKey()));
- get1.addColumn(CF, CQ1);
- Result result1 = table.get(get1);
- assertEquals(Bytes.toString(result1.getRow()), obj.getRowKey());
- assertEquals(Bytes.toString(result1.value()), obj.getData1());
- Get get2 = new Get(Bytes.toBytes(obj.getRowKey()));
- get2.addColumn(CF, CQ2);
- Result result2 = table.get(get2);
- assertEquals(Bytes.toString(result2.getRow()), obj.getRowKey());
- assertEquals(Bytes.toString(result2.value()), obj.getData2());
- }
-}
- </programlisting>
- <para>This code creates an HBase mini-cluster and starts it. Next, it creates a table called
- <literal>MyTest</literal> with one column family, <literal>CF</literal>. A record is
- inserted, a Get is performed from the same table, and the insertion is verified.</para>
- <note>
- <para>Starting the mini-cluster takes about 20-30 seconds, but that should be
- appropriate for integration testing. </para>
- </note>
- <para>To use an HBase mini-cluster on Microsoft Windows, you need to use a Cygwin
- environment.</para>
- <para>See the paper at <link
- xlink:href="http://blog.sematext.com/2010/08/30/hbase-case-study-using-hbasetestingutility-for-local-testing-development/"
- >HBase Case-Study: Using HBaseTestingUtility for Local Testing and
- Development</link> (2010) for more information about HBaseTestingUtility.</para>
- </section>
-
-</chapter>
-
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/upgrading.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/upgrading.xml b/src/main/docbkx/upgrading.xml
deleted file mode 100644
index d5708a4..0000000
--- a/src/main/docbkx/upgrading.xml
+++ /dev/null
@@ -1,833 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="upgrading"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Upgrading</title>
-
-
- <para>You cannot skip major versions upgrading. If you are upgrading from version 0.90.x to
- 0.94.x, you must first go from 0.90.x to 0.92.x and then go from 0.92.x to 0.94.x.</para>
- <note>
- <para>It may be possible to skip across versions -- for example go from 0.92.2 straight to
- 0.98.0 just following the 0.96.x upgrade instructions -- but we have not tried it so
- cannot say whether it works or not.</para>
- </note>
- <para> Review <xref
- linkend="configuration" />, in particular the section on Hadoop version. </para>
- <section
- xml:id="hbase.versioning">
- <title>HBase version number and compatibility</title>
- <para>HBase has two versioning schemes, pre-1.0 and post-1.0. Both are detailed below. </para>
-
- <section xml:id="hbase.versioning.post10">
- <title>Post 1.0 versions</title>
- <para>Starting with 1.0.0 release, HBase uses <link xlink:href="http://semver.org/">Semantic Versioning</link> for it release versioning.
- In summary:
- <blockquote>
- <para>
- Given a version number MAJOR.MINOR.PATCH, increment the:
- <itemizedlist>
- <listitem>MAJOR version when you make incompatible API changes,</listitem>
- <listitem>MINOR version when you add functionality in a backwards-compatible manner, and</listitem>
- <listitem>PATCH version when you make backwards-compatible bug fixes.</listitem>
- <listitem>Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.</listitem>
- </itemizedlist>
- </para>
- </blockquote>
- </para>
-
- <section xml:id="hbase.versioning.compat">
- <title>Compatibility Dimensions</title>
- <para>In addition to the usual API versioning considerations HBase has other compatibility dimensions that we need to consider.</para>
-
- <section>
- <title>Client-Server wire protocol compatibility</title>
- <para><itemizedlist>
- <listitem>Allows updating client and server out of sync.</listitem>
- <listitem>We could only allow upgrading the server first. I.e. the server would be backward compatible to an old client, that way new APIs are OK.</listitem>
- <listitem>Example: A user should be able to use an old client to connect to an upgraded cluster.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Server-Server protocol compatibility</title>
- <para><itemizedlist>
- <listitem>Servers of different versions can co-exist in the same cluster.</listitem>
- <listitem>The wire protocol between servers is compatible.</listitem>
- <listitem>Workers for distributed tasks, such as replication and log splitting, can co-exist in the same cluster.</listitem>
- <listitem>Dependent protocols (such as using ZK for coordination) will also not be changed.</listitem>
- <listitem>Example: A user can perform a rolling upgrade.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>File format compatibility</title>
- <para><itemizedlist>
- <listitem>Support file formats backward and forward compatible</listitem>
- <listitem>Example: File, ZK encoding, directory layout is upgraded automatically as part of an HBase upgrade. User can rollback to the older version and everything will continue to work.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Client API compatibility</title>
- <para><itemizedlist>
- <listitem>Allow changing or removing existing client APIs.</listitem>
- <listitem>An API needs to deprecated for a major version before we will change/remove it.</listitem>
- <listitem>Example: A user using a newly deprecated api does not need to modify application code with hbase api calls until the next major version.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Client Binary compatibility</title>
- <para><itemizedlist>
- <listitem>Old client code can run unchanged (no recompilation needed) against new jars.</listitem>
- <listitem>Example: Old compiled client code will work unchanged with the new jars.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Server-Side Limited API compatibility (taken from Hadoop)</title>
- <para><itemizedlist>
- <listitem>Internal APIs are marked as Stable, Evolving, or Unstable</listitem>
- <listitem>This implies binary compatibility for coprocessors and plugins (pluggable classes, including replication) as long as these are only using marked interfaces/classes.</listitem>
- <listitem>Example: Old compiled Coprocessor, Filter, or Plugin code will work unchanged with the new jars.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Dependency Compatibility</title>
- <para><itemizedlist>
- <listitem>An upgrade of HBase will not require an incompatible upgrade of a dependent project, including the Java runtime.</listitem>
- <listitem>Example: An upgrade of Hadoop will not invalidate any of the compatibilities guarantees we made.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Operational Compatibility</title>
- <para><itemizedlist>
- <listitem>Metric changes</listitem>
- <listitem>Behavioral changes of services</listitem>
- <listitem>Web page APIs</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Summary</title>
- <para><itemizedlist>
- <listitem>A patch upgrade is a drop-in replacement. Any change that is not Java binary compatible would not be allowed.<footnote><link xlink:href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-13.html"/></footnote></listitem>
- <listitem>A minor upgrade requires no application/client code modification. Ideally it would be a drop-in replacement but client code, coprocessors, filters, etc might have to be recompiled if new jars are used.</listitem>
- <listitem>A major upgrade allows the HBase community to make breaking changes.</listitem>
- </itemizedlist></para>
- </section>
- <section>
- <title>Compatibility Matrix <footnote><para>Note that this indicates what could break, not that it will break. We will/should add specifics in our release notes.</para></footnote></title>
- <para> (Y means we support the compatibility. N means we can break it.) </para>
- <table>
- <title>Compatibility Matrix</title>
- <tgroup
- cols="4"
- align="left"
- colsep="1"
- rowsep="1">
- <colspec
- colname="c1"
- align="left" />
- <colspec
- colname="c2"
- align="center" />
- <colspec
- colname="c3"
- align="center" />
- <colspec
- colname="c4"
- align="center" />
- <thead>
- <row>
- <entry> </entry>
- <entry>Major</entry>
- <entry>Minor</entry>
- <entry>Patch</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Client-Server wire Compatibility</entry>
- <entry>N</entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>Server-Server Compatibility</entry>
- <entry>N</entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>File Format Compatibility</entry>
- <entry>N<footnote><para>Running an offline upgrade tool without rollback might be needed. We will typically only support migrating data from major version X to major version X+1.
-</para></footnote></entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>Client API Compatibility</entry>
- <entry>N</entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>Client Binary Compatibility</entry>
- <entry>N</entry>
- <entry>N</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>Server-Side Limited API Compatibility</entry>
- <entry></entry>
- <entry></entry>
- <entry></entry>
- </row>
- <row>
- <entry><itemizedlist><listitem>Stable</listitem></itemizedlist></entry>
- <entry>N</entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry><itemizedlist><listitem>Evolving</listitem></itemizedlist></entry>
- <entry>N</entry>
- <entry>N</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry><itemizedlist><listitem>Unstable</listitem></itemizedlist></entry>
- <entry>N</entry>
- <entry>N</entry>
- <entry>N</entry>
- </row>
- <row>
- <entry>Dependency Compatibility</entry>
- <entry>N</entry>
- <entry>Y</entry>
- <entry>Y</entry>
- </row>
- <row>
- <entry>Operational Compatibility</entry>
- <entry>N</entry>
- <entry>N</entry>
- <entry>Y</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section xml:id="hbase.client.api">
- <title>HBase API surface</title>
- <para> HBase has a lot of API points, but for the compatibility matrix above, we differentiate between Client API, Limited Private API, and Private API. HBase uses a version of
- <link xlink:href="https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html">Hadoop's Interface classification</link>. HBase's Interface classification classes can be found <link xlink:href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/classification/package-summary.html"> here</link>.
- <itemizedlist>
- <listitem>InterfaceAudience: captures the intended audience, possible values are Public (for end users and external projects), LimitedPrivate (for other Projects, Coprocessors or other plugin points), and Private (for internal use).</listitem>
- <listitem>InterfaceStability: describes what types of interface changes are permitted. Possible values are Stable, Evolving, Unstable, and Deprecated.</listitem>
- </itemizedlist>
- </para>
-
- <section xml:id="hbase.client.api">
- <title>HBase Client API</title>
- <para>HBase Client API consists of all the classes or methods that are marked with InterfaceAudience.Public interface. All main classes in hbase-client and dependent modules have either InterfaceAudience.Public, InterfaceAudience.LimitedPrivate, or InterfaceAudience.Private marker. Not all classes in other modules (hbase-server, etc) have the marker. If a class is not annotated with one of these, it is assumed to be a InterfaceAudience.Private class. </para>
- </section>
-
- <section xml:id="hbase.limitetprivate.api">
- <title>HBase LimitedPrivate API</title>
- <para>LimitedPrivate annotation comes with a set of target consumers for the interfaces. Those consumers are coprocessors, phoenix, replication endpoint implemnetations or similar. At this point, HBase only guarantees source and binary compatibility for these interfaces between patch versions. </para>
- </section>
-
- <section xml:id="hbase.private.api">
- <title>HBase Private API</title>
- <para>All classes annotated with InterfaceAudience.Private or all classes that do not have the annotation are for HBase internal use only. The interfaces and method signatures can change at any point in time. If you are relying on a particular interface that is marked Private, you should open a jira to propose changing the interface to be Public or LimitedPrivate, or an interface exposed for this purpose. </para>
- </section>
-
- </section>
- </section>
-
- </section>
-
- <section xml:id="hbase.versioning.pre10">
- <title>Pre 1.0 versions</title>
- <para></para>
-
- <para> Before the semantic versioning scheme pre-1.0, HBase tracked either Hadoop's versions (0.2x)
- or 0.9x versions. If you are into the arcane, checkout our old wiki page on <link
- xlink:href="http://wiki.apache.org/hadoop/Hbase/HBaseVersions">HBase
- Versioning</link> which tries to connect the HBase version dots. Below sections cover ONLY the
- releases before 1.0.</para>
- <section
- xml:id="hbase.development.series">
- <title>Odd/Even Versioning or "Development"" Series Releases</title>
- <para>Ahead of big releases, we have been putting up preview versions to start the
- feedback cycle turning-over earlier. These "Development" Series releases, always
- odd-numbered, come with no guarantees, not even regards being able to upgrade
- between two sequential releases (we reserve the right to break compatibility across
- "Development" Series releases). Needless to say, these releases are not for
- production deploys. They are a preview of what is coming in the hope that interested
- parties will take the release for a test drive and flag us early if we there are
- issues we've missed ahead of our rolling a production-worthy release. </para>
- <para>Our first "Development" Series was the 0.89 set that came out ahead of HBase
- 0.90.0. HBase 0.95 is another "Development" Series that portends HBase 0.96.0.
- 0.99.x is the last series in "developer preview" mode before 1.0. Afterwards,
- we will be using semantic versioning naming scheme (see above).
- </para>
- </section>
- <section
- xml:id="hbase.binary.compatibility">
- <title>Binary Compatibility</title>
- <para>When we say two HBase versions are compatible, we mean that the versions are wire
- and binary compatible. Compatible HBase versions means that clients can talk to
- compatible but differently versioned servers. It means too that you can just swap
- out the jars of one version and replace them with the jars of another, compatible
- version and all will just work. Unless otherwise specified, HBase point versions are
- (mostly) binary compatible. You can safely do rolling upgrades between binary compatible
- versions; i.e. across point versions: e.g. from 0.94.5 to 0.94.6. See <link
- xlink:href="http://search-hadoop.com/m/bOOvwHGW981/Does+compatibility+between+versions+also+mean+binary+compatibility%253F&subj=Re+">Does
- compatibility between versions also mean binary compatibility?</link>
- discussion on the hbaes dev mailing list. </para>
- </section>
-
-
- </section>
- <section xml:id="hbase.rolling.upgrade">
- <title><firstterm>Rolling Upgrades</firstterm></title>
- <para>A rolling upgrade is the process by which you update the servers
- in your cluster a server at a time. You can rolling upgrade across HBase versions
- if they are binary or wire compatible.
- See <xlnk href="hbase.rolling.restart" /> for more on what this means.
- Coarsely, a rolling upgrade is a graceful stop each server,
- update the software, and then restart. You do this for each server in the cluster.
- Usually you upgrade the Master first and then the regionservers.
- See <xlink href="rolling" /> for tools that can help use the rolling upgrade process.
- </para>
- <para>For example, in the below, hbase was symlinked to the actual hbase install.
- On upgrade, before running a rolling restart over the cluser, we changed the symlink
- to point at the new HBase software version and then ran
- <programlisting>$ HADOOP_HOME=~/hadoop-2.6.0-CRC-SNAPSHOT ~/hbase/bin/rolling-restart.sh --config ~/conf_hbase</programlisting>
- The rolling-restart script will first gracefully stop and restart the master, and then
- each of the regionservers in turn. Because the symlink was changed, on restart the
- server will come up using the new hbase version. Check logs for errors as the
- rolling upgrade proceeds.
- </para>
- <section
- xml:id="hbase.rolling.restart">
- <title>Rolling Upgrade between versions that are Binary/Wire compatibile</title>
- <para>Unless otherwise specified, HBase point versions are binary compatible. You can do
- a <xlink href="hbase.rolling.upgrade" /> between hbase point versions.
- For example, you can go to 0.94.6 from 0.94.5 by doing a rolling upgrade
- across the cluster replacing the 0.94.5 binary with a 0.94.6 binary.</para>
- <para>In the minor version-particular sections below, we call out where the versions
- are wire/protocol compatible and in this case, it is also possible to do a
- <xlink href="hbase.rolling.upgrade" />. For example, in
- <xlink href="upgrade1.0.rolling.upgrade" />, we
- state that it is possible to do a rolling upgrade between hbase-0.98.x and hbase-1.0.0.</para>
- </section>
- </section>
- </section>
- <section xml:id="upgrade1.0">
- <title>Upgrading from 0.98.x to 1.0.x</title>
- <para>In this section we first note the significant changes that come in with 1.0.0 HBase and then
- we go over the upgrade process. Be sure to read the significant changes section with care
- so you avoid surprises.
- </para>
- <section xml:id="upgrade1.0.changes">
- <title>Changes of Note!</title>
- <para>In here we list important changes that are in 1.0.0 since 0.98.x., changes you should
- be aware that will go into effect once you upgrade.</para>
- <section xml:id="zookeeper.3.4"><title>ZooKeeper 3.4 is required in HBase 1.0.0</title>
- <para>See <xref linkend="zookeeper.requirements" />.</para>
- </section>
- <section xml:id="default.ports.changed"><title>HBase Default Ports Changed</title>
- <para>The ports used by HBase changed. The used to be in the 600XX range. In
- hbase-1.0.0 they have been moved up out of the ephemeral port range and are
- 160XX instead (Master web UI was 60010 and is now 16030; the RegionServer
- web UI was 60030 and is now 16030, etc). If you want to keep the old port
- locations, copy the port setting configs from <filename>hbase-default.xml</filename>
- into <filename>hbase-site.xml</filename>, change them back to the old values
- from hbase-0.98.x era, and ensure you've distributed your configurations before
- you restart.</para>
- </section>
- <section xml:id="upgrade1.0.hbase.bucketcache.percentage.in.combinedcache">
- <title>hbase.bucketcache.percentage.in.combinedcache configuration has been REMOVED</title>
- <para>You may have made use of this configuration if you are using BucketCache.
- If NOT using BucketCache, this change does not effect you.
- Its removal means that your L1 LruBlockCache is now sized
- using <varname>hfile.block.cache.size</varname> -- i.e. the way you
- would size the onheap L1 LruBlockCache if you were NOT doing
- BucketCache -- and the BucketCache size is not whatever the
- setting for hbase.bucketcache.size is. You may need to adjust
- configs to get the LruBlockCache and BucketCache sizes set to
- what they were in 0.98.x and previous. If you did not set this
- config., its default value was 0.9. If you do nothing, your
- BucketCache will increase in size by 10%. Your L1 LruBlockCache will
- become <varname>hfile.block.cache.size</varname> times your java
- heap size (hfile.block.cache.size is a float between 0.0 and 1.0).
- To read more, see
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-11520">HBASE-11520 Simplify offheap cache config by removing the confusing "hbase.bucketcache.percentage.in.combinedcache"</link>.
- </para>
- </section>
- <section xml:id="hbase-12068"><title>If you have your own customer filters....</title>
- <para>See the release notes on the issue <link xlink:href="https://issues.apache.org/jira/browse/HBASE-12068">HBASE-12068 [Branch-1] Avoid need to always do KeyValueUtil#ensureKeyValue for Filter transformCell</link>;
- be sure to follow the recommendations therein.
- </para>
- </section>
- <section xml:id="dlr"><title>Distributed Log Replay</title>
- <para>
- <xref linkend="distributed.log.replay" /> is off by default in hbase-1.0.
- Enabling it can make a big difference improving HBase MTTR. Enable this
- feature if you are doing a clean stop/start when you are upgrading.
- You cannot rolling upgrade on to this feature (caveat if you are running
- on a version of hbase in excess of hbase-0.98.4 -- see
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-12577">HBASE-12577 Disable distributed log replay by default</link> for more).
- </para>
- </section>
- </section>
- <section xml:id="upgrade1.0.rolling.upgrade">
- <title>Rolling upgrade from 0.98.x to HBase 1.0.0</title>
- <note><title>From 0.96.x to 1.0.0</title>
- <para>You cannot do a <xlink href="rolling.upgrade" /> from 0.96.x to 1.0.0 without
- first doing a rolling upgrade to 0.98.x. See comment in
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-11164?focusedCommentId=14182330&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14182330">HBASE-11164 Document and test rolling updates from 0.98 -> 1.0</link> for the why.
- Also because hbase-1.0.0 enables hfilev3 by default,
- <link xlink:href="https://issues.apache.org/jira/browse/HBASE-9801">HBASE-9801 Change the default HFile version to V3</link>,
- and support for hfilev3 only arrives in 0.98, this is another reason you cannot rolling upgrade from hbase-0.96.x;
- if the rolling upgrade stalls, the 0.96.x servers cannot open files written by the servers running the newer hbase-1.0.0
- hfilev3 writing servers.
- </para>
- </note>
- <para>There are no known issues running a <xlink href="hbase.rolling.upgrade" /> from hbase-0.98.x to hbase-1.0.0.
-
- </para>
- </section>
- <section xml:id="upgrade1.0.from.0.94">
- <title>Upgrading to 1.0 from 0.94</title>
- <para>You cannot rolling upgrade from 0.94.x to 1.x.x. You must stop your cluster,
- install the 1.x.x software, run the migration described at <xref linkend="executing.the.0.96.upgrade" />
- (substituting 1.x.x. wherever we make mention of 0.96.x in the section below),
- and then restart. Be sure to upgrade your zookeeper if it is a version less than the required 3.4.x.
- </para>
-
- </section>
- </section>
-
- <section
- xml:id="upgrade0.98">
- <title>Upgrading from 0.96.x to 0.98.x</title>
- <para>A rolling upgrade from 0.96.x to 0.98.x works. The two versions are not binary
- compatible.</para>
- <para>Additional steps are required to take advantage of some of the new features of 0.98.x,
- including cell visibility labels, cell ACLs, and transparent server side encryption. See
- the <xref
- linkend="security" /> chapter of this guide for more information. Significant
- performance improvements include a change to the write ahead log threading model that
- provides higher transaction throughput under high load, reverse scanners, MapReduce over
- snapshot files, and striped compaction.</para>
- <para>Clients and servers can run with 0.98.x and 0.96.x versions. However, applications may
- need to be recompiled due to changes in the Java API.</para>
- </section>
- <section>
- <title>Upgrading from 0.94.x to 0.98.x</title>
- <para> A rolling upgrade from 0.94.x directly to 0.98.x does not work. The upgrade path
- follows the same procedures as <xref
- linkend="upgrade0.96" />. Additional steps are required to use some of the new
- features of 0.98.x. See <xref
- linkend="upgrade0.98" /> for an abbreviated list of these features. </para>
- </section>
- <section
- xml:id="upgrade0.96">
- <title>Upgrading from 0.94.x to 0.96.x</title>
- <subtitle>The "Singularity"</subtitle>
- <note><title>HBase 0.96.x was EOL'd, September 1st, 2014</title><para>
- Do not deploy 0.96.x Deploy a 0.98.x at least.
- See <link xlink:href="https://issues.apache.org/jira/browse/HBASE-11642">EOL 0.96</link>.
- </para></note>
-
- <para>You will have to stop your old 0.94.x cluster completely to upgrade. If you are
- replicating between clusters, both clusters will have to go down to upgrade. Make sure
- it is a clean shutdown. The less WAL files around, the faster the upgrade will run (the
- upgrade will split any log files it finds in the filesystem as part of the upgrade
- process). All clients must be upgraded to 0.96 too. </para>
- <para>The API has changed. You will need to recompile your code against 0.96 and you may
- need to adjust applications to go against new APIs (TODO: List of changes). </para>
- <section xml:id="executing.the.0.96.upgrade">
- <title>Executing the 0.96 Upgrade</title>
- <note>
- <title>HDFS and ZooKeeper must be up!</title>
- <para>HDFS and ZooKeeper should be up and running during the upgrade process.</para>
- </note>
- <para>hbase-0.96.0 comes with an upgrade script. Run
- <programlisting language="bourne">$ bin/hbase upgrade</programlisting> to see its usage. The script
- has two main modes: -check, and -execute. </para>
- <section>
- <title>check</title>
- <para>The <emphasis>check</emphasis> step is run against a running 0.94 cluster. Run
- it from a downloaded 0.96.x binary. The <emphasis>check</emphasis> step is
- looking for the presence of <filename>HFileV1</filename> files. These are
- unsupported in hbase-0.96.0. To purge them -- have them rewritten as HFileV2 --
- you must run a compaction. </para>
- <para>The <emphasis>check</emphasis> step prints stats at the end of its run (grep
- for “Result:” in the log) printing absolute path of the tables it scanned, any
- HFileV1 files found, the regions containing said files (the regions we need to
- major compact to purge the HFileV1s), and any corrupted files if any found. A
- corrupt file is unreadable, and so is undefined (neither HFileV1 nor HFileV2). </para>
- <para>To run the check step, run <command>$ bin/hbase upgrade -check</command>. Here
- is sample output:</para>
- <screen>
-Tables Processed:
-hdfs://localhost:41020/myHBase/.META.
-hdfs://localhost:41020/myHBase/usertable
-hdfs://localhost:41020/myHBase/TestTable
-hdfs://localhost:41020/myHBase/t
-
-Count of HFileV1: 2
-HFileV1:
-hdfs://localhost:41020/myHBase/usertable /fa02dac1f38d03577bd0f7e666f12812/family/249450144068442524
-hdfs://localhost:41020/myHBase/usertable /ecdd3eaee2d2fcf8184ac025555bb2af/family/249450144068442512
-
-Count of corrupted files: 1
-Corrupted Files:
-hdfs://localhost:41020/myHBase/usertable/fa02dac1f38d03577bd0f7e666f12812/family/1
-Count of Regions with HFileV1: 2
-Regions to Major Compact:
-hdfs://localhost:41020/myHBase/usertable/fa02dac1f38d03577bd0f7e666f12812
-hdfs://localhost:41020/myHBase/usertable/ecdd3eaee2d2fcf8184ac025555bb2af
-
-There are some HFileV1, or corrupt files (files with incorrect major version)
- </screen>
- <para>In the above sample output, there are two HFileV1 in two regions, and one
- corrupt file. Corrupt files should probably be removed. The regions that have
- HFileV1s need to be major compacted. To major compact, start up the hbase shell
- and review how to compact an individual region. After the major compaction is
- done, rerun the check step and the HFileV1s shoudl be gone, replaced by HFileV2
- instances. </para>
- <para>By default, the check step scans the hbase root directory (defined as
- hbase.rootdir in the configuration). To scan a specific directory only, pass the
- <emphasis>-dir</emphasis> option.</para>
- <screen language="bourne">$ bin/hbase upgrade -check -dir /myHBase/testTable</screen>
- <para>The above command would detect HFileV1s in the /myHBase/testTable directory. </para>
- <para> Once the check step reports all the HFileV1 files have been rewritten, it is
- safe to proceed with the upgrade. </para>
- </section>
- <section>
- <title>execute</title>
- <para>After the check step shows the cluster is free of HFileV1, it is safe to
- proceed with the upgrade. Next is the <emphasis>execute</emphasis> step. You
- must <emphasis>SHUTDOWN YOUR 0.94.x CLUSTER</emphasis> before you can run the
- <emphasis>execute</emphasis> step. The execute step will not run if it
- detects running HBase masters or regionservers. <note>
- <para>HDFS and ZooKeeper should be up and running during the upgrade
- process. If zookeeper is managed by HBase, then you can start zookeeper
- so it is available to the upgrade by running <command>$
- ./hbase/bin/hbase-daemon.sh start zookeeper</command>
- </para>
- </note>
- </para>
- <para> The <emphasis>execute</emphasis> upgrade step is made of three substeps. </para>
- <itemizedlist>
- <listitem>
- <para>Namespaces: HBase 0.96.0 has support for namespaces. The upgrade needs
- to reorder directories in the filesystem for namespaces to work.</para>
- </listitem>
- <listitem>
- <para>ZNodes: All znodes are purged so that new ones can be written in their
- place using a new protobuf'ed format and a few are migrated in place:
- e.g. replication and table state znodes</para>
- </listitem>
- <listitem>
- <para>WAL Log Splitting: If the 0.94.x cluster shutdown was not clean, we'll
- split WAL logs as part of migration before we startup on 0.96.0. This
- WAL splitting runs slower than the native distributed WAL splitting
- because it is all inside the single upgrade process (so try and get a
- clean shutdown of the 0.94.0 cluster if you can). </para>
- </listitem>
- </itemizedlist>
- <para> To run the <emphasis>execute</emphasis> step, make sure that first you have
- copied hbase-0.96.0 binaries everywhere under servers and under clients. Make
- sure the 0.94.0 cluster is down. Then do as follows:</para>
- <screen language="bourne">$ bin/hbase upgrade -execute</screen>
- <para>Here is some sample output.</para>
- <programlisting>
-Starting Namespace upgrade
-Created version file at hdfs://localhost:41020/myHBase with version=7
-Migrating table testTable to hdfs://localhost:41020/myHBase/.data/default/testTable
-…..
-Created version file at hdfs://localhost:41020/myHBase with version=8
-Successfully completed NameSpace upgrade.
-Starting Znode upgrade
-….
-Successfully completed Znode upgrade
-
-Starting Log splitting
-…
-Successfully completed Log splitting
- </programlisting>
- <para> If the output from the execute step looks good, stop the zookeeper instance
- you started to do the upgrade:
- <programlisting language="bourne">$ ./hbase/bin/hbase-daemon.sh stop zookeeper</programlisting>
- Now start up hbase-0.96.0. </para>
- </section>
- <section
- xml:id="s096.migration.troubleshooting">
- <title>Troubleshooting</title>
- <section
- xml:id="s096.migration.troubleshooting.old.client">
- <title>Old Client connecting to 0.96 cluster</title>
- <para>It will fail with an exception like the below. Upgrade.</para>
- <screen>17:22:15 Exception in thread "main" java.lang.IllegalArgumentException: Not a host:port pair: PBUF
-17:22:15 *
-17:22:15 api-compat-8.ent.cloudera.com �� ���(
-17:22:15 at org.apache.hadoop.hbase.util.Addressing.parseHostname(Addressing.java:60)
-17:22:15 at org.apache.hadoop.hbase.ServerName.&init>(ServerName.java:101)
-17:22:15 at org.apache.hadoop.hbase.ServerName.parseVersionedServerName(ServerName.java:283)
-17:22:15 at org.apache.hadoop.hbase.MasterAddressTracker.bytesToServerName(MasterAddressTracker.java:77)
-17:22:15 at org.apache.hadoop.hbase.MasterAddressTracker.getMasterAddress(MasterAddressTracker.java:61)
-17:22:15 at org.apache.hadoop.hbase.client.HConnectionManager$HConnectionImplementation.getMaster(HConnectionManager.java:703)
-17:22:15 at org.apache.hadoop.hbase.client.HBaseAdmin.&init>(HBaseAdmin.java:126)
-17:22:15 at Client_4_3_0.setup(Client_4_3_0.java:716)
-17:22:15 at Client_4_3_0.main(Client_4_3_0.java:63)</screen>
- </section>
- </section>
- <section>
- <title>Upgrading <code>META</code> to use Protocol Buffers (Protobuf)</title>
- <para>When you upgrade from versions prior to 0.96, <code>META</code> needs to be
- converted to use protocol buffers. This is controlled by the configuration
- option <option>hbase.MetaMigrationConvertingToPB</option>, which is set to
- <literal>true</literal> by default. Therefore, by default, no action is
- required on your part.</para>
- <para>The migration is a one-time event. However, every time your cluster starts,
- <code>META</code> is scanned to ensure that it does not need to be
- converted. If you have a very large number of regions, this scan can take a long
- time. Starting in 0.98.5, you can set
- <option>hbase.MetaMigrationConvertingToPB</option> to
- <literal>false</literal> in <filename>hbase-site.xml</filename>, to disable
- this start-up scan. This should be considered an expert-level setting.</para>
- </section>
- </section>
-
-
- </section>
-
- <section
- xml:id="upgrade0.94">
- <title>Upgrading from 0.92.x to 0.94.x</title>
- <para>We used to think that 0.92 and 0.94 were interface compatible and that you can do a
- rolling upgrade between these versions but then we figured that <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-5357">HBASE-5357 Use builder
- pattern in HColumnDescriptor</link> changed method signatures so rather than return
- void they instead return HColumnDescriptor. This will throw</para>
- <screen>java.lang.NoSuchMethodError: org.apache.hadoop.hbase.HColumnDescriptor.setMaxVersions(I)V</screen>
- <para>.... so 0.92 and 0.94 are NOT compatible. You cannot do a rolling upgrade between them.</para> </section>
- <section
- xml:id="upgrade0.92">
- <title>Upgrading from 0.90.x to 0.92.x</title>
- <subtitle>Upgrade Guide</subtitle>
- <para>You will find that 0.92.0 runs a little differently to 0.90.x releases. Here are a few
- things to watch out for upgrading from 0.90.x to 0.92.0. </para>
- <note>
- <title>tl;dr</title>
- <para> If you've not patience, here are the important things to know upgrading. <orderedlist>
- <listitem>
- <para>Once you upgrade, you can’t go back.</para>
- </listitem>
- <listitem>
- <para> MSLAB is on by default. Watch that heap usage if you have a lot of
- regions.</para>
- </listitem>
- <listitem>
- <para> Distributed Log Splitting is on by default. It should make region server
- failover faster. </para>
- </listitem>
- <listitem>
- <para> There’s a separate tarball for security. </para>
- </listitem>
- <listitem>
- <para> If -XX:MaxDirectMemorySize is set in your hbase-env.sh, it’s going to
- enable the experimental off-heap cache (You may not want this). </para>
- </listitem>
- </orderedlist>
- </para>
- </note>
-
- <section>
- <title>You can’t go back! </title>
- <para>To move to 0.92.0, all you need to do is shutdown your cluster, replace your hbase
- 0.90.x with hbase 0.92.0 binaries (be sure you clear out all 0.90.x instances) and
- restart (You cannot do a rolling restart from 0.90.x to 0.92.x -- you must restart).
- On startup, the <varname>.META.</varname> table content is rewritten removing the
- table schema from the <varname>info:regioninfo</varname> column. Also, any flushes
- done post first startup will write out data in the new 0.92.0 file format, <link
- xlink:href="http://hbase.apache.org/book.html#hfilev2">HFile V2</link>. This
- means you cannot go back to 0.90.x once you’ve started HBase 0.92.0 over your HBase
- data directory. </para>
- </section>
-
- <section>
- <title>MSLAB is ON by default </title>
- <para>In 0.92.0, the <link
- xlink:href="http://hbase.apache.org/book.html#hbase.hregion.memstore.mslab.enabled">hbase.hregion.memstore.mslab.enabled</link>
- flag is set to true (See <xref
- linkend="mslab" />). In 0.90.x it was <constant>false</constant>. When it is
- enabled, memstores will step allocate memory in MSLAB 2MB chunks even if the
- memstore has zero or just a few small elements. This is fine usually but if you had
- lots of regions per regionserver in a 0.90.x cluster (and MSLAB was off), you may
- find yourself OOME'ing on upgrade because the <code>thousands of regions * number of
- column families * 2MB MSLAB (at a minimum)</code> puts your heap over the top.
- Set <varname>hbase.hregion.memstore.mslab.enabled</varname> to
- <constant>false</constant> or set the MSLAB size down from 2MB by setting
- <varname>hbase.hregion.memstore.mslab.chunksize</varname> to something less.
- </para>
- </section>
-
- <section xml:id="dls">
- <title>Distributed Log Splitting is on by default </title>
- <para>Previous, WAL logs on crash were split by the Master alone. In 0.92.0, log
- splitting is done by the cluster (See See “HBASE-1364 [performance] Distributed
- splitting of regionserver commit logs” or see the blog post
- <link xlink:href="http://blog.cloudera.com/blog/2012/07/hbase-log-splitting/">Apache HBase Log Splitting</link>).
- This should cut down significantly on the
- amount of time it takes splitting logs and getting regions back online again.
- </para>
- </section>
-
- <section>
- <title>Memory accounting is different now </title>
- <para>In 0.92.0, <xref
- linkend="hfilev2" /> indices and bloom filters take up residence in the same LRU
- used caching blocks that come from the filesystem. In 0.90.x, the HFile v1 indices
- lived outside of the LRU so they took up space even if the index was on a ‘cold’
- file, one that wasn’t being actively used. With the indices now in the LRU, you may
- find you have less space for block caching. Adjust your block cache accordingly. See
- the <xref
- linkend="block.cache" /> for more detail. The block size default size has been
- changed in 0.92.0 from 0.2 (20 percent of heap) to 0.25. </para>
- </section>
-
-
- <section>
- <title>On the Hadoop version to use </title>
- <para>Run 0.92.0 on Hadoop 1.0.x (or CDH3u3 when it ships). The performance benefits are
- worth making the move. Otherwise, our Hadoop prescription is as it has been; you
- need an Hadoop that supports a working sync. See <xref
- linkend="hadoop" />. </para>
-
- <para>If running on Hadoop 1.0.x (or CDH3u3), enable local read. See <link
- xlink:href="http://files.meetup.com/1350427/hug_ebay_jdcryans.pdf">Practical
- Caching</link> presentation for ruminations on the performance benefits ‘going
- local’ (and for how to enable local reads). </para>
- </section>
- <section>
- <title>HBase 0.92.0 ships with ZooKeeper 3.4.2 </title>
- <para>If you can, upgrade your zookeeper. If you can’t, 3.4.2 clients should work
- against 3.3.X ensembles (HBase makes use of 3.4.2 API). </para>
- </section>
- <section>
- <title>Online alter is off by default </title>
- <para>In 0.92.0, we’ve added an experimental online schema alter facility (See <xref
- linkend="hbase.online.schema.update.enable" />). Its off by default. Enable it
- at your own risk. Online alter and splitting tables do not play well together so be
- sure your cluster quiescent using this feature (for now). </para>
- </section>
- <section>
- <title>WebUI </title>
- <para>The webui has had a few additions made in 0.92.0. It now shows a list of the
- regions currently transitioning, recent compactions/flushes, and a process list of
- running processes (usually empty if all is well and requests are being handled
- promptly). Other additions including requests by region, a debugging servlet dump,
- etc. </para>
- </section>
- <section>
- <title>Security tarball </title>
- <para>We now ship with two tarballs; secure and insecure HBase. Documentation on how to
- setup a secure HBase is on the way. </para>
- </section>
-
- <section>
- <title>Changes in HBase replication </title>
- <para>0.92.0 adds two new features: multi-slave and multi-master replication. The way to
- enable this is the same as adding a new peer, so in order to have multi-master you
- would just run add_peer for each cluster that acts as a master to the other slave
- clusters. Collisions are handled at the timestamp level which may or may not be what
- you want, this needs to be evaluated on a per use case basis. Replication is still
- experimental in 0.92 and is disabled by default, run it at your own risk. </para>
- </section>
-
-
- <section>
- <title>RegionServer now aborts if OOME </title>
- <para>If an OOME, we now have the JVM kill -9 the regionserver process so it goes down
- fast. Previous, a RegionServer might stick around after incurring an OOME limping
- along in some wounded state. To disable this facility, and recommend you leave it in
- place, you’d need to edit the bin/hbase file. Look for the addition of the
- -XX:OnOutOfMemoryError="kill -9 %p" arguments (See [HBASE-4769] - ‘Abort
- RegionServer Immediately on OOME’) </para>
- </section>
-
-
- <section>
- <title>HFile V2 and the “Bigger, Fewer” Tendency </title>
- <para>0.92.0 stores data in a new format, <xref
- linkend="hfilev2" />. As HBase runs, it will move all your data from HFile v1 to
- HFile v2 format. This auto-migration will run in the background as flushes and
- compactions run. HFile V2 allows HBase run with larger regions/files. In fact, we
- encourage that all HBasers going forward tend toward Facebook axiom #1, run with
- larger, fewer regions. If you have lots of regions now -- more than 100s per host --
- you should look into setting your region size up after you move to 0.92.0 (In
- 0.92.0, default size is now 1G, up from 256M), and then running online merge tool
- (See “HBASE-1621 merge tool should work on online cluster, but disabled table”).
- </para>
- </section>
- </section>
- <section
- xml:id="upgrade0.90">
- <title>Upgrading to HBase 0.90.x from 0.20.x or 0.89.x</title>
- <para>This version of 0.90.x HBase can be started on data written by HBase 0.20.x or HBase
- 0.89.x. There is no need of a migration step. HBase 0.89.x and 0.90.x does write out the
- name of region directories differently -- it names them with a md5 hash of the region
- name rather than a jenkins hash -- so this means that once started, there is no going
- back to HBase 0.20.x. </para>
- <para> Be sure to remove the <filename>hbase-default.xml</filename> from your
- <filename>conf</filename> directory on upgrade. A 0.20.x version of this file will
- have sub-optimal configurations for 0.90.x HBase. The
- <filename>hbase-default.xml</filename> file is now bundled into the HBase jar and
- read from there. If you would like to review the content of this file, see it in the src
- tree at <filename>src/main/resources/hbase-default.xml</filename> or see <xref
- linkend="hbase_default_configurations" />. </para>
- <para> Finally, if upgrading from 0.20.x, check your <varname>.META.</varname> schema in the
- shell. In the past we would recommend that users run with a 16kb
- <varname>MEMSTORE_FLUSHSIZE</varname>. Run <code>hbase> scan '-ROOT-'</code> in the
- shell. This will output the current <varname>.META.</varname> schema. Check
- <varname>MEMSTORE_FLUSHSIZE</varname> size. Is it 16kb (16384)? If so, you will need
- to change this (The 'normal'/default value is 64MB (67108864)). Run the script
- <filename>bin/set_meta_memstore_size.rb</filename>. This will make the necessary
- edit to your <varname>.META.</varname> schema. Failure to run this change will make for
- a slow cluster. See <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-3499">HBASE-3499
- Users upgrading to 0.90.0 need to have their .META. table updated with the
- right MEMSTORE_SIZE</link>
- </para>
- </section>
-</chapter>
[04/15] hbase git commit: HBASE-14066 clean out old docbook docs from
branch-1.
Posted by nd...@apache.org.
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/shell.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/shell.xml b/src/main/docbkx/shell.xml
deleted file mode 100644
index a400d8d..0000000
--- a/src/main/docbkx/shell.xml
+++ /dev/null
@@ -1,386 +0,0 @@
-<?xml version="1.0"?>
-<chapter
- xml:id="shell"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>The Apache HBase Shell</title>
-
- <para> The Apache HBase Shell is <link
- xlink:href="http://jruby.org">(J)Ruby</link>'s IRB with some HBase particular commands
- added. Anything you can do in IRB, you should be able to do in the HBase Shell.</para>
- <para>To run the HBase shell, do as follows:</para>
- <programlisting>$ ./bin/hbase shell</programlisting>
- <para>Type <command>help</command> and then <command><RETURN></command> to see a listing
- of shell commands and options. Browse at least the paragraphs at the end of the help
- emission for the gist of how variables and command arguments are entered into the HBase
- shell; in particular note how table names, rows, and columns, etc., must be quoted.</para>
- <para>See <xref
- linkend="shell_exercises" /> for example basic shell operation. </para>
- <para>Here is a nicely formatted listing of <link
- xlink:href="http://learnhbase.wordpress.com/2013/03/02/hbase-shell-commands/">all shell
- commands</link> by Rajeshbabu Chintaguntla. </para>
-
- <section
- xml:id="scripting">
- <title>Scripting with Ruby</title>
- <para>For examples scripting Apache HBase, look in the HBase <filename>bin</filename>
- directory. Look at the files that end in <filename>*.rb</filename>. To run one of these
- files, do as follows:</para>
- <programlisting>$ ./bin/hbase org.jruby.Main PATH_TO_SCRIPT</programlisting>
- </section>
-
- <section>
- <title>Running the Shell in Non-Interactive Mode</title>
- <para>A new non-interactive mode has been added to the HBase Shell (<link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-11658">HBASE-11658)</link>.
- Non-interactive mode captures the exit status (success or failure) of HBase Shell
- commands and passes that status back to the command interpreter. If you use the normal
- interactive mode, the HBase Shell will only ever return its own exit status, which will
- nearly always be <literal>0</literal> for success.</para>
- <para>To invoke non-interactive mode, pass the <option>-n</option> or
- <option>--non-interactive</option> option to HBase Shell.</para>
- </section>
-
- <section xml:id="hbase.shell.noninteractive">
- <title>HBase Shell in OS Scripts</title>
- <para>You can use the HBase shell from within operating system script interpreters like the
- Bash shell which is the default command interpreter for most Linux and UNIX
- distributions. The following guidelines use Bash syntax, but could be adjusted to work
- with C-style shells such as csh or tcsh, and could probably be modified to work with the
- Microsoft Windows script interpreter as well. Submissions are welcome.</para>
- <note>
- <para>Spawning HBase Shell commands in this way is slow, so keep that in mind when you
- are deciding when combining HBase operations with the operating system command line
- is appropriate.</para>
- </note>
- <example>
- <title>Passing Commands to the HBase Shell</title>
- <para>You can pass commands to the HBase Shell in non-interactive mode (see <xref
- linkend="hbasee.shell.noninteractive"/>) using the <command>echo</command>
- command and the <literal>|</literal> (pipe) operator. Be sure to escape characters
- in the HBase commands which would otherwise be interpreted by the shell. Some
- debug-level output has been truncated from the example below.</para>
- <screen>$ <userinput>echo "describe 'test1'" | ./hbase shell -n</userinput>
- <computeroutput>
-Version 0.98.3-hadoop2, rd5e65a9144e315bb0a964e7730871af32f5018d5, Sat May 31 19:56:09 PDT 2014
-
-describe 'test1'
-
-DESCRIPTION ENABLED
- 'test1', {NAME => 'cf', DATA_BLOCK_ENCODING => 'NON true
- E', BLOOMFILTER => 'ROW', REPLICATION_SCOPE => '0',
- VERSIONS => '1', COMPRESSION => 'NONE', MIN_VERSIO
- NS => '0', TTL => 'FOREVER', KEEP_DELETED_CELLS =>
- 'false', BLOCKSIZE => '65536', IN_MEMORY => 'false'
- , BLOCKCACHE => 'true'}
-1 row(s) in 3.2410 seconds
- </computeroutput>
- </screen>
- <para>To suppress all output, echo it to <filename>/dev/null:</filename></para>
- <screen>$ <userinput>echo "describe 'test'" | ./hbase shell -n > /dev/null 2>&1</userinput></screen>
- </example>
- <example>
- <title>Checking the Result of a Scripted Command</title>
- <para>Since scripts are not designed to be run interactively, you need a way to check
- whether your command failed or succeeded. The HBase shell uses the standard
- convention of returning a value of <literal>0</literal> for successful commands, and
- some non-zero value for failed commands. Bash stores a command's return value in a
- special environment variable called <varname>$?</varname>. Because that variable is
- overwritten each time the shell runs any command, you should store the result in a
- different, script-defined variable.</para>
- <para>This is a naive script that shows one way to store the return value and make a
- decision based upon it.</para>
- <programlisting language="bourne">
-#!/bin/bash
-
-echo "describe 'test'" | ./hbase shell -n > /dev/null 2>&1
-status=$?
-echo "The status was " $status
-if ($status == 0); then
- echo "The command succeeded"
-else
- echo "The command may have failed."
-fi
-return $status
- </programlisting>
- </example>
- <section>
- <title>Checking for Success or Failure In Scripts</title>
- <para>Getting an exit code of 0 means that the command you scripted definitely
- succeeded. However, getting a non-zero exit code does not necessarily mean the
- command failed. The command could have succeeded, but the client lost connectivity,
- or some other event obscured its success. This is because RPC commands are
- stateless. The only way to be sure of the status of an operation is to check. For
- instance, if your script creates a table, but returns a non-zero exit value, you
- should check whether the table was actually created before trying again to create
- it.</para>
- </section>
- </section>
-
- <section>
- <title>Read HBase Shell Commands from a Command File</title>
- <para>You can enter HBase Shell commands into a text file, one command per line, and pass
- that file to the HBase Shell.</para>
- <example>
- <title>Example Command File</title>
- <screen>
-create 'test', 'cf'
-list 'test'
-put 'test', 'row1', 'cf:a', 'value1'
-put 'test', 'row2', 'cf:b', 'value2'
-put 'test', 'row3', 'cf:c', 'value3'
-put 'test', 'row4', 'cf:d', 'value4'
-scan 'test'
-get 'test', 'row1'
-disable 'test'
-enable 'test'
- </screen>
- </example>
- <example>
- <title>Directing HBase Shell to Execute the Commands</title>
- <para>Pass the path to the command file as the only argument to the <command>hbase
- shell</command> command. Each command is executed and its output is shown. If
- you do not include the <command>exit</command> command in your script, you are
- returned to the HBase shell prompt. There is no way to programmatically check each
- individual command for success or failure. Also, though you see the output for each
- command, the commands themselves are not echoed to the screen so it can be difficult
- to line up the command with its output.</para>
- <screen>
-$ <userinput>./hbase shell ./sample_commands.txt</userinput>
-<computeroutput>0 row(s) in 3.4170 seconds
-
-TABLE
-test
-1 row(s) in 0.0590 seconds
-
-0 row(s) in 0.1540 seconds
-
-0 row(s) in 0.0080 seconds
-
-0 row(s) in 0.0060 seconds
-
-0 row(s) in 0.0060 seconds
-
-ROW COLUMN+CELL
- row1 column=cf:a, timestamp=1407130286968, value=value1
- row2 column=cf:b, timestamp=1407130286997, value=value2
- row3 column=cf:c, timestamp=1407130287007, value=value3
- row4 column=cf:d, timestamp=1407130287015, value=value4
-4 row(s) in 0.0420 seconds
-
-COLUMN CELL
- cf:a timestamp=1407130286968, value=value1
-1 row(s) in 0.0110 seconds
-
-0 row(s) in 1.5630 seconds
-
-0 row(s) in 0.4360 seconds</computeroutput>
- </screen>
- </example>
- </section>
- <section>
- <title>Passing VM Options to the Shell</title>
- <para>You can pass VM options to the HBase Shell using the <code>HBASE_SHELL_OPTS</code>
- environment variable. You can set this in your environment, for instance by editing
- <filename>~/.bashrc</filename>, or set it as part of the command to launch HBase
- Shell. The following example sets several garbage-collection-related variables, just for
- the lifetime of the VM running the HBase Shell. The command should be run all on a
- single line, but is broken by the <literal>\</literal> character, for
- readability.</para>
- <screen language="bourne">
-$ <userinput>HBASE_SHELL_OPTS="-verbose:gc -XX:+PrintGCApplicationStoppedTime -XX:+PrintGCDateStamps \
- -XX:+PrintGCDetails -Xloggc:$HBASE_HOME/logs/gc-hbase.log" ./bin/hbase shell</userinput>
- </screen>
- </section>
- <section
- xml:id="shell_tricks">
- <title>Shell Tricks</title>
- <section
- xml:id="table_variables">
- <title>Table variables</title>
-
- <para> HBase 0.95 adds shell commands that provide a jruby-style object-oriented
- references for tables. Previously all of the shell commands that act upon a table
- have a procedural style that always took the name of the table as an argument. HBase
- 0.95 introduces the ability to assign a table to a jruby variable. The table
- reference can be used to perform data read write operations such as puts, scans, and
- gets well as admin functionality such as disabling, dropping, describing tables. </para>
-
- <para> For example, previously you would always specify a table name:</para>
- <screen>
-hbase(main):000:0> create ‘t’, ‘f’
-0 row(s) in 1.0970 seconds
-hbase(main):001:0> put 't', 'rold', 'f', 'v'
-0 row(s) in 0.0080 seconds
-
-hbase(main):002:0> scan 't'
-ROW COLUMN+CELL
- rold column=f:, timestamp=1378473207660, value=v
-1 row(s) in 0.0130 seconds
-
-hbase(main):003:0> describe 't'
-DESCRIPTION ENABLED
- 't', {NAME => 'f', DATA_BLOCK_ENCODING => 'NONE', BLOOMFILTER => 'ROW', REPLICATION_ true
- SCOPE => '0', VERSIONS => '1', COMPRESSION => 'NONE', MIN_VERSIONS => '0', TTL => '2
- 147483647', KEEP_DELETED_CELLS => 'false', BLOCKSIZE => '65536', IN_MEMORY => 'false
- ', BLOCKCACHE => 'true'}
-1 row(s) in 1.4430 seconds
-
-hbase(main):004:0> disable 't'
-0 row(s) in 14.8700 seconds
-
-hbase(main):005:0> drop 't'
-0 row(s) in 23.1670 seconds
-
-hbase(main):006:0>
- </screen>
-
- <para> Now you can assign the table to a variable and use the results in jruby shell
- code.</para>
- <screen>
-hbase(main):007 > t = create 't', 'f'
-0 row(s) in 1.0970 seconds
-
-=> Hbase::Table - t
-hbase(main):008 > t.put 'r', 'f', 'v'
-0 row(s) in 0.0640 seconds
-hbase(main):009 > t.scan
-ROW COLUMN+CELL
- r column=f:, timestamp=1331865816290, value=v
-1 row(s) in 0.0110 seconds
-hbase(main):010:0> t.describe
-DESCRIPTION ENABLED
- 't', {NAME => 'f', DATA_BLOCK_ENCODING => 'NONE', BLOOMFILTER => 'ROW', REPLICATION_ true
- SCOPE => '0', VERSIONS => '1', COMPRESSION => 'NONE', MIN_VERSIONS => '0', TTL => '2
- 147483647', KEEP_DELETED_CELLS => 'false', BLOCKSIZE => '65536', IN_MEMORY => 'false
- ', BLOCKCACHE => 'true'}
-1 row(s) in 0.0210 seconds
-hbase(main):038:0> t.disable
-0 row(s) in 6.2350 seconds
-hbase(main):039:0> t.drop
-0 row(s) in 0.2340 seconds
- </screen>
-
- <para> If the table has already been created, you can assign a Table to a variable by
- using the get_table method:</para>
- <screen>
-hbase(main):011 > create 't','f'
-0 row(s) in 1.2500 seconds
-
-=> Hbase::Table - t
-hbase(main):012:0> tab = get_table 't'
-0 row(s) in 0.0010 seconds
-
-=> Hbase::Table - t
-hbase(main):013:0> tab.put ‘r1’ ,’f’, ‘v’
-0 row(s) in 0.0100 seconds
-hbase(main):014:0> tab.scan
-ROW COLUMN+CELL
- r1 column=f:, timestamp=1378473876949, value=v
-1 row(s) in 0.0240 seconds
-hbase(main):015:0>
- </screen>
-
- <para> The list functionality has also been extended so that it returns a list of table
- names as strings. You can then use jruby to script table operations based on these
- names. The list_snapshots command also acts similarly.</para>
- <screen>
-hbase(main):016 > tables = list(‘t.*’)
-TABLE
-t
-1 row(s) in 0.1040 seconds
-
-=> #<#<Class:0x7677ce29>:0x21d377a4>
-hbase(main):017:0> tables.map { |t| disable t ; drop t}
-0 row(s) in 2.2510 seconds
-
-=> [nil]
-hbase(main):018:0>
- </screen>
- </section>
-
- <section>
- <title><filename>irbrc</filename></title>
- <para>Create an <filename>.irbrc</filename> file for yourself in your home directory.
- Add customizations. A useful one is command history so commands are save across
- Shell invocations:</para>
- <screen>
-$ more .irbrc
-require 'irb/ext/save-history'
-IRB.conf[:SAVE_HISTORY] = 100
-IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.irb-save-history"</screen>
- <para>See the <application>ruby</application> documentation of
- <filename>.irbrc</filename> to learn about other possible configurations.
- </para>
- </section>
- <section>
- <title>LOG data to timestamp</title>
- <para> To convert the date '08/08/16 20:56:29' from an hbase log into a timestamp,
- do:</para>
- <screen>
-hbase(main):021:0> import java.text.SimpleDateFormat
-hbase(main):022:0> import java.text.ParsePosition
-hbase(main):023:0> SimpleDateFormat.new("yy/MM/dd HH:mm:ss").parse("08/08/16 20:56:29", ParsePosition.new(0)).getTime() => 1218920189000</screen>
- <para> To go the other direction:</para>
- <screen>
-hbase(main):021:0> import java.util.Date
-hbase(main):022:0> Date.new(1218920189000).toString() => "Sat Aug 16 20:56:29 UTC 2008"</screen>
- <para> To output in a format that is exactly like that of the HBase log format will take
- a little messing with <link
- xlink:href="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</link>.
- </para>
- </section>
- <section>
- <title>Debug</title>
- <section>
- <title>Shell debug switch</title>
- <para>You can set a debug switch in the shell to see more output -- e.g. more of the
- stack trace on exception -- when you run a command:</para>
- <programlisting>hbase> debug <RETURN></programlisting>
- </section>
- <section>
- <title>DEBUG log level</title>
- <para>To enable DEBUG level logging in the shell, launch it with the
- <command>-d</command> option.</para>
- <programlisting>$ ./bin/hbase shell -d</programlisting>
- </section>
- </section>
- <section>
- <title>Commands</title>
- <section>
- <title>count</title>
- <para>Count command returns the number of rows in a table. It's quite fast when
- configured with the right CACHE
- <programlisting>hbase> count '<tablename>', CACHE => 1000</programlisting>
- The above count fetches 1000 rows at a time. Set CACHE lower if your rows are
- big. Default is to fetch one row at a time. </para>
- </section>
- </section>
-
- </section>
-</chapter>
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/thrift_filter_language.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/thrift_filter_language.xml b/src/main/docbkx/thrift_filter_language.xml
deleted file mode 100644
index 74da600..0000000
--- a/src/main/docbkx/thrift_filter_language.xml
+++ /dev/null
@@ -1,757 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter version="5.0" xml:id="thrift"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
-<!--
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
-
- <title>Thrift API and Filter Language</title>
- <para>Apache <link xlink:href="http://thrift.apache.org/">Thrift</link> is a cross-platform,
- cross-language development framework. HBase includes a Thrift API and filter language. The
- Thrift API relies on client and server processes. Documentation about the HBase Thrift API
- is located at <link xlink:href="http://wiki.apache.org/hadoop/Hbase/ThriftApi"/>. </para>
- <para>You can configure Thrift for secure authentication at the server and client side, by
- following the procedures in <xref linkend="security.client.thrift"/> and <xref
- linkend="security.gateway.thrift"/>. </para>
- <para>The rest of this chapter discusses the filter language provided by the Thrift API.</para>
- <section
- xml:id="thrift.filter-language">
- <title>Filter Language</title>
- <para
- xml:id="use-case">Thrift Filter Language was introduced in APache HBase 0.92. It allows
- you to perform server-side filtering when accessing HBase over Thrift or in the HBase
- shell. You can find out more about shell integration by using the <code>scan help</code>
- command in the shell.</para>
- <para>You specify a filter as a string, which is parsed on the server to construct the
- filter.</para>
-
- <section
- xml:id="general-syntax">
- <title>General Filter String Syntax</title>
- <para>A simple filter expression is expressed as a string:</para>
- <screen>“FilterName (argument, argument,... , argument)”</screen>
- <para>Keep the following syntax guidelines in mind.</para>
- <itemizedlist>
- <listitem>
- <para>Specify the name of the filter followed by the comma-separated argument
- list in parentheses.</para>
- </listitem>
- <listitem>
- <para>If the argument represents a string, it should be enclosed in single
- quotes (<literal>'</literal>).</para>
- </listitem>
- <listitem>
- <para>Arguments which represent a boolean, an integer, or a comparison operator
- (such as <, >, or !=), should not be enclosed in quotes</para>
- </listitem>
- <listitem>
- <para>The filter name must be a single word. All ASCII characters are allowed
- except for whitespace, single quotes and parentheses.</para>
- </listitem>
- <listitem>
- <para>The filter’s arguments can contain any ASCII character. If single quotes
- are present in the argument, they must be escaped by an additional preceding
- single quote.</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section
- xml:id="compound-filters-and-operators">
- <title>Compound Filters and Operators</title>
- <variablelist>
- <title>Binary Operators</title>
- <varlistentry>
- <term><code>AND</code></term>
- <listitem><para>If the <code>AND</code> operator is used, the key-vallue
- must satisfy both the filters.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><code>OR</code></term>
- <listitem><para>If the <code>OR</code> operator is used, the key-value
- must satisfy at least one of the filters.</para></listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <title>Unary Operators</title>
- <varlistentry>
- <term><code>SKIP</code></term>
- <listitem><para>For a particular row, if any of the key-values fail the
- filter condition, the entire row is skipped.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><code>WHILE</code></term>
- <listitem><para>For a particular row, key-values will be emitted until a
- key-value is reached t hat fails the filter condition.</para></listitem>
- </varlistentry>
- </variablelist>
-
- <example>
- <title>Compound Operators</title>
- <para>You can combine multiple operators to create a hierarchy of filters, such as
- the following example:</para>
- <programlisting>(Filter1 AND Filter2) OR (Filter3 AND Filter4)</programlisting>
- </example>
- </section>
-
- <section
- xml:id="order-of-evaluation">
- <title>Order of Evaluation</title>
- <orderedlist>
- <listitem><para>Parentheses have the highest precedence.</para></listitem>
- <listitem><para>The unary operators <code>SKIP</code> and <code>WHILE</code> are next, and have the same
- precedence.</para></listitem>
- <listitem><para>The binary operators follow. <code>AND</code> has highest
- precedence, followed by <code>OR</code>.</para></listitem>
- </orderedlist>
- <example>
- <title>Precedence Example</title>
- <programlisting><userinput>Filter1 AND Filter2 OR Filter</userinput>
-is evaluated as
-<userinput>(Filter1 AND Filter2) OR Filter3</userinput></programlisting>
- <programlisting><userinput>Filter1 AND SKIP Filter2 OR Filter3</userinput>
-is evaluated as
-<userinput>(Filter1 AND (SKIP Filter2)) OR Filter3</userinput></programlisting>
-
- </example>
- <para>You can use parentheses to explicitly control the order of evaluation.</para>
- </section>
-
- <section
- xml:id="compare-operator">
- <title>Compare Operator</title>
- <para>The following compare operators are provided:</para>
- <orderedlist>
- <listitem>
- <para>LESS (<)</para>
- </listitem>
- <listitem>
- <para>LESS_OR_EQUAL (<=)</para>
- </listitem>
- <listitem>
- <para>EQUAL (=)</para>
- </listitem>
- <listitem>
- <para>NOT_EQUAL (!=)</para>
- </listitem>
- <listitem>
- <para>GREATER_OR_EQUAL (>=)</para>
- </listitem>
- <listitem>
- <para>GREATER (>)</para>
- </listitem>
- <listitem>
- <para>NO_OP (no operation)</para>
- </listitem>
- </orderedlist>
- <para>The client should use the symbols (<, <=, =, !=, >, >=) to express compare
- operators.</para>
- </section>
-
- <section
- xml:id="comparator">
- <title>Comparator</title>
- <para>A comparator can be any of the following:</para>
- <orderedlist>
- <listitem>
- <para><emphasis
- role="bold">BinaryComparator</emphasis> - This lexicographically
- compares against the specified byte array using Bytes.compareTo(byte[],
- byte[])</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">BinaryPrefixComparator</emphasis> - This lexicographically
- compares against a specified byte array. It only compares up to the length
- of this byte array.</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">RegexStringComparator</emphasis> - This compares against the
- specified byte array using the given regular expression. Only EQUAL and
- NOT_EQUAL comparisons are valid with this comparator</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">SubStringComparator</emphasis> - This tests if the given
- substring appears in a specified byte array. The comparison is case
- insensitive. Only EQUAL and NOT_EQUAL comparisons are valid with this
- comparator</para>
- </listitem>
- </orderedlist>
- <para>The general syntax of a comparator is:<code>
- ComparatorType:ComparatorValue</code></para>
- <para>The ComparatorType for the various comparators is as follows:</para>
- <orderedlist>
- <listitem>
- <para><emphasis
- role="bold">BinaryComparator</emphasis> - binary</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">BinaryPrefixComparator</emphasis> - binaryprefix</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">RegexStringComparator</emphasis> - regexstring</para>
- </listitem>
- <listitem>
- <para><emphasis
- role="bold">SubStringComparator</emphasis> - substring</para>
- </listitem>
- </orderedlist>
- <para>The ComparatorValue can be any value.</para>
- <example>
- <title>Example 1</title>
- <para><code> >, 'binary:abc' </code>will match everything that is
- lexicographically greater than "abc" </para>
- </example>
- <example>
- <title>Example 2</title>
- <para><code> =, 'binaryprefix:abc' </code>will match everything whose first 3
- characters are lexicographically equal to "abc"</para>
- </example>
- <example>
- <title>Example 3</title>
- <para><code> !=, 'regexstring:ab*yz' </code>will match everything that doesn't
- begin with "ab" and ends with "yz"</para>
- </example>
- <example>
- <title>Example 4</title>
- <para><code> =, 'substring:abc123' </code>will match everything that begins
- with the substring "abc123"</para>
- </example>
- </section>
-
- <section
- xml:id="examplePHPClientProgram">
- <title>Example PHP Client Program that uses the Filter Language</title>
- <programlisting language="PHP" role="PHP"><![CDATA[
-<? $_SERVER['PHP_ROOT'] = realpath(dirname(__FILE__).'/..');
- require_once $_SERVER['PHP_ROOT'].'/flib/__flib.php';
- flib_init(FLIB_CONTEXT_SCRIPT);
- require_module('storage/hbase');
- $hbase = new HBase('<server_name_running_thrift_server>', <port on which thrift server is running>);
- $hbase->open();
- $client = $hbase->getClient();
- $result = $client->scannerOpenWithFilterString('table_name', "(PrefixFilter ('row2') AND (QualifierFilter (>=, 'binary:xyz'))) AND (TimestampsFilter ( 123, 456))");
- $to_print = $client->scannerGetList($result,1);
- while ($to_print) {
- print_r($to_print);
- $to_print = $client->scannerGetList($result,1);
- }
- $client->scannerClose($result);
-?>
- ]]></programlisting>
- </section>
-
- <section
- xml:id="example-filter-strings">
- <title>Example Filter Strings</title>
- <para>
- <itemizedlist>
- <listitem>
- <para><code>“PrefixFilter (‘Row’) AND PageFilter (1) AND FirstKeyOnlyFilter
- ()”</code> will return all key-value pairs that match the following
- conditions:</para>
- <orderedlist>
- <listitem>
- <para>The row containing the key-value should have prefix “Row”
- </para>
- </listitem>
- <listitem>
- <para>The key-value must be located in the first row of the table
- </para>
- </listitem>
- <listitem>
- <para>The key-value pair must be the first key-value in the row
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- </itemizedlist>
- </para>
-
- <orderedlist>
- <listitem>
- <itemizedlist>
- <listitem>
- <para><code>“(RowFilter (=, ‘binary:Row 1’) AND TimeStampsFilter (74689,
- 89734)) OR ColumnRangeFilter (‘abc’, true, ‘xyz’,
- false))”</code> will return all key-value pairs that match both
- the following conditions:</para>
- <itemizedlist>
- <listitem>
- <para>The key-value is in a row having row key “Row 1” </para>
- </listitem>
- <listitem>
- <para>The key-value must have a timestamp of either 74689 or
- 89734.</para>
- </listitem>
- <listitem>
- <para>Or it must match the following condition:</para>
- <itemizedlist>
- <listitem>
- <para>The key-value pair must be in a column that is
- lexicographically >= abc and < xyz </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
-
- <para>
- <itemizedlist>
- <listitem>
- <para><code>“SKIP ValueFilter (0)”</code> will skip the entire row if any of
- the values in the row is not 0</para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section
- xml:id="IndividualFilterSyntax">
- <title>Individual Filter Syntax</title>
- <variablelist>
- <varlistentry>
- <term>KeyOnlyFilter</term>
- <listitem>
- <para>This filter doesn’t take any arguments. It returns only the key
- component of each key-value.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">KeyOnlyFilter ()</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">KeyOnlyFilter ()"</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>FirstKeyOnlyFilter</term>
- <listitem>
- <para>This filter doesn’t take any arguments. It returns only the first
- key-value from each row.</para>
-
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">FirstKeyOnlyFilter ()</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">FirstKeyOnlyFilter ()</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>PrefixFilter</term>
- <listitem>
- <para>This filter takes one argument – a prefix of a row key. It returns
- only those key-values present in a row that starts with the specified
- row prefix</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">PrefixFilter (‘<row_prefix>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">PrefixFilter (‘Row’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ColumnPrefixFilter</term>
- <listitem>
- <para>This filter takes one argument – a column prefix. It returns only
- those key-values present in a column that starts with the specified
- column prefix. The column prefix must be of the form:
- <code>“qualifier”</code>.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">ColumnPrefixFilter(‘<column_prefix>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">ColumnPrefixFilter(‘Col’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>MultipleColumnPrefixFilter</term>
- <listitem>
- <para>This filter takes a list of column prefixes. It returns key-values
- that are present in a column that starts with any of the specified
- column prefixes. Each of the column prefixes must be of the form:
- <code>“qualifier”</code>.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">MultipleColumnPrefixFilter(‘<column_prefix>’, ‘<column_prefix>’, …, ‘<column_prefix>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">MultipleColumnPrefixFilter(‘Col1’, ‘Col2’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ColumnCountGetFilter</term>
- <listitem>
- <para>This filter takes one argument – a limit. It returns the first limit
- number of columns in the table.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">ColumnCountGetFilter
- (‘<limit>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">ColumnCountGetFilter (4)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>PageFilter</term>
- <listitem>
- <para>This filter takes one argument – a page size. It returns page size
- number of rows from the table.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">PageFilter (‘<page_size>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">PageFilter (2)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ColumnPaginationFilter</term>
- <listitem>
- <para>This filter takes two arguments – a limit and offset. It returns limit
- number of columns after offset number of columns. It does this for all
- the rows.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">ColumnPaginationFilter(‘<limit>’, ‘<offset>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">ColumnPaginationFilter (3, 5)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>InclusiveStopFilter</term>
- <listitem>
- <para>This filter takes one argument – a row key on which to stop scanning.
- It returns all key-values present in rows up to and including the
- specified row.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">InclusiveStopFilter(‘<stop_row_key>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">InclusiveStopFilter ('Row2')</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>TimeStampsFilter</term>
- <listitem>
- <para>This filter takes a list of timestamps. It returns those key-values
- whose timestamps matches any of the specified timestamps.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">TimeStampsFilter (<timestamp>, <timestamp>, ... ,<timestamp>)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">TimeStampsFilter (5985489, 48895495, 58489845945)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>RowFilter</term>
- <listitem>
- <para>This filter takes a compare operator and a comparator. It compares
- each row key with the comparator using the compare operator and if the
- comparison returns true, it returns all the key-values in that
- row.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">RowFilter (<compareOp>, ‘<row_comparator>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">RowFilter (<=, ‘xyz)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Family Filter</term>
- <listitem>
- <para>This filter takes a compare operator and a comparator. It compares
- each qualifier name with the comparator using the compare operator and
- if the comparison returns true, it returns all the key-values in that
- column.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">QualifierFilter (<compareOp>, ‘<qualifier_comparator>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">QualifierFilter (=, ‘Column1’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>QualifierFilter</term>
- <listitem>
- <para>This filter takes a compare operator and a comparator. It compares
- each qualifier name with the comparator using the compare operator and
- if the comparison returns true, it returns all the key-values in that
- column.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">QualifierFilter (<compareOp>,‘<qualifier_comparator>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">QualifierFilter (=,‘Column1’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ValueFilter</term>
- <listitem>
- <para>This filter takes a compare operator and a comparator. It compares
- each value with the comparator using the compare operator and if the
- comparison returns true, it returns that key-value.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">ValueFilter (<compareOp>,‘<value_comparator>’) </programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">ValueFilter (!=, ‘Value’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>DependentColumnFilter</term>
- <listitem>
- <para>This filter takes two arguments – a family and a qualifier. It tries
- to locate this column in each row and returns all key-values in that row
- that have the same timestamp. If the row doesn’t contain the specified
- column – none of the key-values in that row will be returned.</para>
- <para>The filter can also take an optional boolean argument –
- dropDependentColumn. If set to true, the column we were depending on
- doesn’t get returned.</para>
- <para>The filter can also take two more additional optional arguments – a
- compare operator and a value comparator, which are further checks in
- addition to the family and qualifier. If the dependent column is found,
- its value should also pass the value check and then only is its
- timestamp taken into consideration.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java"><![CDATA[DependentColumnFilter (‘<family>’,‘<qualifier>’, <boolean>, <compare operator>, ‘<value
- comparator’)]]></programlisting>
- </listitem>
- <listitem>
- <programlisting language="java"><![CDATA[DependentColumnFilter (‘<family>’,‘<qualifier>’, <boolean>)]]></programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">DependentColumnFilter (‘<family>’,‘<qualifier>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">DependentColumnFilter (‘conf’, ‘blacklist’, false, >=, ‘zebra’)</programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">DependentColumnFilter (‘conf’, 'blacklist', true)</programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">DependentColumnFilter (‘conf’, 'blacklist')</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SingleColumnValueFilter</term>
- <listitem>
- <para>This filter takes a column family, a qualifier, a compare operator and
- a comparator. If the specified column is not found – all the columns of
- that row will be emitted. If the column is found and the comparison with
- the comparator returns true, all the columns of the row will be emitted.
- If the condition fails, the row will not be emitted. </para>
- <para>This filter also takes two additional optional boolean arguments –
- filterIfColumnMissing and setLatestVersionOnly</para>
- <para>If the filterIfColumnMissing flag is set to true the columns of the
- row will not be emitted if the specified column to check is not found in
- the row. The default value is false.</para>
- <para>If the setLatestVersionOnly flag is set to false, it will test
- previous versions (timestamps) too. The default value is true.</para>
- <para>These flags are optional and if you must set neither or both.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">SingleColumnValueFilter(‘<family>’,‘<qualifier>’, <compare operator>, ‘<comparator>’, <filterIfColumnMissing_boolean>, <latest_version_boolean>)</programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">SingleColumnValueFilter(‘<family>’, ‘<qualifier>, <compare operator>, ‘<comparator>’)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">SingleColumnValueFilter (‘FamilyA’, ‘Column1’, <=, ‘abc’, true, false)</programlisting>
- </listitem>
- <listitem>
- <programlisting>SingleColumnValueFilter (‘FamilyA’, ‘Column1’, <=, ‘abc’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SingleColumnValueExcludeFilter</term>
- <listitem>
- <para>This filter takes the same arguments and behaves same as
- SingleColumnValueFilter – however, if the column is found and the
- condition passes, all the columns of the row will be emitted except for
- the tested column value.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">SingleColumnValueExcludeFilter('<family>', '<qualifier>', <compare operator>, '<comparator>', <latest_version_boolean>, <filterIfColumnMissing_boolean>)</programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">SingleColumnValueExcludeFilter('<family>', '<qualifier>', <compare operator>, '<comparator>')</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">SingleColumnValueExcludeFilter (‘FamilyA’, ‘Column1’, ‘<=’, ‘abc’, ‘false’, ‘true’)</programlisting>
- </listitem>
- <listitem>
- <programlisting language="java">SingleColumnValueExcludeFilter (‘FamilyA’, ‘Column1’, ‘<=’, ‘abc’)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ColumnRangeFilter</term>
- <listitem>
- <para>This filter is used for selecting only those keys with columns that
- are between minColumn and maxColumn. It also takes two boolean variables
- to indicate whether to include the minColumn and maxColumn or
- not.</para>
- <para>If you don’t want to set the minColumn or the maxColumn – you can pass
- in an empty argument.</para>
- <itemizedlist>
- <title>Syntax</title>
- <listitem>
- <programlisting language="java">ColumnRangeFilter (‘<minColumn>’, <minColumnInclusive_bool>, ‘<maxColumn>’, <maxColumnInclusive_bool>)</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <title>Example</title>
- <listitem>
- <programlisting language="java">ColumnRangeFilter (‘abc’, true, ‘xyz’, false)</programlisting>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
- </section>
-</chapter>
-
http://git-wip-us.apache.org/repos/asf/hbase/blob/0acbff24/src/main/docbkx/tracing.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/tracing.xml b/src/main/docbkx/tracing.xml
deleted file mode 100644
index b5dfd35..0000000
--- a/src/main/docbkx/tracing.xml
+++ /dev/null
@@ -1,187 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix
- xml:id="tracing"
- version="5.0"
- xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns:m="http://www.w3.org/1998/Math/MathML"
- xmlns:html="http://www.w3.org/1999/xhtml"
- xmlns:db="http://docbook.org/ns/docbook">
- <!--/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
--->
- <title>Enabling Dapper-like Tracing in HBase</title>
-
- <para>
- <link
- xlink:href="https://issues.apache.org/jira/browse/HBASE-6449">HBASE-6449</link> added support
- for tracing requests through HBase, using the open source tracing library, <link
- xlink:href="http://github.com/cloudera/htrace">HTrace</link>. Setting up tracing is quite
- simple, however it currently requires some very minor changes to your client code (it would not
- be very difficult to remove this requirement). </para>
-
- <section
- xml:id="tracing.spanreceivers">
- <title>SpanReceivers</title>
- <para> The tracing system works by collecting information in structs called 'Spans'. It is up to
- you to choose how you want to receive this information by implementing the
- <classname>SpanReceiver</classname> interface, which defines one method: </para>
- <programlisting><![CDATA[
-public void receiveSpan(Span span);
-]]></programlisting>
- <para>This method serves as a callback whenever a span is completed. HTrace allows you to use as
- many SpanReceivers as you want so you can easily send trace information to multiple
- destinations. </para>
-
- <para> Configure what SpanReceivers you'd like to us by putting a comma separated list of the
- fully-qualified class name of classes implementing <classname>SpanReceiver</classname> in
- <filename>hbase-site.xml</filename> property:
- <varname>hbase.trace.spanreceiver.classes</varname>. </para>
-
- <para> HTrace includes a <classname>LocalFileSpanReceiver</classname> that writes all span
- information to local files in a JSON-based format. The
- <classname>LocalFileSpanReceiver</classname> looks in <filename>hbase-site.xml</filename>
- for a <varname>hbase.local-file-span-receiver.path</varname> property with a value describing
- the name of the file to which nodes should write their span information. </para>
- <programlisting><![CDATA[
-<property>
- <name>hbase.trace.spanreceiver.classes</name>
- <value>org.htrace.impl.LocalFileSpanReceiver</value>
-</property>
-<property>
- <name>hbase.local-file-span-receiver.path</name>
- <value>/var/log/hbase/htrace.out</value>
-</property>
-]]></programlisting>
-
- <para> HTrace also provides <classname>ZipkinSpanReceiver</classname> which converts spans to <link
- xlink:href="http://github.com/twitter/zipkin">Zipkin</link> span format and send them to
- Zipkin server. In order to use this span receiver, you need to install the jar of
- htrace-zipkin to your HBase's classpath on all of the nodes in your cluster. </para>
- <para>
- <filename>htrace-zipkin</filename> is published to the maven central repository. You could get
- the latest version from there or just build it locally and then copy it out to all nodes,
- change your config to use zipkin receiver, distribute the new configuration and then (rolling)
- restart. </para>
- <para> Here is the example of manual setup procedure. </para>
- <screen language="bourne"><![CDATA[
-$ git clone https://github.com/cloudera/htrace
-$ cd htrace/htrace-zipkin
-$ mvn compile assembly:single
-$ cp target/htrace-zipkin-*-jar-with-dependencies.jar $HBASE_HOME/lib/
- # copy jar to all nodes...
-]]></screen>
- <para>The <classname>ZipkinSpanReceiver</classname> looks in <filename>hbase-site.xml</filename>
- for a <varname>hbase.zipkin.collector-hostname</varname> and
- <varname>hbase.zipkin.collector-port</varname> property with a value describing the Zipkin
- collector server to which span information are sent. </para>
- <programlisting language="xml"><![CDATA[
-<property>
- <name>hbase.trace.spanreceiver.classes</name>
- <value>org.htrace.impl.ZipkinSpanReceiver</value>
-</property>
-<property>
- <name>hbase.zipkin.collector-hostname</name>
- <value>localhost</value>
-</property>
-<property>
- <name>hbase.zipkin.collector-port</name>
- <value>9410</value>
-</property>
-]]></programlisting>
-
- <para> If you do not want to use the included span receivers, you are encouraged to write your
- own receiver (take a look at <classname>LocalFileSpanReceiver</classname> for an example). If
- you think others would benefit from your receiver, file a JIRA or send a pull request to <link
- xlink:href="http://github.com/cloudera/htrace">HTrace</link>. </para>
- </section>
-
- <section
- xml:id="tracing.client.modifications">
- <title>Client Modifications</title>
- <para> In order to turn on tracing in your client code, you must initialize the module sending
- spans to receiver once per client process. </para>
- <programlisting language="java"><![CDATA[
-private SpanReceiverHost spanReceiverHost;
-
-...
-
- Configuration conf = HBaseConfiguration.create();
- SpanReceiverHost spanReceiverHost = SpanReceiverHost.getInstance(conf);
-]]></programlisting>
- <para>Then you simply start tracing span before requests you think are interesting, and close it
- when the request is done. For example, if you wanted to trace all of your get operations, you
- change this: </para>
- <programlisting language="java"><![CDATA[
-HTable table = new HTable(conf, "t1");
-Get get = new Get(Bytes.toBytes("r1"));
-Result res = table.get(get);
-]]></programlisting>
- <para>into: </para>
- <programlisting language="java"><![CDATA[
-TraceScope ts = Trace.startSpan("Gets", Sampler.ALWAYS);
-try {
- HTable table = new HTable(conf, "t1");
- Get get = new Get(Bytes.toBytes("r1"));
- Result res = table.get(get);
-} finally {
- ts.close();
-}
-]]></programlisting>
- <para>If you wanted to trace half of your 'get' operations, you would pass in: </para>
- <programlisting language="java"><![CDATA[
-new ProbabilitySampler(0.5)
-]]></programlisting>
- <para>in lieu of <varname>Sampler.ALWAYS</varname> to <classname>Trace.startSpan()</classname>.
- See the HTrace <filename>README</filename> for more information on Samplers. </para>
- </section>
-
- <section
- xml:id="tracing.client.shell">
- <title>Tracing from HBase Shell</title>
- <para> You can use <command>trace</command> command for tracing requests from HBase Shell.
- <command>trace 'start'</command> command turns on tracing and <command>trace
- 'stop'</command> command turns off tracing. </para>
- <programlisting><![CDATA[
-hbase(main):001:0> trace 'start'
-hbase(main):002:0> put 'test', 'row1', 'f:', 'val1' # traced commands
-hbase(main):003:0> trace 'stop'
-]]></programlisting>
- <para>
- <command>trace 'start'</command> and <command>trace 'stop'</command> always returns boolean
- value representing if or not there is ongoing tracing. As a result, <command>trace
- 'stop'</command> returns false on suceess. <command>trace 'status'</command> just returns if
- or not tracing is turned on. </para>
- <programlisting><![CDATA[
-hbase(main):001:0> trace 'start'
-=> true
-
-hbase(main):002:0> trace 'status'
-=> true
-
-hbase(main):003:0> trace 'stop'
-=> false
-
-hbase(main):004:0> trace 'status'
-=> false
-]]></programlisting>
- </section>
-
-</appendix>