This is the documentation for Cloudera Manager 5.0.x. Documentation for other versions is available at Cloudera Documentation.

Accumulo

Role groups:

Garbage Collector Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Garbage Collector Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_GC_role_env_safety_valve false
Garbage Collector Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Garbage Collector Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Garbage Collector Log Directory The log directory for log files of the role Garbage Collector. log_dir /var/log/accumulo log_dir false
Garbage Collector Logging Threshold The minimum log level for Garbage Collector logs INFO log_threshold false
Garbage Collector Maximum Log File Backups The maximum number of rolled log files to keep for Garbage Collector logs. Typically used by log4j. 10 max_log_backup_index false
Garbage Collector Max Log Size The maximum size, in megabytes, per log file for Garbage Collector logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_gc_fd_thresholds false
Garbage Collector Host Health Test When computing the overall Garbage Collector health, consider the host's health. true accumulo_gc_host_health_enabled false
Garbage Collector Process Health Test Enables the health test that the Garbage Collector's process state is consistent with the role configuration true accumulo_gc_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Java Heap Size of Garbage Collector in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. gc_max_heapsize 1 GiB gc_max_heapsize true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Gateway Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Accumulo Client Advanced Configuration Snippet (Safety Valve) for accumulo-conf/accumulo-env.sh For advanced use only, a string to be inserted into the client configuration for accumulo-conf/accumulo-env.sh. accumulo-conf/accumulo-env.sh_client_config_safety_valve false
Accumulo Client Advanced Configuration Snippet (Safety Valve) for accumulo-conf/accumulo-site.xml For advanced use only, a string to be inserted into the client configuration for accumulo-conf/accumulo-site.xml. accumulo-conf/accumulo-site.xml_client_config_safety_valve false
Accumulo Client Advanced Configuration Snippet (Safety Valve) for accumulo-conf/log4j.properties For advanced use only, a string to be inserted into the client configuration for accumulo-conf/log4j.properties. accumulo-conf/log4j.properties_client_config_safety_valve false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false

Other

Display Name Description Related Name Default Value Unit API Name Required
Alternatives Priority The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others. 50 client_config_priority true
Client Java Heap Size in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. client_max_heapsize 1 GiB client_max_heapsize true

Logger Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Logger Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_LOGGER_role_env_safety_valve false
Logger Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Logger Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Logger Log Directory The log directory for log files of the role Logger. log_dir /var/log/accumulo log_dir false
Logger Logging Threshold The minimum log level for Logger logs INFO log_threshold false
Logger Maximum Log File Backups The maximum number of rolled log files to keep for Logger logs. Typically used by log4j. 10 max_log_backup_index false
Logger Max Log Size The maximum size, in megabytes, per log file for Logger logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_logger_fd_thresholds false
Logger Host Health Test When computing the overall Logger health, consider the host's health. true accumulo_logger_host_health_enabled false
Logger Process Health Test Enables the health test that the Logger's process state is consistent with the role configuration true accumulo_logger_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Logger WAL Directories The directory used to store write-ahead logs on the local filesystem. It is possible to specify a comma-separated list of directories. logger.dir.walog /var/lib/accumulo/walogs logger_dir_walog true
Java Heap Size of Logger in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. logger_max_heapsize 1 GiB logger_max_heapsize true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Master Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Master Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_MASTER_role_env_safety_valve false
Master Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Master Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Master Log Directory The log directory for log files of the role Master. log_dir /var/log/accumulo log_dir false
Master Logging Threshold The minimum log level for Master logs INFO log_threshold false
Master Maximum Log File Backups The maximum number of rolled log files to keep for Master logs. Typically used by log4j. 10 max_log_backup_index false
Master Max Log Size The maximum size, in megabytes, per log file for Master logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_master_fd_thresholds false
Master Host Health Test When computing the overall Master health, consider the host's health. true accumulo_master_host_health_enabled false
Master Process Health Test Enables the health test that the Master's process state is consistent with the role configuration true accumulo_master_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Java Heap Size of Master in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. master_max_heapsize 1 GiB master_max_heapsize true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Monitor Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Monitor Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_MONITOR_role_env_safety_valve false
Monitor Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Monitor Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Monitor Log Directory The log directory for log files of the role Monitor. log_dir /var/log/accumulo log_dir false
Monitor Logging Threshold The minimum log level for Monitor logs INFO log_threshold false
Monitor Maximum Log File Backups The maximum number of rolled log files to keep for Monitor logs. Typically used by log4j. 10 max_log_backup_index false
Monitor Max Log Size The maximum size, in megabytes, per log file for Monitor logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_monitor_fd_thresholds false
Monitor Host Health Test When computing the overall Monitor health, consider the host's health. true accumulo_monitor_host_health_enabled false
Monitor Process Health Test Enables the health test that the Monitor's process state is consistent with the role configuration true accumulo_monitor_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Java Heap Size of Monitor in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. monitor_max_heapsize 1 GiB monitor_max_heapsize true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Service-Wide

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Accumulo Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. ACCUMULO_service_env_safety_valve false
Accumulo Service Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml. Applies to configurations of all roles in this service except client configuration. accumulo-site.xml_service_safety_valve false
System Group The group that this service's processes should run as. accumulo process_groupname true
System User The user that this service's processes should run as. accumulo process_username true

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Service Triggers The configured triggers for this service. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger that fires if there are more than 10 DataNodes with more than 500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:red",
  "streamThreshold": 10, "enabled": "true"}]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false

Other

