You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by ct...@apache.org on 2021/07/13 20:42:28 UTC
[accumulo] branch main updated: Add since information to properties
(#2190)
This is an automated email from the ASF dual-hosted git repository.
ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/main by this push:
new ff835f2 Add since information to properties (#2190)
ff835f2 is described below
commit ff835f28445d2e0a1221da78e3656ba4c8c1240f
Author: Luke Foster <84...@users.noreply.github.com>
AuthorDate: Tue Jul 13 16:42:20 2021 -0400
Add since information to properties (#2190)
* Add since information to properties
* Add links to replaced by properties
* Minor improvement to wording for description of 'experimental'
* Add strikethrough for deprecated properties' keys in addition to their
descriptions
* Add clarifying information to new manager properties 'since'
information, so that it shows the original name with its original
availability, but the new name since 2.1.0
* Replace ternary statements with if-else statements for easier
readability and maintainability.
Co-authored-by: Dom G. <47...@users.noreply.github.com>
Co-authored-by: Christopher Tubbs <ct...@apache.org>
---
.../accumulo/core/conf/ConfigurationDocGen.java | 66 +-
.../org/apache/accumulo/core/conf/Property.java | 846 +++++++++++++--------
2 files changed, 568 insertions(+), 344 deletions(-)
diff --git a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
index ba60da2..13b89e3 100644
--- a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
+++ b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
@@ -70,43 +70,63 @@ public class ConfigurationDocGen {
+ " that is copied from Accumulo build (from core/target/generated-docs)" + " -->\n");
doc.println("Below are properties set in `accumulo.properties` or the"
+ " Accumulo shell that configure Accumulo servers (i.e tablet server,"
- + " manager, etc). Properties labeled 'Experimental' could be part of an incomplete"
- + " feature or have a higher risk of changing in the future.\n");
+ + " manager, etc). Properties labeled 'Experimental' should not be considered stable"
+ + " and have a higher risk of changing in the future.\n");
}
void prefixSection(Property prefix) {
boolean depr = prefix.isDeprecated();
- doc.print("| <a name=\"" + prefix.getKey().replace(".", "_") + "prefix\" class=\"prop\"></a> **"
- + prefix.getKey() + "*** | ");
- doc.print(prefix.isExperimental() ? "**Experimental.** " : "");
- doc.println(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |");
+ String key = strike("<a name=\"" + prefix.getKey().replace(".", "_")
+ + "prefix\" class=\"prop\"></a> **" + prefix.getKey() + "***", depr);
+ String description = prefix.isExperimental() ? "**Experimental**<br>" : "";
+ description += "**Available since:** " + prefix.availableSince() + "<br>";
+ if (depr) {
+ description += "*Deprecated since:* " + prefix.deprecatedSince() + "<br>";
+ if (prefix.isReplaced())
+ description +=
+ "*Replaced by:* " + "<a href=\"#" + prefix.replacedBy().getKey().replace(".", "_")
+ + "prefix\">" + prefix.replacedBy() + "</a><br>";
+ }
+ description += strike(sanitize(prefix.getDescription()), depr);
+ doc.println("| " + key + " | " + description + " |");
}
void property(Property prop) {
boolean depr = prop.isDeprecated();
- doc.print("| <a name=\"" + prop.getKey().replace(".", "_") + "\" class=\"prop\"></a> "
- + prop.getKey() + " | ");
- doc.print(prop.isExperimental() ? "**Experimental.** " : "");
- doc.print(
- (depr ? "**Deprecated.** " : "") + strike(sanitize(prop.getDescription()), depr) + "<br>");
- doc.print(strike("**type:** " + prop.getType().name(), depr) + ", ");
- doc.print(strike("**zk mutable:** " + isZooKeeperMutable(prop), depr) + ", ");
+ String key = strike(
+ "<a name=\"" + prop.getKey().replace(".", "_") + "\" class=\"prop\"></a> " + prop.getKey(),
+ depr);
+ String description = prop.isExperimental() ? "**Experimental**<br>" : "";
+ description += "**Available since:** ";
+ if (prop.getKey().startsWith("manager.")
+ && (prop.availableSince().startsWith("1.") || prop.availableSince().startsWith("2.0"))) {
+ description += "2.1.0 (since " + prop.availableSince() + " as *master."
+ + prop.getKey().substring(8) + "*)" + "<br>";
+ } else {
+ description += prop.availableSince() + "<br>";
+ }
+ if (depr) {
+ description += "*Deprecated since:* " + prop.deprecatedSince() + "<br>";
+ if (prop.isReplaced())
+ description += "*Replaced by:* " + "<a href=\"#"
+ + prop.replacedBy().getKey().replace(".", "_") + "\">" + prop.replacedBy() + "</a><br>";
+ }
+ description += strike(sanitize(prop.getDescription()), depr) + "<br>"
+ + strike("**type:** " + prop.getType().name(), depr) + ", "
+ + strike("**zk mutable:** " + isZooKeeperMutable(prop), depr) + ", ";
String defaultValue = sanitize(prop.getDefaultValue()).trim();
if (defaultValue.isEmpty()) {
- defaultValue = strike("**default value:** empty", depr);
+ description += strike("**default value:** empty", depr);
} else if (defaultValue.contains("\n")) {
// deal with multi-line values, skip strikethrough of value
- defaultValue = strike("**default value:** ", depr) + "\n```\n" + defaultValue + "\n```\n";
+ description += strike("**default value:** ", depr) + "\n```\n" + defaultValue + "\n```\n";
+ } else if (prop.getType() == PropertyType.CLASSNAME
+ && defaultValue.startsWith("org.apache.accumulo")) {
+ description += strike("**default value:** " + "{% jlink -f " + defaultValue + " %}", depr);
} else {
- if (prop.getType() == PropertyType.CLASSNAME
- && defaultValue.startsWith("org.apache.accumulo")) {
- defaultValue = strike("**default value:** " + "{% jlink -f " + defaultValue + " %}", depr);
- } else {
- defaultValue = strike("**default value:** " + "`" + defaultValue + "`", depr);
- }
+ description += strike("**default value:** " + "`" + defaultValue + "`", depr);
}
- doc.println(defaultValue + " |");
+ doc.println("| " + key + " | " + description + " |");
}
private String strike(String s, boolean isDeprecated) {
diff --git a/core/src/main/java/org/apache/accumulo/core/conf/Property.java b/core/src/main/java/org/apache/accumulo/core/conf/Property.java
index 3093990..a9fd2a0 100644
--- a/core/src/main/java/org/apache/accumulo/core/conf/Property.java
+++ b/core/src/main/java/org/apache/accumulo/core/conf/Property.java
@@ -49,49 +49,53 @@ public enum Property {
// across all nodes in an instance)
RPC_PREFIX("rpc.", null, PropertyType.PREFIX,
"Properties in this category related to the configuration of SSL keys for"
- + " RPC. See also instance.ssl.enabled"),
+ + " RPC. See also instance.ssl.enabled",
+ "1.6.0"),
RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH,
- "Path of the keystore file for the server's private SSL key"),
+ "Path of the keystore file for the server's private SSL key", "1.6.0"),
@Sensitive
RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING,
"Password used to encrypt the SSL private keystore. "
- + "Leave blank to use the Accumulo instance secret"),
+ + "Leave blank to use the Accumulo instance secret",
+ "1.6.0"),
RPC_SSL_KEYSTORE_TYPE("rpc.javax.net.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.6.0"),
RPC_SSL_TRUSTSTORE_PATH("rpc.javax.net.ssl.trustStore", "", PropertyType.PATH,
- "Path of the truststore file for the root cert"),
+ "Path of the truststore file for the root cert", "1.6.0"),
@Sensitive
RPC_SSL_TRUSTSTORE_PASSWORD("rpc.javax.net.ssl.trustStorePassword", "", PropertyType.STRING,
- "Password used to encrypt the SSL truststore. Leave blank to use no password"),
+ "Password used to encrypt the SSL truststore. Leave blank to use no password", "1.6.0"),
RPC_SSL_TRUSTSTORE_TYPE("rpc.javax.net.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.6.0"),
RPC_USE_JSSE("rpc.useJsse", "false", PropertyType.BOOLEAN,
"Use JSSE system properties to configure SSL rather than the " + RPC_PREFIX.getKey()
- + "javax.net.ssl.* Accumulo properties"),
+ + "javax.net.ssl.* Accumulo properties",
+ "1.6.0"),
RPC_SSL_CIPHER_SUITES("rpc.ssl.cipher.suites", "", PropertyType.STRING,
- "Comma separated list of cipher suites that can be used by accepted connections"),
+ "Comma separated list of cipher suites that can be used by accepted connections", "1.6.1"),
RPC_SSL_ENABLED_PROTOCOLS("rpc.ssl.server.enabled.protocols", "TLSv1.2", PropertyType.STRING,
- "Comma separated list of protocols that can be used to accept connections"),
+ "Comma separated list of protocols that can be used to accept connections", "1.6.2"),
RPC_SSL_CLIENT_PROTOCOL("rpc.ssl.client.protocol", "TLSv1.2", PropertyType.STRING,
"The protocol used to connect to a secure server, must be in the list of enabled protocols "
- + "on the server side (rpc.ssl.server.enabled.protocols)"),
- /**
- * @since 1.7.0
- */
+ + "on the server side (rpc.ssl.server.enabled.protocols)",
+ "1.6.2"),
RPC_SASL_QOP("rpc.sasl.qop", "auth", PropertyType.STRING,
"The quality of protection to be used with SASL. Valid values are 'auth', 'auth-int',"
- + " and 'auth-conf'"),
+ + " and 'auth-conf'",
+ "1.7.0"),
// instance properties (must be the same for every node in an instance)
INSTANCE_PREFIX("instance.", null, PropertyType.PREFIX,
"Properties in this category must be consistent throughout a cloud. "
- + "This is enforced and servers won't be able to communicate if these differ."),
+ + "This is enforced and servers won't be able to communicate if these differ.",
+ "1.3.5"),
INSTANCE_ZK_HOST("instance.zookeeper.host", "localhost:2181", PropertyType.HOSTLIST,
- "Comma separated list of zookeeper servers"),
+ "Comma separated list of zookeeper servers", "1.3.5"),
INSTANCE_ZK_TIMEOUT("instance.zookeeper.timeout", "30s", PropertyType.TIMEDURATION,
"Zookeeper session timeout; "
+ "max value when represented as milliseconds should be no larger than "
- + Integer.MAX_VALUE),
+ + Integer.MAX_VALUE,
+ "1.3.5"),
@Sensitive
INSTANCE_SECRET("instance.secret", "DEFAULT", PropertyType.STRING,
"A secret unique to a given instance that all servers must know in order"
@@ -101,7 +105,8 @@ public enum Property {
+ " everywhere. Before using the ChangeSecret tool, make sure Accumulo is not"
+ " running and you are logged in as the user that controls Accumulo files in"
+ " HDFS. To use the ChangeSecret tool, run the command: ./bin/accumulo"
- + " org.apache.accumulo.server.util.ChangeSecret"),
+ + " org.apache.accumulo.server.util.ChangeSecret",
+ "1.3.5"),
INSTANCE_VOLUMES("instance.volumes", "", PropertyType.STRING,
"A comma separated list of dfs uris to use. Files will be stored across"
+ " these filesystems. In some situations, the first volume in this list"
@@ -113,7 +118,8 @@ public enum Property {
+ " will not create new files in that location, however Accumulo can still"
+ " reference files created at that location before the config change. To use"
+ " a comma or other reserved characters in a URI use standard URI hex"
- + " encoding. For example replace commas with %2C."),
+ + " encoding. For example replace commas with %2C.",
+ "1.6.0"),
INSTANCE_VOLUMES_REPLACEMENTS("instance.volumes.replacements", "", PropertyType.STRING,
"Since accumulo stores absolute URIs changing the location of a namenode "
+ "could prevent Accumulo from starting. The property helps deal with "
@@ -125,276 +131,320 @@ public enum Property {
+ "Replacements must be configured for use. To see which volumes are "
+ "currently in use, run 'accumulo admin volumes -l'. To use a comma or "
+ "other reserved characters in a URI use standard URI hex encoding. For "
- + "example replace commas with %2C."),
+ + "example replace commas with %2C.",
+ "1.6.0"),
INSTANCE_VOLUMES_UPGRADE_RELATIVE("instance.volumes.upgrade.relative", "", PropertyType.STRING,
"The volume dfs uri containing relative tablet file paths. Relative paths may exist in the metadata from "
+ "versions prior to 1.6. This property is only required if a relative path is detected "
- + "during the upgrade process and will only be used once."),
+ + "during the upgrade process and will only be used once.",
+ "2.1.0"),
@Experimental // interface uses unstable internal types, use with caution
INSTANCE_SECURITY_AUTHENTICATOR("instance.security.authenticator",
"org.apache.accumulo.server.security.handler.ZKAuthenticator", PropertyType.CLASSNAME,
"The authenticator class that accumulo will use to determine if a user "
- + "has privilege to perform an action"),
+ + "has privilege to perform an action",
+ "1.5.0"),
@Experimental // interface uses unstable internal types, use with caution
INSTANCE_SECURITY_AUTHORIZOR("instance.security.authorizor",
"org.apache.accumulo.server.security.handler.ZKAuthorizor", PropertyType.CLASSNAME,
"The authorizor class that accumulo will use to determine what labels a "
- + "user has privilege to see"),
+ + "user has privilege to see",
+ "1.5.0"),
@Experimental // interface uses unstable internal types, use with caution
INSTANCE_SECURITY_PERMISSION_HANDLER("instance.security.permissionHandler",
"org.apache.accumulo.server.security.handler.ZKPermHandler", PropertyType.CLASSNAME,
"The permission handler class that accumulo will use to determine if a "
- + "user has privilege to perform an action"),
+ + "user has privilege to perform an action",
+ "1.5.0"),
INSTANCE_RPC_SSL_ENABLED("instance.rpc.ssl.enabled", "false", PropertyType.BOOLEAN,
"Use SSL for socket connections from clients and among accumulo services. "
- + "Mutually exclusive with SASL RPC configuration."),
+ + "Mutually exclusive with SASL RPC configuration.",
+ "1.6.0"),
INSTANCE_RPC_SSL_CLIENT_AUTH("instance.rpc.ssl.clientAuth", "false", PropertyType.BOOLEAN,
- "Require clients to present certs signed by a trusted root"),
- /**
- * @since 1.7.0
- */
+ "Require clients to present certs signed by a trusted root", "1.6.0"),
INSTANCE_RPC_SASL_ENABLED("instance.rpc.sasl.enabled", "false", PropertyType.BOOLEAN,
"Configures Thrift RPCs to require SASL with GSSAPI which supports "
- + "Kerberos authentication. Mutually exclusive with SSL RPC configuration."),
+ + "Kerberos authentication. Mutually exclusive with SSL RPC configuration.",
+ "1.7.0"),
INSTANCE_RPC_SASL_ALLOWED_USER_IMPERSONATION("instance.rpc.sasl.allowed.user.impersonation", "",
PropertyType.STRING,
"One-line configuration property controlling what users are allowed to "
- + "impersonate other users"),
+ + "impersonate other users",
+ "1.7.1"),
INSTANCE_RPC_SASL_ALLOWED_HOST_IMPERSONATION("instance.rpc.sasl.allowed.host.impersonation", "",
PropertyType.STRING,
"One-line configuration property controlling the network locations "
- + "(hostnames) that are allowed to impersonate other users"),
+ + "(hostnames) that are allowed to impersonate other users",
+ "1.7.1"),
// Crypto-related properties
@Experimental
INSTANCE_CRYPTO_PREFIX("instance.crypto.opts.", null, PropertyType.PREFIX,
- "Properties related to on-disk file encryption."),
+ "Properties related to on-disk file encryption.", "2.0.0"),
@Experimental
@Sensitive
INSTANCE_CRYPTO_SENSITIVE_PREFIX("instance.crypto.opts.sensitive.", null, PropertyType.PREFIX,
- "Sensitive properties related to on-disk file encryption."),
+ "Sensitive properties related to on-disk file encryption.", "2.0.0"),
@Experimental
INSTANCE_CRYPTO_SERVICE("instance.crypto.service",
"org.apache.accumulo.core.spi.crypto.NoCryptoService", PropertyType.CLASSNAME,
"The class which executes on-disk file encryption. The default does nothing. To enable "
+ "encryption, replace this classname with an implementation of the"
- + "org.apache.accumulo.core.spi.crypto.CryptoService interface."),
+ + "org.apache.accumulo.core.spi.crypto.CryptoService interface.",
+ "2.0.0"),
// general properties
GENERAL_PREFIX("general.", null, PropertyType.PREFIX,
"Properties in this category affect the behavior of accumulo overall, but"
- + " do not have to be consistent throughout a cloud."),
+ + " do not have to be consistent throughout a cloud.",
+ "1.3.5"),
@Deprecated(since = "2.0.0")
GENERAL_DYNAMIC_CLASSPATHS(
org.apache.accumulo.start.classloader.vfs.AccumuloVFSClassLoader.DYNAMIC_CLASSPATH_PROPERTY_NAME,
org.apache.accumulo.start.classloader.vfs.AccumuloVFSClassLoader.DEFAULT_DYNAMIC_CLASSPATH_VALUE,
PropertyType.STRING,
- "This property is deprecated since 2.0.0. A list of all of the places where changes "
+ "A list of all of the places where changes "
+ "in jars or classes will force a reload of the classloader. Built-in dynamic class "
+ "loading will be removed in a future version. If this is needed, consider overriding "
+ "the Java system class loader with one that has this feature "
+ "(https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html#getSystemClassLoader--). "
+ "Additionally, this property no longer does property interpolation of environment "
+ "variables, such as '$ACCUMULO_HOME'. Use commons-configuration syntax,"
- + "'${env:ACCUMULO_HOME}' instead."),
+ + "'${env:ACCUMULO_HOME}' instead.",
+ "1.3.5"),
GENERAL_CONTEXT_CLASSLOADER_FACTORY("general.context.class.loader.factory", "",
PropertyType.CLASSNAME,
"Name of classloader factory to be used to create classloaders for named contexts,"
- + " such as per-table contexts set by `table.class.loader.context`."),
+ + " such as per-table contexts set by `table.class.loader.context`.",
+ "2.1.0"),
GENERAL_RPC_TIMEOUT("general.rpc.timeout", "120s", PropertyType.TIMEDURATION,
- "Time to wait on I/O for simple, short RPC calls"),
+ "Time to wait on I/O for simple, short RPC calls", "1.3.5"),
@Experimental
GENERAL_RPC_SERVER_TYPE("general.rpc.server.type", "", PropertyType.STRING,
"Type of Thrift server to instantiate, see "
+ "org.apache.accumulo.server.rpc.ThriftServerType for more information. "
- + "Only useful for benchmarking thrift servers"),
+ + "Only useful for benchmarking thrift servers",
+ "1.7.0"),
GENERAL_KERBEROS_KEYTAB("general.kerberos.keytab", "", PropertyType.PATH,
- "Path to the kerberos keytab to use. Leave blank if not using kerberoized hdfs"),
+ "Path to the kerberos keytab to use. Leave blank if not using kerberoized hdfs", "1.4.1"),
GENERAL_KERBEROS_PRINCIPAL("general.kerberos.principal", "", PropertyType.STRING,
"Name of the kerberos principal to use. _HOST will automatically be "
+ "replaced by the machines hostname in the hostname portion of the "
- + "principal. Leave blank if not using kerberoized hdfs"),
+ + "principal. Leave blank if not using kerberoized hdfs",
+ "1.4.1"),
GENERAL_KERBEROS_RENEWAL_PERIOD("general.kerberos.renewal.period", "30s",
PropertyType.TIMEDURATION,
"The amount of time between attempts to perform Kerberos ticket renewals."
+ " This does not equate to how often tickets are actually renewed (which is"
- + " performed at 80% of the ticket lifetime)."),
+ + " performed at 80% of the ticket lifetime).",
+ "1.6.5"),
GENERAL_MAX_MESSAGE_SIZE("general.server.message.size.max", "1G", PropertyType.BYTES,
- "The maximum size of a message that can be sent to a server."),
+ "The maximum size of a message that can be sent to a server.", "1.5.0"),
GENERAL_SIMPLETIMER_THREADPOOL_SIZE("general.server.simpletimer.threadpool.size", "1",
- PropertyType.COUNT, "The number of threads to use for " + "server-internal scheduled tasks"),
+ PropertyType.COUNT, "The number of threads to use for " + "server-internal scheduled tasks",
+ "1.7.0"),
// If you update the default type, be sure to update the default used for initialization failures
// in VolumeManagerImpl
@Experimental
GENERAL_VOLUME_CHOOSER("general.volume.chooser", RandomVolumeChooser.class.getName(),
PropertyType.CLASSNAME,
- "The class that will be used to select which volume will be used to create new files."),
+ "The class that will be used to select which volume will be used to create new files.",
+ "1.6.0"),
GENERAL_SECURITY_CREDENTIAL_PROVIDER_PATHS("general.security.credential.provider.paths", "",
- PropertyType.STRING, "Comma-separated list of paths to CredentialProviders"),
+ PropertyType.STRING, "Comma-separated list of paths to CredentialProviders", "1.6.1"),
GENERAL_ARBITRARY_PROP_PREFIX("general.custom.", null, PropertyType.PREFIX,
"Prefix to be used for user defined system-wide properties. This may be"
+ " particularly useful for system-wide configuration for various"
+ " user-implementations of pluggable Accumulo features, such as the balancer"
- + " or volume chooser."),
+ + " or volume chooser.",
+ "2.0.0"),
GENERAL_DELEGATION_TOKEN_LIFETIME("general.delegation.token.lifetime", "7d",
PropertyType.TIMEDURATION,
- "The length of time that delegation tokens and secret keys are valid"),
+ "The length of time that delegation tokens and secret keys are valid", "1.7.0"),
GENERAL_DELEGATION_TOKEN_UPDATE_INTERVAL("general.delegation.token.update.interval", "1d",
- PropertyType.TIMEDURATION, "The length of time between generation of new secret keys"),
+ PropertyType.TIMEDURATION, "The length of time between generation of new secret keys",
+ "1.7.0"),
GENERAL_MAX_SCANNER_RETRY_PERIOD("general.max.scanner.retry.period", "5s",
PropertyType.TIMEDURATION,
- "The maximum amount of time that a Scanner should wait before retrying a failed RPC"),
+ "The maximum amount of time that a Scanner should wait before retrying a failed RPC",
+ "1.7.3"),
// properties that are specific to manager server behavior
MANAGER_PREFIX("manager.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the manager server."),
+ "Properties in this category affect the behavior of the manager server. "
+ + "Since 2.1.0, all properties in this category replace the old `master.*` names.",
+ "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.MANAGER_PREFIX)
MASTER_PREFIX("master.", null, PropertyType.PREFIX,
"Properties in this category affect the behavior of the manager (formerly named master) server. "
+ "Since 2.1.0, all properties in this category are deprecated and replaced with corresponding "
+ "`manager.*` properties. The old `master.*` names can still be used until at release 3.0, but a warning "
- + "will be emitted. Configuration files should be updated to use the new property names."),
+ + "will be emitted. Configuration files should be updated to use the new property names.",
+ "1.3.5"),
MANAGER_CLIENTPORT("manager.port.client", "9999", PropertyType.PORT,
- "The port used for handling client connections on the manager"),
+ "The port used for handling client connections on the manager", "1.3.5"),
MANAGER_TABLET_BALANCER("manager.tablet.balancer",
"org.apache.accumulo.core.spi.balancer.TableLoadBalancer", PropertyType.CLASSNAME,
"The balancer class that accumulo will use to make tablet assignment and "
- + "migration decisions."),
+ + "migration decisions.",
+ "1.3.5"),
MANAGER_BULK_RETRIES("manager.bulk.retries", "3", PropertyType.COUNT,
- "The number of attempts to bulk import a RFile before giving up."),
+ "The number of attempts to bulk import a RFile before giving up.", "1.4.0"),
MANAGER_BULK_THREADPOOL_SIZE("manager.bulk.threadpool.size", "5", PropertyType.COUNT,
- "The number of threads to use when coordinating a bulk import."),
+ "The number of threads to use when coordinating a bulk import.", "1.4.0"),
MANAGER_BULK_THREADPOOL_TIMEOUT("manager.bulk.threadpool.timeout", "0s",
PropertyType.TIMEDURATION,
- "The time after which bulk import threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which bulk import threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
MANAGER_BULK_TIMEOUT("manager.bulk.timeout", "5m", PropertyType.TIMEDURATION,
- "The time to wait for a tablet server to process a bulk import request"),
+ "The time to wait for a tablet server to process a bulk import request", "1.4.3"),
MANAGER_RENAME_THREADS("manager.rename.threadpool.size", "20", PropertyType.COUNT,
- "The number of threads to use when renaming user files during table import or bulk ingest."),
+ "The number of threads to use when renaming user files during table import or bulk ingest.",
+ "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = MANAGER_RENAME_THREADS)
MANAGER_BULK_RENAME_THREADS("manager.bulk.rename.threadpool.size", "20", PropertyType.COUNT,
- "This property is deprecated since 2.1.0. The number of threads to use when moving user files to bulk ingest "
- + "directories under accumulo control"),
+ "The number of threads to use when moving user files to bulk ingest "
+ + "directories under accumulo control",
+ "1.7.0"),
MANAGER_BULK_TSERVER_REGEX("manager.bulk.tserver.regex", "", PropertyType.STRING,
- "Regular expression that defines the set of Tablet Servers that will perform bulk imports"),
+ "Regular expression that defines the set of Tablet Servers that will perform bulk imports",
+ "2.0.0"),
MANAGER_MINTHREADS("manager.server.threads.minimum", "20", PropertyType.COUNT,
- "The minimum number of threads to use to handle incoming requests."),
+ "The minimum number of threads to use to handle incoming requests.", "1.4.0"),
MANAGER_MINTHREADS_TIMEOUT("manager.server.threads.timeout", "0s", PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
MANAGER_THREADCHECK("manager.server.threadcheck.time", "1s", PropertyType.TIMEDURATION,
- "The time between adjustments of the server thread pool."),
+ "The time between adjustments of the server thread pool.", "1.4.0"),
MANAGER_RECOVERY_DELAY("manager.recovery.delay", "10s", PropertyType.TIMEDURATION,
"When a tablet server's lock is deleted, it takes time for it to "
- + "completely quit. This delay gives it time before log recoveries begin."),
+ + "completely quit. This delay gives it time before log recoveries begin.",
+ "1.5.0"),
MANAGER_LEASE_RECOVERY_WAITING_PERIOD("manager.lease.recovery.interval", "5s",
PropertyType.TIMEDURATION,
- "The amount of time to wait after requesting a write-ahead log to be recovered"),
+ "The amount of time to wait after requesting a write-ahead log to be recovered", "1.5.0"),
MANAGER_WAL_CLOSER_IMPLEMENTATION("manager.wal.closer.implementation",
"org.apache.accumulo.server.manager.recovery.HadoopLogCloser", PropertyType.CLASSNAME,
- "A class that implements a mechanism to steal write access to a write-ahead log"),
+ "A class that implements a mechanism to steal write access to a write-ahead log", "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.MANAGER_WAL_CLOSER_IMPLEMENTATION)
MANAGER_WALOG_CLOSER_IMPLEMETATION("manager.walog.closer.implementation",
"org.apache.accumulo.server.manager.recovery.HadoopLogCloser", PropertyType.CLASSNAME,
- "A class that implements a mechanism to steal write access to a write-ahead log"),
+ "A class that implements a mechanism to steal write access to a write-ahead log", "1.5.0"),
MANAGER_FATE_METRICS_ENABLED("manager.fate.metrics.enabled", "true", PropertyType.BOOLEAN,
- "Enable reporting of FATE metrics in JMX (and logging with Hadoop Metrics2"),
+ "Enable reporting of FATE metrics in JMX (and logging with Hadoop Metrics2", "1.9.3"),
MANAGER_FATE_METRICS_MIN_UPDATE_INTERVAL("manager.fate.metrics.min.update.interval", "60s",
- PropertyType.TIMEDURATION, "Limit calls from metric sinks to zookeeper to update interval"),
+ PropertyType.TIMEDURATION, "Limit calls from metric sinks to zookeeper to update interval",
+ "1.9.3"),
MANAGER_FATE_THREADPOOL_SIZE("manager.fate.threadpool.size", "4", PropertyType.COUNT,
"The number of threads used to run fault-tolerant executions (FATE)."
- + " These are primarily table operations like merge."),
+ + " These are primarily table operations like merge.",
+ "1.4.3"),
MANAGER_REPLICATION_SCAN_INTERVAL("manager.replication.status.scan.interval", "30s",
PropertyType.TIMEDURATION,
"Amount of time to sleep before scanning the status section of the "
- + "replication table for new data"),
+ + "replication table for new data",
+ "1.7.0"),
MANAGER_REPLICATION_COORDINATOR_PORT("manager.replication.coordinator.port", "10001",
- PropertyType.PORT, "Port for the replication coordinator service"),
+ PropertyType.PORT, "Port for the replication coordinator service", "1.7.0"),
MANAGER_REPLICATION_COORDINATOR_MINTHREADS("manager.replication.coordinator.minthreads", "4",
- PropertyType.COUNT, "Minimum number of threads dedicated to answering coordinator requests"),
+ PropertyType.COUNT, "Minimum number of threads dedicated to answering coordinator requests",
+ "1.7.0"),
MANAGER_REPLICATION_COORDINATOR_THREADCHECK("manager.replication.coordinator.threadcheck.time",
"5s", PropertyType.TIMEDURATION,
- "The time between adjustments of the coordinator thread pool"),
+ "The time between adjustments of the coordinator thread pool", "1.7.0"),
MANAGER_STATUS_THREAD_POOL_SIZE("manager.status.threadpool.size", "0", PropertyType.COUNT,
"The number of threads to use when fetching the tablet server status for balancing. Zero "
- + "indicates an unlimited number of threads will be used."),
+ + "indicates an unlimited number of threads will be used.",
+ "1.8.0"),
MANAGER_METADATA_SUSPENDABLE("manager.metadata.suspendable", "false", PropertyType.BOOLEAN,
"Allow tablets for the " + MetadataTable.NAME
- + " table to be suspended via table.suspend.duration."),
+ + " table to be suspended via table.suspend.duration.",
+ "1.8.0"),
MANAGER_STARTUP_TSERVER_AVAIL_MIN_COUNT("manager.startup.tserver.avail.min.count", "0",
PropertyType.COUNT,
"Minimum number of tservers that need to be registered before manager will "
+ "start tablet assignment - checked at manager initialization, when manager gets lock. "
+ " When set to 0 or less, no blocking occurs. Default is 0 (disabled) to keep original "
- + " behaviour. Added with version 1.10"),
+ + " behaviour. Added with version 1.10",
+ "1.10.0"),
MANAGER_STARTUP_TSERVER_AVAIL_MAX_WAIT("manager.startup.tserver.avail.max.wait", "0",
PropertyType.TIMEDURATION,
"Maximum time manager will wait for tserver available threshold "
+ "to be reached before continuing. When set to 0 or less, will block "
+ "indefinitely. Default is 0 to block indefinitely. Only valid when tserver available "
- + "threshold is set greater than 0. Added with version 1.10"),
+ + "threshold is set greater than 0. Added with version 1.10",
+ "1.10.0"),
// properties that are specific to tablet server behavior
TSERV_PREFIX("tserver.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the tablet servers"),
+ "Properties in this category affect the behavior of the tablet servers", "1.3.5"),
TSERV_CLIENT_TIMEOUT("tserver.client.timeout", "3s", PropertyType.TIMEDURATION,
- "Time to wait for clients to continue scans before closing a session."),
+ "Time to wait for clients to continue scans before closing a session.", "1.3.5"),
TSERV_DEFAULT_BLOCKSIZE("tserver.default.blocksize", "1M", PropertyType.BYTES,
- "Specifies a default blocksize for the tserver caches"),
+ "Specifies a default blocksize for the tserver caches", "1.3.5"),
TSERV_CACHE_MANAGER_IMPL("tserver.cache.manager.class",
"org.apache.accumulo.core.file.blockfile.cache.lru.LruBlockCacheManager", PropertyType.STRING,
"Specifies the class name of the block cache factory implementation."
+ " Alternative implementation is"
- + " org.apache.accumulo.core.file.blockfile.cache.tinylfu.TinyLfuBlockCacheManager"),
+ + " org.apache.accumulo.core.file.blockfile.cache.tinylfu.TinyLfuBlockCacheManager",
+ "2.0.0"),
TSERV_DATACACHE_SIZE("tserver.cache.data.size", "10%", PropertyType.MEMORY,
- "Specifies the size of the cache for RFile data blocks."),
+ "Specifies the size of the cache for RFile data blocks.", "1.3.5"),
TSERV_INDEXCACHE_SIZE("tserver.cache.index.size", "25%", PropertyType.MEMORY,
- "Specifies the size of the cache for RFile index blocks."),
+ "Specifies the size of the cache for RFile index blocks.", "1.3.5"),
TSERV_SUMMARYCACHE_SIZE("tserver.cache.summary.size", "10%", PropertyType.MEMORY,
- "Specifies the size of the cache for summary data on each tablet server."),
+ "Specifies the size of the cache for summary data on each tablet server.", "2.0.0"),
TSERV_PORTSEARCH("tserver.port.search", "false", PropertyType.BOOLEAN,
- "if the ports above are in use, search higher ports until one is available"),
+ "if the ports above are in use, search higher ports until one is available", "1.3.5"),
TSERV_CLIENTPORT("tserver.port.client", "9997", PropertyType.PORT,
- "The port used for handling client connections on the tablet servers"),
+ "The port used for handling client connections on the tablet servers", "1.3.5"),
TSERV_TOTAL_MUTATION_QUEUE_MAX("tserver.total.mutation.queue.max", "5%", PropertyType.MEMORY,
- "The amount of memory used to store write-ahead-log mutations before flushing them."),
+ "The amount of memory used to store write-ahead-log mutations before flushing them.",
+ "1.7.0"),
TSERV_TABLET_SPLIT_FINDMIDPOINT_MAXOPEN("tserver.tablet.split.midpoint.files.max", "300",
PropertyType.COUNT,
"To find a tablets split points, all RFiles are opened and their indexes"
+ " are read. This setting determines how many RFiles can be opened at once."
+ " When there are more RFiles than this setting multiple passes must be"
+ " made, which is slower. However opening too many RFiles at once can cause"
- + " problems."),
+ + " problems.",
+ "1.3.5"),
TSERV_WAL_MAX_REFERENCED("tserver.wal.max.referenced", "3", PropertyType.COUNT,
"When a tablet server has more than this many write ahead logs, any tablet referencing older "
+ "logs over this threshold is minor compacted. Also any tablet referencing this many "
- + "logs or more will be compacted."),
+ + "logs or more will be compacted.",
+ "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_MAX_REFERENCED)
TSERV_WALOG_MAX_REFERENCED("tserver.walog.max.referenced", "3", PropertyType.COUNT,
"When a tablet server has more than this many write ahead logs, any tablet referencing older "
+ "logs over this threshold is minor compacted. Also any tablet referencing this many "
- + "logs or more will be compacted."),
+ + "logs or more will be compacted.",
+ "2.0.0"),
TSERV_WAL_MAX_SIZE("tserver.wal.max.size", "1G", PropertyType.BYTES,
"The maximum size for each write-ahead log. See comment for property"
- + " tserver.memory.maps.max"),
+ + " tserver.memory.maps.max",
+ "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_MAX_SIZE)
TSERV_WALOG_MAX_SIZE("tserver.walog.max.size", "1G", PropertyType.BYTES,
"The maximum size for each write-ahead log. See comment for property"
- + " tserver.memory.maps.max"),
+ + " tserver.memory.maps.max",
+ "1.3.5"),
TSERV_WAL_MAX_AGE("tserver.wal.max.age", "24h", PropertyType.TIMEDURATION,
- "The maximum age for each write-ahead log."),
+ "The maximum age for each write-ahead log.", "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_MAX_AGE)
TSERV_WALOG_MAX_AGE("tserver.walog.max.age", "24h", PropertyType.TIMEDURATION,
- "The maximum age for each write-ahead log."),
+ "The maximum age for each write-ahead log.", "1.6.6"),
TSERV_WAL_TOLERATED_CREATION_FAILURES("tserver.wal.tolerated.creation.failures", "50",
PropertyType.COUNT,
"The maximum number of failures tolerated when creating a new write-ahead"
+ " log. Negative values will allow unlimited creation failures. Exceeding this"
+ " number of failures consecutively trying to create a new write-ahead log"
- + " causes the TabletServer to exit."),
+ + " causes the TabletServer to exit.",
+ "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_TOLERATED_CREATION_FAILURES)
TSERV_WALOG_TOLERATED_CREATION_FAILURES("tserver.walog.tolerated.creation.failures", "50",
@@ -402,48 +452,56 @@ public enum Property {
"The maximum number of failures tolerated when creating a new write-ahead"
+ " log. Negative values will allow unlimited creation failures. Exceeding this"
+ " number of failures consecutively trying to create a new write-ahead log"
- + " causes the TabletServer to exit."),
+ + " causes the TabletServer to exit.",
+ "1.7.1"),
TSERV_WAL_TOLERATED_WAIT_INCREMENT("tserver.wal.tolerated.wait.increment", "1000ms",
PropertyType.TIMEDURATION,
- "The amount of time to wait between failures to create or write a write-ahead log."),
+ "The amount of time to wait between failures to create or write a write-ahead log.", "2.1.0"),
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_TOLERATED_WAIT_INCREMENT)
TSERV_WALOG_TOLERATED_WAIT_INCREMENT("tserver.walog.tolerated.wait.increment", "1000ms",
PropertyType.TIMEDURATION,
- "The amount of time to wait between failures to create or write a write-ahead log."),
+ "The amount of time to wait between failures to create or write a write-ahead log.", "1.7.1"),
// Never wait longer than 5 mins for a retry
TSERV_WAL_TOLERATED_MAXIMUM_WAIT_DURATION("tserver.wal.maximum.wait.duration", "5m",
PropertyType.TIMEDURATION,
- "The maximum amount of time to wait after a failure to create or write a write-ahead log."),
+ "The maximum amount of time to wait after a failure to create or write a write-ahead log.",
+ "2.1.0"),
// Never wait longer than 5 mins for a retry
@Deprecated(since = "2.1.0")
@ReplacedBy(property = Property.TSERV_WAL_TOLERATED_MAXIMUM_WAIT_DURATION)
TSERV_WALOG_TOLERATED_MAXIMUM_WAIT_DURATION("tserver.walog.maximum.wait.duration", "5m",
PropertyType.TIMEDURATION,
- "The maximum amount of time to wait after a failure to create or write a write-ahead log."),
+ "The maximum amount of time to wait after a failure to create or write a write-ahead log.",
+ "1.7.1"),
TSERV_SCAN_MAX_OPENFILES("tserver.scan.files.open.max", "100", PropertyType.COUNT,
- "Maximum total RFiles that all tablets in a tablet server can open for scans. "),
+ "Maximum total RFiles that all tablets in a tablet server can open for scans. ", "1.4.0"),
TSERV_MAX_IDLE("tserver.files.open.idle", "1m", PropertyType.TIMEDURATION,
"Tablet servers leave previously used RFiles open for future queries."
+ " This setting determines how much time an unused RFile should be kept open"
- + " until it is closed."),
+ + " until it is closed.",
+ "1.3.5"),
TSERV_NATIVEMAP_ENABLED("tserver.memory.maps.native.enabled", "true", PropertyType.BOOLEAN,
"An in-memory data store for accumulo implemented in c++ that increases"
- + " the amount of data accumulo can hold in memory and avoids Java GC" + " pauses."),
+ + " the amount of data accumulo can hold in memory and avoids Java GC" + " pauses.",
+ "1.3.5"),
TSERV_MAXMEM("tserver.memory.maps.max", "33%", PropertyType.MEMORY,
"Maximum amount of memory that can be used to buffer data written to a"
+ " tablet server. There are two other properties that can effectively limit"
+ " memory usage table.compaction.minor.logs.threshold and"
+ " tserver.wal.max.size. Ensure that table.compaction.minor.logs.threshold"
- + " * tserver.wal.max.size >= this property."),
+ + " * tserver.wal.max.size >= this property.",
+ "1.3.5"),
TSERV_SESSION_MAXIDLE("tserver.session.idle.max", "1m", PropertyType.TIMEDURATION,
"When a tablet server's SimpleTimer thread triggers to check idle"
+ " sessions, this configurable option will be used to evaluate scan sessions"
- + " to determine if they can be closed due to inactivity"),
+ + " to determine if they can be closed due to inactivity",
+ "1.3.5"),
TSERV_UPDATE_SESSION_MAXIDLE("tserver.session.update.idle.max", "1m", PropertyType.TIMEDURATION,
"When a tablet server's SimpleTimer thread triggers to check idle"
+ " sessions, this configurable option will be used to evaluate update"
- + " sessions to determine if they can be closed due to inactivity"),
+ + " sessions to determine if they can be closed due to inactivity",
+ "1.6.5"),
TSERV_SCAN_EXECUTORS_PREFIX("tserver.scan.executors.", null, PropertyType.PREFIX,
"Prefix for defining executors to service scans. See "
+ "[scan executors]({% durl administration/scan-executors %}) for an overview of why and"
@@ -452,249 +510,289 @@ public enum Property {
+ "`tserver.scan.executors.<name>.threads=<number>`. Optionally, can also set "
+ "`tserver.scan.executors.<name>.priority=<number 1 to 10>`, "
+ "`tserver.scan.executors.<name>.prioritizer=<class name>`, and "
- + "`tserver.scan.executors.<name>.prioritizer.opts.<key>=<value>`"),
+ + "`tserver.scan.executors.<name>.prioritizer.opts.<key>=<value>`",
+ "2.0.0"),
TSERV_SCAN_EXECUTORS_DEFAULT_THREADS("tserver.scan.executors.default.threads", "16",
- PropertyType.COUNT,
- "The number of threads for the scan executor that tables use by default."),
+ PropertyType.COUNT, "The number of threads for the scan executor that tables use by default.",
+ "2.0.0"),
TSERV_SCAN_EXECUTORS_DEFAULT_PRIORITIZER("tserver.scan.executors.default.prioritizer", "",
PropertyType.STRING,
"Prioritizer for the default scan executor. Defaults to none which "
+ "results in FIFO priority. Set to a class that implements "
- + ScanPrioritizer.class.getName() + " to configure one."),
+ + ScanPrioritizer.class.getName() + " to configure one.",
+ "2.0.0"),
TSERV_SCAN_EXECUTORS_META_THREADS("tserver.scan.executors.meta.threads", "8", PropertyType.COUNT,
- "The number of threads for the metadata table scan executor."),
+ "The number of threads for the metadata table scan executor.", "2.0.0"),
TSERV_MIGRATE_MAXCONCURRENT("tserver.migrations.concurrent.max", "1", PropertyType.COUNT,
- "The maximum number of concurrent tablet migrations for a tablet server"),
+ "The maximum number of concurrent tablet migrations for a tablet server", "1.3.5"),
TSERV_MAJC_DELAY("tserver.compaction.major.delay", "30s", PropertyType.TIMEDURATION,
- "Time a tablet server will sleep between checking which tablets need compaction."),
+ "Time a tablet server will sleep between checking which tablets need compaction.", "1.3.5"),
TSERV_COMPACTION_SERVICE_PREFIX("tserver.compaction.major.service.", null, PropertyType.PREFIX,
- "Prefix for compaction services."),
+ "Prefix for compaction services.", "2.1.0"),
TSERV_COMPACTION_SERVICE_ROOT_PLANNER("tserver.compaction.major.service.root.planner",
DefaultCompactionPlanner.class.getName(), PropertyType.CLASSNAME,
- "Compaction planner for root tablet service"),
+ "Compaction planner for root tablet service", "2.1.0"),
TSERV_COMPACTION_SERVICE_ROOT_RATE_LIMIT("tserver.compaction.major.service.root.rate.limit", "0B",
PropertyType.BYTES,
"Maximum number of bytes to read or write per second over all major"
- + " compactions in this compaction service, or 0B for unlimited."),
+ + " compactions in this compaction service, or 0B for unlimited.",
+ "2.1.0"),
TSERV_COMPACTION_SERVICE_ROOT_MAX_OPEN(
"tserver.compaction.major.service.root.planner.opts.maxOpen", "30", PropertyType.COUNT,
- "The maximum number of files a compaction will open"),
+ "The maximum number of files a compaction will open", "2.1.0"),
TSERV_COMPACTION_SERVICE_ROOT_EXECUTORS(
"tserver.compaction.major.service.root.planner.opts.executors",
("[{'name':'small','type':'internal','maxSize':'32M','numThreads':1},{'name':'huge','type':'internal','numThreads':1}]")
.replaceAll("'", "\""),
PropertyType.STRING,
- "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} "),
+ "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} ",
+ "2.1.0"),
TSERV_COMPACTION_SERVICE_META_PLANNER("tserver.compaction.major.service.meta.planner",
DefaultCompactionPlanner.class.getName(), PropertyType.CLASSNAME,
- "Compaction planner for metadata table"),
+ "Compaction planner for metadata table", "2.1.0"),
TSERV_COMPACTION_SERVICE_META_RATE_LIMIT("tserver.compaction.major.service.meta.rate.limit", "0B",
PropertyType.BYTES,
"Maximum number of bytes to read or write per second over all major"
- + " compactions in this compaction service, or 0B for unlimited."),
+ + " compactions in this compaction service, or 0B for unlimited.",
+ "2.1.0"),
TSERV_COMPACTION_SERVICE_META_MAX_OPEN(
"tserver.compaction.major.service.meta.planner.opts.maxOpen", "30", PropertyType.COUNT,
- "The maximum number of files a compaction will open"),
+ "The maximum number of files a compaction will open", "2.1.0"),
TSERV_COMPACTION_SERVICE_META_EXECUTORS(
"tserver.compaction.major.service.meta.planner.opts.executors",
("[{'name':'small','type':'internal','maxSize':'32M','numThreads':2},{'name':'huge','type':'internal','numThreads':2}]")
.replaceAll("'", "\""),
PropertyType.STRING,
- "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} "),
+ "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} ",
+ "2.1.0"),
TSERV_COMPACTION_SERVICE_DEFAULT_PLANNER("tserver.compaction.major.service.default.planner",
DefaultCompactionPlanner.class.getName(), PropertyType.CLASSNAME,
- "Planner for default compaction service."),
+ "Planner for default compaction service.", "2.1.0"),
TSERV_COMPACTION_SERVICE_DEFAULT_RATE_LIMIT("tserver.compaction.major.service.default.rate.limit",
"0B", PropertyType.BYTES,
"Maximum number of bytes to read or write per second over all major"
- + " compactions in this compaction service, or 0B for unlimited."),
+ + " compactions in this compaction service, or 0B for unlimited.",
+ "2.1.0"),
TSERV_COMPACTION_SERVICE_DEFAULT_MAX_OPEN(
"tserver.compaction.major.service.default.planner.opts.maxOpen", "10", PropertyType.COUNT,
- "The maximum number of files a compaction will open"),
+ "The maximum number of files a compaction will open", "2.1.0"),
TSERV_COMPACTION_SERVICE_DEFAULT_EXECUTORS(
"tserver.compaction.major.service.default.planner.opts.executors",
("[{'name':'small','type':'internal','maxSize':'32M','numThreads':2},{'name':'medium','type':'internal','maxSize':'128M','numThreads':2},{'name':'large','type':'internal','numThreads':2}]")
.replaceAll("'", "\""),
PropertyType.STRING,
- "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} "),
+ "See {% jlink -f org.apache.accumulo.core.spi.compaction.DefaultCompactionPlanner %} ",
+ "2.1.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = Property.TSERV_COMPACTION_SERVICE_DEFAULT_MAX_OPEN)
TSERV_MAJC_THREAD_MAXOPEN("tserver.compaction.major.thread.files.open.max", "10",
- PropertyType.COUNT, "Max number of RFiles a major compaction thread can open at once. "),
+ PropertyType.COUNT, "Max number of RFiles a major compaction thread can open at once. ",
+ "1.4.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = Property.TSERV_COMPACTION_SERVICE_DEFAULT_EXECUTORS)
TSERV_MAJC_MAXCONCURRENT("tserver.compaction.major.concurrent.max", "3", PropertyType.COUNT,
- "The maximum number of concurrent major compactions for a tablet server"),
+ "The maximum number of concurrent major compactions for a tablet server", "1.3.5"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = Property.TSERV_COMPACTION_SERVICE_DEFAULT_RATE_LIMIT)
TSERV_MAJC_THROUGHPUT("tserver.compaction.major.throughput", "0B", PropertyType.BYTES,
"Maximum number of bytes to read or write per second over all major"
- + " compactions within each compaction service, or 0B for unlimited."),
+ + " compactions within each compaction service, or 0B for unlimited.",
+ "1.8.0"),
TSERV_MINC_MAXCONCURRENT("tserver.compaction.minor.concurrent.max", "4", PropertyType.COUNT,
- "The maximum number of concurrent minor compactions for a tablet server"),
+ "The maximum number of concurrent minor compactions for a tablet server", "1.3.5"),
TSERV_MAJC_TRACE_PERCENT("tserver.compaction.major.trace.percent", "0.1", PropertyType.FRACTION,
- "The percent of major compactions to trace"),
+ "The percent of major compactions to trace", "1.7.0"),
TSERV_MINC_TRACE_PERCENT("tserver.compaction.minor.trace.percent", "0.1", PropertyType.FRACTION,
- "The percent of minor compactions to trace"),
+ "The percent of minor compactions to trace", "1.7.0"),
TSERV_COMPACTION_WARN_TIME("tserver.compaction.warn.time", "10m", PropertyType.TIMEDURATION,
- "When a compaction has not made progress for this time period, a warning will be logged"),
+ "When a compaction has not made progress for this time period, a warning will be logged",
+ "1.6.0"),
TSERV_BLOOM_LOAD_MAXCONCURRENT("tserver.bloom.load.concurrent.max", "4", PropertyType.COUNT,
"The number of concurrent threads that will load bloom filters in the background. "
- + "Setting this to zero will make bloom filters load in the foreground."),
+ + "Setting this to zero will make bloom filters load in the foreground.",
+ "1.3.5"),
TSERV_MONITOR_FS("tserver.monitor.fs", "false", PropertyType.BOOLEAN,
"When enabled the tserver will monitor file systems and kill itself when"
+ " one switches from rw to ro. This is usually and indication that Linux has"
- + " detected a bad disk."),
+ + " detected a bad disk.",
+ "1.3.5"),
TSERV_MEMDUMP_DIR("tserver.dir.memdump", "/tmp", PropertyType.PATH,
"A long running scan could possibly hold memory that has been minor"
+ " compacted. To prevent this, the in memory map is dumped to a local file"
+ " and the scan is switched to that local file. We can not switch to the"
+ " minor compacted file because it may have been modified by iterators. The"
- + " file dumped to the local dir is an exact copy of what was in memory."),
+ + " file dumped to the local dir is an exact copy of what was in memory.",
+ "1.3.5"),
TSERV_BULK_PROCESS_THREADS("tserver.bulk.process.threads", "1", PropertyType.COUNT,
"The manager will task a tablet server with pre-processing a bulk import"
+ " RFile prior to assigning it to the appropriate tablet servers. This"
- + " configuration value controls the number of threads used to process the" + " files."),
+ + " configuration value controls the number of threads used to process the" + " files.",
+ "1.4.0"),
TSERV_BULK_ASSIGNMENT_THREADS("tserver.bulk.assign.threads", "1", PropertyType.COUNT,
"The manager delegates bulk import RFile processing and assignment to"
+ " tablet servers. After file has been processed, the tablet server will"
+ " assign the file to the appropriate tablets on all servers. This property"
- + " controls the number of threads used to communicate to the other" + " servers."),
+ + " controls the number of threads used to communicate to the other" + " servers.",
+ "1.4.0"),
TSERV_BULK_RETRY("tserver.bulk.retry.max", "5", PropertyType.COUNT,
"The number of times the tablet server will attempt to assign a RFile to"
- + " a tablet as it migrates and splits."),
+ + " a tablet as it migrates and splits.",
+ "1.4.0"),
TSERV_BULK_TIMEOUT("tserver.bulk.timeout", "5m", PropertyType.TIMEDURATION,
- "The time to wait for a tablet server to process a bulk import request."),
+ "The time to wait for a tablet server to process a bulk import request.", "1.4.3"),
TSERV_MINTHREADS("tserver.server.threads.minimum", "20", PropertyType.COUNT,
- "The minimum number of threads to use to handle incoming requests."),
+ "The minimum number of threads to use to handle incoming requests.", "1.4.0"),
TSERV_MINTHREADS_TIMEOUT("tserver.server.threads.timeout", "0s", PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
TSERV_THREADCHECK("tserver.server.threadcheck.time", "1s", PropertyType.TIMEDURATION,
- "The time between adjustments of the server thread pool."),
+ "The time between adjustments of the server thread pool.", "1.4.0"),
TSERV_MAX_MESSAGE_SIZE("tserver.server.message.size.max", "1G", PropertyType.BYTES,
- "The maximum size of a message that can be sent to a tablet server."),
+ "The maximum size of a message that can be sent to a tablet server.", "1.6.0"),
TSERV_LOG_BUSY_TABLETS_COUNT("tserver.log.busy.tablets.count", "0", PropertyType.COUNT,
"Number of busiest tablets to log. Logged at interval controlled by "
- + "tserver.log.busy.tablets.interval. If <= 0, logging of busy tablets is disabled"),
+ + "tserver.log.busy.tablets.interval. If <= 0, logging of busy tablets is disabled",
+ "1.10.0"),
TSERV_LOG_BUSY_TABLETS_INTERVAL("tserver.log.busy.tablets.interval", "1h",
- PropertyType.TIMEDURATION, "Time interval between logging out busy tablets information."),
+ PropertyType.TIMEDURATION, "Time interval between logging out busy tablets information.",
+ "1.10.0"),
TSERV_HOLD_TIME_SUICIDE("tserver.hold.time.max", "5m", PropertyType.TIMEDURATION,
"The maximum time for a tablet server to be in the \"memory full\" state."
+ " If the tablet server cannot write out memory in this much time, it will"
+ " assume there is some failure local to its node, and quit. A value of zero"
- + " is equivalent to forever."),
+ + " is equivalent to forever.",
+ "1.4.0"),
TSERV_WAL_BLOCKSIZE("tserver.wal.blocksize", "0", PropertyType.BYTES,
"The size of the HDFS blocks used to write to the Write-Ahead log. If"
+ " zero, it will be 110% of tserver.wal.max.size (that is, try to use just"
- + " one block)"),
+ + " one block)",
+ "1.5.0"),
TSERV_WAL_REPLICATION("tserver.wal.replication", "0", PropertyType.COUNT,
"The replication to use when writing the Write-Ahead log to HDFS. If"
- + " zero, it will use the HDFS default replication setting."),
+ + " zero, it will use the HDFS default replication setting.",
+ "1.5.0"),
TSERV_RECOVERY_MAX_CONCURRENT("tserver.recovery.concurrent.max", "2", PropertyType.COUNT,
- "The maximum number of threads to use to sort logs during" + " recovery"),
+ "The maximum number of threads to use to sort logs during" + " recovery", "1.5.0"),
TSERV_SORT_BUFFER_SIZE("tserver.sort.buffer.size", "10%", PropertyType.MEMORY,
- "The amount of memory to use when sorting logs during recovery."),
+ "The amount of memory to use when sorting logs during recovery.", "1.5.0"),
TSERV_WORKQ_THREADS("tserver.workq.threads", "2", PropertyType.COUNT,
"The number of threads for the distributed work queue. These threads are"
- + " used for copying failed bulk import RFiles."),
+ + " used for copying failed bulk import RFiles.",
+ "1.4.2"),
TSERV_WAL_SYNC("tserver.wal.sync", "true", PropertyType.BOOLEAN,
"Use the SYNC_BLOCK create flag to sync WAL writes to disk. Prevents"
- + " problems recovering from sudden system resets."),
+ + " problems recovering from sudden system resets.",
+ "1.5.0"),
TSERV_ASSIGNMENT_DURATION_WARNING("tserver.assignment.duration.warning", "10m",
PropertyType.TIMEDURATION,
"The amount of time an assignment can run before the server will print a"
+ " warning along with the current stack trace. Meant to help debug stuck"
- + " assignments"),
+ + " assignments",
+ "1.6.2"),
TSERV_REPLICATION_REPLAYERS("tserver.replication.replayer.", null, PropertyType.PREFIX,
- "Allows configuration of implementation used to apply replicated data"),
+ "Allows configuration of implementation used to apply replicated data", "1.7.0"),
TSERV_REPLICATION_DEFAULT_HANDLER("tserver.replication.default.replayer",
"org.apache.accumulo.tserver.replication.BatchWriterReplicationReplayer",
- PropertyType.CLASSNAME, "Default AccumuloReplicationReplayer implementation"),
+ PropertyType.CLASSNAME, "Default AccumuloReplicationReplayer implementation", "1.7.0"),
TSERV_REPLICATION_BW_REPLAYER_MEMORY("tserver.replication.batchwriter.replayer.memory", "50M",
- PropertyType.BYTES, "Memory to provide to batchwriter to replay mutations for replication"),
+ PropertyType.BYTES, "Memory to provide to batchwriter to replay mutations for replication",
+ "1.7.0"),
TSERV_ASSIGNMENT_MAXCONCURRENT("tserver.assignment.concurrent.max", "2", PropertyType.COUNT,
- "The number of threads available to load tablets. Recoveries are still performed serially."),
+ "The number of threads available to load tablets. Recoveries are still performed serially.",
+ "1.7.0"),
TSERV_SLOW_FLUSH_MILLIS("tserver.slow.flush.time", "100ms", PropertyType.TIMEDURATION,
"If a flush to the write-ahead log takes longer than this period of time,"
- + " debugging information will written, and may result in a log rollover."),
+ + " debugging information will written, and may result in a log rollover.",
+ "1.8.0"),
TSERV_SLOW_FILEPERMIT_MILLIS("tserver.slow.filepermit.time", "100ms", PropertyType.TIMEDURATION,
"If a thread blocks more than this period of time waiting to get file permits,"
- + " debugging information will be written."),
+ + " debugging information will be written.",
+ "1.9.3"),
TSERV_SUMMARY_PARTITION_THREADS("tserver.summary.partition.threads", "10", PropertyType.COUNT,
"Summary data must be retrieved from RFiles. For a large number of"
+ " RFiles, the files are broken into partitions of 100k files. This setting"
+ " determines how many of these groups of 100k RFiles will be processed"
- + " concurrently."),
+ + " concurrently.",
+ "2.0.0"),
TSERV_SUMMARY_REMOTE_THREADS("tserver.summary.remote.threads", "128", PropertyType.COUNT,
"For a partitioned group of 100k RFiles, those files are grouped by"
+ " tablet server. Then a remote tablet server is asked to gather summary"
+ " data. This setting determines how many concurrent request are made per"
- + " partition."),
+ + " partition.",
+ "2.0.0"),
TSERV_SUMMARY_RETRIEVAL_THREADS("tserver.summary.retrieval.threads", "10", PropertyType.COUNT,
"The number of threads on each tablet server available to retrieve"
- + " summary data, that is not currently in cache, from RFiles."),
+ + " summary data, that is not currently in cache, from RFiles.",
+ "2.0.0"),
// accumulo garbage collector properties
GC_PREFIX("gc.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the accumulo garbage collector."),
+ "Properties in this category affect the behavior of the accumulo garbage collector.",
+ "1.3.5"),
GC_CANDIDATE_BATCH_SIZE("gc.candidate.batch.size", "8M", PropertyType.BYTES,
- "The batch size used for garbage collection."),
+ "The batch size used for garbage collection.", "2.1.0"),
GC_CYCLE_START("gc.cycle.start", "30s", PropertyType.TIMEDURATION,
- "Time to wait before attempting to garbage collect any old RFiles or write-ahead logs."),
+ "Time to wait before attempting to garbage collect any old RFiles or write-ahead logs.",
+ "1.3.5"),
GC_CYCLE_DELAY("gc.cycle.delay", "5m", PropertyType.TIMEDURATION,
"Time between garbage collection cycles. In each cycle, old RFiles or write-ahead logs "
- + "no longer in use are removed from the filesystem."),
+ + "no longer in use are removed from the filesystem.",
+ "1.3.5"),
GC_PORT("gc.port.client", "9998", PropertyType.PORT,
- "The listening port for the garbage collector's monitor service"),
+ "The listening port for the garbage collector's monitor service", "1.3.5"),
GC_DELETE_THREADS("gc.threads.delete", "16", PropertyType.COUNT,
- "The number of threads used to delete RFiles and write-ahead logs"),
+ "The number of threads used to delete RFiles and write-ahead logs", "1.3.5"),
GC_TRASH_IGNORE("gc.trash.ignore", "false", PropertyType.BOOLEAN,
- "Do not use the Trash, even if it is configured."),
+ "Do not use the Trash, even if it is configured.", "1.5.0"),
GC_TRACE_PERCENT("gc.trace.percent", "0.01", PropertyType.FRACTION,
- "Percent of gc cycles to trace"),
+ "Percent of gc cycles to trace", "1.7.0"),
GC_SAFEMODE("gc.safemode", "false", PropertyType.BOOLEAN,
- "Provides listing of files to be deleted but does not delete any files"),
+ "Provides listing of files to be deleted but does not delete any files", "2.1.0"),
GC_USE_FULL_COMPACTION("gc.post.metadata.action", "flush", PropertyType.GC_POST_ACTION,
"When the gc runs it can make a lot of changes to the metadata, on completion, "
+ " to force the changes to be written to disk, the metadata and root tables can be flushed"
+ " and possibly compacted. Legal values are: compact - which both flushes and compacts the"
- + " metadata; flush - which flushes only (compactions may be triggered if required); or none"),
+ + " metadata; flush - which flushes only (compactions may be triggered if required); or none",
+ "1.10.0"),
GC_METRICS_ENABLED("gc.metrics.enabled", "true", PropertyType.BOOLEAN,
- "Enable detailed gc metrics reporting with hadoop metrics."),
+ "Enable detailed gc metrics reporting with hadoop metrics.", "1.10.0"),
// properties that are specific to the monitor server behavior
MONITOR_PREFIX("monitor.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the monitor web server."),
+ "Properties in this category affect the behavior of the monitor web server.", "1.3.5"),
MONITOR_PORT("monitor.port.client", "9995", PropertyType.PORT,
- "The listening port for the monitor's http service"),
+ "The listening port for the monitor's http service", "1.3.5"),
MONITOR_SSL_KEYSTORE("monitor.ssl.keyStore", "", PropertyType.PATH,
- "The keystore for enabling monitor SSL."),
+ "The keystore for enabling monitor SSL.", "1.5.0"),
@Sensitive
MONITOR_SSL_KEYSTOREPASS("monitor.ssl.keyStorePassword", "", PropertyType.STRING,
- "The keystore password for enabling monitor SSL."),
+ "The keystore password for enabling monitor SSL.", "1.5.0"),
MONITOR_SSL_KEYSTORETYPE("monitor.ssl.keyStoreType", "jks", PropertyType.STRING,
- "Type of SSL keystore"),
+ "Type of SSL keystore", "1.7.0"),
@Sensitive
MONITOR_SSL_KEYPASS("monitor.ssl.keyPassword", "", PropertyType.STRING,
"Optional: the password for the private key in the keyStore. When not provided, this "
- + "defaults to the keystore password."),
+ + "defaults to the keystore password.",
+ "1.9.3"),
MONITOR_SSL_TRUSTSTORE("monitor.ssl.trustStore", "", PropertyType.PATH,
- "The truststore for enabling monitor SSL."),
+ "The truststore for enabling monitor SSL.", "1.5.0"),
@Sensitive
MONITOR_SSL_TRUSTSTOREPASS("monitor.ssl.trustStorePassword", "", PropertyType.STRING,
- "The truststore password for enabling monitor SSL."),
+ "The truststore password for enabling monitor SSL.", "1.5.0"),
MONITOR_SSL_TRUSTSTORETYPE("monitor.ssl.trustStoreType", "jks", PropertyType.STRING,
- "Type of SSL truststore"),
+ "Type of SSL truststore", "1.7.0"),
MONITOR_SSL_INCLUDE_CIPHERS("monitor.ssl.include.ciphers", "", PropertyType.STRING,
"A comma-separated list of allows SSL Ciphers, see"
- + " monitor.ssl.exclude.ciphers to disallow ciphers"),
+ + " monitor.ssl.exclude.ciphers to disallow ciphers",
+ "1.6.1"),
MONITOR_SSL_EXCLUDE_CIPHERS("monitor.ssl.exclude.ciphers", "", PropertyType.STRING,
"A comma-separated list of disallowed SSL Ciphers, see"
- + " monitor.ssl.include.ciphers to allow ciphers"),
+ + " monitor.ssl.include.ciphers to allow ciphers",
+ "1.6.1"),
MONITOR_SSL_INCLUDE_PROTOCOLS("monitor.ssl.include.protocols", "TLSv1.2", PropertyType.STRING,
- "A comma-separate list of allowed SSL protocols"),
+ "A comma-separate list of allowed SSL protocols", "1.5.3"),
MONITOR_LOCK_CHECK_INTERVAL("monitor.lock.check.interval", "5s", PropertyType.TIMEDURATION,
- "The amount of time to sleep between checking for the Montior ZooKeeper lock"),
+ "The amount of time to sleep between checking for the Montior ZooKeeper lock", "1.5.1"),
MONITOR_RESOURCES_EXTERNAL("monitor.resources.external", "", PropertyType.STRING,
"A JSON Map of Strings. Each String should be an HTML tag of an external"
+ " resource (JS or CSS) to be imported by the Monitor. Be sure to wrap"
@@ -702,31 +800,33 @@ public enum Property {
+ " in the `<head>` tag of the Monitor will be replaced with the tags set here."
+ " Be sure the jquery tag is first since other scripts will depend on it."
+ " The resources that are used by default can be seen in"
- + " accumulo/server/monitor/src/main/resources/templates/default.ftl"),
+ + " accumulo/server/monitor/src/main/resources/templates/default.ftl",
+ "2.0.0"),
TRACE_PREFIX("trace.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of distributed tracing."),
+ "Properties in this category affect the behavior of distributed tracing.", "1.3.5"),
TRACE_SPAN_RECEIVERS("trace.span.receivers", "org.apache.accumulo.tracer.ZooTraceClient",
- PropertyType.CLASSNAMELIST, "A list of span receiver classes to send trace spans"),
+ PropertyType.CLASSNAMELIST, "A list of span receiver classes to send trace spans", "1.7.0"),
TRACE_SPAN_RECEIVER_PREFIX("trace.span.receiver.", null, PropertyType.PREFIX,
- "Prefix for span receiver configuration properties"),
+ "Prefix for span receiver configuration properties", "1.7.0"),
TRACE_ZK_PATH("trace.zookeeper.path", Constants.ZTRACERS, PropertyType.STRING,
- "The zookeeper node where tracers are registered"),
+ "The zookeeper node where tracers are registered", "1.7.0"),
TRACE_PORT("trace.port.client", "12234", PropertyType.PORT,
- "The listening port for the trace server"),
+ "The listening port for the trace server", "1.3.5"),
TRACE_TABLE("trace.table", "trace", PropertyType.STRING,
- "The name of the table to store distributed traces"),
+ "The name of the table to store distributed traces", "1.3.5"),
TRACE_USER("trace.user", "root", PropertyType.STRING,
- "The name of the user to store distributed traces"),
+ "The name of the user to store distributed traces", "1.3.5"),
@Sensitive
TRACE_PASSWORD("trace.password", "secret", PropertyType.STRING,
- "The password for the user used to store distributed traces"),
+ "The password for the user used to store distributed traces", "1.3.5"),
@Sensitive
TRACE_TOKEN_PROPERTY_PREFIX("trace.token.property.", null, PropertyType.PREFIX,
"The prefix used to create a token for storing distributed traces. For"
- + " each property required by trace.token.type, place this prefix in front of it."),
+ + " each property required by trace.token.type, place this prefix in front of it.",
+ "1.5.0"),
TRACE_TOKEN_TYPE("trace.token.type", PasswordToken.class.getName(), PropertyType.CLASSNAME,
- "An AuthenticationToken type supported by the authorizer"),
+ "An AuthenticationToken type supported by the authorizer", "1.5.0"),
// per table properties
TABLE_PREFIX("table.", null, PropertyType.PREFIX,
@@ -738,12 +838,14 @@ public enum Property {
+ " which sets the overridden value in zookeeper. Restarting accumulo tablet"
+ " servers after setting these properties in accumulo.properties will cause the"
+ " global setting to take effect. However, you must use the API or the shell"
- + " to change properties in zookeeper that are set on a table."),
+ + " to change properties in zookeeper that are set on a table.",
+ "1.3.5"),
TABLE_ARBITRARY_PROP_PREFIX("table.custom.", null, PropertyType.PREFIX,
- "Prefix to be used for user defined arbitrary properties."),
+ "Prefix to be used for user defined arbitrary properties.", "1.7.0"),
TABLE_MAJC_RATIO("table.compaction.major.ratio", "3", PropertyType.FRACTION,
"Minimum ratio of total input size to maximum input RFile size for"
- + " running a major compaction. "),
+ + " running a major compaction. ",
+ "1.3.5"),
@Deprecated(since = "2.1.0", forRemoval = true)
TABLE_MAJC_COMPACTALL_IDLETIME("table.compaction.major.everything.idle", "1h",
PropertyType.TIMEDURATION,
@@ -751,98 +853,112 @@ public enum Property {
+ " have all of its RFiles compacted into one. There is no guarantee an idle"
+ " tablet will be compacted. Compactions of idle tablets are only started"
+ " when regular compactions are not running. Idle compactions only take"
- + " place for tablets that have one or more RFiles."),
+ + " place for tablets that have one or more RFiles.",
+ "1.3.5"),
TABLE_SPLIT_THRESHOLD("table.split.threshold", "1G", PropertyType.BYTES,
- "A tablet is split when the combined size of RFiles exceeds this amount."),
+ "A tablet is split when the combined size of RFiles exceeds this amount.", "1.3.5"),
TABLE_MAX_END_ROW_SIZE("table.split.endrow.size.max", "10k", PropertyType.BYTES,
- "Maximum size of end row"),
+ "Maximum size of end row", "1.7.0"),
@Deprecated(since = "2.0.0")
@ReplacedBy(property = Property.TSERV_WAL_MAX_REFERENCED)
TABLE_MINC_LOGS_MAX("table.compaction.minor.logs.threshold", "3", PropertyType.COUNT,
- "This property is deprecated since 2.0.0."),
+ "This property is deprecated and replaced.", "1.3.5"),
TABLE_MINC_COMPACT_IDLETIME("table.compaction.minor.idle", "5m", PropertyType.TIMEDURATION,
"After a tablet has been idle (no mutations) for this time period it may have its "
+ "in-memory map flushed to disk in a minor compaction. There is no guarantee an idle "
- + "tablet will be compacted."),
+ + "tablet will be compacted.",
+ "1.3.5"),
TABLE_COMPACTION_DISPATCHER("table.compaction.dispatcher",
SimpleCompactionDispatcher.class.getName(), PropertyType.CLASSNAME,
- "A configurable dispatcher that decides what comaction service a table should use."),
+ "A configurable dispatcher that decides what comaction service a table should use.", "2.1.0"),
TABLE_COMPACTION_DISPATCHER_OPTS("table.compaction.dispatcher.opts.", null, PropertyType.PREFIX,
- "Options for the table compaction dispatcher"),
+ "Options for the table compaction dispatcher", "2.1.0"),
TABLE_COMPACTION_SELECTOR("table.compaction.selector", "", PropertyType.CLASSNAME,
"A configurable selector for a table that can periodically select file for mandatory "
- + "compaction, even if the files do not meet the compaction ratio."),
+ + "compaction, even if the files do not meet the compaction ratio.",
+ "2.1.0"),
TABLE_COMPACTION_SELECTOR_OPTS("table.compaction.selector.opts.", null, PropertyType.PREFIX,
- "Options for the table compaction dispatcher"),
+ "Options for the table compaction dispatcher", "2.1.0"),
TABLE_COMPACTION_CONFIGURER("table.compaction.configurer", "", PropertyType.CLASSNAME,
- "A plugin that can dynamically configure compaction output files based on input files."),
+ "A plugin that can dynamically configure compaction output files based on input files.",
+ "2.1.0"),
TABLE_COMPACTION_CONFIGURER_OPTS("table.compaction.configurer.opts.", null, PropertyType.PREFIX,
- "Options for the table compaction configuror"),
+ "Options for the table compaction configuror", "2.1.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = TABLE_COMPACTION_SELECTOR)
TABLE_COMPACTION_STRATEGY("table.majc.compaction.strategy",
"org.apache.accumulo.tserver.compaction.DefaultCompactionStrategy", PropertyType.CLASSNAME,
- "Deprecated since 2.1.0 See {% jlink -f org.apache.accumulo.core.spi.compaction}"),
+ "See {% jlink -f org.apache.accumulo.core.spi.compaction}", "1.6.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = TABLE_COMPACTION_SELECTOR_OPTS)
TABLE_COMPACTION_STRATEGY_PREFIX("table.majc.compaction.strategy.opts.", null,
PropertyType.PREFIX,
- "Properties in this category are used to configure the compaction strategy."),
+ "Properties in this category are used to configure the compaction strategy.", "1.6.0"),
TABLE_SCAN_DISPATCHER("table.scan.dispatcher", SimpleScanDispatcher.class.getName(),
PropertyType.CLASSNAME,
"This class is used to dynamically dispatch scans to configured scan executors. Configured "
+ "classes must implement {% jlink " + ScanDispatcher.class.getName() + " %} See "
+ "[scan executors]({% durl administration/scan-executors %}) for an overview of why"
+ " and how to use this property. This property is ignored for the root and metadata"
- + " table. The metadata table always dispatches to a scan executor named `meta`."),
+ + " table. The metadata table always dispatches to a scan executor named `meta`.",
+ "2.0.0"),
TABLE_SCAN_DISPATCHER_OPTS("table.scan.dispatcher.opts.", null, PropertyType.PREFIX,
- "Options for the table scan dispatcher"),
+ "Options for the table scan dispatcher", "2.0.0"),
TABLE_SCAN_MAXMEM("table.scan.max.memory", "512k", PropertyType.BYTES,
"The maximum amount of memory that will be used to cache results of a client query/scan. "
- + "Once this limit is reached, the buffered data is sent to the client."),
+ + "Once this limit is reached, the buffered data is sent to the client.",
+ "1.3.5"),
TABLE_FILE_TYPE("table.file.type", RFile.EXTENSION, PropertyType.STRING,
- "Change the type of file a table writes"),
+ "Change the type of file a table writes", "1.3.5"),
TABLE_LOAD_BALANCER("table.balancer", "org.apache.accumulo.core.spi.balancer.SimpleLoadBalancer",
PropertyType.STRING,
"This property can be set to allow the LoadBalanceByTable load balancer"
- + " to change the called Load Balancer for this table"),
+ + " to change the called Load Balancer for this table",
+ "1.3.5"),
TABLE_FILE_COMPRESSION_TYPE("table.file.compress.type", "gz", PropertyType.STRING,
"Compression algorithm used on index and data blocks before they are"
- + " written. Possible values: zstd, gz, snappy, lzo, none"),
+ + " written. Possible values: zstd, gz, snappy, lzo, none",
+ "1.3.5"),
TABLE_FILE_COMPRESSED_BLOCK_SIZE("table.file.compress.blocksize", "100k", PropertyType.BYTES,
- "The maximum size of data blocks in RFiles before they are compressed and written."),
+ "The maximum size of data blocks in RFiles before they are compressed and written.", "1.3.5"),
TABLE_FILE_COMPRESSED_BLOCK_SIZE_INDEX("table.file.compress.blocksize.index", "128k",
PropertyType.BYTES,
- "The maximum size of index blocks in RFiles before they are compressed and written."),
+ "The maximum size of index blocks in RFiles before they are compressed and written.",
+ "1.4.0"),
TABLE_FILE_BLOCK_SIZE("table.file.blocksize", "0B", PropertyType.BYTES,
"The HDFS block size used when writing RFiles. When set to 0B, the"
- + " value/defaults of HDFS property 'dfs.block.size' will be used."),
+ + " value/defaults of HDFS property 'dfs.block.size' will be used.",
+ "1.3.5"),
TABLE_FILE_REPLICATION("table.file.replication", "0", PropertyType.COUNT,
"The number of replicas for a table's RFiles in HDFS. When set to 0, HDFS"
- + " defaults are used."),
+ + " defaults are used.",
+ "1.3.5"),
TABLE_FILE_MAX("table.file.max", "15", PropertyType.COUNT,
"The maximum number of RFiles each tablet in a table can have. When"
+ " adjusting this property you may want to consider adjusting"
+ " table.compaction.major.ratio also. Setting this property to 0 will make"
+ " it default to tserver.scan.files.open.max-1, this will prevent a tablet"
+ " from having more RFiles than can be opened. Setting this property low may"
- + " throttle ingest and increase query performance."),
+ + " throttle ingest and increase query performance.",
+ "1.4.0"),
TABLE_FILE_SUMMARY_MAX_SIZE("table.file.summary.maxSize", "256k", PropertyType.BYTES,
"The maximum size summary that will be stored. The number of RFiles that"
+ " had summary data exceeding this threshold is reported by"
+ " Summary.getFileStatistics().getLarge(). When adjusting this consider the"
+ " expected number RFiles with summaries on each tablet server and the"
- + " summary cache size."),
+ + " summary cache size.",
+ "2.0.0"),
TABLE_BLOOM_ENABLED("table.bloom.enabled", "false", PropertyType.BOOLEAN,
- "Use bloom filters on this table."),
+ "Use bloom filters on this table.", "1.3.5"),
TABLE_BLOOM_LOAD_THRESHOLD("table.bloom.load.threshold", "1", PropertyType.COUNT,
"This number of seeks that would actually use a bloom filter must occur"
+ " before a RFile's bloom filter is loaded. Set this to zero to initiate"
- + " loading of bloom filters when a RFile is opened."),
+ + " loading of bloom filters when a RFile is opened.",
+ "1.3.5"),
TABLE_BLOOM_SIZE("table.bloom.size", "1048576", PropertyType.COUNT,
- "Bloom filter size, as number of keys."),
+ "Bloom filter size, as number of keys.", "1.3.5"),
TABLE_BLOOM_ERRORRATE("table.bloom.error.rate", "0.5%", PropertyType.FRACTION,
- "Bloom filter error rate."),
+ "Bloom filter error rate.", "1.3.5"),
TABLE_BLOOM_KEY_FUNCTOR("table.bloom.key.functor",
"org.apache.accumulo.core.file.keyfunctor.RowFunctor", PropertyType.CLASSNAME,
"A function that can transform the key prior to insertion and check of"
@@ -850,23 +966,27 @@ public enum Property {
+ " org.apache.accumulo.core.file.keyfunctor.ColumnFamilyFunctor, and"
+ " org.apache.accumulo.core.file.keyfunctor.ColumnQualifierFunctor are"
+ " allowable values. One can extend any of the above mentioned classes to"
- + " perform specialized parsing of the key. "),
+ + " perform specialized parsing of the key. ",
+ "1.3.5"),
TABLE_BLOOM_HASHTYPE("table.bloom.hash.type", "murmur", PropertyType.STRING,
- "The bloom filter hash type"),
+ "The bloom filter hash type", "1.3.5"),
TABLE_BULK_MAX_TABLETS("table.bulk.max.tablets", "0", PropertyType.COUNT,
"The maximum number of tablets allowed for one bulk import file. Value of 0 is Unlimited. "
- + "This property is only enforced in the new bulk import API"),
+ + "This property is only enforced in the new bulk import API",
+ "2.1.0"),
TABLE_DURABILITY("table.durability", "sync", PropertyType.DURABILITY,
"The durability used to write to the write-ahead log. Legal values are:"
+ " none, which skips the write-ahead log; log, which sends the data to the"
+ " write-ahead log, but does nothing to make it durable; flush, which pushes"
- + " data to the file system; and sync, which ensures the data is written to disk."),
+ + " data to the file system; and sync, which ensures the data is written to disk.",
+ "1.7.0"),
TABLE_FAILURES_IGNORE("table.failures.ignore", "false", PropertyType.BOOLEAN,
"If you want queries for your table to hang or fail when data is missing"
+ " from the system, then set this to false. When this set to true missing"
+ " data will be reported but queries will still run possibly returning a"
- + " subset of the data."),
+ + " subset of the data.",
+ "1.3.5"),
TABLE_DEFAULT_SCANTIME_VISIBILITY("table.security.scan.visibility.default", "",
PropertyType.STRING,
"The security label that will be assumed at scan time if an entry does"
@@ -878,20 +998,22 @@ public enum Property {
+ " table's default visibility is also empty, access will ALWAYS be"
+ " granted for users with permission to that table. Additionally, if this"
+ " field is changed, all existing data with an empty visibility label"
- + " will be interpreted with the new label on the next scan."),
+ + " will be interpreted with the new label on the next scan.",
+ "1.3.5"),
TABLE_LOCALITY_GROUPS("table.groups.enabled", "", PropertyType.STRING,
- "A comma separated list of locality group names to enable for this table."),
+ "A comma separated list of locality group names to enable for this table.", "1.3.5"),
TABLE_CONSTRAINT_PREFIX("table.constraint.", null, PropertyType.PREFIX,
"Properties in this category are per-table properties that add"
+ " constraints to a table. These properties start with the category"
+ " prefix, followed by a number, and their values correspond to a fully"
+ " qualified Java class that implements the Constraint interface.\n" + "For example:\n"
+ "table.constraint.1 = org.apache.accumulo.core.constraints.MyCustomConstraint\n"
- + "and:\n" + " table.constraint.2 = my.package.constraints.MySecondConstraint"),
+ + "and:\n" + " table.constraint.2 = my.package.constraints.MySecondConstraint",
+ "1.3.5"),
TABLE_INDEXCACHE_ENABLED("table.cache.index.enable", "true", PropertyType.BOOLEAN,
- "Determines whether index block cache is enabled for a table."),
+ "Determines whether index block cache is enabled for a table.", "1.3.5"),
TABLE_BLOCKCACHE_ENABLED("table.cache.block.enable", "false", PropertyType.BOOLEAN,
- "Determines whether data block cache is enabled for a table."),
+ "Determines whether data block cache is enabled for a table.", "1.3.5"),
TABLE_ITERATOR_PREFIX("table.iterator.", null, PropertyType.PREFIX,
"Properties in this category specify iterators that are applied at"
+ " various stages (scopes) of interaction with a table. These properties"
@@ -904,13 +1026,17 @@ public enum Property {
+ "These iterators can take options if additional properties are set that"
+ " look like this property, but are suffixed with a period, followed by 'opt'"
+ " followed by another period, and a property name.\n"
- + "For example, table.iterator.minc.vers.opt.maxVersions = 3"),
+ + "For example, table.iterator.minc.vers.opt.maxVersions = 3",
+ "1.3.5"),
TABLE_ITERATOR_SCAN_PREFIX(TABLE_ITERATOR_PREFIX.getKey() + IteratorScope.scan.name() + ".", null,
- PropertyType.PREFIX, "Convenience prefix to find options for the scan iterator scope"),
+ PropertyType.PREFIX, "Convenience prefix to find options for the scan iterator scope",
+ "1.5.2"),
TABLE_ITERATOR_MINC_PREFIX(TABLE_ITERATOR_PREFIX.getKey() + IteratorScope.minc.name() + ".", null,
- PropertyType.PREFIX, "Convenience prefix to find options for the minc iterator scope"),
+ PropertyType.PREFIX, "Convenience prefix to find options for the minc iterator scope",
+ "1.5.2"),
TABLE_ITERATOR_MAJC_PREFIX(TABLE_ITERATOR_PREFIX.getKey() + IteratorScope.majc.name() + ".", null,
- PropertyType.PREFIX, "Convenience prefix to find options for the majc iterator scope"),
+ PropertyType.PREFIX, "Convenience prefix to find options for the majc iterator scope",
+ "1.5.2"),
TABLE_LOCALITY_GROUP_PREFIX("table.group.", null, PropertyType.PREFIX,
"Properties in this category are per-table properties that define"
+ " locality groups in a table. These properties start with the category"
@@ -920,25 +1046,29 @@ public enum Property {
+ " group called group1. Once configured, group1 can be enabled by adding"
+ " it to the list of groups in the " + TABLE_LOCALITY_GROUPS.getKey() + " property.\n"
+ "Additional group options may be specified for a named group by setting"
- + " `table.group.<name>.opt.<key>=<value>`."),
+ + " `table.group.<name>.opt.<key>=<value>`.",
+ "1.3.5"),
TABLE_FORMATTER_CLASS("table.formatter", DefaultFormatter.class.getName(), PropertyType.STRING,
- "The Formatter class to apply on results in the shell"),
+ "The Formatter class to apply on results in the shell", "1.4.0"),
TABLE_INTERPRETER_CLASS("table.interepreter", DefaultScanInterpreter.class.getName(),
- PropertyType.STRING, "The ScanInterpreter class to apply on scan arguments in the shell"),
+ PropertyType.STRING, "The ScanInterpreter class to apply on scan arguments in the shell",
+ "1.5.0"),
TABLE_CLASSLOADER_CONTEXT("table.class.loader.context", "", PropertyType.STRING,
"The context to use for loading per-table resources, such as iterators"
- + " from the configured factory in `general.context.class.loader.factory`."),
+ + " from the configured factory in `general.context.class.loader.factory`.",
+ "2.1.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
@ReplacedBy(property = TABLE_CLASSLOADER_CONTEXT)
- TABLE_CLASSPATH("table.classpath.context", "", PropertyType.STRING,
- "Per table classpath context"),
+ TABLE_CLASSPATH("table.classpath.context", "", PropertyType.STRING, "Per table classpath context",
+ "1.5.0"),
TABLE_REPLICATION("table.replication", "false", PropertyType.BOOLEAN,
- "Is replication enabled for the given table"),
+ "Is replication enabled for the given table", "1.7.0"),
TABLE_REPLICATION_TARGET("table.replication.target.", null, PropertyType.PREFIX,
"Enumerate a mapping of other systems which this table should replicate"
+ " their data to. The key suffix is the identifying cluster name and the"
+ " value is an identifier for a location on the target system, e.g. the ID"
- + " of the table on the target to replicate to"),
+ + " of the table on the target to replicate to",
+ "1.7.0"),
TABLE_SAMPLER("table.sampler", "", PropertyType.CLASSNAME,
"The name of a class that implements org.apache.accumulo.core.Sampler."
+ " Setting this option enables storing a sample of data which can be"
@@ -946,23 +1076,27 @@ public enum Property {
+ " and data comprehension. After enabling sampling for an existing table,"
+ " a compaction is needed to compute the sample for existing data. The"
+ " compact command in the shell has an option to only compact RFiles without"
- + " sample data."),
+ + " sample data.",
+ "1.8.0"),
TABLE_SAMPLER_OPTS("table.sampler.opt.", null, PropertyType.PREFIX,
"The property is used to set options for a sampler. If a sample had two"
+ " options like hasher and modulous, then the two properties"
+ " table.sampler.opt.hasher=${hash algorithm} and"
- + " table.sampler.opt.modulous=${mod} would be set."),
+ + " table.sampler.opt.modulous=${mod} would be set.",
+ "1.8.0"),
TABLE_SUSPEND_DURATION("table.suspend.duration", "0s", PropertyType.TIMEDURATION,
"For tablets belonging to this table: When a tablet server dies, allow"
+ " the tablet server this duration to revive before reassigning its tablets"
- + " to other tablet servers."),
+ + " to other tablet servers.",
+ "1.8.0"),
TABLE_SUMMARIZER_PREFIX("table.summarizer.", null, PropertyType.PREFIX,
"Prefix for configuring summarizers for a table. Using this prefix"
+ " multiple summarizers can be configured with options for each one. Each"
+ " summarizer configured should have a unique id, this id can be anything."
+ " To add a summarizer set "
+ "`table.summarizer.<unique id>=<summarizer class name>.` If the summarizer has options"
- + ", then for each option set `table.summarizer.<unique id>.opt.<key>=<value>`."),
+ + ", then for each option set `table.summarizer.<unique id>.opt.<key>=<value>`.",
+ "2.0.0"),
@Experimental
TABLE_DELETE_BEHAVIOR("table.delete.behavior",
DeletingIterator.Behavior.PROCESS.name().toLowerCase(), PropertyType.STRING,
@@ -972,7 +1106,8 @@ public enum Property {
+ " an exception. The purpose of `fail` is to support tables that never delete data and"
+ " need fast seeks within the timestamp range of a column. When setting this to fail, "
+ "also consider configuring the `" + NoDeleteConstraint.class.getName() + "` "
- + "constraint."),
+ + "constraint.",
+ "2.0.0"),
// VFS ClassLoader properties
@@ -983,7 +1118,8 @@ public enum Property {
org.apache.accumulo.start.classloader.vfs.AccumuloVFSClassLoader.VFS_CLASSLOADER_SYSTEM_CLASSPATH_PROPERTY,
"", PropertyType.STRING,
"Configuration for a system level vfs classloader. Accumulo jar can be"
- + " configured here and loaded out of HDFS."),
+ + " configured here and loaded out of HDFS.",
+ "1.5.0"),
@Deprecated(since = "2.1.0", forRemoval = true)
VFS_CONTEXT_CLASSPATH_PROPERTY(
org.apache.accumulo.start.classloader.vfs.AccumuloVFSClassLoader.VFS_CONTEXT_CLASSPATH_PROPERTY,
@@ -996,7 +1132,8 @@ public enum Property {
+ " context first instead of the parent first. Do this by setting"
+ " `general.vfs.context.classpath.<name>.delegation=post`, where `<name>` is"
+ " your context name. If delegation is not specified, it defaults to loading"
- + " from parent classloader first."),
+ + " from parent classloader first.",
+ "1.5.0"),
// this property shouldn't be used directly; it exists solely to document the default value
// defined by its use in AccumuloVFSClassLoader when generating the property documentation
@@ -1008,183 +1145,206 @@ public enum Property {
+ " in a subdirectory, `accumulo-vfs-cache-<jvmProcessName>-${user.name}`, where"
+ " `<jvmProcessName>` is determined by the JVM's internal management engine."
+ " The cache will keep a soft reference to all of the classes loaded in the VM."
- + " This should be on local disk on each node with sufficient space."),
+ + " This should be on local disk on each node with sufficient space.",
+ "1.5.0"),
// General properties for configuring replication
REPLICATION_PREFIX("replication.", null, PropertyType.PREFIX,
- "Properties in this category affect the replication of data to other Accumulo instances."),
+ "Properties in this category affect the replication of data to other Accumulo instances.",
+ "1.7.0"),
REPLICATION_PEERS("replication.peer.", null, PropertyType.PREFIX,
- "Properties in this category control what systems data can be replicated to"),
+ "Properties in this category control what systems data can be replicated to", "1.7.0"),
REPLICATION_PEER_USER("replication.peer.user.", null, PropertyType.PREFIX,
- "The username to provide when authenticating with the given peer"),
+ "The username to provide when authenticating with the given peer", "1.7.0"),
@Sensitive
REPLICATION_PEER_PASSWORD("replication.peer.password.", null, PropertyType.PREFIX,
- "The password to provide when authenticating with the given peer"),
+ "The password to provide when authenticating with the given peer", "1.7.0"),
REPLICATION_PEER_KEYTAB("replication.peer.keytab.", null, PropertyType.PREFIX,
- "The keytab to use when authenticating with the given peer"),
+ "The keytab to use when authenticating with the given peer", "1.7.0"),
REPLICATION_NAME("replication.name", "", PropertyType.STRING,
"Name of this cluster with respect to replication. Used to identify this"
- + " instance from other peers"),
+ + " instance from other peers",
+ "1.7.0"),
REPLICATION_MAX_WORK_QUEUE("replication.max.work.queue", "1000", PropertyType.COUNT,
- "Upper bound of the number of files queued for replication"),
+ "Upper bound of the number of files queued for replication", "1.7.0"),
REPLICATION_WORK_ASSIGNMENT_SLEEP("replication.work.assignment.sleep", "30s",
- PropertyType.TIMEDURATION, "Amount of time to sleep between replication work assignment"),
+ PropertyType.TIMEDURATION, "Amount of time to sleep between replication work assignment",
+ "1.7.0"),
REPLICATION_WORKER_THREADS("replication.worker.threads", "4", PropertyType.COUNT,
- "Size of the threadpool that each tabletserver devotes to replicating data"),
+ "Size of the threadpool that each tabletserver devotes to replicating data", "1.7.0"),
REPLICATION_RECEIPT_SERVICE_PORT("replication.receipt.service.port", "10002", PropertyType.PORT,
- "Listen port used by thrift service in tserver listening for replication"),
+ "Listen port used by thrift service in tserver listening for replication", "1.7.0"),
REPLICATION_WORK_ATTEMPTS("replication.work.attempts", "10", PropertyType.COUNT,
"Number of attempts to try to replicate some data before giving up and"
- + " letting it naturally be retried later"),
+ + " letting it naturally be retried later",
+ "1.7.0"),
REPLICATION_MIN_THREADS("replication.receiver.min.threads", "1", PropertyType.COUNT,
- "Minimum number of threads for replication"),
+ "Minimum number of threads for replication", "1.7.0"),
REPLICATION_THREADCHECK("replication.receiver.threadcheck.time", "30s", PropertyType.TIMEDURATION,
- "The time between adjustments of the replication thread pool."),
+ "The time between adjustments of the replication thread pool.", "1.7.0"),
REPLICATION_MAX_UNIT_SIZE("replication.max.unit.size", "64M", PropertyType.BYTES,
- "Maximum size of data to send in a replication message"),
+ "Maximum size of data to send in a replication message", "1.7.0"),
REPLICATION_WORK_ASSIGNER("replication.work.assigner",
"org.apache.accumulo.manager.replication.UnorderedWorkAssigner", PropertyType.CLASSNAME,
- "Replication WorkAssigner implementation to use"),
+ "Replication WorkAssigner implementation to use", "1.7.0"),
REPLICATION_DRIVER_DELAY("replication.driver.delay", "0s", PropertyType.TIMEDURATION,
- "Amount of time to wait before the replication work loop begins in the manager."),
+ "Amount of time to wait before the replication work loop begins in the manager.", "1.7.0"),
REPLICATION_WORK_PROCESSOR_DELAY("replication.work.processor.delay", "0s",
PropertyType.TIMEDURATION,
"Amount of time to wait before first checking for replication work, not"
- + " useful outside of tests"),
+ + " useful outside of tests",
+ "1.7.0"),
REPLICATION_WORK_PROCESSOR_PERIOD("replication.work.processor.period", "0s",
PropertyType.TIMEDURATION,
"Amount of time to wait before re-checking for replication work, not"
- + " useful outside of tests"),
+ + " useful outside of tests",
+ "1.7.0"),
REPLICATION_TRACE_PERCENT("replication.trace.percent", "0.1", PropertyType.FRACTION,
- "The sampling percentage to use for replication traces"),
+ "The sampling percentage to use for replication traces", "1.7.0"),
REPLICATION_RPC_TIMEOUT("replication.rpc.timeout", "2m", PropertyType.TIMEDURATION,
"Amount of time for a single replication RPC call to last before failing"
- + " the attempt. See replication.work.attempts."),
+ + " the attempt. See replication.work.attempts.",
+ "1.7.4"),
// Compactor properties
@Experimental
COMPACTOR_PREFIX("compactor.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the accumulo compactor server."),
+ "Properties in this category affect the behavior of the accumulo compactor server.", "2.1.0"),
@Experimental
COMPACTOR_PORTSEARCH("compactor.port.search", "false", PropertyType.BOOLEAN,
- "If the compactor.port.client is in use, search higher ports until one is available"),
+ "If the compactor.port.client is in use, search higher ports until one is available",
+ "2.1.0"),
@Experimental
COMPACTOR_CLIENTPORT("compactor.port.client", "9133", PropertyType.PORT,
- "The port used for handling client connections on the compactor servers"),
+ "The port used for handling client connections on the compactor servers", "2.1.0"),
@Experimental
COMPACTOR_MINTHREADS("compactor.threads.minimum", "1", PropertyType.COUNT,
- "The minimum number of threads to use to handle incoming requests."),
+ "The minimum number of threads to use to handle incoming requests.", "2.1.0"),
@Experimental
COMPACTOR_MINTHREADS_TIMEOUT("compactor.threads.timeout", "0s", PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
@Experimental
COMPACTOR_THREADCHECK("compactor.threadcheck.time", "1s", PropertyType.TIMEDURATION,
- "The time between adjustments of the server thread pool."),
+ "The time between adjustments of the server thread pool.", "2.1.0"),
@Experimental
COMPACTOR_MAX_MESSAGE_SIZE("compactor.message.size.max", "10M", PropertyType.BYTES,
- "The maximum size of a message that can be sent to a tablet server."),
+ "The maximum size of a message that can be sent to a tablet server.", "2.1.0"),
// CompactionCoordinator properties
@Experimental
COMPACTION_COORDINATOR_PREFIX("compaction.coordinator.", null, PropertyType.PREFIX,
- "Properties in this category affect the behavior of the accumulo compaction coordinator server."),
+ "Properties in this category affect the behavior of the accumulo compaction coordinator server.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_THRIFTCLIENT_PORTSEARCH("compaction.coordinator.port.search", "false",
PropertyType.BOOLEAN,
- "If the ports above are in use, search higher ports until one is available"),
+ "If the ports above are in use, search higher ports until one is available", "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_CLIENTPORT("compaction.coordinator.port.client", "9132", PropertyType.PORT,
- "The port used for handling Thrift client connections on the compaction coordinator server"),
+ "The port used for handling Thrift client connections on the compaction coordinator server",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MINTHREADS("compaction.coordinator.threads.minimum", "1",
- PropertyType.COUNT, "The minimum number of threads to use to handle incoming requests."),
+ PropertyType.COUNT, "The minimum number of threads to use to handle incoming requests.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MINTHREADS_TIMEOUT("compaction.coordinator.threads.timeout", "0s",
PropertyType.TIMEDURATION,
- "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely."),
+ "The time after which incoming request threads terminate with no work available. Zero (0) will keep the threads alive indefinitely.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_THREADCHECK("compaction.coordinator.threadcheck.time", "1s",
- PropertyType.TIMEDURATION, "The time between adjustments of the server thread pool."),
+ PropertyType.TIMEDURATION, "The time between adjustments of the server thread pool.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_MAX_MESSAGE_SIZE("compaction.coordinator.message.size.max", "10M",
- PropertyType.BYTES, "The maximum size of a message that can be sent to a tablet server."),
+ PropertyType.BYTES, "The maximum size of a message that can be sent to a tablet server.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_DEAD_COMPACTOR_CHECK_INTERVAL(
"compaction.coordinator.compactor.dead.check.interval", "5m", PropertyType.TIMEDURATION,
- "The interval at which to check for dead compactors."),
+ "The interval at which to check for dead compactors.", "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_FINALIZER_TSERVER_NOTIFIER_MAXTHREADS(
"compaction.coordinator.compaction.finalizer.threads.maximum", "5", PropertyType.COUNT,
- "The maximum number of threads to use for notifying tablet servers that an external compaction has completed."),
+ "The maximum number of threads to use for notifying tablet servers that an external compaction has completed.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_FINALIZER_COMPLETION_CHECK_INTERVAL(
"compaction.coordinator.compaction.finalizer.check.interval", "60s",
PropertyType.TIMEDURATION,
- "The interval at which to check for external compaction final state markers in the metadata table."),
+ "The interval at which to check for external compaction final state markers in the metadata table.",
+ "2.1.0"),
@Experimental
COMPACTION_COORDINATOR_TSERVER_COMPACTION_CHECK_INTERVAL(
"compaction.coordinator.tserver.check.interval", "1m", PropertyType.TIMEDURATION,
- "The interval at which to check the tservers for external compactions."),
+ "The interval at which to check the tservers for external compactions.", "2.1.0"),
// deprecated properties grouped at the end to reference property that replaces them
@Deprecated(since = "1.6.0")
@ReplacedBy(property = INSTANCE_VOLUMES)
INSTANCE_DFS_URI("instance.dfs.uri", "", PropertyType.URI,
- "This property is deprecated since 1.6.0. "
- + "A url accumulo should use to connect to DFS. If this is empty, accumulo"
+ "A url accumulo should use to connect to DFS. If this is empty, accumulo"
+ " will obtain this information from the hadoop configuration. This property"
+ " will only be used when creating new files if instance.volumes is empty."
+ " After an upgrade to 1.6.0 Accumulo will start using absolute paths to"
+ " reference files. Files created before a 1.6.0 upgrade are referenced via"
+ " relative paths. Relative paths will always be resolved using this config"
- + " (if empty using the hadoop config)."),
+ + " (if empty using the hadoop config).",
+ "1.4.0"),
@Deprecated(since = "1.6.0")
@ReplacedBy(property = INSTANCE_VOLUMES)
INSTANCE_DFS_DIR("instance.dfs.dir", "/accumulo", PropertyType.ABSOLUTEPATH,
- "This property is deprecated since 1.6.0. "
- + "HDFS directory in which accumulo instance will run. "
- + "Do not change after accumulo is initialized."),
+ "HDFS directory in which accumulo instance will run. "
+ + "Do not change after accumulo is initialized.",
+ "1.3.5"),
@Deprecated(since = "2.0.0")
GENERAL_CLASSPATHS(org.apache.accumulo.start.classloader.AccumuloClassLoader.GENERAL_CLASSPATHS,
"", PropertyType.STRING,
- "This property is deprecated since 2.0.0. The class path should instead be configured"
+ "The class path should instead be configured"
+ " by the launch environment (for example, accumulo-env.sh). A list of all"
+ " of the places to look for a class. Order does matter, as it will look for"
+ " the jar starting in the first location to the last. Supports full regex"
- + " on filename alone."),
+ + " on filename alone.",
+ "1.3.5"),
@Deprecated(since = "1.7.0")
@ReplacedBy(property = TABLE_DURABILITY)
TSERV_WAL_SYNC_METHOD("tserver.wal.sync.method", "hsync", PropertyType.STRING,
- "This property is deprecated since 1.7.0. Use table.durability instead."),
+ "Use table.durability instead.", "1.5.2"),
@Deprecated(since = "1.7.0")
@ReplacedBy(property = TABLE_DURABILITY)
TABLE_WALOG_ENABLED("table.walog.enabled", "true", PropertyType.BOOLEAN,
- "This setting is deprecated since 1.7.0. Use table.durability=none instead."),
+ "Use table.durability=none instead.", "1.3.5"),
@Deprecated(since = "2.0.0")
@ReplacedBy(property = TSERV_SCAN_EXECUTORS_DEFAULT_THREADS)
TSERV_READ_AHEAD_MAXCONCURRENT("tserver.readahead.concurrent.max", "16", PropertyType.COUNT,
- "This property is deprecated since 2.0.0, use tserver.scan.executors.default.threads "
- + "instead. The maximum number of concurrent read ahead that will execute. This "
+ "The maximum number of concurrent read ahead that will execute. This "
+ "effectively limits the number of long running scans that can run concurrently "
- + "per tserver.\""),
+ + "per tserver.\"",
+ "1.3.5"),
@Deprecated(since = "2.0.0")
@ReplacedBy(property = TSERV_SCAN_EXECUTORS_META_THREADS)
TSERV_METADATA_READ_AHEAD_MAXCONCURRENT("tserver.metadata.readahead.concurrent.max", "8",
- PropertyType.COUNT,
- "This property is deprecated since 2.0.0, use tserver.scan.executors.meta.threads instead. "
- + "The maximum number of concurrent metadata read ahead that will execute.");
+ PropertyType.COUNT, "The maximum number of concurrent metadata read ahead that will execute.",
+ "1.3.5");
private final String key;
private final String defaultValue;
private final String description;
+ private String deprecatedSince;
+ private final String availableSince;
private boolean annotationsComputed = false;
private boolean isSensitive;
private boolean isDeprecated;
private boolean isExperimental;
+ private boolean isReplaced;
private Property replacedBy = null;
private final PropertyType type;
- Property(String name, String defaultValue, PropertyType type, String description) {
+ Property(String name, String defaultValue, PropertyType type, String description,
+ String availableSince) {
this.key = name;
this.defaultValue = defaultValue;
this.description = description;
+ this.availableSince = availableSince;
this.type = type;
}
@@ -1253,6 +1413,26 @@ public enum Property {
}
/**
+ * Gets the version in which the property was deprecated.
+ *
+ * @return Accumulo Version
+ */
+ public String deprecatedSince() {
+ Preconditions.checkState(annotationsComputed,
+ "precomputeAnnotations() must be called before calling this method");
+ return deprecatedSince;
+ }
+
+ /**
+ * Gets the version in which the property was introduced.
+ *
+ * @return Accumulo Version
+ */
+ public String availableSince() {
+ return this.availableSince;
+ }
+
+ /**
* Checks if this property is sensitive.
*
* @return true if this property is sensitive
@@ -1263,6 +1443,22 @@ public enum Property {
return isSensitive;
}
+ /**
+ * Checks if this property is replaced.
+ *
+ * @return true if this property is replaced
+ */
+ public boolean isReplaced() {
+ Preconditions.checkState(annotationsComputed,
+ "precomputeAnnotations() must be called before calling this method");
+ return isReplaced;
+ }
+
+ /**
+ * Gets the property in which the tagged property is replaced by.
+ *
+ * @return replacedBy
+ */
public Property replacedBy() {
Preconditions.checkState(annotationsComputed,
"precomputeAnnotations() must be called before calling this method");
@@ -1274,8 +1470,16 @@ public enum Property {
hasAnnotation(Sensitive.class) || hasPrefixWithAnnotation(getKey(), Sensitive.class);
isDeprecated =
hasAnnotation(Deprecated.class) || hasPrefixWithAnnotation(getKey(), Deprecated.class);
+ if (hasAnnotation(Deprecated.class)) {
+ Deprecated dep = getAnnotation(Deprecated.class);
+ if (dep != null) {
+ deprecatedSince = dep.since();
+ }
+ }
isExperimental =
hasAnnotation(Experimental.class) || hasPrefixWithAnnotation(getKey(), Experimental.class);
+ isReplaced =
+ hasAnnotation(ReplacedBy.class) || hasPrefixWithAnnotation(getKey(), ReplacedBy.class);
if (hasAnnotation(ReplacedBy.class)) {
ReplacedBy rb = getAnnotation(ReplacedBy.class);
if (rb != null) {