HBASE-26304 Reflect out of band locality improvements in metrics and balancer (#3803)
[hbase.git] / hbase-common / src / main / resources / hbase-default.xml
blobd14792e78bb9435fecf7a453693a9f70dbb95a21
1 <?xml version="1.0"?>
2 <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
3 <!--
4 /**
5  * Licensed to the Apache Software Foundation (ASF) under one
6  * or more contributor license agreements.  See the NOTICE file
7  * distributed with this work for additional information
8  * regarding copyright ownership.  The ASF licenses this file
9  * to you under the Apache License, Version 2.0 (the
10  * "License"); you may not use this file except in compliance
11  * with the License.  You may obtain a copy of the License at
12  *
13  *     http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  */
21 -->
23 <!--
24 OVERVIEW
26 The important configs. are listed near the top.  You should change
27 at least the setting for hbase.tmp.dir.  Other settings will change
28 dependent on whether you are running hbase in standalone mode or
29 distributed.  See the hbase reference guide for requirements and
30 guidance making configuration.
32 This file does not contain all possible configurations.  The file would be
33 much larger if it carried everything. The absent configurations will only be
34 found through source code reading.  The idea is that such configurations are
35 exotic and only those who would go to the trouble of reading a particular
36 section in the code would be knowledgeable or invested enough in ever wanting
37 to alter such configurations, so we do not list them here.  Listing all
38 possible configurations would overwhelm and obscure the important.
39 -->
41 <configuration>
42   <!--Configs you will likely change are listed here at the top of the file.
43   -->
44   <property >
45     <name>hbase.tmp.dir</name>
46     <value>${java.io.tmpdir}/hbase-${user.name}</value>
47     <description>Temporary directory on the local filesystem.
48     Change this setting to point to a location more permanent
49     than '/tmp', the usual resolve for java.io.tmpdir, as the
50     '/tmp' directory is cleared on machine restart.</description>
51   </property>
52   <property >
53     <name>hbase.rootdir</name>
54     <value>${hbase.tmp.dir}/hbase</value>
55     <description>The directory shared by region servers and into
56     which HBase persists.  The URL should be 'fully-qualified'
57     to include the filesystem scheme.  For example, to specify the
58     HDFS directory '/hbase' where the HDFS instance's namenode is
59     running at namenode.example.org on port 9000, set this value to:
60     hdfs://namenode.example.org:9000/hbase.  By default, we write
61     to whatever ${hbase.tmp.dir} is set too -- usually /tmp --
62     so change this configuration or else all data will be lost on
63     machine restart.</description>
64   </property>
65   <property >
66     <name>hbase.cluster.distributed</name>
67     <value>false</value>
68     <description>The mode the cluster will be in. Possible values are
69       false for standalone mode and true for distributed mode.  If
70       false, startup will run all HBase and ZooKeeper daemons together
71       in the one JVM.</description>
72   </property>
73   <property>
74     <name>hbase.zookeeper.quorum</name>
75     <!--Ideally we should be using a hostname here instead of IP address. Please refer to
76     https://issues.apache.org/jira/browse/HBASE-23764 for why we switched to IP address. Should be
77     changed once we fix the underlying ZK issue.-->
78     <value>127.0.0.1</value>
79     <description>Comma separated list of servers in the ZooKeeper ensemble
80     (This config. should have been named hbase.zookeeper.ensemble).
81     For example, "host1.mydomain.com,host2.mydomain.com,host3.mydomain.com".
82     By default this is set to localhost for local and pseudo-distributed modes
83     of operation. For a fully-distributed setup, this should be set to a full
84     list of ZooKeeper ensemble servers. If HBASE_MANAGES_ZK is set in hbase-env.sh
85     this is the list of servers which hbase will start/stop ZooKeeper on as
86     part of cluster start/stop.  Client-side, we will take this list of
87     ensemble members and put it together with the hbase.zookeeper.property.clientPort
88     config. and pass it into zookeeper constructor as the connectString
89     parameter.</description>
90   </property>
91   <!--The above are the important configurations for getting hbase up
92     and running -->
94   <property>
95     <name>zookeeper.recovery.retry.maxsleeptime</name>
96     <value>60000</value>
97     <description>Max sleep time before retry zookeeper operations in milliseconds,
98     a max time is needed here so that sleep time won't grow unboundedly
99     </description>
100   </property>
101   <property>
102     <name>hbase.local.dir</name>
103     <value>${hbase.tmp.dir}/local/</value>
104     <description>Directory on the local filesystem to be used
105     as a local storage.</description>
106   </property>
108   <!--Master configurations-->
109   <property >
110     <name>hbase.master.port</name>
111     <value>16000</value>
112     <description>The port the HBase Master should bind to.</description>
113   </property>
114   <property>
115     <name>hbase.master.info.port</name>
116     <value>16010</value>
117     <description>The port for the HBase Master web UI.
118     Set to -1 if you do not want a UI instance run.</description>
119   </property>
120   <property>
121     <name>hbase.master.info.bindAddress</name>
122     <value>0.0.0.0</value>
123     <description>The bind address for the HBase Master web UI
124     </description>
125   </property>
126   <property>
127     <name>hbase.master.logcleaner.plugins</name>
128     <value>org.apache.hadoop.hbase.master.cleaner.TimeToLiveLogCleaner,org.apache.hadoop.hbase.master.cleaner.TimeToLiveProcedureWALCleaner,org.apache.hadoop.hbase.master.cleaner.TimeToLiveMasterLocalStoreWALCleaner</value>
129     <description>A comma-separated list of BaseLogCleanerDelegate invoked by
130     the LogsCleaner service. These WAL cleaners are called in order,
131     so put the cleaner that prunes the most files in front. To
132     implement your own BaseLogCleanerDelegate, just put it in HBase's classpath
133     and add the fully qualified class name here. Always add the above
134     default log cleaners in the list.</description>
135   </property>
136   <property>
137     <name>hbase.master.logcleaner.ttl</name>
138     <value>600000</value>
139     <description>How long a WAL remain in the archive ({hbase.rootdir}/oldWALs) directory,
140     after which it will be cleaned by a Master thread. The value is in milliseconds.</description>
141   </property>
142   <property>
143     <name>hbase.master.hfilecleaner.plugins</name>
144     <value>org.apache.hadoop.hbase.master.cleaner.TimeToLiveHFileCleaner,org.apache.hadoop.hbase.master.cleaner.TimeToLiveMasterLocalStoreHFileCleaner</value>
145     <description>A comma-separated list of BaseHFileCleanerDelegate invoked by
146     the HFileCleaner service. These HFiles cleaners are called in order,
147     so put the cleaner that prunes the most files in front. To
148     implement your own BaseHFileCleanerDelegate, just put it in HBase's classpath
149     and add the fully qualified class name here. Always add the above
150     default hfile cleaners in the list as they will be overwritten in
151     hbase-site.xml.</description>
152   </property>
153   <property>
154     <name>hbase.master.infoserver.redirect</name>
155     <value>true</value>
156     <description>Whether or not the Master listens to the Master web
157       UI port (hbase.master.info.port) and redirects requests to the web
158       UI server shared by the Master and RegionServer. Config. makes
159       sense when Master is serving Regions (not the default).</description>
160   </property>
161   <property>
162     <name>hbase.master.fileSplitTimeout</name>
163     <value>600000</value>
164     <description>Splitting a region, how long to wait on the file-splitting
165       step before aborting the attempt. Default: 600000. This setting used
166       to be known as hbase.regionserver.fileSplitTimeout in hbase-1.x.
167       Split is now run master-side hence the rename (If a
168       'hbase.master.fileSplitTimeout' setting found, will use it to
169       prime the current 'hbase.master.fileSplitTimeout'
170       Configuration.</description>
171   </property>
173   <!--RegionServer configurations-->
174   <property>
175     <name>hbase.regionserver.port</name>
176     <value>16020</value>
177     <description>The port the HBase RegionServer binds to.</description>
178   </property>
179   <property>
180     <name>hbase.regionserver.info.port</name>
181     <value>16030</value>
182     <description>The port for the HBase RegionServer web UI
183     Set to -1 if you do not want the RegionServer UI to run.</description>
184   </property>
185   <property>
186     <name>hbase.regionserver.info.bindAddress</name>
187     <value>0.0.0.0</value>
188     <description>The address for the HBase RegionServer web UI</description>
189   </property>
190   <property>
191     <name>hbase.regionserver.info.port.auto</name>
192     <value>false</value>
193     <description>Whether or not the Master or RegionServer
194     UI should search for a port to bind to. Enables automatic port
195     search if hbase.regionserver.info.port is already in use.
196     Useful for testing, turned off by default.</description>
197   </property>
198   <property>
199     <name>hbase.regionserver.handler.count</name>
200     <value>30</value>
201     <description>Count of RPC Listener instances spun up on RegionServers.
202       Same property is used by the Master for count of master handlers.
203       Too many handlers can be counter-productive. Make it a multiple of
204       CPU count. If mostly read-only, handlers count close to cpu count
205       does well. Start with twice the CPU count and tune from there.</description>
206   </property>
207   <property>
208     <name>hbase.ipc.server.callqueue.handler.factor</name>
209     <value>0.1</value>
210     <description>Factor to determine the number of call queues.
211       A value of 0 means a single queue shared between all the handlers.
212       A value of 1 means that each handler has its own queue.</description>
213   </property>
214   <property>
215     <name>hbase.ipc.server.callqueue.read.ratio</name>
216     <value>0</value>
217     <description>Split the call queues into read and write queues.
218       The specified interval (which should be between 0.0 and 1.0)
219       will be multiplied by the number of call queues.
220       A value of 0 indicate to not split the call queues, meaning that both read and write
221       requests will be pushed to the same set of queues.
222       A value lower than 0.5 means that there will be less read queues than write queues.
223       A value of 0.5 means there will be the same number of read and write queues.
224       A value greater than 0.5 means that there will be more read queues than write queues.
225       A value of 1.0 means that all the queues except one are used to dispatch read requests.
227       Example: Given the total number of call queues being 10
228       a read.ratio of 0 means that: the 10 queues will contain both read/write requests.
229       a read.ratio of 0.3 means that: 3 queues will contain only read requests
230       and 7 queues will contain only write requests.
231       a read.ratio of 0.5 means that: 5 queues will contain only read requests
232       and 5 queues will contain only write requests.
233       a read.ratio of 0.8 means that: 8 queues will contain only read requests
234       and 2 queues will contain only write requests.
235       a read.ratio of 1 means that: 9 queues will contain only read requests
236       and 1 queues will contain only write requests.
237     </description>
238   </property>
239   <property>
240     <name>hbase.ipc.server.callqueue.scan.ratio</name>
241     <value>0</value>
242     <description>Given the number of read call queues, calculated from the total number
243       of call queues multiplied by the callqueue.read.ratio, the scan.ratio property
244       will split the read call queues into small-read and long-read queues.
245       A value lower than 0.5 means that there will be less long-read queues than short-read queues.
246       A value of 0.5 means that there will be the same number of short-read and long-read queues.
247       A value greater than 0.5 means that there will be more long-read queues than short-read queues
248       A value of 0 or 1 indicate to use the same set of queues for gets and scans.
250       Example: Given the total number of read call queues being 8
251       a scan.ratio of 0 or 1 means that: 8 queues will contain both long and short read requests.
252       a scan.ratio of 0.3 means that: 2 queues will contain only long-read requests
253       and 6 queues will contain only short-read requests.
254       a scan.ratio of 0.5 means that: 4 queues will contain only long-read requests
255       and 4 queues will contain only short-read requests.
256       a scan.ratio of 0.8 means that: 6 queues will contain only long-read requests
257       and 2 queues will contain only short-read requests.
258     </description>
259   </property>
260   <property>
261     <name>hbase.regionserver.msginterval</name>
262     <value>3000</value>
263     <description>Interval between messages from the RegionServer to Master
264     in milliseconds.</description>
265   </property>
266   <property>
267     <name>hbase.regionserver.logroll.period</name>
268     <value>3600000</value>
269     <description>Period at which we will roll the commit log regardless
270     of how many edits it has.</description>
271   </property>
272   <property>
273     <name>hbase.regionserver.logroll.errors.tolerated</name>
274     <value>2</value>
275     <description>The number of consecutive WAL close errors we will allow
276     before triggering a server abort.  A setting of 0 will cause the
277     region server to abort if closing the current WAL writer fails during
278     log rolling.  Even a small value (2 or 3) will allow a region server
279     to ride over transient HDFS errors.</description>
280   </property>
281   <property>
282     <name>hbase.regionserver.hlog.reader.impl</name>
283     <value>org.apache.hadoop.hbase.regionserver.wal.ProtobufLogReader</value>
284     <description>The WAL file reader implementation.</description>
285   </property>
286   <property>
287     <name>hbase.regionserver.hlog.writer.impl</name>
288     <value>org.apache.hadoop.hbase.regionserver.wal.ProtobufLogWriter</value>
289     <description>The WAL file writer implementation.</description>
290   </property>
291   <property>
292     <name>hbase.regionserver.global.memstore.size</name>
293     <value></value>
294     <description>Maximum size of all memstores in a region server before new
295       updates are blocked and flushes are forced. Defaults to 40% of heap (0.4).
296       Updates are blocked and flushes are forced until size of all memstores
297       in a region server hits hbase.regionserver.global.memstore.size.lower.limit.
298       The default value in this configuration has been intentionally left empty in order to
299       honor the old hbase.regionserver.global.memstore.upperLimit property if present.
300     </description>
301   </property>
302   <property>
303     <name>hbase.regionserver.global.memstore.size.lower.limit</name>
304     <value></value>
305     <description>Maximum size of all memstores in a region server before flushes
306       are forced. Defaults to 95% of hbase.regionserver.global.memstore.size
307       (0.95). A 100% value for this value causes the minimum possible flushing
308       to occur when updates are blocked due to memstore limiting. The default
309       value in this configuration has been intentionally left empty in order to
310       honor the old hbase.regionserver.global.memstore.lowerLimit property if
311       present.
312     </description>
313   </property>
314   <property>
315     <name>hbase.systemtables.compacting.memstore.type</name>
316     <value>NONE</value>
317     <description>Determines the type of memstore to be used for system tables like
318       META, namespace tables etc. By default NONE is the type and hence we use the
319       default memstore for all the system tables. If we need to use compacting
320       memstore for system tables then set this property to BASIC/EAGER
321     </description>
322   </property>
323   <property>
324     <name>hbase.regionserver.optionalcacheflushinterval</name>
325     <value>3600000</value>
326     <description>
327     Maximum amount of time an edit lives in memory before being automatically flushed.
328     Default 1 hour. Set it to 0 to disable automatic flushing.
329   </description>
330   </property>
331   <property>
332     <name>hbase.regionserver.dns.interface</name>
333     <value>default</value>
334     <description>The name of the Network Interface from which a region server
335       should report its IP address.</description>
336   </property>
337   <property>
338     <name>hbase.regionserver.dns.nameserver</name>
339     <value>default</value>
340     <description>The host name or IP address of the name server (DNS)
341       which a region server should use to determine the host name used by the
342       master for communication and display purposes.</description>
343   </property>
344   <property>
345     <name>hbase.regionserver.region.split.policy</name>
346     <value>org.apache.hadoop.hbase.regionserver.SteppingSplitPolicy</value>
347     <description>
348       A split policy determines when a region should be split. The various
349       other split policies that are available currently are BusyRegionSplitPolicy,
350       ConstantSizeRegionSplitPolicy, DisabledRegionSplitPolicy,
351       DelimitedKeyPrefixRegionSplitPolicy, KeyPrefixRegionSplitPolicy, and
352       SteppingSplitPolicy. DisabledRegionSplitPolicy blocks manual region splitting.
353     </description>
354   </property>
355   <property>
356     <name>hbase.regionserver.regionSplitLimit</name>
357     <value>1000</value>
358     <description>
359       Limit for the number of regions after which no more region splitting
360       should take place. This is not hard limit for the number of regions
361       but acts as a guideline for the regionserver to stop splitting after
362       a certain limit. Default is set to 1000.
363     </description>
364   </property>
366   <!--ZooKeeper configuration-->
367   <property>
368     <name>zookeeper.session.timeout</name>
369     <value>90000</value>
370     <description>ZooKeeper session timeout in milliseconds. It is used in two different ways.
371       First, this value is used in the ZK client that HBase uses to connect to the ensemble.
372       It is also used by HBase when it starts a ZK server and it is passed as the 'maxSessionTimeout'.
373       See https://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#ch_zkSessions.
374       For example, if an HBase region server connects to a ZK ensemble that's also managed
375       by HBase, then the session timeout will be the one specified by this configuration.
376       But, a region server that connects to an ensemble managed with a different configuration
377       will be subjected that ensemble's maxSessionTimeout. So, even though HBase might propose
378       using 90 seconds, the ensemble can have a max timeout lower than this and it will take
379       precedence. The current default maxSessionTimeout that ZK ships with is 40 seconds, which is lower than
380       HBase's.
381     </description>
382   </property>
383   <property>
384     <name>zookeeper.znode.parent</name>
385     <value>/hbase</value>
386     <description>Root ZNode for HBase in ZooKeeper. All of HBase's ZooKeeper
387       files that are configured with a relative path will go under this node.
388       By default, all of HBase's ZooKeeper file paths are configured with a
389       relative path, so they will all go under this directory unless changed.
390     </description>
391   </property>
392   <property>
393     <name>zookeeper.znode.acl.parent</name>
394     <value>acl</value>
395     <description>Root ZNode for access control lists.</description>
396   </property>
397   <property>
398     <name>hbase.zookeeper.dns.interface</name>
399     <value>default</value>
400     <description>The name of the Network Interface from which a ZooKeeper server
401       should report its IP address.</description>
402   </property>
403   <property>
404     <name>hbase.zookeeper.dns.nameserver</name>
405     <value>default</value>
406     <description>The host name or IP address of the name server (DNS)
407       which a ZooKeeper server should use to determine the host name used by the
408       master for communication and display purposes.</description>
409   </property>
410   <!--
411   The following three properties are used together to create the list of
412   host:peer_port:leader_port quorum servers for ZooKeeper.
413   -->
414   <property>
415     <name>hbase.zookeeper.peerport</name>
416     <value>2888</value>
417     <description>Port used by ZooKeeper peers to talk to each other.
418     See https://zookeeper.apache.org/doc/r3.4.10/zookeeperStarted.html#sc_RunningReplicatedZooKeeper
419     for more information.</description>
420   </property>
421   <property>
422     <name>hbase.zookeeper.leaderport</name>
423     <value>3888</value>
424     <description>Port used by ZooKeeper for leader election.
425     See https://zookeeper.apache.org/doc/r3.4.10/zookeeperStarted.html#sc_RunningReplicatedZooKeeper
426     for more information.</description>
427   </property>
428   <!-- End of properties used to generate ZooKeeper host:port quorum list. -->
430   <!--
431   Beginning of properties that are directly mapped from ZooKeeper's zoo.cfg.
432   All properties with an "hbase.zookeeper.property." prefix are converted for
433   ZooKeeper's configuration. Hence, if you want to add an option from zoo.cfg,
434   e.g.  "initLimit=10" you would append the following to your configuration:
435     <property>
436       <name>hbase.zookeeper.property.initLimit</name>
437       <value>10</value>
438     </property>
439   -->
440   <property>
441     <name>hbase.zookeeper.property.initLimit</name>
442     <value>10</value>
443     <description>Property from ZooKeeper's config zoo.cfg.
444     The number of ticks that the initial synchronization phase can take.</description>
445   </property>
446   <property>
447     <name>hbase.zookeeper.property.syncLimit</name>
448     <value>5</value>
449     <description>Property from ZooKeeper's config zoo.cfg.
450     The number of ticks that can pass between sending a request and getting an
451     acknowledgment.</description>
452   </property>
453   <property>
454     <name>hbase.zookeeper.property.dataDir</name>
455     <value>${hbase.tmp.dir}/zookeeper</value>
456     <description>Property from ZooKeeper's config zoo.cfg.
457     The directory where the snapshot is stored.</description>
458   </property>
459   <property>
460     <name>hbase.zookeeper.property.clientPort</name>
461     <value>2181</value>
462     <description>Property from ZooKeeper's config zoo.cfg.
463     The port at which the clients will connect.</description>
464   </property>
465   <property>
466     <name>hbase.zookeeper.property.maxClientCnxns</name>
467     <value>300</value>
468     <description>Property from ZooKeeper's config zoo.cfg.
469     Limit on number of concurrent connections (at the socket level) that a
470     single client, identified by IP address, may make to a single member of
471     the ZooKeeper ensemble. Set high to avoid zk connection issues running
472     standalone and pseudo-distributed.</description>
473   </property>
474   <!-- End of properties that are directly mapped from ZooKeeper's zoo.cfg -->
476   <!--Client configurations-->
477   <property>
478     <name>hbase.client.write.buffer</name>
479     <value>2097152</value>
480     <description>Default size of the BufferedMutator write buffer in bytes.
481     A bigger buffer takes more memory -- on both the client and server
482     side since server instantiates the passed write buffer to process
483     it -- but a larger buffer size reduces the number of RPCs made.
484     For an estimate of server-side memory-used, evaluate
485     hbase.client.write.buffer * hbase.regionserver.handler.count</description>
486   </property>
487   <property>
488     <name>hbase.client.pause</name>
489     <value>100</value>
490     <description>General client pause value.  Used mostly as value to wait
491     before running a retry of a failed get, region lookup, etc.
492     See hbase.client.retries.number for description of how we backoff from
493     this initial pause amount and how this pause works w/ retries.</description>
494   </property>
495   <property>
496     <name>hbase.client.pause.cqtbe</name>
497     <value></value>
498     <description>Whether or not to use a special client pause for
499     CallQueueTooBigException (cqtbe). Set this property to a higher value
500     than hbase.client.pause if you observe frequent CQTBE from the same
501     RegionServer and the call queue there keeps full</description>
502   </property>
503   <property>
504     <name>hbase.client.retries.number</name>
505     <value>15</value>
506     <description>Maximum retries.  Used as maximum for all retryable
507     operations such as the getting of a cell's value, starting a row update,
508     etc.  Retry interval is a rough function based on hbase.client.pause.  At
509     first we retry at this interval but then with backoff, we pretty quickly reach
510     retrying every ten seconds.  See HConstants#RETRY_BACKOFF for how the backup
511     ramps up.  Change this setting and hbase.client.pause to suit your workload.</description>
512   </property>
513   <property>
514     <name>hbase.client.max.total.tasks</name>
515     <value>100</value>
516     <description>The maximum number of concurrent mutation tasks a single HTable instance will
517     send to the cluster.</description>
518   </property>
519   <property>
520     <name>hbase.client.max.perserver.tasks</name>
521     <value>2</value>
522     <description>The maximum number of concurrent mutation tasks a single HTable instance will
523     send to a single region server.</description>
524   </property>
525   <property>
526     <name>hbase.client.max.perregion.tasks</name>
527     <value>1</value>
528     <description>The maximum number of concurrent mutation tasks the client will
529     maintain to a single Region. That is, if there is already
530     hbase.client.max.perregion.tasks writes in progress for this region, new puts
531     won't be sent to this region until some writes finishes.</description>
532   </property>
533   <property>
534     <name>hbase.client.perserver.requests.threshold</name>
535     <value>2147483647</value>
536     <description>The max number of concurrent pending requests for one server in all client threads
537     (process level). Exceeding requests will be thrown ServerTooBusyException immediately to prevent
538     user's threads being occupied and blocked by only one slow region server. If you use a fix
539     number of threads to access HBase in a synchronous way, set this to a suitable value which is
540     related to the number of threads will help you. See
541     https://issues.apache.org/jira/browse/HBASE-16388 for details.</description>
542   </property>
543   <property>
544     <name>hbase.client.scanner.caching</name>
545     <value>2147483647</value>
546     <description>Number of rows that we try to fetch when calling next
547     on a scanner if it is not served from (local, client) memory. This configuration
548     works together with hbase.client.scanner.max.result.size to try and use the
549     network efficiently. The default value is Integer.MAX_VALUE by default so that
550     the network will fill the chunk size defined by hbase.client.scanner.max.result.size
551     rather than be limited by a particular number of rows since the size of rows varies
552     table to table. If you know ahead of time that you will not require more than a certain
553     number of rows from a scan, this configuration should be set to that row limit via
554     Scan#setCaching. Higher caching values will enable faster scanners but will eat up more
555     memory and some calls of next may take longer and longer times when the cache is empty.
556     Do not set this value such that the time between invocations is greater than the scanner
557     timeout; i.e. hbase.client.scanner.timeout.period</description>
558   </property>
559   <property>
560     <name>hbase.client.keyvalue.maxsize</name>
561     <value>10485760</value>
562     <description>Specifies the combined maximum allowed size of a KeyValue
563     instance. This is to set an upper boundary for a single entry saved in a
564     storage file. Since they cannot be split it helps avoiding that a region
565     cannot be split any further because the data is too large. It seems wise
566     to set this to a fraction of the maximum region size. Setting it to zero
567     or less disables the check.</description>
568   </property>
569   <property>
570     <name>hbase.server.keyvalue.maxsize</name>
571     <value>10485760</value>
572     <description>Maximum allowed size of an individual cell, inclusive of value and all key
573     components. A value of 0 or less disables the check.
574     The default value is 10MB.
575     This is a safety setting to protect the server from OOM situations.
576     </description>
577   </property>
578   <property>
579     <name>hbase.client.scanner.timeout.period</name>
580     <value>60000</value>
581     <description>Client scanner lease period in milliseconds.</description>
582   </property>
583   <property>
584     <name>hbase.client.localityCheck.threadPoolSize</name>
585     <value>2</value>
586   </property>
588   <!--Miscellaneous configuration-->
589   <property>
590     <name>hbase.bulkload.retries.number</name>
591     <value>10</value>
592     <description>Maximum retries.  This is maximum number of iterations
593     to atomic bulk loads are attempted in the face of splitting operations
594     0 means never give up.</description>
595   </property>
596   <property>
597     <name>hbase.compaction.after.bulkload.enable</name>
598     <value>false</value>
599     <description>Request Compaction after bulkload immediately.
600       If bulkload is continuous, the triggered compactions may increase load,
601       bring about performance side effect.</description>
602   </property>
603   <property>
604     <name>hbase.master.balancer.maxRitPercent</name>
605     <value>1.0</value>
606     <description>The max percent of regions in transition when balancing.
607       The default value is 1.0. So there are no balancer throttling. If set this config to 0.01,
608       It means that there are at most 1% regions in transition when balancing.
609       Then the cluster's availability is at least 99% when balancing.</description>
610   </property>
611   <property>
612     <name>hbase.balancer.period</name>
613     <value>300000</value>
614     <description>Period at which the region balancer runs in the Master, in
615       milliseconds.</description>
616   </property>
617   <property>
618     <name>hbase.regions.slop</name>
619     <value>0.001</value>
620     <description>Rebalance if any regionserver has average + (average * slop) regions.
621       The default value of this parameter is 0.001 in StochasticLoadBalancer (the default load
622       balancer), while the default is 0.2 in other load balancers (i.e.,
623       SimpleLoadBalancer).</description>
624   </property>
625   <property>
626     <name>hbase.normalizer.period</name>
627     <value>300000</value>
628     <description>Period at which the region normalizer runs in the Master, in
629       milliseconds.</description>
630   </property>
631   <property>
632     <name>hbase.normalizer.split.enabled</name>
633     <value>true</value>
634     <description>Whether to split a region as part of normalization.</description>
635   </property>
636   <property>
637     <name>hbase.normalizer.merge.enabled</name>
638     <value>true</value>
639     <description>Whether to merge a region as part of normalization.</description>
640   </property>
641   <property>
642     <name>hbase.normalizer.merge.min.region.count</name>
643     <value>3</value>
644     <description>The minimum number of regions in a table to consider it for merge
645       normalization.</description>
646   </property>
647   <property>
648     <name>hbase.normalizer.merge.min_region_age.days</name>
649     <value>3</value>
650     <description>The minimum age for a region to be considered for a merge, in days.</description>
651   </property>
652   <property>
653     <name>hbase.normalizer.merge.min_region_age.days</name>
654     <value>3</value>
655     <description>The minimum age for a region to be considered for a merge, in days.</description>
656   </property>
657   <property>
658     <name>hbase.normalizer.merge.min_region_size.mb</name>
659     <value>1</value>
660     <description>The minimum size for a region to be considered for a merge, in whole
661       MBs.</description>
662   </property>
663   <property>
664     <name>hbase.table.normalization.enabled</name>
665     <value>false</value>
666     <description>This config is used to set default behaviour of normalizer at table level.
667       To override this at table level one can set NORMALIZATION_ENABLED at table descriptor level
668       and that property will be honored</description>
669   </property>
670   <property>
671     <name>hbase.server.thread.wakefrequency</name>
672     <value>10000</value>
673     <description>In master side, this config is the period used for FS related behaviors:
674       checking if hdfs is out of safe mode, setting or checking hbase.version file,
675       setting or checking hbase.id file. Using default value should be fine.
676       In regionserver side, this config is used in several places: flushing check interval,
677       compaction check interval, wal rolling check interval. Specially, admin can tune
678       flushing and compaction check interval by hbase.regionserver.flush.check.period
679       and hbase.regionserver.compaction.check.period. (in milliseconds)</description>
680   </property>
681   <property>
682     <name>hbase.regionserver.flush.check.period</name>
683     <value>${hbase.server.thread.wakefrequency}</value>
684     <description>It determines the flushing check period of PeriodicFlusher in regionserver.
685       If unset, it uses hbase.server.thread.wakefrequency as default value.
686       (in milliseconds)</description>
687   </property>
688   <property>
689     <name>hbase.regionserver.compaction.check.period</name>
690     <value>${hbase.server.thread.wakefrequency}</value>
691     <description>It determines the compaction check period of CompactionChecker in regionserver.
692       If unset, it uses hbase.server.thread.wakefrequency as default value.
693       (in milliseconds)</description>
694   </property>
695   <property>
696     <name>hbase.server.versionfile.writeattempts</name>
697     <value>3</value>
698     <description>
699     How many times to retry attempting to write a version file
700     before just aborting. Each attempt is separated by the
701     hbase.server.thread.wakefrequency milliseconds.</description>
702   </property>
703   <property>
704     <name>hbase.hregion.memstore.flush.size</name>
705     <value>134217728</value>
706     <description>
707     Memstore will be flushed to disk if size of the memstore
708     exceeds this number of bytes.  Value is checked by a thread that runs
709     every hbase.server.thread.wakefrequency.</description>
710   </property>
711   <property>
712     <name>hbase.hregion.percolumnfamilyflush.size.lower.bound.min</name>
713     <value>16777216</value>
714     <description>
715     If FlushLargeStoresPolicy is used and there are multiple column families,
716     then every time that we hit the total memstore limit, we find out all the
717     column families whose memstores exceed a "lower bound" and only flush them
718     while retaining the others in memory. The "lower bound" will be
719     "hbase.hregion.memstore.flush.size / column_family_number" by default
720     unless value of this property is larger than that. If none of the families
721     have their memstore size more than lower bound, all the memstores will be
722     flushed (just as usual).
723     </description>
724   </property>
725   <property>
726     <name>hbase.hregion.preclose.flush.size</name>
727     <value>5242880</value>
728     <description>
729       If the memstores in a region are this size or larger when we go
730       to close, run a "pre-flush" to clear out memstores before we put up
731       the region closed flag and take the region offline.  On close,
732       a flush is run under the close flag to empty memory.  During
733       this time the region is offline and we are not taking on any writes.
734       If the memstore content is large, this flush could take a long time to
735       complete.  The preflush is meant to clean out the bulk of the memstore
736       before putting up the close flag and taking the region offline so the
737       flush that runs under the close flag has little to do.</description>
738   </property>
739   <property>
740     <name>hbase.hregion.memstore.block.multiplier</name>
741     <value>4</value>
742     <description>
743     Block updates if memstore has hbase.hregion.memstore.block.multiplier
744     times hbase.hregion.memstore.flush.size bytes.  Useful preventing
745     runaway memstore during spikes in update traffic.  Without an
746     upper-bound, memstore fills such that when it flushes the
747     resultant flush files take a long time to compact or split, or
748     worse, we OOME.</description>
749   </property>
750   <property>
751     <name>hbase.hregion.memstore.mslab.enabled</name>
752     <value>true</value>
753     <description>
754       Enables the MemStore-Local Allocation Buffer,
755       a feature which works to prevent heap fragmentation under
756       heavy write loads. This can reduce the frequency of stop-the-world
757       GC pauses on large heaps.
758     </description>
759   </property>
760   <property>
761     <name>hbase.hregion.memstore.mslab.chunksize</name>
762     <value>2097152</value>
763     <description>The maximum byte size of a chunk in the MemStoreLAB. Unit: bytes</description>
764   </property>
765   <property>
766     <name>hbase.regionserver.offheap.global.memstore.size</name>
767     <value>0</value>
768     <description>The amount of off-heap memory all MemStores in a RegionServer may use.
769       A value of 0 means that no off-heap memory will be used and all chunks in MSLAB
770       will be HeapByteBuffer, otherwise the non-zero value means how many megabyte of
771       off-heap memory will be used for chunks in MSLAB and all chunks in MSLAB will be
772       DirectByteBuffer. Unit: megabytes.
773     </description>
774   </property>
775   <property>
776     <name>hbase.hregion.memstore.mslab.max.allocation</name>
777     <value>262144</value>
778     <description>The maximal size of one allocation in the MemStoreLAB, if the desired byte
779       size exceed this threshold then it will be just allocated from JVM heap rather than MemStoreLAB.
780     </description>
781   </property>
782   <property>
783     <name>hbase.hregion.max.filesize</name>
784     <value>10737418240</value>
785     <description>Maximum file size. If the sum of the sizes of a region's HFiles has
786       grown to exceed this value, the region is split in two. There are two choices of
787       how this option works, the first is when any store's size exceed the threshold
788       then split, and the other is overall region's size exceed the threshold then split,
789       it can be configed by hbase.hregion.split.overallfiles.</description>
790   </property>
791   <property>
792     <name>hbase.hregion.split.overallfiles</name>
793     <value>true</value>
794     <description>If we should sum overall region files size when check to split.</description>
795   </property>
796   <property>
797     <name>hbase.hregion.majorcompaction</name>
798     <value>604800000</value>
799     <description>Time between major compactions, expressed in milliseconds. Set to 0 to disable
800       time-based automatic major compactions. User-requested and size-based major compactions will
801       still run. This value is multiplied by hbase.hregion.majorcompaction.jitter to cause
802       compaction to start at a somewhat-random time during a given window of time. The default value
803       is 7 days, expressed in milliseconds. If major compactions are causing disruption in your
804       environment, you can configure them to run at off-peak times for your deployment, or disable
805       time-based major compactions by setting this parameter to 0, and run major compactions in a
806       cron job or by another external mechanism.</description>
807   </property>
808   <property>
809     <name>hbase.hregion.majorcompaction.jitter</name>
810     <value>0.50</value>
811     <description>A multiplier applied to hbase.hregion.majorcompaction to cause compaction to occur
812       a given amount of time either side of hbase.hregion.majorcompaction. The smaller the number,
813       the closer the compactions will happen to the hbase.hregion.majorcompaction
814       interval.</description>
815   </property>
816   <property>
817     <name>hbase.hstore.compactionThreshold</name>
818     <value>3</value>
819     <description> If more than this number of StoreFiles exist in any one Store
820       (one StoreFile is written per flush of MemStore), a compaction is run to rewrite all
821       StoreFiles into a single StoreFile. Larger values delay compaction, but when compaction does
822       occur, it takes longer to complete.</description>
823   </property>
824   <property>
825     <name>hbase.regionserver.compaction.enabled</name>
826     <value>true</value>
827     <description>Enable/disable compactions on by setting true/false.
828       We can further switch compactions dynamically with the
829       compaction_switch shell command.</description>
830   </property>
831   <property>
832     <name>hbase.hstore.flusher.count</name>
833     <value>2</value>
834     <description> The number of flush threads. With fewer threads, the MemStore flushes will be
835       queued. With more threads, the flushes will be executed in parallel, increasing the load on
836       HDFS, and potentially causing more compactions. </description>
837   </property>
838   <property>
839     <name>hbase.hstore.blockingStoreFiles</name>
840     <value>16</value>
841     <description> If more than this number of StoreFiles exist in any one Store (one StoreFile
842      is written per flush of MemStore), updates are blocked for this region until a compaction is
843       completed, or until hbase.hstore.blockingWaitTime has been exceeded.</description>
844   </property>
845   <property>
846     <name>hbase.hstore.blockingWaitTime</name>
847     <value>90000</value>
848     <description> The time for which a region will block updates after reaching the StoreFile limit
849     defined by hbase.hstore.blockingStoreFiles. After this time has elapsed, the region will stop
850     blocking updates even if a compaction has not been completed.</description>
851   </property>
852   <property>
853     <name>hbase.hstore.compaction.min</name>
854     <value></value>
855     <description>The minimum number of StoreFiles which must be eligible for compaction before
856       compaction can run. The goal of tuning hbase.hstore.compaction.min is to avoid ending up with
857       too many tiny StoreFiles to compact. Setting this value to 2 would cause a minor compaction
858       each time you have two StoreFiles in a Store, and this is probably not appropriate. If you
859       set this value too high, all the other values will need to be adjusted accordingly. For most
860       cases, the default value is appropriate  (empty value here, results in 3 by code logic). In 
861       previous versions of HBase, the parameter hbase.hstore.compaction.min was named 
862       hbase.hstore.compactionThreshold.</description>
863   </property>
864   <property>
865     <name>hbase.hstore.compaction.max</name>
866     <value>10</value>
867     <description>The maximum number of StoreFiles which will be selected for a single minor
868       compaction, regardless of the number of eligible StoreFiles. Effectively, the value of
869       hbase.hstore.compaction.max controls the length of time it takes a single compaction to
870       complete. Setting it larger means that more StoreFiles are included in a compaction. For most
871       cases, the default value is appropriate.</description>
872   </property>
873   <property>
874     <name>hbase.hstore.compaction.min.size</name>
875     <value>134217728</value>
876     <description>A StoreFile (or a selection of StoreFiles, when using ExploringCompactionPolicy)
877       smaller than this size will always be eligible for minor compaction.
878       HFiles this size or larger are evaluated by hbase.hstore.compaction.ratio to determine if
879       they are eligible. Because this limit represents the "automatic include" limit for all
880       StoreFiles smaller than this value, this value may need to be reduced in write-heavy
881       environments where many StoreFiles in the 1-2 MB range are being flushed, because every
882       StoreFile will be targeted for compaction and the resulting StoreFiles may still be under the
883       minimum size and require further compaction. If this parameter is lowered, the ratio check is
884       triggered more quickly. This addressed some issues seen in earlier versions of HBase but
885       changing this parameter is no longer necessary in most situations. Default: 128 MB expressed
886       in bytes.</description>
887   </property>
888     <property>
889     <name>hbase.hstore.compaction.max.size</name>
890     <value>9223372036854775807</value>
891     <description>A StoreFile (or a selection of StoreFiles, when using ExploringCompactionPolicy)
892       larger than this size will be excluded from compaction. The effect of
893       raising hbase.hstore.compaction.max.size is fewer, larger StoreFiles that do not get
894       compacted often. If you feel that compaction is happening too often without much benefit, you
895       can try raising this value. Default: the value of LONG.MAX_VALUE, expressed in bytes.</description>
896   </property>
897   <property>
898     <name>hbase.hstore.compaction.ratio</name>
899     <value>1.2F</value>
900     <description>For minor compaction, this ratio is used to determine whether a given StoreFile
901       which is larger than hbase.hstore.compaction.min.size is eligible for compaction. Its
902       effect is to limit compaction of large StoreFiles. The value of hbase.hstore.compaction.ratio
903       is expressed as a floating-point decimal. A large ratio, such as 10, will produce a single
904       giant StoreFile. Conversely, a low value, such as .25, will produce behavior similar to the
905       BigTable compaction algorithm, producing four StoreFiles. A moderate value of between 1.0 and
906       1.4 is recommended. When tuning this value, you are balancing write costs with read costs.
907       Raising the value (to something like 1.4) will have more write costs, because you will
908       compact larger StoreFiles. However, during reads, HBase will need to seek through fewer
909       StoreFiles to accomplish the read. Consider this approach if you cannot take advantage of
910       Bloom filters. Otherwise, you can lower this value to something like 1.0 to reduce the
911       background cost of writes, and use Bloom filters to control the number of StoreFiles touched
912       during reads. For most cases, the default value is appropriate.</description>
913   </property>
914   <property>
915     <name>hbase.hstore.compaction.ratio.offpeak</name>
916     <value>5.0F</value>
917     <description>Allows you to set a different (by default, more aggressive) ratio for determining
918       whether larger StoreFiles are included in compactions during off-peak hours. Works in the
919       same way as hbase.hstore.compaction.ratio. Only applies if hbase.offpeak.start.hour and
920       hbase.offpeak.end.hour are also enabled.</description>
921   </property>
922   <property>
923     <name>hbase.hstore.time.to.purge.deletes</name>
924     <value>0</value>
925     <description>The amount of time to delay purging of delete markers with future timestamps. If
926       unset, or set to 0, all delete markers, including those with future timestamps, are purged
927       during the next major compaction. Otherwise, a delete marker is kept until the major compaction
928       which occurs after the marker's timestamp plus the value of this setting, in milliseconds.
929     </description>
930   </property>
931   <property>
932     <name>hbase.offpeak.start.hour</name>
933     <value>-1</value>
934     <description>The start of off-peak hours, expressed as an integer between 0 and 23, inclusive.
935       Set to -1 to disable off-peak.</description>
936   </property>
937   <property>
938     <name>hbase.offpeak.end.hour</name>
939     <value>-1</value>
940     <description>The end of off-peak hours, expressed as an integer between 0 and 23, inclusive. Set
941       to -1 to disable off-peak.</description>
942   </property>
943   <property>
944     <name>hbase.regionserver.thread.compaction.throttle</name>
945     <value>2684354560</value>
946     <description>There are two different thread pools for compactions, one for large compactions and
947       the other for small compactions. This helps to keep compaction of lean tables (such as
948       hbase:meta) fast. If a compaction is larger than this threshold, it
949       goes into the large compaction pool. In most cases, the default value is appropriate. Default:
950       2 x hbase.hstore.compaction.max x hbase.hregion.memstore.flush.size (which defaults to 128MB).
951       The value field assumes that the value of hbase.hregion.memstore.flush.size is unchanged from
952       the default.</description>
953   </property>
954   <property>
955     <name>hbase.regionserver.majorcompaction.pagecache.drop</name>
956     <value>true</value>
957     <description>Specifies whether to drop pages read/written into the system page cache by
958       major compactions. Setting it to true helps prevent major compactions from
959       polluting the page cache, which is almost always required, especially for clusters
960       with low/moderate memory to storage ratio.</description>
961   </property>
962   <property>
963     <name>hbase.regionserver.minorcompaction.pagecache.drop</name>
964     <value>true</value>
965     <description>Specifies whether to drop pages read/written into the system page cache by
966       minor compactions. Setting it to true helps prevent minor compactions from
967       polluting the page cache, which is most beneficial on clusters with low
968       memory to storage ratio or very write heavy clusters. You may want to set it to
969       false under moderate to low write workload when bulk of the reads are
970       on the most recently written data.</description>
971   </property>
972   <property>
973     <name>hbase.hstore.compaction.kv.max</name>
974     <value>10</value>
975     <description>The maximum number of KeyValues to read and then write in a batch when flushing or
976       compacting. Set this lower if you have big KeyValues and problems with Out Of Memory
977       Exceptions Set this higher if you have wide, small rows. </description>
978   </property>
979   <property>
980     <name>hbase.storescanner.parallel.seek.enable</name>
981     <value>false</value>
982     <description>
983       Enables StoreFileScanner parallel-seeking in StoreScanner,
984       a feature which can reduce response latency under special conditions.</description>
985   </property>
986   <property>
987     <name>hbase.storescanner.parallel.seek.threads</name>
988     <value>10</value>
989     <description>
990       The default thread pool size if parallel-seeking feature enabled.</description>
991   </property>
992   <property>
993     <name>hfile.block.cache.policy</name>
994     <value>LRU</value>
995     <description>The eviction policy for the L1 block cache (LRU or TinyLFU).</description>
996   </property>
997   <property>
998     <name>hfile.block.cache.size</name>
999     <value>0.4</value>
1000     <description>Percentage of maximum heap (-Xmx setting) to allocate to block cache
1001         used by a StoreFile. Default of 0.4 means allocate 40%.
1002         Set to 0 to disable but it's not recommended; you need at least
1003         enough cache to hold the storefile indices.</description>
1004   </property>
1005   <property>
1006       <name>hfile.block.index.cacheonwrite</name>
1007       <value>false</value>
1008       <description>This allows to put non-root multi-level index blocks into the block
1009           cache at the time the index is being written.</description>
1010   </property>
1011   <property>
1012       <name>hfile.index.block.max.size</name>
1013       <value>131072</value>
1014       <description>When the size of a leaf-level, intermediate-level, or root-level
1015           index block in a multi-level block index grows to this size, the
1016           block is written out and a new block is started.</description>
1017   </property>
1018     <property>
1019     <name>hbase.bucketcache.ioengine</name>
1020     <value></value>
1021     <description>Where to store the contents of the bucketcache. One of: offheap,
1022     file, files, mmap or pmem. If a file or files, set it to file(s):PATH_TO_FILE.
1023     mmap means the content will be in an mmaped file. Use mmap:PATH_TO_FILE. 'pmem'
1024     is bucket cache over a file on the persistent memory device.
1025     Use pmem:PATH_TO_FILE.
1026     See http://hbase.apache.org/book.html#offheap.blockcache for more information.
1027     </description>
1028   </property>
1029   <property>
1030     <name>hbase.hstore.compaction.throughput.lower.bound</name>
1031     <value>52428800</value>
1032     <description>The target lower bound on aggregate compaction throughput, in bytes/sec. Allows
1033     you to tune the minimum available compaction throughput when the
1034     PressureAwareCompactionThroughputController throughput controller is active. (It is active by
1035     default.)</description>
1036   </property>
1037   <property>
1038     <name>hbase.hstore.compaction.throughput.higher.bound</name>
1039     <value>104857600</value>
1040     <description>The target upper bound on aggregate compaction throughput, in bytes/sec. Allows
1041     you to control aggregate compaction throughput demand when the
1042     PressureAwareCompactionThroughputController throughput controller is active. (It is active by
1043     default.) The maximum throughput will be tuned between the lower and upper bounds when
1044     compaction pressure is within the range [0.0, 1.0]. If compaction pressure is 1.0 or greater
1045     the higher bound will be ignored until pressure returns to the normal range.</description>
1046   </property>
1047   <property>
1048     <name>hbase.bucketcache.size</name>
1049     <value></value>
1050     <description>It is the total capacity in megabytes of BucketCache. Default: 0.0</description>
1051   </property>
1052   <property>
1053     <name>hbase.bucketcache.bucket.sizes</name>
1054     <value></value>
1055     <description>A comma-separated list of sizes for buckets for the bucketcache.
1056     Can be multiple sizes. List block sizes in order from smallest to largest.
1057     The sizes you use will depend on your data access patterns.
1058     Must be a multiple of 256 else you will run into
1059     'java.io.IOException: Invalid HFile block magic' when you go to read from cache.
1060     If you specify no values here, then you pick up the default bucketsizes set
1061     in code (See BucketAllocator#DEFAULT_BUCKET_SIZES).
1062   </description>
1063   </property>
1064   <property>
1065       <name>hfile.format.version</name>
1066       <value>3</value>
1067       <description>The HFile format version to use for new files.
1068       Version 3 adds support for tags in hfiles (See http://hbase.apache.org/book.html#hbase.tags).
1069       Also see the configuration 'hbase.replication.rpc.codec'.
1070       </description>
1071   </property>
1072   <property>
1073       <name>hfile.block.bloom.cacheonwrite</name>
1074       <value>false</value>
1075       <description>Enables cache-on-write for inline blocks of a compound Bloom filter.</description>
1076   </property>
1077   <property>
1078       <name>io.storefile.bloom.block.size</name>
1079       <value>131072</value>
1080       <description>The size in bytes of a single block ("chunk") of a compound Bloom
1081           filter. This size is approximate, because Bloom blocks can only be
1082           inserted at data block boundaries, and the number of keys per data
1083           block varies.</description>
1084   </property>
1085   <property>
1086       <name>hbase.rs.cacheblocksonwrite</name>
1087       <value>false</value>
1088       <description>Whether an HFile block should be added to the block cache when the
1089         block is finished.</description>
1090   </property>
1091   <property>
1092     <name>hbase.rpc.timeout</name>
1093     <value>60000</value>
1094     <description>This is for the RPC layer to define how long (millisecond) HBase client applications
1095         take for a remote call to time out. It uses pings to check connections
1096         but will eventually throw a TimeoutException.</description>
1097   </property>
1098   <property>
1099     <name>hbase.client.operation.timeout</name>
1100     <value>1200000</value>
1101     <description>Operation timeout is a top-level restriction (millisecond) that makes sure a
1102       blocking operation in Table will not be blocked more than this. In each operation, if rpc
1103       request fails because of timeout or other reason, it will retry until success or throw
1104       RetriesExhaustedException. But if the total time being blocking reach the operation timeout
1105       before retries exhausted, it will break early and throw SocketTimeoutException.</description>
1106   </property>
1107   <property>
1108     <name>hbase.cells.scanned.per.heartbeat.check</name>
1109     <value>10000</value>
1110     <description>The number of cells scanned in between heartbeat checks. Heartbeat
1111         checks occur during the processing of scans to determine whether or not the
1112         server should stop scanning in order to send back a heartbeat message to the
1113         client. Heartbeat messages are used to keep the client-server connection alive
1114         during long running scans. Small values mean that the heartbeat checks will
1115         occur more often and thus will provide a tighter bound on the execution time of
1116         the scan. Larger values mean that the heartbeat checks occur less frequently
1117         </description>
1118   </property>
1119   <property>
1120     <name>hbase.rpc.shortoperation.timeout</name>
1121     <value>10000</value>
1122     <description>This is another version of "hbase.rpc.timeout". For those RPC operation
1123         within cluster, we rely on this configuration to set a short timeout limitation
1124         for short operation. For example, short rpc timeout for region server's trying
1125         to report to active master can benefit quicker master failover process.</description>
1126   </property>
1127   <property>
1128     <name>hbase.ipc.client.tcpnodelay</name>
1129     <value>true</value>
1130     <description>Set no delay on rpc socket connections.  See
1131     http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Socket.html#getTcpNoDelay()</description>
1132   </property>
1133   <property>
1134     <name>hbase.unsafe.regionserver.hostname</name>
1135     <value></value>
1136     <description>This config is for experts: don't set its value unless you really know what you are doing.
1137     When set to a non-empty value, this represents the (external facing) hostname for the underlying server.
1138     See https://issues.apache.org/jira/browse/HBASE-12954 for details.</description>
1139   </property>
1140   <property>
1141     <name>hbase.unsafe.regionserver.hostname.disable.master.reversedns</name>
1142     <value>false</value>
1143     <description>This config is for experts: don't set its value unless you really know what you are doing.
1144     When set to true, regionserver will use the current node hostname for the servername and HMaster will
1145     skip reverse DNS lookup and use the hostname sent by regionserver instead. Note that this config and
1146     hbase.unsafe.regionserver.hostname are mutually exclusive. See https://issues.apache.org/jira/browse/HBASE-18226
1147     for more details.</description>
1148   </property>
1149   <!-- The following properties configure authentication information for
1150        HBase processes when using Kerberos security.  There are no default
1151        values, included here for documentation purposes -->
1152   <property>
1153     <name>hbase.master.keytab.file</name>
1154     <value></value>
1155     <description>Full path to the kerberos keytab file to use for logging in
1156     the configured HMaster server principal.</description>
1157   </property>
1158   <property>
1159     <name>hbase.master.kerberos.principal</name>
1160     <value></value>
1161     <description>Ex. "hbase/_HOST@EXAMPLE.COM".  The kerberos principal name
1162     that should be used to run the HMaster process.  The principal name should
1163     be in the form: user/hostname@DOMAIN.  If "_HOST" is used as the hostname
1164     portion, it will be replaced with the actual hostname of the running
1165     instance.</description>
1166   </property>
1167   <property>
1168     <name>hbase.regionserver.keytab.file</name>
1169     <value></value>
1170     <description>Full path to the kerberos keytab file to use for logging in
1171     the configured HRegionServer server principal.</description>
1172   </property>
1173   <property>
1174     <name>hbase.regionserver.kerberos.principal</name>
1175     <value></value>
1176     <description>Ex. "hbase/_HOST@EXAMPLE.COM".  The kerberos principal name
1177     that should be used to run the HRegionServer process.  The principal name
1178     should be in the form: user/hostname@DOMAIN.  If "_HOST" is used as the
1179     hostname portion, it will be replaced with the actual hostname of the
1180     running instance.  An entry for this principal must exist in the file
1181     specified in hbase.regionserver.keytab.file</description>
1182   </property>
1183   <!-- Additional configuration specific to HBase security -->
1184   <property>
1185     <name>hadoop.policy.file</name>
1186     <value>hbase-policy.xml</value>
1187     <description>The policy configuration file used by RPC servers to make
1188       authorization decisions on client requests.  Only used when HBase
1189       security is enabled.</description>
1190   </property>
1191   <property>
1192     <name>hbase.superuser</name>
1193     <value></value>
1194     <description>List of users or groups (comma-separated), who are allowed
1195     full privileges, regardless of stored ACLs, across the cluster.
1196     Only used when HBase security is enabled.</description>
1197   </property>
1198   <property>
1199     <name>hbase.auth.key.update.interval</name>
1200     <value>86400000</value>
1201     <description>The update interval for master key for authentication tokens
1202     in servers in milliseconds.  Only used when HBase security is enabled.</description>
1203   </property>
1204   <property>
1205     <name>hbase.auth.token.max.lifetime</name>
1206     <value>604800000</value>
1207     <description>The maximum lifetime in milliseconds after which an
1208     authentication token expires.  Only used when HBase security is enabled.</description>
1209   </property>
1210   <property>
1211     <name>hbase.ipc.client.fallback-to-simple-auth-allowed</name>
1212     <value>false</value>
1213     <description>When a client is configured to attempt a secure connection, but attempts to
1214       connect to an insecure server, that server may instruct the client to
1215       switch to SASL SIMPLE (unsecure) authentication. This setting controls
1216       whether or not the client will accept this instruction from the server.
1217       When false (the default), the client will not allow the fallback to SIMPLE
1218       authentication, and will abort the connection.</description>
1219   </property>
1220   <property>
1221     <name>hbase.ipc.server.fallback-to-simple-auth-allowed</name>
1222     <value>false</value>
1223     <description>When a server is configured to require secure connections, it will
1224       reject connection attempts from clients using SASL SIMPLE (unsecure) authentication.
1225       This setting allows secure servers to accept SASL SIMPLE connections from clients
1226       when the client requests.  When false (the default), the server will not allow the fallback
1227       to SIMPLE authentication, and will reject the connection.  WARNING: This setting should ONLY
1228       be used as a temporary measure while converting clients over to secure authentication.  It
1229       MUST BE DISABLED for secure operation.</description>
1230   </property>
1231   <property>
1232     <name>hbase.unsafe.client.kerberos.hostname.disable.reversedns</name>
1233     <value>false</value>
1234     <description>This config is for experts: don't set its value unless you really know what you are doing.
1235       When set to true, HBase client using SASL Kerberos will skip reverse DNS lookup and use provided
1236       hostname of the destination for the principal instead. See https://issues.apache.org/jira/browse/HBASE-25665
1237       for more details.</description>
1238   </property>
1239   <property>
1240     <name>hbase.display.keys</name>
1241     <value>true</value>
1242     <description>When this is set to true the webUI and such will display all start/end keys
1243                  as part of the table details, region names, etc. When this is set to false,
1244                  the keys are hidden.</description>
1245   </property>
1246   <property>
1247     <name>hbase.coprocessor.enabled</name>
1248     <value>true</value>
1249     <description>Enables or disables coprocessor loading. If 'false'
1250     (disabled), any other coprocessor related configuration will be ignored.
1251     </description>
1252   </property>
1253   <property>
1254     <name>hbase.coprocessor.user.enabled</name>
1255     <value>true</value>
1256     <description>Enables or disables user (aka. table) coprocessor loading.
1257     If 'false' (disabled), any table coprocessor attributes in table
1258     descriptors will be ignored. If "hbase.coprocessor.enabled" is 'false'
1259     this setting has no effect.
1260     </description>
1261   </property>
1262   <property>
1263     <name>hbase.coprocessor.region.classes</name>
1264     <value></value>
1265     <description>A comma-separated list of region observer or endpoint coprocessors
1266     that are loaded by default on all tables. For any override coprocessor method,
1267     these classes will be called in order. After implementing your own Coprocessor,
1268     add it to HBase's classpath and add the fully qualified class name here.
1269     A coprocessor can also be loaded on demand by setting HTableDescriptor or the
1270     HBase shell.</description>
1271   </property>
1272   <property>
1273     <name>hbase.coprocessor.master.classes</name>
1274     <value></value>
1275     <description>A comma-separated list of
1276     org.apache.hadoop.hbase.coprocessor.MasterObserver coprocessors that are
1277     loaded by default on the active HMaster process. For any implemented
1278     coprocessor methods, the listed classes will be called in order. After
1279     implementing your own MasterObserver, just put it in HBase's classpath
1280     and add the fully qualified class name here.</description>
1281   </property>
1282   <property>
1283       <name>hbase.coprocessor.abortonerror</name>
1284       <value>true</value>
1285       <description>Set to true to cause the hosting server (master or regionserver)
1286       to abort if a coprocessor fails to load, fails to initialize, or throws an
1287       unexpected Throwable object. Setting this to false will allow the server to
1288       continue execution but the system wide state of the coprocessor in question
1289       will become inconsistent as it will be properly executing in only a subset
1290       of servers, so this is most useful for debugging only.</description>
1291   </property>
1292   <property>
1293     <name>hbase.rest.port</name>
1294     <value>8080</value>
1295     <description>The port for the HBase REST server.</description>
1296   </property>
1297   <property>
1298     <name>hbase.rest.readonly</name>
1299     <value>false</value>
1300     <description>Defines the mode the REST server will be started in. Possible values are:
1301     false: All HTTP methods are permitted - GET/PUT/POST/DELETE.
1302     true: Only the GET method is permitted.</description>
1303   </property>
1304   <property>
1305     <name>hbase.rest.threads.max</name>
1306     <value>100</value>
1307     <description>The maximum number of threads of the REST server thread pool.
1308         Threads in the pool are reused to process REST requests. This
1309         controls the maximum number of requests processed concurrently.
1310         It may help to control the memory used by the REST server to
1311         avoid OOM issues. If the thread pool is full, incoming requests
1312         will be queued up and wait for some free threads.</description>
1313   </property>
1314   <property>
1315     <name>hbase.rest.threads.min</name>
1316     <value>2</value>
1317     <description>The minimum number of threads of the REST server thread pool.
1318         The thread pool always has at least these number of threads so
1319         the REST server is ready to serve incoming requests.</description>
1320   </property>
1321   <property>
1322     <name>hbase.rest.support.proxyuser</name>
1323     <value>false</value>
1324     <description>Enables running the REST server to support proxy-user mode.</description>
1325   </property>
1326   <property skipInDoc="true">
1327     <name>hbase.defaults.for.version</name>
1328     <value>@@@VERSION@@@</value>
1329     <description>This defaults file was compiled for version ${project.version}. This variable is used
1330     to make sure that a user doesn't have an old version of hbase-default.xml on the
1331     classpath.</description>
1332   </property>
1333   <property>
1334     <name>hbase.defaults.for.version.skip</name>
1335     <value>false</value>
1336     <description>Set to true to skip the 'hbase.defaults.for.version' check.
1337     Setting this to true can be useful in contexts other than
1338     the other side of a maven generation; i.e. running in an
1339     IDE.  You'll want to set this boolean to true to avoid
1340     seeing the RuntimeException complaint: "hbase-default.xml file
1341     seems to be for and old version of HBase (\${hbase.version}), this
1342     version is X.X.X-SNAPSHOT"</description>
1343   </property>
1344   <property>
1345     <name>hbase.table.lock.enable</name>
1346     <value>true</value>
1347     <description>Set to true to enable locking the table in zookeeper for schema change operations.
1348     Table locking from master prevents concurrent schema modifications to corrupt table
1349     state.</description>
1350   </property>
1351   <property>
1352     <name>hbase.table.max.rowsize</name>
1353     <value>1073741824</value>
1354     <description>
1355       Maximum size of single row in bytes (default is 1 Gb) for Get'ting
1356       or Scan'ning without in-row scan flag set. If row size exceeds this limit
1357       RowTooBigException is thrown to client.
1358     </description>
1359   </property>
1360   <property>
1361     <name>hbase.thrift.minWorkerThreads</name>
1362     <value>16</value>
1363     <description>The "core size" of the thread pool. New threads are created on every
1364     connection until this many threads are created.</description>
1365   </property>
1366   <property>
1367     <name>hbase.thrift.maxWorkerThreads</name>
1368     <value>1000</value>
1369     <description>The maximum size of the thread pool. When the pending request queue
1370     overflows, new threads are created until their number reaches this number.
1371     After that, the server starts dropping connections.</description>
1372   </property>
1373   <property>
1374     <name>hbase.thrift.maxQueuedRequests</name>
1375     <value>1000</value>
1376     <description>The maximum number of pending Thrift connections waiting in the queue. If
1377      there are no idle threads in the pool, the server queues requests. Only
1378      when the queue overflows, new threads are added, up to
1379      hbase.thrift.maxQueuedRequests threads.</description>
1380   </property>
1381   <property>
1382     <name>hbase.regionserver.thrift.framed</name>
1383     <value>false</value>
1384     <description>Use Thrift TFramedTransport on the server side.
1385       This is the recommended transport for thrift servers and requires a similar setting
1386       on the client side. Changing this to false will select the default transport,
1387       vulnerable to DoS when malformed requests are issued due to THRIFT-601.
1388     </description>
1389   </property>
1390   <property>
1391    <name>hbase.regionserver.thrift.framed.max_frame_size_in_mb</name>
1392     <value>2</value>
1393     <description>Default frame size when using framed transport, in MB</description>
1394   </property>
1395   <property>
1396     <name>hbase.regionserver.thrift.compact</name>
1397     <value>false</value>
1398     <description>Use Thrift TCompactProtocol binary serialization protocol.</description>
1399   </property>
1400   <property>
1401     <name>hbase.rootdir.perms</name>
1402     <value>700</value>
1403     <description>FS Permissions for the root data subdirectory in a secure (kerberos) setup.
1404     When master starts, it creates the rootdir with this permissions or sets the permissions
1405     if it does not match.</description>
1406   </property>
1407   <property>
1408     <name>hbase.wal.dir.perms</name>
1409     <value>700</value>
1410     <description>FS Permissions for the root WAL directory in a secure(kerberos) setup.
1411       When master starts, it creates the WAL dir with this permissions or sets the permissions
1412       if it does not match.</description>
1413   </property>
1414   <property>
1415     <name>hbase.data.umask.enable</name>
1416     <value>false</value>
1417     <description>Enable, if true, that file permissions should be assigned
1418       to the files written by the regionserver</description>
1419   </property>
1420   <property>
1421     <name>hbase.data.umask</name>
1422     <value>000</value>
1423     <description>File permissions that should be used to write data
1424       files when hbase.data.umask.enable is true</description>
1425   </property>
1426   <property>
1427     <name>hbase.snapshot.enabled</name>
1428     <value>true</value>
1429     <description>Set to true to allow snapshots to be taken / restored / cloned.</description>
1430   </property>
1431   <property>
1432     <name>hbase.snapshot.restore.take.failsafe.snapshot</name>
1433     <value>true</value>
1434     <description>Set to true to take a snapshot before the restore operation.
1435       The snapshot taken will be used in case of failure, to restore the previous state.
1436       At the end of the restore operation this snapshot will be deleted</description>
1437   </property>
1438   <property>
1439     <name>hbase.snapshot.restore.failsafe.name</name>
1440     <value>hbase-failsafe-{snapshot.name}-{restore.timestamp}</value>
1441     <description>Name of the failsafe snapshot taken by the restore operation.
1442       You can use the {snapshot.name}, {table.name} and {restore.timestamp} variables
1443       to create a name based on what you are restoring.</description>
1444   </property>
1445   <property>
1446     <name>hbase.snapshot.working.dir</name>
1447     <value></value>
1448     <description>Location where the snapshotting process will occur. The location of the
1449       completed snapshots will not change, but the temporary directory where the snapshot
1450       process occurs will be set to this location. This can be a separate filesystem than
1451       the root directory, for performance increase purposes. See HBASE-21098 for more
1452       information</description>
1453   </property>
1454   <property>
1455     <name>hbase.server.compactchecker.interval.multiplier</name>
1456     <value>1000</value>
1457     <description>The number that determines how often we scan to see if compaction is necessary.
1458         Normally, compactions are done after some events (such as memstore flush), but if
1459         region didn't receive a lot of writes for some time, or due to different compaction
1460         policies, it may be necessary to check it periodically. The interval between checks is
1461         hbase.server.compactchecker.interval.multiplier multiplied by
1462         hbase.server.thread.wakefrequency.</description>
1463   </property>
1464   <property>
1465     <name>hbase.lease.recovery.timeout</name>
1466     <value>900000</value>
1467     <description>How long we wait on dfs lease recovery in total before giving up.</description>
1468   </property>
1469   <property>
1470     <name>hbase.lease.recovery.dfs.timeout</name>
1471     <value>64000</value>
1472     <description>How long between dfs recover lease invocations. Should be larger than the sum of
1473         the time it takes for the namenode to issue a block recovery command as part of
1474         datanode; dfs.heartbeat.interval and the time it takes for the primary
1475         datanode, performing block recovery to timeout on a dead datanode; usually
1476         dfs.client.socket-timeout. See the end of HBASE-8389 for more.</description>
1477   </property>
1478   <property>
1479     <name>hbase.column.max.version</name>
1480     <value>1</value>
1481     <description>New column family descriptors will use this value as the default number of versions
1482       to keep.</description>
1483   </property>
1484   <property>
1485     <name>dfs.client.read.shortcircuit</name>
1486     <value></value>
1487     <description>
1488       If set to true, this configuration parameter enables short-circuit local
1489       reads.
1490     </description>
1491   </property>
1492   <property>
1493     <name>dfs.domain.socket.path</name>
1494     <value></value>
1495     <description>
1496       This is a path to a UNIX domain socket that will be used for
1497       communication between the DataNode and local HDFS clients, if
1498       dfs.client.read.shortcircuit is set to true. If the string "_PORT" is
1499       present in this path, it will be replaced by the TCP port of the DataNode.
1500       Be careful about permissions for the directory that hosts the shared
1501       domain socket; dfsclient will complain if open to other users than the HBase user.
1502     </description>
1503   </property>
1504   <property>
1505     <name>hbase.dfs.client.read.shortcircuit.buffer.size</name>
1506     <value>131072</value>
1507     <description>If the DFSClient configuration
1508     dfs.client.read.shortcircuit.buffer.size is unset, we will
1509     use what is configured here as the short circuit read default
1510     direct byte buffer size. DFSClient native default is 1MB; HBase
1511     keeps its HDFS files open so number of file blocks * 1MB soon
1512     starts to add up and threaten OOME because of a shortage of
1513     direct memory.  So, we set it down from the default.  Make
1514     it > the default hbase block size set in the HColumnDescriptor
1515     which is usually 64k.
1516     </description>
1517   </property>
1518   <property>
1519     <name>hbase.regionserver.checksum.verify</name>
1520     <value>true</value>
1521     <description>
1522         If set to true (the default), HBase verifies the checksums for hfile
1523         blocks. HBase writes checksums inline with the data when it writes out
1524         hfiles. HDFS (as of this writing) writes checksums to a separate file
1525         than the data file necessitating extra seeks.  Setting this flag saves
1526         some on i/o.  Checksum verification by HDFS will be internally disabled
1527         on hfile streams when this flag is set.  If the hbase-checksum verification
1528         fails, we will switch back to using HDFS checksums (so do not disable HDFS
1529         checksums!  And besides this feature applies to hfiles only, not to WALs).
1530         If this parameter is set to false, then hbase will not verify any checksums,
1531         instead it will depend on checksum verification being done in the HDFS client.
1532     </description>
1533   </property>
1534   <property>
1535     <name>hbase.hstore.bytes.per.checksum</name>
1536     <value>16384</value>
1537     <description>
1538         Number of bytes in a newly created checksum chunk for HBase-level
1539         checksums in hfile blocks.
1540     </description>
1541   </property>
1542   <property>
1543     <name>hbase.hstore.checksum.algorithm</name>
1544     <value>CRC32C</value>
1545     <description>
1546       Name of an algorithm that is used to compute checksums. Possible values
1547       are NULL, CRC32, CRC32C.
1548     </description>
1549   </property>
1550   <property>
1551     <name>hbase.client.scanner.max.result.size</name>
1552     <value>2097152</value>
1553     <description>Maximum number of bytes returned when calling a scanner's next method.
1554     Note that when a single row is larger than this limit the row is still returned completely.
1555     The default value is 2MB, which is good for 1ge networks.
1556     With faster and/or high latency networks this value should be increased.
1557     </description>
1558   </property>
1559   <property>
1560     <name>hbase.server.scanner.max.result.size</name>
1561     <value>104857600</value>
1562     <description>Maximum number of bytes returned when calling a scanner's next method.
1563     Note that when a single row is larger than this limit the row is still returned completely.
1564     The default value is 100MB.
1565     This is a safety setting to protect the server from OOM situations.
1566     </description>
1567   </property>
1568   <property>
1569     <name>hbase.status.published</name>
1570     <value>false</value>
1571     <description>
1572       This setting activates the publication by the master of the status of the region server.
1573       When a region server dies and its recovery starts, the master will push this information
1574       to the client application, to let them cut the connection immediately instead of waiting
1575       for a timeout.
1576     </description>
1577   </property>
1578   <property>
1579     <name>hbase.status.publisher.class</name>
1580     <value>org.apache.hadoop.hbase.master.ClusterStatusPublisher$MulticastPublisher</value>
1581     <description>
1582       Implementation of the status publication with a multicast message.
1583     </description>
1584   </property>
1585   <property>
1586     <name>hbase.status.listener.class</name>
1587     <value>org.apache.hadoop.hbase.client.ClusterStatusListener$MulticastListener</value>
1588     <description>
1589       Implementation of the status listener with a multicast message.
1590     </description>
1591   </property>
1592   <property>
1593     <name>hbase.status.multicast.address.ip</name>
1594     <value>226.1.1.3</value>
1595     <description>
1596       Multicast address to use for the status publication by multicast.
1597     </description>
1598   </property>
1599   <property>
1600     <name>hbase.status.multicast.address.port</name>
1601     <value>16100</value>
1602     <description>
1603       Multicast port to use for the status publication by multicast.
1604     </description>
1605   </property>
1606   <property>
1607     <name>hbase.dynamic.jars.dir</name>
1608     <value>${hbase.rootdir}/lib</value>
1609     <description>
1610       The directory from which the custom filter JARs can be loaded
1611       dynamically by the region server without the need to restart. However,
1612       an already loaded filter/co-processor class would not be un-loaded. See
1613       HBASE-1936 for more details.
1615       Does not apply to coprocessors.
1616     </description>
1617   </property>
1618   <property>
1619     <name>hbase.security.authentication</name>
1620     <value>simple</value>
1621     <description>
1622       Controls whether or not secure authentication is enabled for HBase.
1623       Possible values are 'simple' (no authentication), and 'kerberos'.
1624     </description>
1625   </property>
1626   <property>
1627     <name>hbase.rest.filter.classes</name>
1628     <value>org.apache.hadoop.hbase.rest.filter.GzipFilter</value>
1629     <description>
1630       Servlet filters for REST service.
1631     </description>
1632   </property>
1633   <property>
1634     <name>hbase.master.loadbalancer.class</name>
1635     <value>org.apache.hadoop.hbase.master.balancer.StochasticLoadBalancer</value>
1636     <description>
1637       Class used to execute the regions balancing when the period occurs.
1638       See the class comment for more on how it works
1639       http://hbase.apache.org/devapidocs/org/apache/hadoop/hbase/master/balancer/StochasticLoadBalancer.html
1640       It replaces the DefaultLoadBalancer as the default (since renamed
1641       as the SimpleLoadBalancer).
1642     </description>
1643   </property>
1644   <property>
1645     <name>hbase.master.loadbalance.bytable</name>
1646     <value>false</value>
1647     <description>Factor Table name when the balancer runs.
1648       Default: false.
1649     </description>
1650   </property>
1651   <property>
1652     <name>hbase.master.normalizer.class</name>
1653     <value>org.apache.hadoop.hbase.master.normalizer.SimpleRegionNormalizer</value>
1654     <description>
1655       Class used to execute the region normalization when the period occurs.
1656       See the class comment for more on how it works
1657       http://hbase.apache.org/devapidocs/org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html
1658     </description>
1659   </property>
1660 <property>
1661         <name>hbase.rest.csrf.enabled</name>
1662         <value>false</value>
1663   <description>
1664     Set to true to enable protection against cross-site request forgery (CSRF)
1665         </description>
1666 </property>
1667 <property>
1668   <name>hbase.rest-csrf.browser-useragents-regex</name>
1669   <value>^Mozilla.*,^Opera.*</value>
1670   <description>
1671     A comma-separated list of regular expressions used to match against an HTTP
1672     request's User-Agent header when protection against cross-site request
1673     forgery (CSRF) is enabled for REST server by setting
1674     hbase.rest.csrf.enabled to true.  If the incoming User-Agent matches
1675     any of these regular expressions, then the request is considered to be sent
1676     by a browser, and therefore CSRF prevention is enforced.  If the request's
1677     User-Agent does not match any of these regular expressions, then the request
1678     is considered to be sent by something other than a browser, such as scripted
1679     automation.  In this case, CSRF is not a potential attack vector, so
1680     the prevention is not enforced.  This helps achieve backwards-compatibility
1681     with existing automation that has not been updated to send the CSRF
1682     prevention header.
1683   </description>
1684 </property>
1685   <property>
1686     <name>hbase.security.exec.permission.checks</name>
1687     <value>false</value>
1688     <description>
1689       If this setting is enabled and ACL based access control is active (the
1690       AccessController coprocessor is installed either as a system coprocessor
1691       or on a table as a table coprocessor) then you must grant all relevant
1692       users EXEC privilege if they require the ability to execute coprocessor
1693       endpoint calls. EXEC privilege, like any other permission, can be
1694       granted globally to a user, or to a user on a per table or per namespace
1695       basis. For more information on coprocessor endpoints, see the coprocessor
1696       section of the HBase online manual. For more information on granting or
1697       revoking permissions using the AccessController, see the security
1698       section of the HBase online manual.
1699     </description>
1700   </property>
1701   <property>
1702     <name>hbase.procedure.regionserver.classes</name>
1703     <value></value>
1704     <description>A comma-separated list of
1705     org.apache.hadoop.hbase.procedure.RegionServerProcedureManager procedure managers that are
1706     loaded by default on the active HRegionServer process. The lifecycle methods (init/start/stop)
1707     will be called by the active HRegionServer process to perform the specific globally barriered
1708     procedure. After implementing your own RegionServerProcedureManager, just put it in
1709     HBase's classpath and add the fully qualified class name here.
1710     </description>
1711   </property>
1712     <property>
1713     <name>hbase.procedure.master.classes</name>
1714     <value></value>
1715     <description>A comma-separated list of
1716     org.apache.hadoop.hbase.procedure.MasterProcedureManager procedure managers that are
1717     loaded by default on the active HMaster process. A procedure is identified by its signature and
1718     users can use the signature and an instant name to trigger an execution of a globally barriered
1719     procedure. After implementing your own MasterProcedureManager, just put it in HBase's classpath
1720     and add the fully qualified class name here.</description>
1721   </property>
1722   <property>
1723     <name>hbase.coordinated.state.manager.class</name>
1724     <value>org.apache.hadoop.hbase.coordination.ZkCoordinatedStateManager</value>
1725     <description>Fully qualified name of class implementing coordinated state manager.</description>
1726   </property>
1727   <property>
1728     <name>hbase.regionserver.storefile.refresh.period</name>
1729     <value>0</value>
1730     <description>
1731       The period (in milliseconds) for refreshing the store files for the secondary regions. 0
1732       means this feature is disabled. Secondary regions sees new files (from flushes and
1733       compactions) from primary once the secondary region refreshes the list of files in the
1734       region (there is no notification mechanism). But too frequent refreshes might cause
1735       extra Namenode pressure. If the files cannot be refreshed for longer than HFile TTL
1736       (hbase.master.hfilecleaner.ttl) the requests are rejected. Configuring HFile TTL to a larger
1737       value is also recommended with this setting.
1738     </description>
1739   </property>
1740   <property>
1741     <name>hbase.region.replica.replication.enabled</name>
1742     <value>false</value>
1743     <description>
1744       Whether asynchronous WAL replication to the secondary region replicas is enabled or not.
1745       If this is enabled, a replication peer named "region_replica_replication" will be created
1746       which will tail the logs and replicate the mutations to region replicas for tables that
1747       have region replication > 1. If this is enabled once, disabling this replication also
1748       requires disabling the replication peer using shell or Admin java class.
1749       Replication to secondary region replicas works over standard inter-cluster replication.
1750     </description>
1751   </property>
1752   <property>
1753     <name>hbase.http.filter.initializers</name>
1754     <value>org.apache.hadoop.hbase.http.lib.StaticUserWebFilter</value>
1755     <description>
1756       A comma separated list of class names. Each class in the list must extend
1757       org.apache.hadoop.hbase.http.FilterInitializer. The corresponding Filter will
1758       be initialized. Then, the Filter will be applied to all user facing jsp
1759       and servlet web pages.
1760       The ordering of the list defines the ordering of the filters.
1761       The default StaticUserWebFilter add a user principal as defined by the
1762       hbase.http.staticuser.user property.
1763     </description>
1764   </property>
1765     <property>
1766     <name>hbase.security.visibility.mutations.checkauths</name>
1767     <value>false</value>
1768     <description>
1769       This property if enabled, will check whether the labels in the visibility
1770       expression are associated with the user issuing the mutation
1771     </description>
1772   </property>
1773   <property>
1774     <name>hbase.http.max.threads</name>
1775     <value>16</value>
1776     <description>
1777       The maximum number of threads that the HTTP Server will create in its
1778       ThreadPool.
1779     </description>
1780   </property>
1781   <property>
1782         <name>hbase.replication.rpc.codec</name>
1783         <value>org.apache.hadoop.hbase.codec.KeyValueCodecWithTags</value>
1784         <description>
1785                 The codec that is to be used when replication is enabled so that
1786                 the tags are also replicated. This is used along with HFileV3 which
1787                 supports tags in them.  If tags are not used or if the hfile version used
1788                 is HFileV2 then KeyValueCodec can be used as the replication codec. Note that
1789                 using KeyValueCodecWithTags for replication when there are no tags causes no harm.
1790         </description>
1791   </property>
1792   <property>
1793     <name>hbase.replication.source.maxthreads</name>
1794     <value>10</value>
1795     <description>
1796         The maximum number of threads any replication source will use for
1797         shipping edits to the sinks in parallel. This also limits the number of
1798         chunks each replication batch is broken into. Larger values can improve
1799         the replication throughput between the master and slave clusters. The
1800         default of 10 will rarely need to be changed.
1801     </description>
1802   </property>
1803   <!-- Static Web User Filter properties. -->
1804   <property>
1805     <name>hbase.http.staticuser.user</name>
1806     <value>dr.stack</value>
1807     <description>
1808       The user name to filter as, on static web filters
1809       while rendering content. An example use is the HDFS
1810       web UI (user to be used for browsing files).
1811     </description>
1812   </property>
1813   <property>
1814     <name>hbase.regionserver.handler.abort.on.error.percent</name>
1815     <value>0.5</value>
1816     <description>The percent of region server RPC threads failed to abort RS.
1817     -1 Disable aborting; 0 Abort if even a single handler has died;
1818     0.x Abort only when this percent of handlers have died;
1819     1 Abort only all of the handers have died.</description>
1820   </property>
1821   <!-- Mob properties. -->
1822   <property>
1823     <name>hbase.mob.file.cache.size</name>
1824     <value>1000</value>
1825     <description>
1826       Number of opened file handlers to cache.
1827       A larger value will benefit reads by providing more file handlers per mob
1828       file cache and would reduce frequent file opening and closing.
1829       However, if this is set too high, this could lead to a "too many opened file handlers"
1830       The default value is 1000.
1831     </description>
1832   </property>
1833   <property>
1834     <name>hbase.mob.cache.evict.period</name>
1835     <value>3600</value>
1836     <description>
1837       The amount of time in seconds before the mob cache evicts cached mob files.
1838       The default value is 3600 seconds.
1839     </description>
1840   </property>
1841   <property>
1842     <name>hbase.mob.cache.evict.remain.ratio</name>
1843     <value>0.5f</value>
1844     <description>
1845       The ratio (between 0.0 and 1.0) of files that remains cached after an eviction
1846       is triggered when the number of cached mob files exceeds the hbase.mob.file.cache.size.
1847       The default value is 0.5f.
1848     </description>
1849   </property>
1850   <property>
1851     <name>hbase.master.mob.cleaner.period</name>
1852     <value>86400</value>
1853     <description>
1854       The period that MobFileCleanerChore runs. The unit is second.
1855       The default value is one day. The MOB file name uses only the date part of
1856       the file creation time in it. We use this time for deciding TTL expiry of
1857       the files. So the removal of TTL expired files might be delayed. The max
1858       delay might be 24 hrs.
1859     </description>
1860   </property>
1861   <property>
1862     <name>hbase.mob.major.compaction.region.batch.size</name>
1863     <value>0</value>
1864     <description>
1865       The max number of a MOB table regions that is allowed in a batch of the mob compaction. By
1866       setting this number to a custom value, users can control the overall effect of a major
1867       compaction of a large MOB-enabled table.
1868       Default is 0 - means no limit - all regions of a MOB table will be compacted at once
1869     </description>
1870   </property>
1871   <property>
1872     <name>hbase.mob.compaction.chore.period</name>
1873     <value>604800</value>
1874     <description>
1875       The period that MobCompactionChore runs. The unit is second.
1876       The default value is one week.
1877     </description>
1878   </property>
1879   <property>
1880     <name>hbase.snapshot.master.timeout.millis</name>
1881     <value>300000</value>
1882     <description>
1883        Timeout for master for the snapshot procedure execution.
1884     </description>
1885    </property>
1886      <property>
1887     <name>hbase.snapshot.region.timeout</name>
1888     <value>300000</value>
1889     <description>
1890        Timeout for regionservers to keep threads in snapshot request pool waiting.
1891     </description>
1892    </property>
1893    <property>
1894     <name>hbase.rpc.rows.warning.threshold</name>
1895     <value>5000</value>
1896     <description>
1897       Number of rows in a batch operation above which a warning will be logged.
1898     </description>
1899   </property>
1900   <property>
1901     <name>hbase.master.wait.on.service.seconds</name>
1902     <value>30</value>
1903     <description>Default is 5 minutes. Make it 30 seconds for tests. See
1904     HBASE-19794 for some context.</description>
1905   </property>
1906   <property>
1907     <name>hbase.master.cleaner.snapshot.interval</name>
1908     <value>1800000</value>
1909     <description>
1910       Snapshot Cleanup chore interval in milliseconds.
1911       The cleanup thread keeps running at this interval
1912       to find all snapshots that are expired based on TTL
1913       and delete them.
1914     </description>
1915   </property>
1916   <property>
1917     <name>hbase.master.snapshot.ttl</name>
1918     <value>0</value>
1919     <description>
1920       Default Snapshot TTL to be considered when the user does not specify TTL while
1921       creating snapshot. Default value 0 indicates FOREVERE - snapshot should not be
1922       automatically deleted until it is manually deleted
1923     </description>
1924   </property>
1925   <property>
1926     <name>hbase.master.regions.recovery.check.interval</name>
1927     <value>1200000</value>
1928     <description>
1929       Regions Recovery Chore interval in milliseconds.
1930       This chore keeps running at this interval to
1931       find all regions with configurable max store file ref count
1932       and reopens them.
1933     </description>
1934   </property>
1935   <property>
1936     <name>hbase.regions.recovery.store.file.ref.count</name>
1937     <value>-1</value>
1938     <description>
1939       Very large number of ref count on a compacted
1940       store file indicates that it is a ref leak
1941       on that object(compacted store file).
1942       Such files can not be removed after
1943       it is invalidated via compaction.
1944       Only way to recover in such scenario is to
1945       reopen the region which can release
1946       all resources, like the refcount,
1947       leases, etc. This config represents Store files Ref
1948       Count threshold value considered for reopening
1949       regions. Any region with compacted store files
1950       ref count > this value would be eligible for
1951       reopening by master. Here, we get the max
1952       refCount among all refCounts on all
1953       compacted away store files that belong to a
1954       particular region. Default value -1 indicates
1955       this feature is turned off. Only positive
1956       integer value should be provided to
1957       enable this feature.
1958     </description>
1959   </property>
1960   <property>
1961     <name>hbase.regionserver.slowlog.ringbuffer.size</name>
1962     <value>256</value>
1963     <description>
1964       Default size of ringbuffer to be maintained by each RegionServer in order
1965       to store online slowlog responses. This is an in-memory ring buffer of
1966       requests that were judged to be too slow in addition to the responseTooSlow
1967       logging. The in-memory representation would be complete.
1968       For more details, please look into Doc Section:
1969       Get Slow Response Log from shell
1970     </description>
1971   </property>
1972   <property>
1973     <name>hbase.regionserver.slowlog.buffer.enabled</name>
1974     <value>false</value>
1975     <description>
1976       Indicates whether RegionServers have ring buffer running for storing
1977       Online Slow logs in FIFO manner with limited entries. The size of
1978       the ring buffer is indicated by config: hbase.regionserver.slowlog.ringbuffer.size
1979       The default value is false, turn this on and get latest slowlog
1980       responses with complete data.
1981     </description>
1982   </property>
1983   <property>
1984     <name>hbase.regionserver.slowlog.systable.enabled</name>
1985     <value>false</value>
1986     <description>
1987       Should be enabled only if hbase.regionserver.slowlog.buffer.enabled is enabled. If enabled
1988       (true), all slow/large RPC logs would be persisted to system table hbase:slowlog (in addition
1989       to in-memory ring buffer at each RegionServer). The records are stored in increasing
1990       order of time. Operators can scan the table with various combination of ColumnValueFilter.
1991       More details are provided in the doc section:
1992       "Get Slow/Large Response Logs from System table hbase:slowlog"
1993     </description>
1994   </property>
1995   <property>
1996     <name>hbase.master.metafixer.max.merge.count</name>
1997     <value>64</value>
1998     <description>
1999       Maximum regions to merge at a time when we fix overlaps noted in
2000       CJ consistency report, but avoid merging 100 regions in one go!
2001     </description>
2002   </property>
2003   <property>
2004     <name>hbase.rpc.rows.size.threshold.reject</name>
2005     <value>false</value>
2006     <description>
2007       If value is true, RegionServer will abort batch requests of Put/Delete with number of rows
2008       in a batch operation exceeding threshold defined by value of config:
2009       hbase.rpc.rows.warning.threshold. The default value is false and hence, by default, only
2010       warning will be logged. This config should be turned on to prevent RegionServer from serving
2011       very large batch size of rows and this way we can improve CPU usages by discarding
2012       too large batch request.
2013     </description>
2014   </property>
2015   <property>
2016     <name>hbase.namedqueue.provider.classes</name>
2017     <value>org.apache.hadoop.hbase.namequeues.impl.SlowLogQueueService,org.apache.hadoop.hbase.namequeues.impl.BalancerDecisionQueueService,org.apache.hadoop.hbase.namequeues.impl.BalancerRejectionQueueService</value>
2018     <description>
2019       Default values for NamedQueueService implementors. This comma separated full class names
2020       represent all implementors of NamedQueueService that we would like to be invoked by
2021       LogEvent handler service. One example of NamedQueue service is SlowLogQueueService which
2022       is used to store slow/large RPC logs in ringbuffer at each RegionServer.
2023       All implementors of NamedQueueService should be found under package:
2024       "org.apache.hadoop.hbase.namequeues.impl"
2025     </description>
2026   </property>
2027   <property>
2028     <name>hbase.master.balancer.decision.buffer.enabled</name>
2029     <value>false</value>
2030     <description>
2031       Indicates whether active HMaster has ring buffer running for storing
2032       balancer decisions in FIFO manner with limited entries. The size of
2033       the ring buffer is indicated by config: hbase.master.balancer.decision.queue.size
2034     </description>
2035   </property>
2036   <property>
2037     <name>hbase.master.balancer.rejection.buffer.enabled</name>
2038     <value>false</value>
2039     <description>
2040       Indicates whether active HMaster has ring buffer running for storing
2041       balancer rejection in FIFO manner with limited entries. The size of
2042       the ring buffer is indicated by config: hbase.master.balancer.rejection.queue.size
2043     </description>
2044   </property>
2045   <property>
2046     <name>hbase.locality.inputstream.derive.enabled</name>
2047     <value>false</value>
2048     <description>
2049       If true, derive StoreFile locality metrics from the underlying DFSInputStream
2050       backing reads for that StoreFile. This value will update as the DFSInputStream's
2051       block locations are updated over time. Otherwise, locality is computed on StoreFile
2052       open, and cached until the StoreFile is closed.
2053     </description>
2054   </property>
2055   <property>
2056     <name>hbase.locality.inputstream.derive.cache.period</name>
2057     <value>60000</value>
2058     <description>
2059       If deriving StoreFile locality metrics from the underlying DFSInputStream, how
2060       long should the derived values be cached for. The derivation process may involve
2061       hitting the namenode, if the DFSInputStream's block list is incomplete.
2062     </description>
2063   </property>
2064 </configuration>