Display Name Description Related Name Default Value Unit API Name Required
Additional Classpath Additional paths to add to general.classpaths. accumulo_classpath accumulo_classpath false
HDFS Directory The directory used in HDFS by Accumulo. instance.dfs.dir /accumulo accumulo_hdfs_dir true
Instance Name Name of the Accumulo instance. Used while initializing Accumulo. accumulo_instance_name accumulo accumulo_instance_name true
Accumulo Instance Secret A secret unique to a given instance that all servers must know in order to communicate with one another. instance.secret DEFAULT accumulo_instance_secret true
Additional Java Options These arguments will be passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags would be passed here. accumulo_java_opts -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:-CMSConcurrentMTEnabled -XX:CMSInitiatingOccupancyFraction=70 -XX:+CMSParallelRemarkEnabled -Djava.net.preferIPv4Stack=true accumulo_java_opts false
Root Password Password for root Accumulo user. Used while initializing Accumulo. If you are chaging this and are using root user for tracing, make sure to set Trace Password to same value. accumulo_root_password secret accumulo_root_password true
Trace Password Trace Password. If you are using root user for tracing, then make sure it is set to same value as Root Password. trace.password secret accumulo_trace_password true
Trace User Trace User trace.user root accumulo_trace_user true
MapReduce Service Name of the MapReduce service that this Accumulo service instance depends on mapreduce_service true
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 180000 stop_timeout false
Table File Replication Replication factor for table files. table.file.replication 3 table_file_replication true
ZooKeeper Service Name of the ZooKeeper service that this Accumulo service instance depends on zookeeper_service true

Ports and Addresses

Display Name Description Related Name Default Value Unit API Name Required
Master Client Port Port number on which clients communicate with Accumulo Master master.port.client 10010 master_port_client true
Monitor Client Port Port number on which clients communicate with Accumulo Monitor monitor.port.client 50095 monitor_port_client true
Tablet Server Client Port Port number on which clients communicate with Tablet Server tserver.port.client 10011 tserver_port_client true

Tablet Server Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Tablet Server Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_TSERVER_role_env_safety_valve false
Tablet Server Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Tablet Server Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Tablet Server Log Directory The log directory for log files of the role Tablet Server. log_dir /var/log/accumulo log_dir false
Tablet Server Logging Threshold The minimum log level for Tablet Server logs INFO log_threshold false
Tablet Server Maximum Log File Backups The maximum number of rolled log files to keep for Tablet Server logs. Typically used by log4j. 10 max_log_backup_index false
Tablet Server Max Log Size The maximum size, in megabytes, per log file for Tablet Server logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_tserver_fd_thresholds false
Tablet Server Host Health Test When computing the overall Tablet Server health, consider the host's health. true accumulo_tserver_host_health_enabled false
Tablet Server Process Health Test Enables the health test that the Tablet Server's process state is consistent with the role configuration true accumulo_tserver_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Tablet Server Cache Data Size Tablet Server cache data size. tserver.cache.data.size 15 MiB tserver_cache_data_size true
Tablet Server Cache Index Size Tablet Server cache index size. tserver.cache.index.size 40 MiB tserver_cache_index_size true
Java Heap Size of Tablet Server in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. tserver_max_heapsize 2 GiB tserver_max_heapsize true
Tablet Server Memory Maps Max Size Maximum size of Tablet Servers memory maps. tserver.memory.maps.max 256 MiB tserver_memory_maps_max true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Tracer Default Group

Advanced

Display Name Description Related Name Default Value Unit API Name Required
Tracer Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. ACCUMULO_TRACER_role_env_safety_valve false
Tracer Advanced Configuration Snippet (Safety Valve) for accumulo-site.xml For advanced use only, a string to be inserted into accumulo-site.xml for this role only. accumulo-site.xml_role_safety_valve false
Tracer Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. false process_auto_restart true

Logs

Display Name Description Related Name Default Value Unit API Name Required
Tracer Log Directory The log directory for log files of the role Tracer. log_dir /var/log/accumulo log_dir false
Tracer Logging Threshold The minimum log level for Tracer logs INFO log_threshold false
Tracer Maximum Log File Backups The maximum number of rolled log files to keep for Tracer logs. Typically used by log4j. 10 max_log_backup_index false
Tracer Max Log Size The maximum size, in megabytes, per log file for Tracer logs. Typically used by log4j. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value Unit API Name Required
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % accumulo_tracer_fd_thresholds false
Tracer Host Health Test When computing the overall Tracer health, consider the host's health. true accumulo_tracer_host_health_enabled false
Tracer Process Health Test Enables the health test that the Tracer's process state is consistent with the role configuration true accumulo_tracer_scm_health_enabled false
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Role Triggers The configured triggers for this role. This is a JSON formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has all of the following fields:
  • triggerName (mandatory) - the name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - a tsquery expression representing the trigger.
  • streamThreshold (optional) - the maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned will cause the condition to fire.
  • enabled (optional) - by default set to 'true'. If set to 'false' the trigger will not be evaluated.
For example, here is a JSON formatted trigger configured for a DataNode that fires if the DataNode has more than 1500 file-descriptors opened: 
[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:red",
  "streamThreshold": 0}, "enabled": "true"]
Consult the trigger rules documentation for more details on how to write triggers using tsquery. The JSON format is evolving and may change in the future and as a result backward compatibility is not guaranteed between releases at this time. 		[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value Unit API Name Required
Java Heap Size of Tracer in Bytes Maximum size for the Java Process heap memory. Passed to Java -Xmx. Measured in bytes. tracer_max_heapsize 1 GiB tracer_max_heapsize true

Performance

Display Name Description Related Name Default Value Unit API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Resource Management

Display Name Description Related Name Default Value Unit API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 B to specify no limit. By default processes not managed by Cloudera Manager will have no limit. memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true
Page generated September 3, 2015.