Return-Path: X-Original-To: apmail-hbase-commits-archive@www.apache.org Delivered-To: apmail-hbase-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id B29EB18D44 for ; Thu, 10 Dec 2015 17:12:40 +0000 (UTC) Received: (qmail 55370 invoked by uid 500); 10 Dec 2015 17:12:24 -0000 Delivered-To: apmail-hbase-commits-archive@hbase.apache.org Received: (qmail 55041 invoked by uid 500); 10 Dec 2015 17:12:24 -0000 Mailing-List: contact commits-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list commits@hbase.apache.org Received: (qmail 54258 invoked by uid 99); 10 Dec 2015 17:12:23 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 10 Dec 2015 17:12:23 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 74688E17DA; Thu, 10 Dec 2015 17:12:23 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: misty@apache.org To: commits@hbase.apache.org Date: Thu, 10 Dec 2015 17:12:28 -0000 Message-Id: <392b7c19cc9041258196a43e0e1bab0d@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [06/51] [partial] hbase-site git commit: Published site at 26ac60b03f80c9215103a02db783341e67037753. http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f68717a0/devapidocs/src-html/org/apache/hadoop/hbase/HConstants.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/HConstants.html b/devapidocs/src-html/org/apache/hadoop/hbase/HConstants.html index 11d594c..ef5bdbb 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/HConstants.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/HConstants.html @@ -858,412 +858,424 @@ 850 REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service"; 851 public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT = 852 "org.apache.hadoop.hbase.replication.regionserver.Replication"; -853 -854 /** HBCK special code name used as server name when manipulating ZK nodes */ -855 public static final String HBCK_CODE_NAME = "HBCKServerName"; -856 -857 public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER = -858 "hbase.regionserver.hostname.seen.by.master"; -859 -860 public static final String HBASE_MASTER_LOGCLEANER_PLUGINS = -861 "hbase.master.logcleaner.plugins"; +853 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled"; +854 public static final boolean REPLICATION_BULKLOAD_ENABLE_DEFAULT = false; +855 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */ +856 public static final String REPLICATION_CLUSTER_ID = "hbase.replication.cluster.id"; +857 /** +858 * Directory where the source cluster file system client configuration are placed which is used by +859 * sink cluster to copy HFiles from source cluster file system +860 */ +861 public static final String REPLICATION_CONF_DIR = "hbase.replication.conf.dir"; 862 -863 public static final String HBASE_REGION_SPLIT_POLICY_KEY = -864 "hbase.regionserver.region.split.policy"; +863 /** Maximum time to retry for a failed bulk load request */ +864 public static final String BULKLOAD_MAX_RETRIES_NUMBER = "hbase.bulkload.retries.number"; 865 -866 /** Whether nonces are enabled; default is true. */ -867 public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled"; +866 /** HBCK special code name used as server name when manipulating ZK nodes */ +867 public static final String HBCK_CODE_NAME = "HBCKServerName"; 868 -869 /** -870 * Configuration key for the size of the block cache -871 */ -872 public static final String HFILE_BLOCK_CACHE_SIZE_KEY = -873 "hfile.block.cache.size"; +869 public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER = +870 "hbase.regionserver.hostname.seen.by.master"; +871 +872 public static final String HBASE_MASTER_LOGCLEANER_PLUGINS = +873 "hbase.master.logcleaner.plugins"; 874 -875 public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f; -876 -877 /* -878 * Minimum percentage of free heap necessary for a successful cluster startup. -879 */ -880 public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f; -881 -882 public static final Pattern CP_HTD_ATTR_KEY_PATTERN = -883 Pattern.compile("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE); -884 -885 /** -886 * <pre> -887 * Pattern that matches a coprocessor specification. Form is: -888 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]} -889 * where arguments are {@code <KEY> '=' <VALUE> [,...]} -890 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2} -891 * </pre> -892 */ -893 public static final Pattern CP_HTD_ATTR_VALUE_PATTERN = -894 Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$"); -895 -896 public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+"; -897 public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+"; -898 public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile( -899 "(" + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" + -900 CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?"); -901 -902 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */ -903 public static final int SOCKET_RETRY_WAIT_MS = 200; -904 -905 /** Host name of the local machine */ -906 public static final String LOCALHOST = "localhost"; +875 public static final String HBASE_REGION_SPLIT_POLICY_KEY = +876 "hbase.regionserver.region.split.policy"; +877 +878 /** Whether nonces are enabled; default is true. */ +879 public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled"; +880 +881 /** +882 * Configuration key for the size of the block cache +883 */ +884 public static final String HFILE_BLOCK_CACHE_SIZE_KEY = +885 "hfile.block.cache.size"; +886 +887 public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f; +888 +889 /* +890 * Minimum percentage of free heap necessary for a successful cluster startup. +891 */ +892 public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f; +893 +894 public static final Pattern CP_HTD_ATTR_KEY_PATTERN = +895 Pattern.compile("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE); +896 +897 /** +898 * <pre> +899 * Pattern that matches a coprocessor specification. Form is: +900 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]} +901 * where arguments are {@code <KEY> '=' <VALUE> [,...]} +902 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2} +903 * </pre> +904 */ +905 public static final Pattern CP_HTD_ATTR_VALUE_PATTERN = +906 Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$"); 907 -908 /** -909 * If this parameter is set to true, then hbase will read -910 * data and then verify checksums. Checksum verification -911 * inside hdfs will be switched off. However, if the hbase-checksum -912 * verification fails, then it will switch back to using -913 * hdfs checksums for verifiying data that is being read from storage. -914 * -915 * If this parameter is set to false, then hbase will not -916 * verify any checksums, instead it will depend on checksum verification -917 * being done in the hdfs client. -918 */ -919 public static final String HBASE_CHECKSUM_VERIFICATION = -920 "hbase.regionserver.checksum.verify"; -921 -922 public static final String LOCALHOST_IP = "127.0.0.1"; -923 -924 /** Conf key that enables unflushed WAL edits directly being replayed to region servers */ -925 public static final String DISTRIBUTED_LOG_REPLAY_KEY = "hbase.master.distributed.log.replay"; -926 public static final boolean DEFAULT_DISTRIBUTED_LOG_REPLAY_CONFIG = false; -927 public static final String DISALLOW_WRITES_IN_RECOVERING = -928 "hbase.regionserver.disallow.writes.when.recovering"; -929 public static final boolean DEFAULT_DISALLOW_WRITES_IN_RECOVERING_CONFIG = false; -930 -931 public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count"; -932 public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30; +908 public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+"; +909 public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+"; +910 public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile( +911 "(" + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" + +912 CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?"); +913 +914 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */ +915 public static final int SOCKET_RETRY_WAIT_MS = 200; +916 +917 /** Host name of the local machine */ +918 public static final String LOCALHOST = "localhost"; +919 +920 /** +921 * If this parameter is set to true, then hbase will read +922 * data and then verify checksums. Checksum verification +923 * inside hdfs will be switched off. However, if the hbase-checksum +924 * verification fails, then it will switch back to using +925 * hdfs checksums for verifiying data that is being read from storage. +926 * +927 * If this parameter is set to false, then hbase will not +928 * verify any checksums, instead it will depend on checksum verification +929 * being done in the hdfs client. +930 */ +931 public static final String HBASE_CHECKSUM_VERIFICATION = +932 "hbase.regionserver.checksum.verify"; 933 -934 /* -935 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT: -936 * -1 => Disable aborting -937 * 0 => Abort if even a single handler has died -938 * 0.x => Abort only when this percent of handlers have died -939 * 1 => Abort only all of the handers have died -940 */ -941 public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = -942 "hbase.regionserver.handler.abort.on.error.percent"; -943 public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5; -944 -945 //High priority handlers to deal with admin requests and system table operation requests -946 public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = -947 "hbase.regionserver.metahandler.count"; -948 public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20; -949 -950 public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT = -951 "hbase.regionserver.replication.handler.count"; -952 public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3; -953 -954 public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count"; -955 public static final int DEFAULT_MASTER_HANLDER_COUNT = 25; +934 public static final String LOCALHOST_IP = "127.0.0.1"; +935 +936 /** Conf key that enables unflushed WAL edits directly being replayed to region servers */ +937 public static final String DISTRIBUTED_LOG_REPLAY_KEY = "hbase.master.distributed.log.replay"; +938 public static final boolean DEFAULT_DISTRIBUTED_LOG_REPLAY_CONFIG = false; +939 public static final String DISALLOW_WRITES_IN_RECOVERING = +940 "hbase.regionserver.disallow.writes.when.recovering"; +941 public static final boolean DEFAULT_DISALLOW_WRITES_IN_RECOVERING_CONFIG = false; +942 +943 public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count"; +944 public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30; +945 +946 /* +947 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT: +948 * -1 => Disable aborting +949 * 0 => Abort if even a single handler has died +950 * 0.x => Abort only when this percent of handlers have died +951 * 1 => Abort only all of the handers have died +952 */ +953 public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = +954 "hbase.regionserver.handler.abort.on.error.percent"; +955 public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5; 956 -957 /** Conf key that specifies timeout value to wait for a region ready */ -958 public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT = -959 "hbase.master.log.replay.wait.region.timeout"; -960 -961 /** Conf key for enabling meta replication */ -962 public static final String USE_META_REPLICAS = "hbase.meta.replicas.use"; -963 public static final boolean DEFAULT_USE_META_REPLICAS = false; -964 public static final String META_REPLICAS_NUM = "hbase.meta.replica.count"; -965 public static final int DEFAULT_META_REPLICA_NUM = 1; -966 -967 /** -968 * The name of the configuration parameter that specifies -969 * the number of bytes in a newly created checksum chunk. -970 */ -971 public static final String BYTES_PER_CHECKSUM = -972 "hbase.hstore.bytes.per.checksum"; -973 -974 /** -975 * The name of the configuration parameter that specifies -976 * the name of an algorithm that is used to compute checksums -977 * for newly created blocks. -978 */ -979 public static final String CHECKSUM_TYPE_NAME = -980 "hbase.hstore.checksum.algorithm"; -981 -982 /** Enable file permission modification from standard hbase */ -983 public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable"; -984 /** File permission umask to use when creating hbase data files */ -985 public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask"; -986 -987 /** Configuration name of WAL Compression */ -988 public static final String ENABLE_WAL_COMPRESSION = -989 "hbase.regionserver.wal.enablecompression"; -990 -991 /** Configuration name of WAL storage policy -992 * Valid values are: -993 * NONE: no preference in destination of block replicas -994 * ONE_SSD: place only one block replica in SSD and the remaining in default storage -995 * and ALL_SSD: place all block replicas on SSD -996 * -997 * See http://hadoop.apache.org/docs/r2.6.0/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/ -998 public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy"; -999 public static final String DEFAULT_WAL_STORAGE_POLICY = "NONE"; -1000 -1001 /** Region in Transition metrics threshold time */ -1002 public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD = -1003 "hbase.metrics.rit.stuck.warning.threshold"; -1004 -1005 public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop"; -1006 -1007 /** -1008 * The byte array represents for NO_NEXT_INDEXED_KEY; -1009 * The actual value is irrelevant because this is always compared by reference. -1010 */ -1011 public static final Cell NO_NEXT_INDEXED_KEY = new KeyValue(); -1012 /** delimiter used between portions of a region name */ -1013 public static final int DELIMITER = ','; -1014 -1015 /** -1016 * QOS attributes: these attributes are used to demarcate RPC call processing -1017 * by different set of handlers. For example, HIGH_QOS tagged methods are -1018 * handled by high priority handlers. -1019 */ -1020 // normal_QOS < QOS_threshold < replication_QOS < replay_QOS < admin_QOS < high_QOS -1021 public static final int NORMAL_QOS = 0; -1022 public static final int QOS_THRESHOLD = 10; -1023 public static final int HIGH_QOS = 200; -1024 public static final int REPLICATION_QOS = 5; -1025 public static final int REPLAY_QOS = 6; -1026 public static final int ADMIN_QOS = 100; -1027 public static final int SYSTEMTABLE_QOS = HIGH_QOS; -1028 -1029 /** Directory under /hbase where archived hfiles are stored */ -1030 public static final String HFILE_ARCHIVE_DIRECTORY = "archive"; -1031 -1032 /** -1033 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for -1034 * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and -1035 * uni-directional. -1036 */ -1037 public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot"; -1038 -1039 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */ -1040 public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot"; -1041 -1042 /** Temporary directory used for table creation and deletion */ -1043 public static final String HBASE_TEMP_DIRECTORY = ".tmp"; +957 //High priority handlers to deal with admin requests and system table operation requests +958 public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = +959 "hbase.regionserver.metahandler.count"; +960 public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20; +961 +962 public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT = +963 "hbase.regionserver.replication.handler.count"; +964 public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3; +965 +966 public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count"; +967 public static final int DEFAULT_MASTER_HANLDER_COUNT = 25; +968 +969 /** Conf key that specifies timeout value to wait for a region ready */ +970 public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT = +971 "hbase.master.log.replay.wait.region.timeout"; +972 +973 /** Conf key for enabling meta replication */ +974 public static final String USE_META_REPLICAS = "hbase.meta.replicas.use"; +975 public static final boolean DEFAULT_USE_META_REPLICAS = false; +976 public static final String META_REPLICAS_NUM = "hbase.meta.replica.count"; +977 public static final int DEFAULT_META_REPLICA_NUM = 1; +978 +979 /** +980 * The name of the configuration parameter that specifies +981 * the number of bytes in a newly created checksum chunk. +982 */ +983 public static final String BYTES_PER_CHECKSUM = +984 "hbase.hstore.bytes.per.checksum"; +985 +986 /** +987 * The name of the configuration parameter that specifies +988 * the name of an algorithm that is used to compute checksums +989 * for newly created blocks. +990 */ +991 public static final String CHECKSUM_TYPE_NAME = +992 "hbase.hstore.checksum.algorithm"; +993 +994 /** Enable file permission modification from standard hbase */ +995 public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable"; +996 /** File permission umask to use when creating hbase data files */ +997 public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask"; +998 +999 /** Configuration name of WAL Compression */ +1000 public static final String ENABLE_WAL_COMPRESSION = +1001 "hbase.regionserver.wal.enablecompression"; +1002 +1003 /** Configuration name of WAL storage policy +1004 * Valid values are: +1005 * NONE: no preference in destination of block replicas +1006 * ONE_SSD: place only one block replica in SSD and the remaining in default storage +1007 * and ALL_SSD: place all block replicas on SSD +1008 * +1009 * See http://hadoop.apache.org/docs/r2.6.0/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/ +1010 public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy"; +1011 public static final String DEFAULT_WAL_STORAGE_POLICY = "NONE"; +1012 +1013 /** Region in Transition metrics threshold time */ +1014 public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD = +1015 "hbase.metrics.rit.stuck.warning.threshold"; +1016 +1017 public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop"; +1018 +1019 /** +1020 * The byte array represents for NO_NEXT_INDEXED_KEY; +1021 * The actual value is irrelevant because this is always compared by reference. +1022 */ +1023 public static final Cell NO_NEXT_INDEXED_KEY = new KeyValue(); +1024 /** delimiter used between portions of a region name */ +1025 public static final int DELIMITER = ','; +1026 +1027 /** +1028 * QOS attributes: these attributes are used to demarcate RPC call processing +1029 * by different set of handlers. For example, HIGH_QOS tagged methods are +1030 * handled by high priority handlers. +1031 */ +1032 // normal_QOS < QOS_threshold < replication_QOS < replay_QOS < admin_QOS < high_QOS +1033 public static final int NORMAL_QOS = 0; +1034 public static final int QOS_THRESHOLD = 10; +1035 public static final int HIGH_QOS = 200; +1036 public static final int REPLICATION_QOS = 5; +1037 public static final int REPLAY_QOS = 6; +1038 public static final int ADMIN_QOS = 100; +1039 public static final int SYSTEMTABLE_QOS = HIGH_QOS; +1040 +1041 /** Directory under /hbase where archived hfiles are stored */ +1042 public static final String HFILE_ARCHIVE_DIRECTORY = "archive"; +1043 1044 /** -1045 * The period (in milliseconds) between computing region server point in time metrics -1046 */ -1047 public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period"; -1048 public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000; -1049 /** Directories that are not HBase table directories */ -1050 public static final List<String> HBASE_NON_TABLE_DIRS = -1051 Collections.unmodifiableList(Arrays.asList(new String[] { -1052 HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME -1053 })); -1054 -1055 /** Directories that are not HBase user table directories */ -1056 public static final List<String> HBASE_NON_USER_TABLE_DIRS = -1057 Collections.unmodifiableList(Arrays.asList((String[])ArrayUtils.addAll( -1058 new String[] { TableName.META_TABLE_NAME.getNameAsString() }, -1059 HBASE_NON_TABLE_DIRS.toArray()))); -1060 -1061 /** Health script related settings. */ -1062 public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location"; -1063 public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout"; -1064 public static final String HEALTH_CHORE_WAKE_FREQ = -1065 "hbase.node.health.script.frequency"; -1066 public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000; -1067 /** -1068 * The maximum number of health check failures a server can encounter consecutively. -1069 */ -1070 public static final String HEALTH_FAILURE_THRESHOLD = -1071 "hbase.node.health.failure.threshold"; -1072 public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3; -1073 -1074 -1075 /** -1076 * Setting to activate, or not, the publication of the status by the master. Default -1077 * notification is by a multicast message. -1078 */ -1079 public static final String STATUS_PUBLISHED = "hbase.status.published"; -1080 public static final boolean STATUS_PUBLISHED_DEFAULT = false; -1081 -1082 /** -1083 * IP to use for the multicast status messages between the master and the clients. -1084 * The default address is chosen as one among others within the ones suitable for multicast -1085 * messages. -1086 */ -1087 public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip"; -1088 public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3"; -1089 -1090 /** -1091 * The address to use for binding the local socket for receiving multicast. Defaults to -1092 * 0.0.0.0. -1093 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a> -1094 */ -1095 public static final String STATUS_MULTICAST_BIND_ADDRESS = -1096 "hbase.status.multicast.bind.address.ip"; -1097 public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0"; -1098 -1099 /** -1100 * The port to use for the multicast messages. -1101 */ -1102 public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port"; -1103 public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100; -1104 -1105 public static final long NO_NONCE = 0; -1106 -1107 /** Default cipher for encryption */ -1108 public static final String CIPHER_AES = "AES"; -1109 -1110 /** Configuration key for the crypto algorithm provider, a class name */ -1111 public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider"; -1112 -1113 /** Configuration key for the crypto key provider, a class name */ -1114 public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider"; -1115 -1116 /** Configuration key for the crypto key provider parameters */ -1117 public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY = -1118 "hbase.crypto.keyprovider.parameters"; -1119 -1120 /** Configuration key for the name of the master key for the cluster, a string */ -1121 public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name"; -1122 -1123 /** Configuration key for the name of the alternate master key for the cluster, a string */ -1124 public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY = -1125 "hbase.crypto.master.alternate.key.name"; -1126 -1127 /** Configuration key for the algorithm to use when encrypting the WAL, a string */ -1128 public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm"; -1129 -1130 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */ -1131 public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name"; -1132 -1133 /** Configuration key for the algorithm used for creating jks key, a string */ -1134 public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm"; -1135 -1136 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */ -1137 public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY = -1138 "hbase.crypto.alternate.key.algorithm"; -1139 -1140 /** Configuration key for enabling WAL encryption, a boolean */ -1141 public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption"; -1142 -1143 /** Configuration key for setting RPC codec class name */ -1144 public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec"; -1145 -1146 /** Configuration key for setting replication codec class name */ -1147 public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec"; -1148 -1149 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ -1150 public static final String REPLICATION_SOURCE_MAXTHREADS_KEY = -1151 "hbase.replication.source.maxthreads"; -1152 -1153 public static final int REPLICATION_SOURCE_MAXTHREADS_DEFAULT = 10; +1045 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for +1046 * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and +1047 * uni-directional. +1048 */ +1049 public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot"; +1050 +1051 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */ +1052 public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot"; +1053 +1054 /** Temporary directory used for table creation and deletion */ +1055 public static final String HBASE_TEMP_DIRECTORY = ".tmp"; +1056 /** +1057 * The period (in milliseconds) between computing region server point in time metrics +1058 */ +1059 public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period"; +1060 public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000; +1061 /** Directories that are not HBase table directories */ +1062 public static final List<String> HBASE_NON_TABLE_DIRS = +1063 Collections.unmodifiableList(Arrays.asList(new String[] { +1064 HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME +1065 })); +1066 +1067 /** Directories that are not HBase user table directories */ +1068 public static final List<String> HBASE_NON_USER_TABLE_DIRS = +1069 Collections.unmodifiableList(Arrays.asList((String[])ArrayUtils.addAll( +1070 new String[] { TableName.META_TABLE_NAME.getNameAsString() }, +1071 HBASE_NON_TABLE_DIRS.toArray()))); +1072 +1073 /** Health script related settings. */ +1074 public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location"; +1075 public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout"; +1076 public static final String HEALTH_CHORE_WAKE_FREQ = +1077 "hbase.node.health.script.frequency"; +1078 public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000; +1079 /** +1080 * The maximum number of health check failures a server can encounter consecutively. +1081 */ +1082 public static final String HEALTH_FAILURE_THRESHOLD = +1083 "hbase.node.health.failure.threshold"; +1084 public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3; +1085 +1086 +1087 /** +1088 * Setting to activate, or not, the publication of the status by the master. Default +1089 * notification is by a multicast message. +1090 */ +1091 public static final String STATUS_PUBLISHED = "hbase.status.published"; +1092 public static final boolean STATUS_PUBLISHED_DEFAULT = false; +1093 +1094 /** +1095 * IP to use for the multicast status messages between the master and the clients. +1096 * The default address is chosen as one among others within the ones suitable for multicast +1097 * messages. +1098 */ +1099 public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip"; +1100 public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3"; +1101 +1102 /** +1103 * The address to use for binding the local socket for receiving multicast. Defaults to +1104 * 0.0.0.0. +1105 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a> +1106 */ +1107 public static final String STATUS_MULTICAST_BIND_ADDRESS = +1108 "hbase.status.multicast.bind.address.ip"; +1109 public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0"; +1110 +1111 /** +1112 * The port to use for the multicast messages. +1113 */ +1114 public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port"; +1115 public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100; +1116 +1117 public static final long NO_NONCE = 0; +1118 +1119 /** Default cipher for encryption */ +1120 public static final String CIPHER_AES = "AES"; +1121 +1122 /** Configuration key for the crypto algorithm provider, a class name */ +1123 public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider"; +1124 +1125 /** Configuration key for the crypto key provider, a class name */ +1126 public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider"; +1127 +1128 /** Configuration key for the crypto key provider parameters */ +1129 public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY = +1130 "hbase.crypto.keyprovider.parameters"; +1131 +1132 /** Configuration key for the name of the master key for the cluster, a string */ +1133 public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name"; +1134 +1135 /** Configuration key for the name of the alternate master key for the cluster, a string */ +1136 public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY = +1137 "hbase.crypto.master.alternate.key.name"; +1138 +1139 /** Configuration key for the algorithm to use when encrypting the WAL, a string */ +1140 public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm"; +1141 +1142 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */ +1143 public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name"; +1144 +1145 /** Configuration key for the algorithm used for creating jks key, a string */ +1146 public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm"; +1147 +1148 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */ +1149 public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY = +1150 "hbase.crypto.alternate.key.algorithm"; +1151 +1152 /** Configuration key for enabling WAL encryption, a boolean */ +1153 public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption"; 1154 -1155 /** Config for pluggable consensus provider */ -1156 public static final String HBASE_COORDINATED_STATE_MANAGER_CLASS = -1157 "hbase.coordinated.state.manager.class"; -1158 -1159 /** Configuration key for SplitLog manager timeout */ -1160 public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout"; -1161 -1162 /** -1163 * Configuration keys for Bucket cache -1164 */ -1165 // TODO moving these bucket cache implementation specific configs to this level is violation of -1166 // encapsulation. But as these has to be referred from hbase-common and bucket cache -1167 // sits in hbase-server, there were no other go! Can we move the cache implementation to -1168 // hbase-common? -1169 -1170 /** -1171 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path -1172 * to the file that will host the file-based cache. See BucketCache#getIOEngineFromName() for -1173 * list of supported ioengine options. -1174 * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache. -1175 */ -1176 public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine"; -1177 -1178 /** -1179 * When using bucket cache, this is a float that EITHER represents a percentage of total heap -1180 * memory size to give to the cache (if &lt; 1.0) OR, it is the capacity in -1181 * megabytes of the cache. -1182 */ -1183 public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size"; -1184 -1185 /** -1186 * HConstants for fast fail on the client side follow +1155 /** Configuration key for setting RPC codec class name */ +1156 public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec"; +1157 +1158 /** Configuration key for setting replication codec class name */ +1159 public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec"; +1160 +1161 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ +1162 public static final String REPLICATION_SOURCE_MAXTHREADS_KEY = +1163 "hbase.replication.source.maxthreads"; +1164 +1165 public static final int REPLICATION_SOURCE_MAXTHREADS_DEFAULT = 10; +1166 +1167 /** Config for pluggable consensus provider */ +1168 public static final String HBASE_COORDINATED_STATE_MANAGER_CLASS = +1169 "hbase.coordinated.state.manager.class"; +1170 +1171 /** Configuration key for SplitLog manager timeout */ +1172 public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout"; +1173 +1174 /** +1175 * Configuration keys for Bucket cache +1176 */ +1177 // TODO moving these bucket cache implementation specific configs to this level is violation of +1178 // encapsulation. But as these has to be referred from hbase-common and bucket cache +1179 // sits in hbase-server, there were no other go! Can we move the cache implementation to +1180 // hbase-common? +1181 +1182 /** +1183 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path +1184 * to the file that will host the file-based cache. See BucketCache#getIOEngineFromName() for +1185 * list of supported ioengine options. +1186 * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache. 1187 */ -1188 /** -1189 * Config for enabling/disabling the fast fail mode. -1190 */ -1191 public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED = -1192 "hbase.client.fast.fail.mode.enabled"; -1193 -1194 public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT = -1195 false; +1188 public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine"; +1189 +1190 /** +1191 * When using bucket cache, this is a float that EITHER represents a percentage of total heap +1192 * memory size to give to the cache (if &lt; 1.0) OR, it is the capacity in +1193 * megabytes of the cache. +1194 */ +1195 public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size"; 1196 -1197 public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS = -1198 "hbase.client.fastfail.threshold"; -1199 -1200 public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT = -1201 60000; -1202 -1203 public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS = -1204 "hbase.client.fast.fail.cleanup.duration"; +1197 /** +1198 * HConstants for fast fail on the client side follow +1199 */ +1200 /** +1201 * Config for enabling/disabling the fast fail mode. +1202 */ +1203 public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED = +1204 "hbase.client.fast.fail.mode.enabled"; 1205 -1206 public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT = -1207 600000; +1206 public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT = +1207 false; 1208 -1209 public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL = -1210 "hbase.client.fast.fail.interceptor.impl"; +1209 public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS = +1210 "hbase.client.fastfail.threshold"; 1211 -1212 /** Config key for if the server should send backpressure and if the client should listen to -1213 * that backpressure from the server */ -1214 public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled"; -1215 public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false; -1216 -1217 public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY = -1218 "hbase.heap.occupancy.low_water_mark"; -1219 public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f; -1220 public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY = -1221 "hbase.heap.occupancy.high_water_mark"; -1222 public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f; +1212 public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT = +1213 60000; +1214 +1215 public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS = +1216 "hbase.client.fast.fail.cleanup.duration"; +1217 +1218 public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT = +1219 600000; +1220 +1221 public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL = +1222 "hbase.client.fast.fail.interceptor.impl"; 1223 -1224 /** -1225 * The max number of threads used for splitting storefiles in parallel during -1226 * the region split process. -1227 */ -1228 public static final String REGION_SPLIT_THREADS_MAX = -1229 "hbase.regionserver.region.split.threads.max"; -1230 -1231 /** Canary config keys */ -1232 public static final String HBASE_CANARY_WRITE_DATA_TTL_KEY = "hbase.canary.write.data.ttl"; -1233 -1234 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_LOWERLIMIT_KEY = -1235 "hbase.canary.write.perserver.regions.lowerLimit"; -1236 -1237 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_UPPERLIMIT_KEY = -1238 "hbase.canary.write.perserver.regions.upperLimit"; -1239 -1240 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size"; -1241 -1242 public static final String HBASE_CANARY_WRITE_TABLE_CHECK_PERIOD_KEY = -1243 "hbase.canary.write.table.check.period"; -1244 -1245 /** -1246 * Configuration keys for programmatic JAAS configuration for secured ZK interaction -1247 */ -1248 public static final String ZK_CLIENT_KEYTAB_FILE = "hbase.zookeeper.client.keytab.file"; -1249 public static final String ZK_CLIENT_KERBEROS_PRINCIPAL = -1250 "hbase.zookeeper.client.kerberos.principal"; -1251 public static final String ZK_SERVER_KEYTAB_FILE = "hbase.zookeeper.server.keytab.file"; -1252 public static final String ZK_SERVER_KERBEROS_PRINCIPAL = -1253 "hbase.zookeeper.server.kerberos.principal"; -1254 -1255 private HConstants() { -1256 // Can't be instantiated with this ctor. -1257 } -1258} +1224 /** Config key for if the server should send backpressure and if the client should listen to +1225 * that backpressure from the server */ +1226 public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled"; +1227 public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false; +1228 +1229 public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY = +1230 "hbase.heap.occupancy.low_water_mark"; +1231 public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f; +1232 public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY = +1233 "hbase.heap.occupancy.high_water_mark"; +1234 public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f; +1235 +1236 /** +1237 * The max number of threads used for splitting storefiles in parallel during +1238 * the region split process. +1239 */ +1240 public static final String REGION_SPLIT_THREADS_MAX = +1241 "hbase.regionserver.region.split.threads.max"; +1242 +1243 /** Canary config keys */ +1244 public static final String HBASE_CANARY_WRITE_DATA_TTL_KEY = "hbase.canary.write.data.ttl"; +1245 +1246 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_LOWERLIMIT_KEY = +1247 "hbase.canary.write.perserver.regions.lowerLimit"; +1248 +1249 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_UPPERLIMIT_KEY = +1250 "hbase.canary.write.perserver.regions.upperLimit"; +1251 +1252 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size"; +1253 +1254 public static final String HBASE_CANARY_WRITE_TABLE_CHECK_PERIOD_KEY = +1255 "hbase.canary.write.table.check.period"; +1256 +1257 /** +1258 * Configuration keys for programmatic JAAS configuration for secured ZK interaction +1259 */ +1260 public static final String ZK_CLIENT_KEYTAB_FILE = "hbase.zookeeper.client.keytab.file"; +1261 public static final String ZK_CLIENT_KERBEROS_PRINCIPAL = +1262 "hbase.zookeeper.client.kerberos.principal"; +1263 public static final String ZK_SERVER_KEYTAB_FILE = "hbase.zookeeper.server.keytab.file"; +1264 public static final String ZK_SERVER_KERBEROS_PRINCIPAL = +1265 "hbase.zookeeper.server.kerberos.principal"; +1266 +1267 private HConstants() { +1268 // Can't be instantiated with this ctor. +1269 } +1270}