HBase Properties in Cloudera Runtime 7.1.7
Role groups:
Gateway
Advanced
Deploy Directory
- Description
- The directory where the client configs will be deployed
- Related Name
- Default Value
- /etc/hbase
- API Name
-
client_config_root_dir
- Required
- true
HBase Client Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only, a string to be inserted into the client configuration for hbase-site.xml.
- Related Name
- Default Value
- API Name
-
hbase_client_config_safety_valve
- Required
- false
HBase Client Environment Advanced Configuration Snippet (Safety Valve) for hbase-env.sh
- Description
- For advanced use only, key-value pairs (one on each line) to be inserted into the client configuration for hbase-env.sh
- Related Name
- Default Value
- API Name
-
hbase_client_env_safety_valve
- Required
- false
Client Java Configuration Options
- Description
- These are Java command-line arguments. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here.
- Related Name
- Default Value
- -XX:+HeapDumpOnOutOfMemoryError -Djava.net.preferIPv4Stack=true
- API Name
-
hbase_client_java_opts
- Required
- false
Gateway Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Logs
Gateway Logging Threshold
- Description
- The minimum log level for Gateway logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
Monitoring
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Other
Alternatives Priority
- Description
- 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.
- Related Name
- Default Value
- 90
- API Name
-
client_config_priority
- Required
- true
HBase Client Get Timeout For Secondary Region Replicas
- Description
- If a get operation is performed with 'Consistency.TIMELINE', the read RPC is sent to the primary RegionServer first. After this timeout, parallel RPC for secondary region replicas is also sent if the primary does not respond. After this, the result is returned from whichever RPC is finished first. If the response returns from the primary region replica, that data is the most recent. Result.isStale() API has been added to inspect the staleness. If the result is from a secondary region, Result.isStale() is set to true.
- Related Name
-
hbase.client.primaryCallTimeout.get
- Default Value
- 10 second(s)
- API Name
-
hbase_client_primaryCallTimeout_get
- Required
- false
HBase Client Multiget Timeout For Secondary Region Replicas
- Description
- If a multiget operation is performed with 'Consistency.TIMELINE', the read RPC is sent to the primary RegionServer first. After this timeout, a parallel RPC for secondary region replicas is also sent if the primary does not respond. After this, the result is returned from whichever RPC is finished first. If the response returns from the primary region replica, that the data is the most recent. Result.isStale() API has been added to inspect the staleness. If the result is from a secondary region, Result.isStale() is set to true.
- Related Name
-
hbase.client.primaryCallTimeout.multiget
- Default Value
- 10 second(s)
- API Name
-
hbase_client_primaryCallTimeout_multiget
- Required
- false
HBase Client Scanner Timeout
- Description
- Scanner Timeout, in milliseconds, for HBase Clients. Scanner related RPCs will apply this timeout against the RegionServers they talk to.
- Related Name
-
hbase.client.scanner.timeout.period
- Default Value
- 1 minute(s)
- API Name
-
hbase_client_scanner_timeout_period
- Required
- false
Enable Client RPC Threads Interruption
- Description
- Whether to enable interruption of RPC threads at the client. The default value of true enables primary RegionServers to access data from other regions' secondary replicas.
- Related Name
-
hbase.ipc.client.allowsInterrupt
- Default Value
- true
- API Name
-
hbase_ipc_client_allowsInterrupt
- Required
- false
Resource Management
Client Java Heap Size in Bytes
- Description
- Maximum size in bytes for the Java process heap memory. Passed to Java -Xmx.
- Related Name
- Default Value
- 256 MiB
- API Name
-
hbase_client_java_heapsize
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: Deploy Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_client_config_root_dir
- Required
- true
Suppress Configuration Validator: HBase Client Scanner Timeout exceeds Lease Period Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Client Scanner Timeout exceeds Lease Period Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_client_server_scanner_rpc_timeout_validator
- Required
- true
Suppress Parameter Validation: HBase Client Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Client Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_config_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Client Environment Advanced Configuration Snippet (Safety Valve) for hbase-env.sh
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Client Environment Advanced Configuration Snippet (Safety Valve) for hbase-env.sh parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_env_safety_valve
- Required
- true
Suppress Parameter Validation: Client Java Configuration Options
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Client Java Configuration Options parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_java_opts
- Required
- true
Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
HBase REST Server
Advanced
HBase REST Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only. A string to be inserted into hbase-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
hbase_restserver_config_safety_valve
- Required
- false
Java Configuration Options for HBase REST Server
- Description
- These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
- Related Name
- Default Value
- JAVA_GC_ARGS
- API Name
-
hbase_restserver_java_opts
- Required
- false
HBase REST Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- 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.
- Related Name
- Default Value
- API Name
-
HBASERESTSERVER_role_env_safety_valve
- Required
- false
HBase REST Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- true
- API Name
-
oom_heap_dump_enabled
- Required
- true
Kill When Out of Memory
- Description
- When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
- Related Name
- Default Value
- true
- API Name
-
oom_sigkill_enabled
- Required
- true
Automatically Restart Process
- Description
- When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
- Related Name
- Default Value
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
Logs
HBase REST Server Log Directory
- Description
- Directory where HBase REST Server will place its log files.
- Related Name
-
hadoop.log.dir
- Default Value
- /var/log/hbase
- API Name
-
hbase_restserver_log_dir
- Required
- false
HBase REST Server Logging Threshold
- Description
- The minimum log level for HBase REST Server logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
HBase REST Server Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for HBase REST Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
HBase REST Server Max Log Size
- Description
- The maximum size, in megabytes, per log file for HBase REST Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- 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
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
hbaserestserver_fd_thresholds
- Required
- false
HBase REST Server Host Health Test
- Description
- When computing the overall HBase REST Server health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
hbaserestserver_host_health_enabled
- Required
- false
HBase REST Server Process Health Test
- Description
- Enables the health test that the HBase REST Server's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
hbaserestserver_scm_health_enabled
- Required
- false
Heap Dump Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
heap_dump_directory_free_space_absolute_thresholds
- Required
- false
Heap Dump Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
heap_dump_directory_free_space_percentage_thresholds
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- 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.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
Rules to Extract Events from Log Files
- Description
- This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
alert
- whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".rate
(mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more thanrate
matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.periodminutes
- the number of minutes during which the publisher will only publishrate
events or fewer. If not specified, the default is one minutethreshold
- apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.content
- match only those messages for which contents match this regular expression.exceptiontype
- match only those messages that are part of an exception message. The exception type must match this regular expression.
{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}
This rule sends events to Cloudera Manager for everyStringIndexOutOfBoundsException
, up to a maximum of 10 every minute.{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}
In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
- Related Name
- Default Value
- version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
- API Name
-
log_event_whitelist
- Required
- false
Navigator Audit Failure Thresholds
- Description
- The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
- Related Name
-
mgmt.navigator.failure.thresholds
- Default Value
- Warning: Never, Critical: Any
- API Name
-
mgmt_navigator_failure_thresholds
- Required
- false
Monitoring Period For Audit Failures
- Description
- The period to review when checking if audits are blocked and not getting processed.
- Related Name
-
mgmt.navigator.failure.window
- Default Value
- 20 minute(s)
- API Name
-
mgmt_navigator_failure_window
- Required
- false
Navigator Audit Pipeline Health Check
- Description
- Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
- Related Name
-
mgmt.navigator.status.check.enabled
- Default Value
- true
- API Name
-
mgmt_navigator_status_check_enabled
- Required
- false
Metric Filter
- Description
- Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
- Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
- Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
- Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
- Metric Name - The name of a metric that will be included or excluded during metric collection.
jvm_heap_used_mb
metric:- Include only Health Test Metric Set: Selected.
- Include/Exclude Custom Metrics: Set to Include.
- Metric Name:
jvm_heap_used_mb
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
Role Triggers
- Description
- 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 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 causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
role_triggers
- Required
- true
Unexpected Exits Thresholds
- Description
- The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
- Related Name
- Default Value
- Warning: Never, Critical: Any
- API Name
-
unexpected_exits_thresholds
- Required
- false
Unexpected Exits Monitoring Period
- Description
- The period to review when computing unexpected exits.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
unexpected_exits_window
- Required
- false
Other
Enable HBase REST Server Read Only Mode
- Description
- When false, all HTTP methods are permitted (GET/PUT/POST/DELETE). When true, only GET is permitted.
- Related Name
-
hbase.rest.readonly
- Default Value
- false
- API Name
-
hbase_restserver_readonly
- Required
- false
Performance
HBase REST Server Maximum Threads
- Description
- Maximum size of the HBase REST Server thread pool. The server can process this number of concurrent requests. Setting this too high can lead to out of memory errors.
- Related Name
-
hbase.rest.threads.max
- Default Value
- 100
- API Name
-
hbase_restserver_threads_max
- Required
- true
HBase REST Server Minimum Threads
- Description
- Minimum size of the HBase REST Server thread pool. The server will maintain at least this number of threads in the pool at all times. The thread pool can grow up to the maximum size set by hbase.rest.threads.max.
- Related Name
-
hbase.rest.threads.min
- Default Value
- 2
- API Name
-
hbase_restserver_threads_min
- Required
- true
Maximum Process File Descriptors
- Description
- If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
- Related Name
- Default Value
- API Name
-
rlimit_fds
- Required
- false
Ports and Addresses
HBase REST Server DNS Network Interface
- Description
- The name of the DNS network interface from which an HBase REST Server should report its IP address.
- Related Name
-
hbase.rest.dns.interface
- Default Value
- API Name
-
hbase_restserver_dns_interface
- Required
- false
HBase REST Server DNS Name Server
- Description
- The host name or IP address of the DNS name server which an HBase REST Server should use to determine the host name used for communication and display purposes.
- Related Name
-
hbase.rest.dns.nameserver
- Default Value
- API Name
-
hbase_restserver_dns_nameserver
- Required
- false
HBase REST Server Host Address
- Description
- HBase REST Server will bind to this address.
- Related Name
-
hbase.rest.host
- Default Value
- 0.0.0.0
- API Name
-
hbase_restserver_host
- Required
- false
HBase REST Server Web UI Bind to Wildcard Address
- Description
- If true, HBase REST Server Web UI will bind to a wildcard address (0.0.0.0). Otherwise it will bind to a host name. Only available in CDH 4.3 and later.
- Related Name
-
hbase.rest.info.bindAddress
- Default Value
- true
- API Name
-
hbase_restserver_info_bind_to_wildcard
- Required
- false
HBase REST Server Web UI Port
- Description
- The port that HBase REST Server Web UI binds to.
- Related Name
-
hbase.rest.info.port
- Default Value
- 8085
- API Name
-
hbase_restserver_info_port
- Required
- true
HBase REST Server Port
- Description
- The port that HBase REST Server binds to.
- Related Name
-
hbase.rest.port
- Default Value
- 20550
- API Name
-
hbase_restserver_port
- Required
- true
Resource Management
Java Heap Size of HBase REST Server in Bytes
- Description
- Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
- Related Name
- Default Value
- 1 GiB
- API Name
-
hbase_restserver_java_heapsize
- Required
- false
Cgroup CPU Shares
- Description
- 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.
- Related Name
-
cpu.shares
- Default Value
- 1024
- API Name
-
rm_cpu_shares
- Required
- true
Custom Control Group Resources (overrides Cgroup settings)
- Description
- Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
- Related Name
-
custom.cgroups
- Default Value
- API Name
-
rm_custom_resources
- Required
- false
Cgroup I/O Weight
- Description
- 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.
- Related Name
-
blkio.weight
- Default Value
- 500
- API Name
-
rm_io_weight
- Required
- true
Cgroup Memory Hard Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_hard_limit
- Required
- true
Cgroup Memory Soft Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.soft_limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_soft_limit
- Required
- true
Security
HBase REST Server TLS/SSL Server Keystore File Location
- Description
- The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HBase REST Server is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
- Related Name
-
hbase.rest.ssl.keystore.store
- Default Value
- API Name
-
hbase_restserver_keystore_file
- Required
- false
HBase REST Server TLS/SSL Server Keystore Key Password
- Description
- The password that protects the private key contained in the keystore used when HBase REST Server is acting as a TLS/SSL server.
- Related Name
-
hbase.rest.ssl.keystore.keypassword
- Default Value
- API Name
-
hbase_restserver_keystore_keypassword
- Required
- false
HBase REST Server TLS/SSL Server Keystore File Password
- Description
- The password for the HBase REST Server keystore file.
- Related Name
-
hbase.rest.ssl.keystore.password
- Default Value
- API Name
-
hbase_restserver_keystore_password
- Required
- false
Enable TLS/SSL for HBase REST Server
- Description
- Encrypt communication between clients and HBase REST Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
- Related Name
-
hbase.rest.ssl.enabled
- Default Value
- false
- API Name
-
hbase_restserver_ssl_enable
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: HBase REST Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_config_safety_valve
- Required
- true
Suppress Parameter Validation: HBase REST Server DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server DNS Network Interface parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_dns_interface
- Required
- true
Suppress Parameter Validation: HBase REST Server DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server DNS Name Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_dns_nameserver
- Required
- true
Suppress Parameter Validation: HBase REST Server Host Address
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Host Address parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_host
- Required
- true
Suppress Parameter Validation: HBase REST Server Web UI Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Web UI Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_info_port
- Required
- true
Suppress Parameter Validation: Java Configuration Options for HBase REST Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for HBase REST Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_java_opts
- Required
- true
Suppress Parameter Validation: HBase REST Server TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server TLS/SSL Server Keystore File Location parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_file
- Required
- true
Suppress Parameter Validation: HBase REST Server TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server TLS/SSL Server Keystore Key Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_keypassword
- Required
- true
Suppress Parameter Validation: HBase REST Server TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server TLS/SSL Server Keystore File Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_password
- Required
- true
Suppress Parameter Validation: HBase REST Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_log_dir
- Required
- true
Suppress Parameter Validation: HBase REST Server Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_port
- Required
- true
Suppress Parameter Validation: HBase REST Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbaserestserver_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: HBase REST Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase REST Server Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Parameter Validation: Rules to Extract Events from Log Files
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_event_whitelist
- Required
- true
Suppress Parameter Validation: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Parameter Validation: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Parameter Validation: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Health Test: Audit Pipeline Test
- Description
- Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_audit_health
- Required
- true
Suppress Health Test: File Descriptors
- Description
- Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_file_descriptor
- Required
- true
Suppress Health Test: Heap Dump Directory Free Space
- Description
- Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_heap_dump_directory_free_space
- Required
- true
Suppress Health Test: Host Health
- Description
- Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_host_health
- Required
- true
Suppress Health Test: Log Directory Free Space
- Description
- Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_log_directory_free_space
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_scm_health
- Required
- true
Suppress Health Test: Swap Memory Usage
- Description
- Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_rest_server_unexpected_exits
- Required
- true
HBase Thrift Server
Advanced
HBase Thrift Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only. A string to be inserted into hbase-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
hbase_thriftserver_config_safety_valve
- Required
- false
Java Configuration Options for HBase Thrift Server
- Description
- These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
- Related Name
- Default Value
- JAVA_GC_ARGS
- API Name
-
hbase_thriftserver_java_opts
- Required
- false
HBase Thrift Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- 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.
- Related Name
- Default Value
- API Name
-
HBASETHRIFTSERVER_role_env_safety_valve
- Required
- false
HBase Thrift Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- true
- API Name
-
oom_heap_dump_enabled
- Required
- true
Kill When Out of Memory
- Description
- When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
- Related Name
- Default Value
- true
- API Name
-
oom_sigkill_enabled
- Required
- true
Automatically Restart Process
- Description
- When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
- Related Name
- Default Value
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
Logs
HBase Thrift Server Log Directory
- Description
- Directory where HBase Thrift Server will place its log files.
- Related Name
-
hadoop.log.dir
- Default Value
- /var/log/hbase
- API Name
-
hbase_thriftserver_log_dir
- Required
- false
HBase Thrift Server Logging Threshold
- Description
- The minimum log level for HBase Thrift Server logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
HBase Thrift Server Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for HBase Thrift Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
HBase Thrift Server Max Log Size
- Description
- The maximum size, in megabytes, per log file for HBase Thrift Server logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- 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
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
hbasethriftserver_fd_thresholds
- Required
- false
HBase Thrift Server Host Health Test
- Description
- When computing the overall HBase Thrift Server health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
hbasethriftserver_host_health_enabled
- Required
- false
HBase Thrift Server Process Health Test
- Description
- Enables the health test that the HBase Thrift Server's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
hbasethriftserver_scm_health_enabled
- Required
- false
Heap Dump Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
heap_dump_directory_free_space_absolute_thresholds
- Required
- false
Heap Dump Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
heap_dump_directory_free_space_percentage_thresholds
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- 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.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
Rules to Extract Events from Log Files
- Description
- This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
alert
- whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".rate
(mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more thanrate
matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.periodminutes
- the number of minutes during which the publisher will only publishrate
events or fewer. If not specified, the default is one minutethreshold
- apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.content
- match only those messages for which contents match this regular expression.exceptiontype
- match only those messages that are part of an exception message. The exception type must match this regular expression.
{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}
This rule sends events to Cloudera Manager for everyStringIndexOutOfBoundsException
, up to a maximum of 10 every minute.{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}
In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
- Related Name
- Default Value
- version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
- API Name
-
log_event_whitelist
- Required
- false
Navigator Audit Failure Thresholds
- Description
- The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
- Related Name
-
mgmt.navigator.failure.thresholds
- Default Value
- Warning: Never, Critical: Any
- API Name
-
mgmt_navigator_failure_thresholds
- Required
- false
Monitoring Period For Audit Failures
- Description
- The period to review when checking if audits are blocked and not getting processed.
- Related Name
-
mgmt.navigator.failure.window
- Default Value
- 20 minute(s)
- API Name
-
mgmt_navigator_failure_window
- Required
- false
Navigator Audit Pipeline Health Check
- Description
- Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
- Related Name
-
mgmt.navigator.status.check.enabled
- Default Value
- true
- API Name
-
mgmt_navigator_status_check_enabled
- Required
- false
Metric Filter
- Description
- Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
- Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
- Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
- Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
- Metric Name - The name of a metric that will be included or excluded during metric collection.
jvm_heap_used_mb
metric:- Include only Health Test Metric Set: Selected.
- Include/Exclude Custom Metrics: Set to Include.
- Metric Name:
jvm_heap_used_mb
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
Role Triggers
- Description
- 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 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 causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
role_triggers
- Required
- true
Unexpected Exits Thresholds
- Description
- The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
- Related Name
- Default Value
- Warning: Never, Critical: Any
- API Name
-
unexpected_exits_thresholds
- Required
- false
Unexpected Exits Monitoring Period
- Description
- The period to review when computing unexpected exits.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
unexpected_exits_window
- Required
- false
Other
Enable HBase Thrift Server Compact Protocol
- Description
- Use the TCompactProtocol instead of the default TBinaryProtocol. TCompactProtocol is a binary protocol that is more compact than the default and typically more efficient.
- Related Name
-
hbase.regionserver.thrift.compact
- Default Value
- true
- API Name
-
hbase_thriftserver_compact
- Required
- false
Enable HBase Thrift Server Framed Transport
- Description
- Use framed transport. When using the THsHaServer or TNonblockingServer, framed transport is always used irrespective of this configuration value.
- Related Name
-
hbase.regionserver.thrift.framed
- Default Value
- true
- API Name
-
hbase_thriftserver_framed
- Required
- false
HBase Thrift Server Type
- Description
- Type of HBase Thrift Server.
- Related Name
-
hbase.regionserver.thrift.server.type
- Default Value
- threadpool
- API Name
-
hbase_thriftserver_type
- Required
- false
Performance
HBase Thrift Server Min Worker Threads
- Description
- The "core size" of the thread pool. New threads are created on every connection until this many threads are created.
- Related Name
-
hbase.thrift.minWorkerThreads
- Default Value
- 200
- API Name
-
hbase_thriftserver_min_worker_threads
- Required
- false
Maximum Process File Descriptors
- Description
- If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
- Related Name
- Default Value
- API Name
-
rlimit_fds
- Required
- false
Ports and Addresses
HBase Thrift Server Bind Address
- Description
- Address to bind the HBase Thrift Server to. When using the THsHaServer or the TNonblockingServer, always binds to 0.0.0.0 irrespective of this configuration value.
- Related Name
-
hbase.regionserver.thrift.ipaddress
- Default Value
- 0.0.0.0
- API Name
-
hbase_thriftserver_bindaddress
- Required
- false
HBase Thrift Server DNS Network Interface
- Description
- The name of the DNS network interface from which an HBase Thrift Server should report its IP address.
- Related Name
-
hbase.thrift.dns.interface
- Default Value
- API Name
-
hbase_thriftserver_dns_interface
- Required
- false
HBase Thrift Server DNS Name Server
- Description
- The host name or IP address of the DNS name server which an HBase Thrift Server should use to determine the host name used for communication and display purposes.
- Related Name
-
hbase.thrift.dns.nameserver
- Default Value
- API Name
-
hbase_thriftserver_dns_nameserver
- Required
- false
HBase Thrift Server Web UI Bind to Wildcard Address
- Description
- If true, HBase Thrift Server Web UI will bind to a wildcard address (0.0.0.0). Otherwise it will bind to a host name. Only available in CDH 4.3 and later.
- Related Name
-
hbase.thrift.info.bindAddress
- Default Value
- true
- API Name
-
hbase_thriftserver_info_bind_to_wildcard
- Required
- false
HBase Thrift Server Web UI Port
- Description
- The port that HBase Thrift Server Web UI binds to.
- Related Name
-
hbase.thrift.info.port
- Default Value
- 9095
- API Name
-
hbase_thriftserver_info_port
- Required
- true
HBase Thrift Server Port
- Description
- The port that HBase Thrift Server binds to.
- Related Name
-
hbase.regionserver.thrift.port
- Default Value
- 9090
- API Name
-
hbase_thriftserver_port
- Required
- true
Resource Management
Java Heap Size of HBase Thrift Server in Bytes
- Description
- Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
- Related Name
- Default Value
- 1 GiB
- API Name
-
hbase_thriftserver_java_heapsize
- Required
- false
Cgroup CPU Shares
- Description
- 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.
- Related Name
-
cpu.shares
- Default Value
- 1024
- API Name
-
rm_cpu_shares
- Required
- true
Custom Control Group Resources (overrides Cgroup settings)
- Description
- Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
- Related Name
-
custom.cgroups
- Default Value
- API Name
-
rm_custom_resources
- Required
- false
Cgroup I/O Weight
- Description
- 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.
- Related Name
-
blkio.weight
- Default Value
- 500
- API Name
-
rm_io_weight
- Required
- true
Cgroup Memory Hard Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_hard_limit
- Required
- true
Cgroup Memory Soft Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.soft_limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_soft_limit
- Required
- true
Security
HBase Thrift Server over HTTP TLS/SSL Server Keystore File Location
- Description
- The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HBase Thrift Server over HTTP is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
- Related Name
-
hbase.thrift.ssl.keystore.store
- Default Value
- API Name
-
hbase_thriftserver_http_keystore_file
- Required
- false
HBase Thrift Server over HTTP TLS/SSL Server Keystore Key Password
- Description
- The password that protects the private key contained in the keystore used when HBase Thrift Server over HTTP is acting as a TLS/SSL server.
- Related Name
-
hbase.thrift.ssl.keystore.keypassword
- Default Value
- API Name
-
hbase_thriftserver_http_keystore_keypassword
- Required
- false
HBase Thrift Server over HTTP TLS/SSL Server Keystore File Password
- Description
- The password for the HBase Thrift Server over HTTP keystore file.
- Related Name
-
hbase.thrift.ssl.keystore.password
- Default Value
- API Name
-
hbase_thriftserver_http_keystore_password
- Required
- false
Enable TLS/SSL for HBase Thrift Server over HTTP
- Description
- Encrypt communication between clients and HBase Thrift Server over HTTP using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
- Related Name
-
hbase.thrift.ssl.enabled
- Default Value
- false
- API Name
-
hbase_thriftserver_http_use_ssl
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Configuration Validator: HBase Kerberos Secure Thrift Server Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Kerberos Secure Thrift Server Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_kerberos_secure_thrift_validator
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Bind Address
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Bind Address parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_bindaddress
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_config_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Thrift Server DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server DNS Network Interface parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_dns_interface
- Required
- true
Suppress Parameter Validation: HBase Thrift Server DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server DNS Name Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_dns_nameserver
- Required
- true
Suppress Parameter Validation: HBase Thrift Server over HTTP TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server over HTTP TLS/SSL Server Keystore File Location parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_file
- Required
- true
Suppress Parameter Validation: HBase Thrift Server over HTTP TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server over HTTP TLS/SSL Server Keystore Key Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_keypassword
- Required
- true
Suppress Parameter Validation: HBase Thrift Server over HTTP TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server over HTTP TLS/SSL Server Keystore File Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_password
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Web UI Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Web UI Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_info_port
- Required
- true
Suppress Parameter Validation: Java Configuration Options for HBase Thrift Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for HBase Thrift Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_java_opts
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_log_dir
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_port
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbasethriftserver_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Thrift Server Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Thrift Server Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Parameter Validation: Rules to Extract Events from Log Files
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_event_whitelist
- Required
- true
Suppress Parameter Validation: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Parameter Validation: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Parameter Validation: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Health Test: Audit Pipeline Test
- Description
- Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_audit_health
- Required
- true
Suppress Health Test: File Descriptors
- Description
- Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_file_descriptor
- Required
- true
Suppress Health Test: Heap Dump Directory Free Space
- Description
- Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_heap_dump_directory_free_space
- Required
- true
Suppress Health Test: Host Health
- Description
- Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_host_health
- Required
- true
Suppress Health Test: Log Directory Free Space
- Description
- Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_log_directory_free_space
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_scm_health
- Required
- true
Suppress Health Test: Swap Memory Usage
- Description
- Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_hbase_thrift_server_unexpected_exits
- Required
- true
Master
Advanced
Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)
- Description
- Advanced Configuration Snippet (Safety Valve) for Hadoop Metrics2. Properties will be inserted into hadoop-metrics2.properties.
- Related Name
- Default Value
- API Name
-
hadoop_metrics2_safety_valve
- Required
- false
HBase Coprocessor Master Classes
- Description
- List of org.apache.hadoop.hbase.coprocessor.MasterObserver coprocessors that are loaded by default on the active HMaster process. For any implemented coprocessor methods, the listed classes will be called in order. After implementing your own MasterObserver, just put it in HBase's classpath and add the fully qualified class name here.
- Related Name
-
hbase.coprocessor.master.classes
- Default Value
- API Name
-
hbase_coprocessor_master_classes
- Required
- false
Master Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only. A string to be inserted into hbase-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
hbase_master_config_safety_valve
- Required
- false
Java Configuration Options for HBase Master
- Description
- These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
- Related Name
- Default Value
- JAVA_GC_ARGS -XX:ReservedCodeCacheSize=256m
- API Name
-
hbase_master_java_opts
- Required
- false
Master Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Master Environment Advanced Configuration Snippet (Safety Valve)
- Description
- 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.
- Related Name
- Default Value
- API Name
-
MASTER_role_env_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- true
- API Name
-
oom_heap_dump_enabled
- Required
- true
Kill When Out of Memory
- Description
- When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
- Related Name
- Default Value
- true
- API Name
-
oom_sigkill_enabled
- Required
- true
Automatically Restart Process
- Description
- When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
- Related Name
- Default Value
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
Logs
Master Log Directory
- Description
- Directory where Master will place its log files.
- Related Name
-
hadoop.log.dir
- Default Value
- /var/log/hbase
- API Name
-
hbase_master_log_dir
- Required
- false
Master Logging Threshold
- Description
- The minimum log level for Master logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
Master Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for Master logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
Master Max Log Size
- Description
- The maximum size, in megabytes, per log file for Master logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Metrics
Extended Period
- Description
- Time period in seconds to reset long-running metrics (e.g. compactions). This is an HBase specific configuration.
- Related Name
-
hbase.extendedperiod
- Default Value
- 1 hour(s)
- API Name
-
hbase_metrics_extended_period
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- 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
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Heap Dump Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
heap_dump_directory_free_space_absolute_thresholds
- Required
- false
Heap Dump Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
heap_dump_directory_free_space_percentage_thresholds
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- 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.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
Rules to Extract Events from Log Files
- Description
- This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
alert
- whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".rate
(mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more thanrate
matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.periodminutes
- the number of minutes during which the publisher will only publishrate
events or fewer. If not specified, the default is one minutethreshold
- apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.content
- match only those messages for which contents match this regular expression.exceptiontype
- match only those messages that are part of an exception message. The exception type must match this regular expression.
{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}
This rule sends events to Cloudera Manager for everyStringIndexOutOfBoundsException
, up to a maximum of 10 every minute.{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}
In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
- Related Name
- Default Value
- version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, exceptiontype: java.io.IOException , alert: false, rate: 0, exceptiontype: java.net.SocketException , alert: false, rate: 0, exceptiontype: java.net.SocketClosedException , alert: false, rate: 0, exceptiontype: java.io.EOFException , alert: false, rate: 0, exceptiontype: java.nio.channels.CancelledKeyException , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: IPC Server handler.*ClosedChannelException , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: IPC Server Responder, call.*output error , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Daughter regiondir does not exist: .* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: File.*might still be open.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: File.*might still be open.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Moving table .+ state to enabled but was already enabled , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Received OPENED for region.*but region was in the state.* , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 0, threshold: WARN, content: Unknown job [^ ]+ being deleted.* , alert: false, rate: 0, threshold: WARN, content: Error executing shell command .+ No such process.+ , alert: false, rate: 0, threshold: WARN, content: .*attempt to override final parameter.+ , alert: false, rate: 0, threshold: WARN, content: [^ ]+ is a deprecated filesystem name. Use.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
- API Name
-
log_event_whitelist
- Required
- false
HBase Master Canary Health Test
- Description
- Enables the health test that a client can connect to the HBase Master
- Related Name
- Default Value
- true
- API Name
-
master_canary_health_enabled
- Required
- false
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
master_fd_thresholds
- Required
- false
Garbage Collection Duration Thresholds
- Description
- The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
- Related Name
- Default Value
- Warning: 30.0, Critical: 60.0
- API Name
-
master_gc_duration_thresholds
- Required
- false
Garbage Collection Duration Monitoring Period
- Description
- The period to review when computing the moving average of garbage collection time.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
master_gc_duration_window
- Required
- false
Master Host Health Test
- Description
- When computing the overall Master health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
master_host_health_enabled
- Required
- false
HBase Regions In Transition Over Threshold Health Test
- Description
- Enable the health test that checks if there are regions in transition over the threshold configured in HBase.
- Related Name
- Default Value
- true
- API Name
-
master_regions_in_transition_health_enabled
- Required
- false
Master Process Health Test
- Description
- Enables the health test that the Master's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
master_scm_health_enabled
- Required
- false
Health Test Startup Tolerance
- Description
- The amount of time allowed after this role is started that failures of health tests that rely on communication with this role will be tolerated.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
master_startup_tolerance
- Required
- false
Web Metric Collection
- Description
- Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
- Related Name
- Default Value
- true
- API Name
-
master_web_metric_collection_enabled
- Required
- false
Web Metric Collection Duration
- Description
- The health test thresholds on the duration of the metrics request to the web server.
- Related Name
- Default Value
- Warning: 10 second(s), Critical: Never
- API Name
-
master_web_metric_collection_thresholds
- Required
- false
Navigator Audit Failure Thresholds
- Description
- The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
- Related Name
-
mgmt.navigator.failure.thresholds
- Default Value
- Warning: Never, Critical: Any
- API Name
-
mgmt_navigator_failure_thresholds
- Required
- false
Monitoring Period For Audit Failures
- Description
- The period to review when checking if audits are blocked and not getting processed.
- Related Name
-
mgmt.navigator.failure.window
- Default Value
- 20 minute(s)
- API Name
-
mgmt_navigator_failure_window
- Required
- false
Navigator Audit Pipeline Health Check
- Description
- Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
- Related Name
-
mgmt.navigator.status.check.enabled
- Default Value
- true
- API Name
-
mgmt_navigator_status_check_enabled
- Required
- false
Metric Filter
- Description
- Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
- Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
- Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
- Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
- Metric Name - The name of a metric that will be included or excluded during metric collection.
jvm_heap_used_mb
metric:- Include only Health Test Metric Set: Selected.
- Include/Exclude Custom Metrics: Set to Include.
- Metric Name:
jvm_heap_used_mb
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
Role Triggers
- Description
- 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 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 causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
role_triggers
- Required
- true
Unexpected Exits Thresholds
- Description
- The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
- Related Name
- Default Value
- Warning: Never, Critical: Any
- API Name
-
unexpected_exits_thresholds
- Required
- false
Unexpected Exits Monitoring Period
- Description
- The period to review when computing unexpected exits.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
unexpected_exits_window
- Required
- false
Other
HBase Master Handler Count
- Description
- Number of RPC Server instances spun up on HBase Master.
- Related Name
-
hbase.master.handler.count
- Default Value
- 25
- API Name
-
hbase_master_handler_count
- Required
- false
HBase Master Log Cleaner Plugins
- Description
- A comma-separated list of LogCleanerDelegate(s) that are used in LogsCleaner. WAL/HLog cleaner(s) are called in order, so put the log cleaner that prunes the most log files in the front. To implement your own LogCleanerDelegate, add it to HBase's classpath and add the fully-qualified class name here. You should always add the above default log cleaners in the list, unless you have a special reason not to.
- Related Name
-
hbase.master.logcleaner.plugins
- Default Value
- API Name
-
hbase_master_logcleaner_plugins
- Required
- false
Maximum Time to Keep HLogs
- Description
- Maximum time an HLog remains in the .oldlogdir directory until an HBase Master thread deletes it.
- Related Name
-
hbase.master.logcleaner.ttl
- Default Value
- 1 minute(s)
- API Name
-
hbase_master_logcleaner_ttl
- Required
- false
Set HBase Master UI to read-only.
- Description
- Read-only mode for the HBase Master UI disallows operations from the UI which change the state of HBase, such as triggering compactions or splits.
- Related Name
-
hbase.master.ui.readonly
- Default Value
- true
- API Name
-
hbase_master_ui_readonly
- Required
- false
Performance
Region Closing Threads
- Description
- Number of pooled threads to handle region closing in the master.
- Related Name
-
hbase.master.executor.closeregion.threads
- Default Value
- 5
- API Name
-
hbase_master_executor_closeregion_threads
- Required
- false
Region Opening Threads
- Description
- Number of pooled threads to handle region opening in the master.
- Related Name
-
hbase.master.executor.openregion.threads
- Default Value
- 5
- API Name
-
hbase_master_executor_openregion_threads
- Required
- false
RegionServer Recovery Threads
- Description
- Number of pooled threads to handle the recovery of the RegionServers in the master.
- Related Name
-
hbase.master.executor.serverops.threads
- Default Value
- 5
- API Name
-
hbase_master_executor_serverops_threads
- Required
- false
Maximum Process File Descriptors
- Description
- If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
- Related Name
- Default Value
- API Name
-
rlimit_fds
- Required
- false
Ports and Addresses
HBase Master Bind to Wildcard Address
- Description
- When true, HBase Master will bind to 0.0.0.0. Only available with CDH 4.3 and later.
- Related Name
-
hbase.master.ipc.address
- Default Value
- true
- API Name
-
hbase_master_bind_to_wildcard_address
- Required
- true
HBase Master DNS Network Interface
- Description
- The name of the DNS network interface from which an HBase Master should report its IP address.
- Related Name
-
hbase.master.dns.interface
- Default Value
- API Name
-
hbase_master_dns_interface
- Required
- false
HBase Master DNS Name Server
- Description
- The host name or IP address of the DNS name server which an HBase Master should use to determine the host name used for communication and display purposes.
- Related Name
-
hbase.master.dns.nameserver
- Default Value
- API Name
-
hbase_master_dns_nameserver
- Required
- false
HBase Master Web UI Address
- Description
- The address for the HBase Master web UI
- Related Name
-
hbase.master.info.bindAddress
- Default Value
- API Name
-
hbase_master_info_bindAddress
- Required
- false
HBase Master Web UI Port
- Description
- The port for the HBase Master web UI. Set to -1 to disable the HBase Master web UI.
- Related Name
-
hbase.master.info.port
- Default Value
- 16010
- API Name
-
hbase_master_info_port
- Required
- false
HBase Master Port
- Description
- The port that the HBase Master binds to.
- Related Name
-
hbase.master.port
- Default Value
- 16000
- API Name
-
hbase_master_port
- Required
- false
Resource Management
Java Heap Size of HBase Master in Bytes
- Description
- Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
- Related Name
- Default Value
- 1 GiB
- API Name
-
hbase_master_java_heapsize
- Required
- false
Cgroup CPU Shares
- Description
- 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.
- Related Name
-
cpu.shares
- Default Value
- 1024
- API Name
-
rm_cpu_shares
- Required
- true
Custom Control Group Resources (overrides Cgroup settings)
- Description
- Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
- Related Name
-
custom.cgroups
- Default Value
- API Name
-
rm_custom_resources
- Required
- false
Cgroup I/O Weight
- Description
- 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.
- Related Name
-
blkio.weight
- Default Value
- 500
- API Name
-
rm_io_weight
- Required
- true
Cgroup Memory Hard Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_hard_limit
- Required
- true
Cgroup Memory Soft Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.soft_limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_soft_limit
- Required
- true
Security
Require EXEC privilege to execute coprocessor calls
- Description
- If this setting is enabled and ACL based access control is active (the AccessController coprocessor is installed either as a system coprocessor or on a table as a table coprocessor) then you must grant all relevant users EXEC privilege if they require the ability to execute coprocessor endpoint calls. EXEC privilege, like any other permission, can be granted globally to a user, or to a user on a per table or per namespace basis. For more information on coprocessor endpoints, see the coprocessor section of the HBase online manual. For more information on granting or revoking permissions using the AccessController, see the security section of the HBase online manual.
- Related Name
-
hbase.security.exec.permission.checks
- Default Value
- false
- API Name
-
hbase_security_exec_permission_checks
- Required
- false
HBase Master TLS/SSL Trust Store File
- Description
- The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that HBase Master might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
- Related Name
- Default Value
- API Name
-
master_truststore_file
- Required
- false
HBase Master TLS/SSL Trust Store Password
- Description
- The password for the HBase Master TLS/SSL Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
- Related Name
- Default Value
- API Name
-
master_truststore_password
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_metrics2_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Coprocessor Master Classes
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Coprocessor Master Classes parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_coprocessor_master_classes
- Required
- true
Suppress Parameter Validation: Master Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_config_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Master DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master DNS Network Interface parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_dns_interface
- Required
- true
Suppress Parameter Validation: HBase Master DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master DNS Name Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_dns_nameserver
- Required
- true
Suppress Parameter Validation: HBase Master Web UI Address
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master Web UI Address parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_info_bindaddress
- Required
- true
Suppress Parameter Validation: HBase Master Web UI Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master Web UI Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_info_port
- Required
- true
Suppress Parameter Validation: Java Configuration Options for HBase Master
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for HBase Master parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_java_opts
- Required
- true
Suppress Parameter Validation: Master Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_log_dir
- Required
- true
Suppress Parameter Validation: HBase Master Log Cleaner Plugins
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master Log Cleaner Plugins parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_logcleaner_plugins
- Required
- true
Suppress Parameter Validation: HBase Master Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_port
- Required
- true
Suppress Parameter Validation: Master Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Parameter Validation: Rules to Extract Events from Log Files
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_event_whitelist
- Required
- true
Suppress Parameter Validation: Master Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Master Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Master TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master TLS/SSL Trust Store File parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_truststore_file
- Required
- true
Suppress Parameter Validation: HBase Master TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Master TLS/SSL Trust Store Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_truststore_password
- Required
- true
Suppress Parameter Validation: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Parameter Validation: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Parameter Validation: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Health Test: Audit Pipeline Test
- Description
- Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_audit_health
- Required
- true
Suppress Health Test: HBase Master Canary
- Description
- Whether to suppress the results of the HBase Master Canary heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_canary_health
- Required
- true
Suppress Health Test: File Descriptors
- Description
- Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_file_descriptor
- Required
- true
Suppress Health Test: GC Duration
- Description
- Whether to suppress the results of the GC Duration heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_gc_duration
- Required
- true
Suppress Health Test: Heap Dump Directory Free Space
- Description
- Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_heap_dump_directory_free_space
- Required
- true
Suppress Health Test: Host Health
- Description
- Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_host_health
- Required
- true
Suppress Health Test: Log Directory Free Space
- Description
- Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_log_directory_free_space
- Required
- true
Suppress Health Test: HBase Regions In Transition Over Threshold
- Description
- Whether to suppress the results of the HBase Regions In Transition Over Threshold heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_regions_in_transition_over_threshold
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_scm_health
- Required
- true
Suppress Health Test: Swap Memory Usage
- Description
- Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_unexpected_exits
- Required
- true
Suppress Health Test: Web Server Status
- Description
- Whether to suppress the results of the Web Server Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_master_web_metric_collection
- Required
- true
RegionServer
Advanced
Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)
- Description
- Advanced Configuration Snippet (Safety Valve) for Hadoop Metrics2. Properties will be inserted into hadoop-metrics2.properties.
- Related Name
- Default Value
- API Name
-
hadoop_metrics2_safety_valve
- Required
- false
BucketCache IOEngine
- Description
- Where to store the contents of the BucketCache. Either "offheap" or file:/path/to/file -- this should be a file in the local file system (not HDFS), and is generally a file on ramdisk or SSD (not spinning disk). If this is set to "offheap" then Java's -XX:MaxDirectMemorySize is set to the value of hbase.bucketcache.size plus 1GB for short-circuit reads.
- Related Name
-
hbase.bucketcache.ioengine
- Default Value
- API Name
-
hbase_bucketcache_ioengine
- Required
- false
BucketCache Size
- Description
- The total size of the BucketCache, in megabytes. The size to configure depends on the amount of memory available to HBase, or the size of a local SSD. If hbase.bucketcache.ioengine is set to "offheap", then the bucketcache consumes the configured amount of memory from Java's Direct Memory.
- Related Name
-
hbase.bucketcache.size
- Default Value
- 1 GiB
- API Name
-
hbase_bucketcache_size
- Required
- false
HBase Coprocessor Region Classes
- Description
- List of coprocessors that are loaded by default on all tables. For any override coprocessor method, these classes will be called in order. After implementing your own coprocessor, just put it in HBase's classpath and add the fully qualified class name here. A coprocessor can also be loaded on demand by setting HTableDescriptor.
- Related Name
-
hbase.coprocessor.region.classes
- Default Value
- API Name
-
hbase_coprocessor_region_classes
- Required
- false
Canary Interval
- Description
- Duration between consecutive checks done by the Canary.
- Related Name
- Default Value
- 6 second(s)
- API Name
-
hbase_regionserver_canary_interval
- Required
- false
Canary Timeout
- Description
- Timeout for Canary to perform its checks.
- Related Name
- Default Value
- 15 second(s)
- API Name
-
hbase_regionserver_canary_timeout
- Required
- false
RegionServer Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only. A string to be inserted into hbase-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
hbase_regionserver_config_safety_valve
- Required
- false
Java Configuration Options for HBase RegionServer
- Description
- These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version.
- Related Name
- Default Value
- JAVA_GC_ARGS -XX:ReservedCodeCacheSize=256m
- API Name
-
hbase_regionserver_java_opts
- Required
- false
Write-Ahead Log (WAL) Codec Class
- Description
- Configuration key for the class to use when encoding cells in the Write-Ahead Log (WAL)
- Related Name
-
hbase.regionserver.wal.codec
- Default Value
- API Name
-
hbase_regionserver_wal_codec
- Required
- false
RegionServer Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- true
- API Name
-
oom_heap_dump_enabled
- Required
- true
Kill When Out of Memory
- Description
- When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
- Related Name
- Default Value
- true
- API Name
-
oom_sigkill_enabled
- Required
- true
Automatically Restart Process
- Description
- When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
- Related Name
- Default Value
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
RegionServer Environment Advanced Configuration Snippet (Safety Valve)
- Description
- 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.
- Related Name
- Default Value
- API Name
-
REGIONSERVER_role_env_safety_valve
- Required
- false
Logs
RegionServer Log Directory
- Description
- Directory where RegionServer will place its log files.
- Related Name
-
hadoop.log.dir
- Default Value
- /var/log/hbase
- API Name
-
hbase_regionserver_log_dir
- Required
- false
RegionServer Logging Threshold
- Description
- The minimum log level for RegionServer logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
RegionServer Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for RegionServer logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
RegionServer Max Log Size
- Description
- The maximum size, in megabytes, per log file for RegionServer logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Metrics
Extended Period
- Description
- Time period in seconds to reset long-running metrics (e.g. compactions). This is an HBase specific configuration.
- Related Name
-
hbase.extendedperiod
- Default Value
- 1 hour(s)
- API Name
-
hbase_metrics_extended_period
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- 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
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Heap Dump Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
heap_dump_directory_free_space_absolute_thresholds
- Required
- false
Heap Dump Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
heap_dump_directory_free_space_percentage_thresholds
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- 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.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
Rules to Extract Events from Log Files
- Description
- This file contains the rules that govern how log messages are turned into events by the custom log4j appender that this role loads. It is in JSON format, and is composed of a list of rules. Every log message is evaluated against each of these rules in turn to decide whether or not to send an event for that message. If a log message matches multiple rules, the first matching rule is used.. Each rule has some or all of the following fields:
alert
- whether or not events generated from this rule should be promoted to alerts. A value of "true" will cause alerts to be generated. If not specified, the default is "false".rate
(mandatory) - the maximum number of log messages matching this rule that can be sent as events every minute. If more thanrate
matching log messages are received in a single minute, the extra messages are ignored. If rate is less than 0, the number of messages per minute is unlimited.periodminutes
- the number of minutes during which the publisher will only publishrate
events or fewer. If not specified, the default is one minutethreshold
- apply this rule only to messages with this log4j severity level or above. An example is "WARN" for warning level messages or higher.content
- match only those messages for which contents match this regular expression.exceptiontype
- match only those messages that are part of an exception message. The exception type must match this regular expression.
{"alert": false, "rate": 10, "exceptiontype": "java.lang.StringIndexOutOfBoundsException"}
This rule sends events to Cloudera Manager for everyStringIndexOutOfBoundsException
, up to a maximum of 10 every minute.{"alert": false, "rate": 1, "periodminutes": 1, "exceptiontype": ".*"}, {"alert": true, "rate": 1, "periodminutes": 1, "threshold":"ERROR"}
In this example, an event generated may not be promoted to alert if an exception is in the ERROR log message, because the first rule with alert = false will match.
- Related Name
- Default Value
- version: 0, rules: [ alert: false, rate: 1, periodminutes: 1, threshold: FATAL , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Instead, use .* , alert: false, rate: 0, threshold: WARN, content: .* is deprecated. Use .* instead , alert: false, rate: 0, exceptiontype: java.io.IOException , alert: false, rate: 0, exceptiontype: java.net.SocketException , alert: false, rate: 0, exceptiontype: java.net.SocketClosedException , alert: false, rate: 0, exceptiontype: java.io.EOFException , alert: false, rate: 0, exceptiontype: java.nio.channels.CancelledKeyException , alert: false, rate: 0, threshold: WARN, content: IPC Server handler.*took.*appending an edit to hlog.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: ABORTING region server serverName.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: DFSOutputStream ResponseProcessor exception.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Error Recovery for block blk.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Failed init , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Problem renewing lease for DFSClient.* , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: remote error telling master we are up , alert: false, rate: 1, periodminutes: 1, threshold: WARN, content: Session.*for server.*closing socket connection and attempting reconnect. , alert: false, rate: 1, periodminutes: 2, exceptiontype: .* , alert: false, rate: 0, threshold: WARN, content: Error executing shell command .+ No such process.+ , alert: false, rate: 0, threshold: WARN, content: .*attempt to override final parameter.+ , alert: false, rate: 0, threshold: WARN, content: [^ ]+ is a deprecated filesystem name. Use.* , alert: false, rate: -1, threshold: INFO, content: ^Starting .*compaction on region (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_REGION_STARTED, attribute:SEVERITY: INFORMATIONAL, group0: REGION , alert: false, rate: -1, threshold: INFO, content: ^completed compaction on region (.+) after (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_REGION_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: DURATION , alert: false, rate: -1, threshold: INFO, content: ^Starting compaction on (.+) in region (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_COLUMN_FAMILY_STARTED, attribute:SEVERITY: INFORMATIONAL, group0: COLUMN_FAMILY, group1: REGION , alert: false, rate: -1, threshold: INFO, content: ^completed compaction: regionName\u003d(.+), storeName\u003d(.+), fileCount\u003d(.+), fileSize\u003d(.+), priority\u003d(.+), time\u003d(.+); duration\u003d(.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_COLUMN_FAMILY_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: COLUMN_FAMILY, group2: FILE_COUNT, group3: FILE_SIZE, group4: PRIORITY, group5: REQUEST_TIME_NANOS, group6: DURATION , alert: false, rate: -1, threshold: INFO, content: ^Completed compaction: Request \u003d regionName\u003d(.+), storeName\u003d(.+), fileCount\u003d(.+), fileSize\u003d(.+), priority\u003d(.+), time\u003d(.+); duration\u003d(.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_COLUMN_FAMILY_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: COLUMN_FAMILY, group2: FILE_COUNT, group3: FILE_SIZE, group4: PRIORITY, group5: REQUEST_TIME_NANOS, group6: DURATION , alert: false, rate: -1, threshold: INFO, content: ^aborted compaction: regionName\u003d(.+), storeName\u003d(.+), fileCount\u003d(.+), fileSize\u003d(.+), priority\u003d(.+), time\u003d(.+); duration\u003d(.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_COMPACTION_COLUMN_FAMILY_ABORTED, attribute:SEVERITY: IMPORTANT, group0: REGION, group1: COLUMN_FAMILY, group2: FILE_COUNT, group3: FILE_SIZE, group4: PRIORITY, group5: REQUEST_TIME_NANOS, group6: DURATION , alert: false, rate: -1, threshold: INFO, content: ^Finished memstore flush of .+ for region (.+) in (.+), sequenceid\u003d(.+), compaction requested\u003d(.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_FLUSH_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: DURATION, group2: SEQUENCE_ID, group3: COMPACTION_REQUESTED , alert: false, rate: -1, threshold: INFO, content: ^Flush of region (.+) due to global heap pressure$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_FLUSH_DUE_TO_HEAP_PRESSURE, attribute:SEVERITY: IMPORTANT, group0: REGION , alert: false, rate: -1, threshold: WARN, content: ^Region (.+) has too many store files; delaying flush up to 90000ms$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_FLUSH_DELAYED_TOO_MANY_STORE_FILES, attribute:SEVERITY: CRITICAL, group0: REGION , alert: false, rate: -1, threshold: INFO, content: ^Starting split of region (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_SPLIT_STARTED, attribute:SEVERITY: INFORMATIONAL, group0: REGION , alert: false, rate: -1, threshold: INFO, content: ^Running rollback/cleanup of failed split of (.+);.+$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_SPLIT_ABORTED, attribute:SEVERITY: IMPORTANT, group0: REGION , alert: false, rate: -1, threshold: INFO, content: ^Region split, hbase:meta updated, and report to master. Parent\u003d(.+), new regions: (.+, .*, .+), (.+, .*, .+). Split took (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_SPLIT_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: DAUGHTER_REGIONS, group2: DAUGHTER_REGIONS, group3: DURATION , alert: false, rate: -1, threshold: INFO, content: ^Region split, META updated, and report to master. Parent\u003d(.+), new regions: (.+, .*, .+), (.+, .*, .+). Split took (.+)$, attribute:CATEGORY: HBASE, attribute:EVENTCODE: EV_HBASE_SPLIT_COMPLETED, attribute:SEVERITY: INFORMATIONAL, group0: REGION, group1: DAUGHTER_REGIONS, group2: DAUGHTER_REGIONS, group3: DURATION , alert: false, rate: 1, periodminutes: 1, threshold: WARN ]
- API Name
-
log_event_whitelist
- Required
- false
Navigator Audit Failure Thresholds
- Description
- The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server.
- Related Name
-
mgmt.navigator.failure.thresholds
- Default Value
- Warning: Never, Critical: Any
- API Name
-
mgmt_navigator_failure_thresholds
- Required
- false
Monitoring Period For Audit Failures
- Description
- The period to review when checking if audits are blocked and not getting processed.
- Related Name
-
mgmt.navigator.failure.window
- Default Value
- 20 minute(s)
- API Name
-
mgmt_navigator_failure_window
- Required
- false
Navigator Audit Pipeline Health Check
- Description
- Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit.
- Related Name
-
mgmt.navigator.status.check.enabled
- Default Value
- true
- API Name
-
mgmt_navigator_status_check_enabled
- Required
- false
Metric Filter
- Description
- Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
- Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
- Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
- Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
- Metric Name - The name of a metric that will be included or excluded during metric collection.
jvm_heap_used_mb
metric:- Include only Health Test Metric Set: Selected.
- Include/Exclude Custom Metrics: Set to Include.
- Metric Name:
jvm_heap_used_mb
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
HBase RegionServer Compaction Queue Monitoring Thresholds
- Description
- The health test thresholds of the weighted average size of the HBase RegionServer compaction queue over a recent period. See HBase RegionServer Compaction Queue Monitoring Period.
- Related Name
- Default Value
- Warning: 10.0, Critical: Never
- API Name
-
regionserver_compaction_queue_thresholds
- Required
- false
HBase RegionServer Compaction Queue Monitoring Period
- Description
- The period over which to compute the moving average of the compaction queue size.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
regionserver_compaction_queue_window
- Required
- false
HBase Region Server Connectivity Tolerance at Startup
- Description
- The amount of time to wait for the HBase Region Server to fully start up and connect to the HBase Master before enforcing the connectivity check.
- Related Name
- Default Value
- 3 minute(s)
- API Name
-
regionserver_connectivity_tolerance
- Required
- false
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
regionserver_fd_thresholds
- Required
- false
HBase RegionServer Flush Queue Monitoring Thresholds
- Description
- The health test thresholds of the average size of the HBase RegionServer flush queue over a recent period. See HBase RegionServer Flush Queue Monitoring Period.
- Related Name
- Default Value
- Warning: 10.0, Critical: Never
- API Name
-
regionserver_flush_queue_thresholds
- Required
- false
HBase RegionServer Flush Queue Monitoring Period
- Description
- The period over which to compute the moving average of the flush queue size.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
regionserver_flush_queue_window
- Required
- false
Garbage Collection Duration Thresholds
- Description
- The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
- Related Name
- Default Value
- Warning: 30.0, Critical: 60.0
- API Name
-
regionserver_gc_duration_thresholds
- Required
- false
Garbage Collection Duration Monitoring Period
- Description
- The period to review when computing the moving average of garbage collection time.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
regionserver_gc_duration_window
- Required
- false
RegionServer Host Health Test
- Description
- When computing the overall RegionServer health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
regionserver_host_health_enabled
- Required
- false
HBase RegionServer to Master Connectivity Test
- Description
- Enables the health test that the RegionServer is connected to the Master
- Related Name
- Default Value
- true
- API Name
-
regionserver_master_connectivity_enabled
- Required
- false
HBase RegionServer Memstore Size Thresholds
- Description
- The health test thresholds of the total size of RegionServer's memstores. Specified as a percentage of the configured upper limit. See Maximum Size of All Memstores in RegionServer.
- Related Name
- Default Value
- Warning: 95.0 %, Critical: 100.0 %
- API Name
-
regionserver_memstore_size_thresholds
- Required
- false
HBase RegionServer HDFS Read Latency Thresholds
- Description
- The health test thresholds of the latency that the RegionServer sees for HDFS read operations
- Related Name
- Default Value
- Warning: 50 millisecond(s), Critical: 100 millisecond(s)
- API Name
-
regionserver_read_latency_thresholds
- Required
- false
HBase RegionServer HDFS Read Latency Monitoring Period
- Description
- The period over which to compute the moving average of the HDFS read latency of the HBase RegionServer.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
regionserver_read_latency_window
- Required
- false
RegionServer Process Health Test
- Description
- Enables the health test that the RegionServer's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
regionserver_scm_health_enabled
- Required
- false
Percentage of Heap Used by HStoreFile Index
- Description
- The health test thresholds of the size used by the HStoreFile index. Specified as a percentage of the total heap size.
- Related Name
- Default Value
- Warning: 10.0 %, Critical: Never
- API Name
-
regionserver_store_file_idx_size_thresholds
- Required
- false
HBase RegionServer HDFS Sync Latency Thresholds
- Description
- The health test thresholds for the latency of HDFS write operations that the RegionServer detects
- Related Name
- Default Value
- Warning: 500 millisecond(s), Critical: 5 second(s)
- API Name
-
regionserver_sync_latency_thresholds
- Required
- false
HBase RegionServer HDFS Sync Latency Monitoring Period
- Description
- The period over which to compute the moving average of the HDFS sync latency of the HBase RegionServer.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
regionserver_sync_latency_window
- Required
- false
Web Metric Collection
- Description
- Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
- Related Name
- Default Value
- true
- API Name
-
regionserver_web_metric_collection_enabled
- Required
- false
Web Metric Collection Duration
- Description
- The health test thresholds on the duration of the metrics request to the web server.
- Related Name
- Default Value
- Warning: 10 second(s), Critical: Never
- API Name
-
regionserver_web_metric_collection_thresholds
- Required
- false
Role Triggers
- Description
- 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 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 causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
role_triggers
- Required
- true
Unexpected Exits Thresholds
- Description
- The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
- Related Name
- Default Value
- Warning: Never, Critical: Any
- API Name
-
unexpected_exits_thresholds
- Required
- false
Unexpected Exits Monitoring Period
- Description
- The period to review when computing unexpected exits.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
unexpected_exits_window
- Required
- false
Other
HBase Hash Type
- Description
- The hashing algorithm for use in HashFunction. Two values are supported: 'murmur' (for MurmurHash) and 'jenkins' (for JenkinsHash).
- Related Name
-
hbase.hash.type
- Default Value
- murmur
- API Name
-
hbase_hash_type
- Required
- false
HBase HRegion Major Compaction
- Description
- The time, in milliseconds, between 'major' compactions of all HStoreFiles in a region. To disable automated major compactions, set this value to 0.
- Related Name
-
hbase.hregion.majorcompaction
- Default Value
- 7 day(s)
- API Name
-
hbase_hregion_majorcompaction
- Required
- false
HBase HRegion Major Compaction Jitter
- Description
- Jitter outer bound for major compactions. On each RegionServer, the hbase.region.majorcompaction interval is multiplied by a random fraction that is inside the bounds of this maximum. This + or - product is added to when the next major compaction is to run. Major compaction should not occur on every RegionServer at the same time. The smaller this number, the closer together the compactions.
- Related Name
-
hbase.hregion.majorcompaction.jitter
- Default Value
- 0.5
- API Name
-
hbase_hregion_majorcompaction_jitter
- Required
- false
HBase Maximum File Size
- Description
- Maximum HStoreFile size. If any one of a column families' HStoreFiles has grown to exceed this value, the hosting HRegion is split in two.
- Related Name
-
hbase.hregion.max.filesize
- Default Value
- 10 GiB
- API Name
-
hbase_hregion_max_filesize
- Required
- false
HBase Memstore Block Multiplier
- Description
- Blocks writes if the size of the memstore increases to the value of 'hbase.hregion.block.memstore' multiplied by the value of 'hbase.hregion.flush.size' bytes. This setting is useful for preventing runaway memstore during spikes in update traffic. Without an upper-bound, memstore fills such that when it flushes, the resultant process of flushing files take a long time to compact or split, or worse, an "out of memory" error occurs.
- Related Name
-
hbase.hregion.memstore.block.multiplier
- Default Value
- 2
- API Name
-
hbase_hregion_memstore_block_multiplier
- Required
- false
HBase Memstore Flush Size
- Description
- Memstore will be flushed to disk if size of the memstore exceeds this value in number of bytes. This value is checked by a thread that runs the frequency specified by hbase.server.thread.wakefrequency.
- Related Name
-
hbase.hregion.memstore.flush.size
- Default Value
- 128 MiB
- API Name
-
hbase_hregion_memstore_flush_size
- Required
- false
Chunk Size Allocated by MSLAB Allocation Scheme
- Description
- The size of the chunks allocated by MSLAB, in bytes.
- Related Name
-
hbase.hregion.memstore.mslab.chunksize
- Default Value
- 2 MiB
- API Name
-
hbase_hregion_memstore_mslab_chunksize
- Required
- false
Enable MSLAB Allocation Scheme
- Description
- Enable MemStore-Local Allocation Buffer (MSLAB) Allocation Scheme. Note: This feature is experimental in CDH3.
- Related Name
-
hbase.hregion.memstore.mslab.enabled
- Default Value
- true
- API Name
-
hbase_hregion_memstore_mslab_enabled
- Required
- false
Maximum Byte Array from MSLAB Allocation Scheme
- Description
- The maximum size byte array that should come from the MSLAB, in bytes.
- Related Name
-
hbase.hregion.memstore.mslab.max.allocation
- Default Value
- 256 KiB
- API Name
-
hbase_hregion_memstore_mslab_max_allocation
- Required
- false
HBase Memstore Pre-close Flush Size
- Description
- If the memstores in a region are this size or larger when closing, run a pre-flush process to clear out memstores before putting up the region closed flag and taking the region offline. On close, a flush process is run under the close flag up to empty memory. During this time, the region is offline and no writes are taken. If the memstore content is large, the flush process could take a long time to complete. The pre-flush process cleans out the bulk of the memstore before putting up the close flag and taking the region offline, so that the flush process that runs under the close flag has little to do.
- Related Name
-
hbase.hregion.preclose.flush.size
- Default Value
- 5 MiB
- API Name
-
hbase_hregion_preclose_flush_size
- Required
- false
HStore Blocking Store Files
- Description
- If there are more than this number of HStoreFiles in any one HStore, then updates are blocked for this HRegion until a compaction is completed, or until the value specified for 'hbase.hstore.blockingWaitTime' has been exceeded.
- Related Name
-
hbase.hstore.blockingStoreFiles
- Default Value
- 16
- API Name
-
hbase_hstore_blockingStoreFiles
- Required
- false
HStore Blocking Wait Time
- Description
- The period of time that an HRegion will block updates after reaching the HStoreFile limit that is specified by 'hbase.hstore.blockingStoreFiles'. After this time has elapsed, the HRegion will stop blocking updates even if a compaction has not been completed.
- Related Name
-
hbase.hstore.blockingWaitTime
- Default Value
- 1 minute(s), 30 second(s)
- API Name
-
hbase_hstore_blockingWaitTime
- Required
- false
Maximum Number of HStoreFiles Compaction
- Description
- Maximum number of HStoreFiles to compact per minor compaction.
- Related Name
-
hbase.hstore.compaction.max
- Default Value
- API Name
-
hbase_hstore_compaction_max
- Required
- false
HStore Compaction Threshold
- Description
- If this number of HStoreFiles in any one HStore is exceeded, then a compaction is run to rewrite all HStoreFiles files as one HStoreFile. (One HStoreFile is written per flush of memstore.) You can delay compaction by specifying a larger number, but the compaction will take longer when it does run. During a compaction, updates cannot be flushed to disk. Long compactions require memory sufficient to carry the logging of all updates across the duration of the compaction. If too large, clients timeout during compaction.
- Related Name
-
hbase.hstore.compactionThreshold
- Default Value
- 3
- API Name
-
hbase_hstore_compactionThreshold
- Required
- false
Enable Replication To Secondary Region Replicas
- Description
- Whether asynchronous WAL replication to the secondary region replicas is enabled. If enabled, a replication peer named 'region_replica_replication' is created that tails the logs and replicates the mutations to region replicas for tables that have region replication > 1. Disabling this replication also requires disabling the replication peer using shell or the ReplicationAdmin Java class. Replication to secondary region replicas works over standard intercluster replication. If disabled explicitly, enable replication by setting 'hbase.replication' to true for this feature to work.
- Related Name
-
hbase.region.replica.replication.enabled
- Default Value
- false
- API Name
-
hbase_region_replica_replication_enabled
- Required
- false
HBase RegionServer Interface Class
- Description
- An interface that is assignable to HRegionInterface. Used in HBase Client for opening a proxy to a remote HBase RegionServer.
- Related Name
-
hbase.regionserver.class
- Default Value
- API Name
-
hbase_regionserver_class
- Required
- false
RegionServer Codecs
- Description
- Comma-separated list of codecs that the RegionServer requires to start. Use this setting to make sure that all RegionServers joining a cluster are installed with a particular set of codecs.
- Related Name
-
hbase.regionserver.codecs
- Default Value
- API Name
-
hbase_regionserver_codecs
- Required
- false
Low Watermark for Memstore Flush
- Description
- Controls when memstores are forced to flush to make room in memory. The memstore will begin flushing when this threshold is reached. Prior to CDH 5.8.0, this amount is the percentage of the heap size of the Region Server and you can set it equal to 'Maximum Size of All Memstores in RegionServer' for minimal possible flushing. In CDH 5.8.0 and later, this amount is the percentage of memstore memory and you can set it equal to 1.0 for minimal possible flushing.
- Related Name
-
hbase.regionserver.global.memstore.size.lower.limit
- Default Value
- 0.95
- API Name
-
hbase_regionserver_global_memstore_lowerLimit
- Required
- false
Maximum Size of All Memstores in RegionServer
- Description
- Maximum size of all memstores in a RegionServer before new updates are blocked and flushes are forced.
- Related Name
-
hbase.regionserver.global.memstore.size
- Default Value
- 0.4
- API Name
-
hbase_regionserver_global_memstore_upperLimit
- Required
- false
HBase RegionServer Handler Count
- Description
- Number of RPC Server instances spun up on RegionServers.
- Related Name
-
hbase.regionserver.handler.count
- Default Value
- 30
- API Name
-
hbase_regionserver_handler_count
- Required
- false
HLog Reader Implementation
- Description
- The HLog file reader implementation.
- Related Name
-
hbase.regionserver.hlog.reader.impl
- Default Value
- API Name
-
hbase_regionserver_hlog_reader_impl
- Required
- false
HLog Writer Implementation
- Description
- The HLog file writer implementation.
- Related Name
-
hbase.regionserver.hlog.writer.impl
- Default Value
- API Name
-
hbase_regionserver_hlog_writer_impl
- Required
- false
HBase RegionServer Lease Period
- Description
- The lease period, in milliseconds, for the HBase RegionServer. Clients must report in within this period or else they are considered dead.
- Related Name
-
hbase.client.scanner.timeout.period
- Default Value
- 1 minute(s)
- API Name
-
hbase_regionserver_lease_period
- Required
- false
HBase RegionServer Log Roll Period
- Description
- Period, in milliseconds, at which to roll the commit log.
- Related Name
-
hbase.regionserver.logroll.period
- Default Value
- 1 hour(s)
- API Name
-
hbase_regionserver_logroll_period
- Required
- false
Maximum number of Write-Ahead Log (WAL) files
- Description
- Maximum number of Write-Ahead Log (WAL) files. This value multiplied by HDFS Block Size (dfs.blocksize) is the size of the WAL that will need to be replayed when a server crashes. This value is inversely proportional to the frequency of flushes to disk.
- Related Name
-
hbase.regionserver.maxlogs
- Default Value
- 32
- API Name
-
hbase_regionserver_maxlogs
- Required
- false
HBase RegionServer Meta-Handler Count
- Description
- Number of handlers for processing priority requests in a RegionServer.
- Related Name
-
hbase.regionserver.metahandler.count
- Default Value
- 10
- API Name
-
hbase_regionserver_metahandler_count
- Required
- false
HBase RegionServer Message Interval
- Description
- Interval, in milliseconds, between messages from the RegionServer to the HBase Master. Use a high value such as 3000 for clusters that have more than 10 hosts.
- Related Name
-
hbase.regionserver.msginterval
- Default Value
- 3 second(s)
- API Name
-
hbase_regionserver_msginterval
- Required
- false
RegionServer Reservation Blocks
- Description
- The number of reservation blocks that are used to prevent unstable RegionServers caused by an OOME.
- Related Name
-
hbase.regionserver.nbreservationblocks
- Default Value
- 4
- API Name
-
hbase_regionserver_nbreservationblocks
- Required
- false
Synch Interval of HLog Entries
- Description
- Sync the HLog to HDFS after this interval, in milliseconds, if it has not accumulated the number of HLog Entries specified to trigger a sync.
- Related Name
-
hbase.regionserver.optionallogflushinterval
- Default Value
- 1 second(s)
- API Name
-
hbase_regionserver_optionallogflushinterval
- Required
- false
WAL Delegate Provider
- Description
- The write ahead log (WAL) delegate provider.
- Related Name
-
hbase.wal.regiongrouping.delegate.provider
- Default Value
- filesystem
- API Name
-
hbase_regionserver_regiongrouping_delegate_provider
- Required
- false
HBase Region Split Limit
- Description
- Limit for the number of regions after which no more region splitting should take place. This is not a hard limit for the number of regions but acts as a guideline for the RegionServer to stop splitting after a certain limit.
- Related Name
-
hbase.regionserver.regionSplitLimit
- Default Value
- 2147483647
- API Name
-
hbase_regionserver_regionSplitLimit
- Required
- false
Per-RegionServer Number of WAL Pipelines
- Description
- When using Multiple HDFS WAL as the WALProvider, sets how many write-ahead-logs each RegionServer should run. Will result in this number of HDFS pipelines. Writes for a given Region only go to a single pipeline, spreading total RegionServer load.
- Related Name
-
hbase.wal.regiongrouping.numgroups
- Default Value
- 1
- API Name
-
hbase_regionserver_wal_pipelines
- Required
- false
WAL Provider
- Description
- The implementation that should be used by the RegionServer for the write-ahead-log. The HBase Default (HBase Internal HDFS Client) - is deprecated since it is redundant with Single HDFS WAL.
- Related Name
-
hbase.wal.provider
- Default Value
- multiwal
- API Name
-
hbase_regionserver_wal_provider
- Required
- false
WAL HSM Storage Policy
- Description
- The Hierarchical Storage Management policy that should be used by the RegionServer for the write-ahead-log. Using an SSD policy will have no effect unless HDFS HSM is configured to know which drives are SSDs. See Enabling HSM with HBase .
- Related Name
-
hbase.wal.storage.policy
- Default Value
- NONE
- API Name
-
hbase_regionserver_wal_storage_policy
- Required
- false
HFile Block Cache Size
- Description
- Percentage of maximum heap (-Xmx setting) to allocate to block cache used by HFile/StoreFile. To disable, set this value to 0 .
- Related Name
-
hfile.block.cache.size
- Default Value
- 0.4
- API Name
-
hfile_block_cache_size
- Required
- false
Performance
RegionServer IPC Read Threadpool Size
- Description
- Read threadpool size used by the RegionServer HBase IPC Server.
- Related Name
-
hbase.ipc.server.read.threadpool.size
- Default Value
- 10
- API Name
-
hbase_ipc_server_read_threadpool_size
- Required
- false
Region Mover Threads
- Description
- Number of threads to use while loading and unloading regions to or from a RegionServer. Can be used to increase the speed of decommissioning or rolling restart operations.
- Related Name
- Default Value
- 1
- API Name
-
hbase_regionserver_regionmover_thread_count
- Required
- true
RegionServer Small Compactions Thread Count
- Description
- Number of threads for completing small compactions.
- Related Name
-
hbase.regionserver.thread.compaction.small
- Default Value
- 1
- API Name
-
hbase_regionserver_thread_compaction_small
- Required
- false
Maximum Process File Descriptors
- Description
- If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
- Related Name
- Default Value
- 32768
- API Name
-
rlimit_fds
- Required
- false
Ports and Addresses
HBase RegionServer Bind to Wildcard Address
- Description
- When true, HBase RegionServer will bind to 0.0.0.0. Only available in CDH 4.3 and later.
- Related Name
-
hbase.regionserver.ipc.address
- Default Value
- true
- API Name
-
hbase_regionserver_bind_to_wildcard_address
- Required
- true
RegionServer DNS Network Interface
- Description
- The name of the DNS Network Interface from which a RegionServer should report its IP address.
- Related Name
-
hbase.regionserver.dns.interface
- Default Value
- API Name
-
hbase_regionserver_dns_interface
- Required
- false
RegionServer DNS Nameserver
- Description
- The host name or IP address of the DNS name server which a RegionServer should use to determine the host name used by the HBase Master for communication and display purposes.
- Related Name
-
hbase.regionserver.dns.nameserver
- Default Value
- API Name
-
hbase_regionserver_dns_nameserver
- Required
- false
HBase RegionServer Web UI Address
- Description
- The address for the HBase RegionServer web UI
- Related Name
-
hbase.regionserver.info.bindAddress
- Default Value
- API Name
-
hbase_regionserver_info_bindAddress
- Required
- false
HBase RegionServer Web UI port
- Description
- The port for the HBase RegionServer web UI. Set to -1 to disable RegionServer web UI.
- Related Name
-
hbase.regionserver.info.port
- Default Value
- 16030
- API Name
-
hbase_regionserver_info_port
- Required
- false
HBase RegionServer Port
- Description
- The port that an HBase RegionServer binds to.
- Related Name
-
hbase.regionserver.port
- Default Value
- 16020
- API Name
-
hbase_regionserver_port
- Required
- false
Resource Management
Java Heap Size of HBase RegionServer in Bytes
- Description
- Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
- Related Name
- Default Value
- 4 GiB
- API Name
-
hbase_regionserver_java_heapsize
- Required
- false
Cgroup CPU Shares
- Description
- 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.
- Related Name
-
cpu.shares
- Default Value
- 1024
- API Name
-
rm_cpu_shares
- Required
- true
Custom Control Group Resources (overrides Cgroup settings)
- Description
- Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
- Related Name
-
custom.cgroups
- Default Value
- API Name
-
rm_custom_resources
- Required
- false
Cgroup I/O Weight
- Description
- 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.
- Related Name
-
blkio.weight
- Default Value
- 500
- API Name
-
rm_io_weight
- Required
- true
Cgroup Memory Hard Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_hard_limit
- Required
- true
Cgroup Memory Soft Limit
- Description
- 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 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.soft_limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_soft_limit
- Required
- true
Security
Require EXEC privilege to execute coprocessor calls
- Description
- If this setting is enabled and ACL based access control is active (the AccessController coprocessor is installed either as a system coprocessor or on a table as a table coprocessor) then you must grant all relevant users EXEC privilege if they require the ability to execute coprocessor endpoint calls. EXEC privilege, like any other permission, can be granted globally to a user, or to a user on a per table or per namespace basis. For more information on coprocessor endpoints, see the coprocessor section of the HBase online manual. For more information on granting or revoking permissions using the AccessController, see the security section of the HBase online manual.
- Related Name
-
hbase.security.exec.permission.checks
- Default Value
- false
- API Name
-
hbase_security_exec_permission_checks
- Required
- false
HBase Region Server TLS/SSL Trust Store File
- Description
- The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that HBase Region Server might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
- Related Name
- Default Value
- API Name
-
regionserver_truststore_file
- Required
- false
HBase Region Server TLS/SSL Trust Store Password
- Description
- The password for the HBase Region Server TLS/SSL Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
- Related Name
- Default Value
- API Name
-
regionserver_truststore_password
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_metrics2_safety_valve
- Required
- true
Suppress Parameter Validation: BucketCache IOEngine
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the BucketCache IOEngine parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_bucketcache_ioengine
- Required
- true
Suppress Parameter Validation: HBase Coprocessor Region Classes
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Coprocessor Region Classes parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_coprocessor_region_classes
- Required
- true
Suppress Parameter Validation: HBase HRegion Major Compaction
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase HRegion Major Compaction parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_hregion_majorcompaction
- Required
- true
Suppress Parameter Validation: HBase RegionServer Interface Class
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase RegionServer Interface Class parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_class
- Required
- true
Suppress Parameter Validation: RegionServer Codecs
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer Codecs parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_codecs
- Required
- true
Suppress Parameter Validation: RegionServer Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_config_safety_valve
- Required
- true
Suppress Parameter Validation: RegionServer DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer DNS Network Interface parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_dns_interface
- Required
- true
Suppress Parameter Validation: RegionServer DNS Nameserver
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer DNS Nameserver parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_dns_nameserver
- Required
- true
Suppress Configuration Validator: HBase Region Server Memstore Lower Limit Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Region Server Memstore Lower Limit Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_global_memstore_lowerlimit_validator
- Required
- true
Suppress Parameter Validation: HLog Reader Implementation
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HLog Reader Implementation parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_hlog_reader_impl
- Required
- true
Suppress Parameter Validation: HLog Writer Implementation
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HLog Writer Implementation parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_hlog_writer_impl
- Required
- true
Suppress Parameter Validation: HBase RegionServer Web UI Address
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase RegionServer Web UI Address parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_info_bindaddress
- Required
- true
Suppress Parameter Validation: HBase RegionServer Web UI port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase RegionServer Web UI port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_info_port
- Required
- true
Suppress Parameter Validation: Java Heap Size of HBase RegionServer in Bytes
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of HBase RegionServer in Bytes parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_java_heapsize
- Required
- true
Suppress Parameter Validation: Java Configuration Options for HBase RegionServer
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for HBase RegionServer parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_java_opts
- Required
- true
Suppress Parameter Validation: RegionServer Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_log_dir
- Required
- true
Suppress Configuration Validator: HBase RegionServer Multiple HDFS WAL with Replication Validator
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Multiple HDFS WAL with Replication Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_multiwal_replication_validator
- Required
- true
Suppress Parameter Validation: HBase RegionServer Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase RegionServer Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_port
- Required
- true
Suppress Parameter Validation: Write-Ahead Log (WAL) Codec Class
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Write-Ahead Log (WAL) Codec Class parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_wal_codec
- Required
- true
Suppress Parameter Validation: RegionServer Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Parameter Validation: Rules to Extract Events from Log Files
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Rules to Extract Events from Log Files parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_event_whitelist
- Required
- true
Suppress Parameter Validation: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Configuration Validator: RegionServer File Descriptor Limit Validator
- Description
- Whether to suppress configuration warnings produced by the RegionServer File Descriptor Limit Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_fd_limit_validator
- Required
- true
Suppress Parameter Validation: RegionServer Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the RegionServer Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Region Server TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Region Server TLS/SSL Trust Store File parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_truststore_file
- Required
- true
Suppress Parameter Validation: HBase Region Server TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Region Server TLS/SSL Trust Store Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_truststore_password
- Required
- true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Parameter Validation: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Parameter Validation: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Health Test: Audit Pipeline Test
- Description
- Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_audit_health
- Required
- true
Suppress Health Test: Compaction Queue Size
- Description
- Whether to suppress the results of the Compaction Queue Size heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_compaction_queue
- Required
- true
Suppress Health Test: File Descriptors
- Description
- Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_file_descriptor
- Required
- true
Suppress Health Test: Flush Queue Size
- Description
- Whether to suppress the results of the Flush Queue Size heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_flush_queue
- Required
- true
Suppress Health Test: GC Duration
- Description
- Whether to suppress the results of the GC Duration heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_gc_duration
- Required
- true
Suppress Health Test: Heap Dump Directory Free Space
- Description
- Whether to suppress the results of the Heap Dump Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_heap_dump_directory_free_space
- Required
- true
Suppress Health Test: Host Health
- Description
- Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_host_health
- Required
- true
Suppress Health Test: Log Directory Free Space
- Description
- Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_log_directory_free_space
- Required
- true
Suppress Health Test: Cluster Connectivity
- Description
- Whether to suppress the results of the Cluster Connectivity heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_master_connectivity
- Required
- true
Suppress Health Test: Memstore Size
- Description
- Whether to suppress the results of the Memstore Size heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_memstore_size
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_scm_health
- Required
- true
Suppress Health Test: Store File Index Size
- Description
- Whether to suppress the results of the Store File Index Size heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_store_file_idx_size
- Required
- true
Suppress Health Test: Swap Memory Usage
- Description
- Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_unexpected_exits
- Required
- true
Suppress Health Test: Web Server Status
- Description
- Whether to suppress the results of the Web Server Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_region_server_web_metric_collection
- Required
- true
Service-Wide
Advanced
HBase Service Advanced Configuration Snippet (Safety Valve) for atlas-application.properties
- Description
- For advanced use only, a string to be inserted into atlas-application.properties. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
application_properties_safety_valve
- Required
- false
Enable Atlas Hook
- Description
- Enable Atlas Hook to generate Metadata / Lineage information. This Atlas hook is only for the instance of HBase that the Atlas service is using. No other instance of HBase can or should enable this hook.
- Related Name
- Default Value
- false
- API Name
-
hbase_atlas_hook_enable
- Required
- false
HBase Coprocessor Abort on Error
- Description
- Set to true to cause the hosting server (Master or RegionServer) to abort if a coprocessor throws a Throwable object that is not IOException or a subclass of IOException. Setting it to true might be useful in development environments where one wants to terminate the server as soon as possible to simplify coprocessor failure analysis.
- Related Name
-
hbase.coprocessor.abortonerror
- Default Value
- false
- API Name
-
hbase_coprocessor_abort_on_error
- Required
- false
HBase Service Advanced Configuration Snippet (Safety Valve) for core-site.xml
- Description
- For advanced use only, a string to be inserted into core-site.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
hbase_core_site_safety_valve
- Required
- false
Dynamic Jars Directory
- Description
- The directory from which the custom filter, comparator, and exception JARs can be loaded without the need to restart. However, an already loaded class would not be un-loaded. Specify a full hadoop filesystem URL.
- Related Name
-
hbase.dynamic.jars.dir
- Default Value
- API Name
-
hbase_dynamic_jars_dir
- Required
- false
Enable HBase Canary
- Description
- Start a process to periodically check that RegionServer is alive when RegionServer is started. Note: This canary is different from the Cloudera Service Monitoring canary and is provided by the HBase service itself.
- Related Name
- Default Value
- false
- API Name
-
hbase_regionserver_enable_canary
- Required
- false
HBase replication auxiliary info
- Description
- Do not modify this value!
- Related Name
- Default Value
- API Name
-
hbase_replication_auxiliary_info
- Required
- false
HBase replication setup status
- Description
- Do not modify this value!
- Related Name
- Default Value
- API Name
-
hbase_replication_setup_statuses
- Required
- false
HBase Service Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- For advanced use only, a string to be inserted into hbase-site.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
hbase_service_config_safety_valve
- Required
- false
HBase Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- 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.
- Related Name
- Default Value
- API Name
-
hbase_service_env_safety_valve
- Required
- false
Skip Region Reload During Rolling Restart
- Description
- Whether the step to reload regions back onto the original RegionServers should be skipped during rolling restart. This can be used to increase the speed of rolling restart or upgrade operations, but can result in regions being moved multiple times, decreasing performance for clients during rolling restart.
- Related Name
- Default Value
- false
- API Name
-
hbase_skip_reload_during_rr
- Required
- true
HBase Snapshot Service Advanced Configuration Snippet (Safety Valve) for mapred-site.xml
- Description
- For advanced use only, a string to be inserted into mapred-site.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
hbase_snapshot_mapreduce_config_safety_valve
- Required
- false
HBase Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml
- Description
- For advanced use only, a string to be inserted into ssl-server.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
hbase_ssl_server_safety_valve
- Required
- false
Enable dynamic loading of filter, comparator and exception classes
- Description
- Whether to dynamically load certain classes
- Related Name
-
hbase.use.dynamic.jars
- Default Value
- false
- API Name
-
hbase_use_dynamic_jars
- Required
- true
HBase User to Impersonate
- Description
- The user the management services impersonate when connecting to HBase. If no value is specified, the HBase superuser is used.
- Related Name
- Default Value
- API Name
-
hbase_user_to_impersonate
- Required
- false
HBASE Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties
- Description
- For advanced use only, a string to be inserted into the client configuration for navigator.client.properties.
- Related Name
- Default Value
- API Name
-
navigator_client_config_safety_valve
- Required
- false
System Group
- Description
- The group that this service's processes should run as.
- Related Name
- Default Value
- hbase
- API Name
-
process_groupname
- Required
- true
System User
- Description
- The user that this service's processes should run as.
- Related Name
- Default Value
- hbase
- API Name
-
process_username
- Required
- true
HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-audit.xml
- Description
- For advanced use only, a string to be inserted into ranger-hbase-audit.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
ranger_audit_safety_valve
- Required
- false
HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-policymgr-ssl.xml
- Description
- For advanced use only, a string to be inserted into ranger-hbase-policymgr-ssl.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
ranger_policymgr_ssl_safety_valve
- Required
- false
HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-security.xml
- Description
- For advanced use only, a string to be inserted into ranger-hbase-security.xml. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
ranger_security_safety_valve
- Required
- false
Backup
Enable Indexing
- Description
- Allow indexing of tables in HBase by Lily HBase Indexer. Note: Replication must be enabled for indexing to work.
- Related Name
- Default Value
- false
- API Name
-
hbase_enable_indexing
- Required
- false
Enable Replication
- Description
- Allow HBase tables to be replicated.
- Related Name
-
hbase.replication
- Default Value
- false
- API Name
-
hbase_enable_replication
- Required
- false
Replication Batch Size
- Description
- Maximum number of hlog entries to replicate in one go. If this is large, and a consumer takes a while to process the events, the HBase RPC call will time out.
- Related Name
-
replication.source.nb.capacity
- Default Value
- 1000
- API Name
-
hbase_replication_source_nb_capacity
- Required
- false
Replication Source Ratio
- Description
- Ratio of Lily HBase Indexers used by each HBase RegionServer while doing replication.
- Related Name
-
replication.source.ratio
- Default Value
- 1.0
- API Name
-
hbase_replication_source_ratio
- Required
- false
Enable Snapshots
- Description
- Enable snapshots. Disabling snapshots requires deletion of all snapshots before restarting the HBase master; the HBase master will not start if snapshots are disabled and snapshots exist.
- Related Name
-
hbase.snapshot.enabled
- Default Value
- true
- API Name
-
hbase_snapshot_enabled
- Required
- false
HBase Master Snapshot Timeout
- Description
- The maximum amount of time the HBase master waits for a snapshot to complete.
- Related Name
-
hbase.snapshot.master.timeout.millis
- Default Value
- 5 minute(s)
- API Name
-
hbase_snapshot_master_timeout_millis
- Required
- false
HBase RegionServer Snapshot Timeout
- Description
- The maximum amount of time the Hbase RegionServer waits for a snapshot to complete.
- Related Name
-
hbase.snapshot.region.timeout
- Default Value
- 5 minute(s)
- API Name
-
hbase_snapshot_region_timeout
- Required
- false
AWS S3 Access Key ID for Remote Snapshots
- Description
- Access key ID required to access AWS S3 to store remote snapshots.
- Related Name
- Default Value
- API Name
-
hbase_snapshot_s3_access_key_id
- Required
- false
AWS S3 Path for Remote Snapshots
- Description
- AWS S3 path where remote snapshots should be stored.
- Related Name
- Default Value
- API Name
-
hbase_snapshot_s3_path
- Required
- false
Scheduler Pool for Remote Snapshots in AWS S3
- Description
- Name of the scheduler pool to use for MR jobs created during export/import of remote snapshots in AWS S3.
- Related Name
- Default Value
- API Name
-
hbase_snapshot_s3_scheduler_pool
- Required
- false
AWS S3 Secret Access Key for Remote Snapshots
- Description
- AWS secret access key required to access S3 to store remote snapshots.
- Related Name
- Default Value
- API Name
-
hbase_snapshot_s3_secret_access_key
- Required
- false
Cloudera Navigator
Logs
Audit Log Directory
- Description
- Path to the directory where audit logs will be written. The directory will be created if it doesn't exist.
- Related Name
-
audit_event_log_dir
- Default Value
- /var/log/hbase/audit
- API Name
-
audit_event_log_dir
- Required
- false
Maximum Audit Log File Size
- Description
- Maximum size of audit log file in MB before it is rolled over.
- Related Name
-
navigator.audit_log_max_file_size
- Default Value
- 100 MiB
- API Name
-
navigator_audit_log_max_file_size
- Required
- false
Number of Audit Logs to Retain
- Description
- Maximum number of rolled-over audit logs to retain. The logs are not deleted if they contain audit events that have not yet been propagated to the Audit Server.
- Related Name
-
navigator.client.max_num_audit_log
- Default Value
- 10
- API Name
-
navigator_client_max_num_audit_log
- Required
- false
Monitoring
Enable Log Event Capture
- Description
- When set, each role identifies important log events and forwards them to Cloudera Manager.
- Related Name
- Default Value
- true
- API Name
-
catch_events
- Required
- false
Enable Service Level Health Alerts
- Description
- 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
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
HBase Active Master Detection Window
- Description
- The tolerance window that will be used in HBase service tests that depend on detection of the active HBase Master.
- Related Name
- Default Value
- 3 minute(s)
- API Name
-
hbase_active_master_detection_window
- Required
- false
Backup Masters Health Test
- Description
- When computing the overall HBase cluster health, consider the health of the backup HBase Masters.
- Related Name
- Default Value
- true
- API Name
-
hbase_backup_masters_health_enabled
- Required
- false
HBase Canary Unhealthy Region Count Alert Threshold
- Description
- An alert is published if the HBase region health canary detects at least this many unhealthy regions. This setting takes precedence over the hbase_canary_alert_unhealthy_region_percent_threshold config.
- Related Name
- Default Value
- API Name
-
hbase_canary_alert_unhealthy_region_count_threshold
- Required
- false
HBase Canary Unhealthy Region Percentage Alert Threshold
- Description
- An alert is published if the HBase region health canary detects at least this percentage of total regions are unhealthy. This threshold is used if the explicit count is not set via the hbase_canary_alert_unhealthy_region_count_threshold config.
- Related Name
- Default Value
- 0.1
- API Name
-
hbase_canary_alert_unhealthy_region_percent_threshold
- Required
- false
HBase Erasure Code Canary
- Description
- Enables the canary that checks if erasure coding is set for hbase root directory.
- Related Name
- Default Value
- true
- API Name
-
hbase_erasure_code_canary_enabled
- Required
- false
Active Master Health Test
- Description
- When computing the overall HBase cluster health, consider the active HBase Master's health.
- Related Name
- Default Value
- true
- API Name
-
hbase_master_health_enabled
- Required
- false
HBase Region Health Canary
- Description
- Enables the canary that checks HBase region availability by scanning a row from every region.
- Related Name
- Default Value
- true
- API Name
-
hbase_region_health_canary_enabled
- Required
- false
HBase Region Health Canary Exclude Tables
- Description
- Tables to exclude in the HBase Region Health Canary which will scan a row from every region.
- Related Name
- Default Value
- API Name
-
hbase_region_health_canary_exclude_tables
- Required
- false
HBase Region Health Canary Slow Run Alert Enabled
- Description
- An alert is published if the HBase region health canary runs slowly.
- Related Name
- Default Value
- true
- API Name
-
hbase_region_health_canary_slow_run_alert_enabled
- Required
- false
Healthy RegionServer Monitoring Thresholds
- Description
- The health test thresholds of the overall RegionServer health. The check returns "Concerning" health if the percentage of "Healthy" RegionServers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" RegionServers falls below the critical threshold.
- Related Name
- Default Value
- Warning: 95.0 %, Critical: 90.0 %
- API Name
-
hbase_regionservers_healthy_thresholds
- Required
- false
Log Event Retry Frequency
- Description
- The frequency in which the log4j event publication appender will retry sending undelivered log events to the Event server, in seconds
- Related Name
- Default Value
- 30
- API Name
-
log_event_retry_frequency
- Required
- false
Service Triggers
- Description
- 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 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 causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
service_triggers
- Required
- true
Service Monitor Client Config Overrides
- Description
- For advanced use only, a list of configuration properties that will be used by the Service Monitor instead of the current client configuration for the service.
- Related Name
- Default Value
- <property> <name>zookeeper.recovery.retry</name> <value>0</value> </property> <property> <name>zookeeper.recovery.retry.intervalmill</name> <value>3000</value> </property> <property> <name>hbase.zookeeper.recoverable.waittime</name> <value>1000</value> </property> <property> <name>zookeeper.session.timeout</name> <value>30000</value> </property> <property> <name>hbase.rpc.timeout</name> <value>10000</value> </property> <property> <name>hbase.client.retries.number</name> <value>1</value> </property> <property> <name>hbase.client.rpc.maxattempts</name> <value>1</value> </property> <property> <name>hbase.client.operation.timeout</name> <value>10000</value> </property>
- API Name
-
smon_client_config_overrides
- Required
- false
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
- Related Name
- Default Value
- API Name
-
smon_derived_configs_safety_valve
- Required
- false
Other
Atlas Service
- Description
- Name of the Atlas service that this Hbase service instance depends on
- Related Name
- Default Value
- API Name
-
atlas_service
- Required
- false
Generate HADOOP_CREDSTORE_PASSWORD
- Description
- Flag to enable or disable the generation of HADOOP_CREDSTORE_PASSWORD.
- Related Name
-
generate_jceks_password
- Default Value
- true
- API Name
-
generate_jceks_password
- Required
- false
Maximum Size of HBase Client KeyValue
- Description
- Specifies the combined maximum allowed size of a KeyValue instance. This option configures an upper boundary for a single entry saved in a storage file. This option prevents a region from splitting if the data is too large. Set this option to a fraction of the maximum region size. To disable this check, use a value of zero or less.
- Related Name
-
hbase.client.keyvalue.maxsize
- Default Value
- 10 MiB
- API Name
-
hbase_client_keyvalue_maxsize
- Required
- false
HBase Client Pause
- Description
- A general client pause time value. Used mostly as a time period to wait before retrying operations such as a failed get or region lookup.
- Related Name
-
hbase.client.pause
- Default Value
- 100 millisecond(s)
- API Name
-
hbase_client_pause
- Required
- false
Maximum HBase Client Retries
- Description
- Maximum number of client retries. Used as a maximum for all operations such as fetching of the root region from the root RegionServer, getting a cell's value, and starting a row update.
- Related Name
-
hbase.client.retries.number
- Default Value
- 10
- API Name
-
hbase_client_retries_number
- Required
- false
HBase Client Scanner Caching
- Description
- Number of rows to fetch when calling next on a scanner if it is not served from memory. Higher caching values enable faster scanners but require more memory and some calls of next may take longer when the cache is empty.
- Related Name
-
hbase.client.scanner.caching
- Default Value
- 100
- API Name
-
hbase_client_scanner_caching
- Required
- false
HBase Client Write Buffer
- Description
- Write buffer size in bytes. A larger buffer requires more memory on both the client and the server because the server instantiates the passed write buffer to process it but reduces the number of remote procedure calls (RPC). To estimate the amount of server memory used, multiply the value of 'hbase.client.write.buffer' by the value of 'hbase.regionserver.handler.count'.
- Related Name
-
hbase.client.write.buffer
- Default Value
- 2 MiB
- API Name
-
hbase_client_write_buffer
- Required
- false
Graceful Shutdown Timeout
- Description
- Timeout for graceful shutdown of this HBase service. Once this timeout is reached, any remaining running roles are abruptly shutdown. A value of 0 means no timeout.
- Related Name
- Default Value
- 3 minute(s)
- API Name
-
hbase_graceful_stop_timeout
- Required
- true
HBoss Maximum Number of S3 Connections
- Description
- Controls the maximum number of simultaneous connections to S3 from HBoss.
- Related Name
-
fs.s3a.connection.maximum
- Default Value
- 300
- API Name
-
hbase_hboss_fs_s3a_connection_maximum
- Required
- false
HBoss S3A Implementation Class
- Description
- The implementation to use (HBoss) for S3A FileSystem access.
- Related Name
-
fs.s3a.impl
- Default Value
- org.apache.hadoop.hbase.oss.HBaseObjectStoreSemantics
- API Name
-
hbase_hboss_fs_s3a_impl
- Required
- false
HBoss Maximum Number of Concurrent S3 Uploads
- Description
- Maximum number of concurrent active (part)uploads, which each use a thread from the threadpool.
- Related Name
-
fs.s3a.threads.max
- Default Value
- 200
- API Name
-
hbase_hboss_fs_s3a_threads_max
- Required
- false
HBoss Lock Implementation
- Description
- The HBoss implementation to use for distributing locking on top of S3A.
- Related Name
-
fs.hboss.sync.impl
- Default Value
- org.apache.hadoop.hbase.oss.sync.ZKTreeLockManager
- API Name
-
hbase_hboss_fs_sync_impl
- Required
- false
HBoss Wrapped S3A Implementation Class
- Description
- The implementation which HBoss should instantiate for S3A FileSystem access.
- Related Name
-
fs.hboss.fs.s3a.impl
- Default Value
- org.apache.hadoop.fs.s3a.S3AFileSystem
- API Name
-
hbase_hboss_wrapped_fs_s3a_impl
- Required
- false
Enable HBase REST Server Proxy Users
- Description
- Use this to allow proxy users on HBase REST server, which is mainly needed for "doAs" functionality.
- Related Name
-
hbase.rest.support.proxyuser
- Default Value
- false
- API Name
-
hbase_restserver_support_proxyuser
- Required
- false
RPC Timeout
- Description
- Timeout for all HBase RPCs in milliseconds.
- Related Name
-
hbase.rpc.timeout
- Default Value
- 1 minute(s)
- API Name
-
hbase_rpc_timeout
- Required
- false
HBase Server Thread Wake Frequency
- Description
- Period of time, in milliseconds, to pause between searches for work. Used as a sleep interval by service threads such as a META scanner and log roller.
- Related Name
-
hbase.server.thread.wakefrequency
- Default Value
- 10 second(s)
- API Name
-
hbase_server_thread_wakefrequency
- Required
- false
HBase Superusers
- Description
- List of users or groups, who are allowed full privileges, regardless of stored ACLs, across the cluster. Only used when HBase security is enabled.
- Related Name
-
hbase.superuser
- Default Value
- API Name
-
hbase_superuser
- Required
- false
Enable HBase Thrift Http Server
- Description
- Use this to enable Http server usage on thrift, which is mainly needed for "doAs" functionality.
- Related Name
-
hbase.regionserver.thrift.http
- Default Value
- false
- API Name
-
hbase_thriftserver_http
- Required
- false
Enable HBase Thrift Proxy Users
- Description
- Use this to allow proxy users on thrift gateway, which is mainly needed for "doAs" functionality.
- Related Name
-
hbase.thrift.support.proxyuser
- Default Value
- false
- API Name
-
hbase_thriftserver_support_proxyuser
- Required
- false
HDFS WAL Directory
- Description
- The HDFS directory used for the WAL, shared by HBase RegionServers.
- Related Name
-
hbase.wal.dir
- Default Value
- API Name
-
hbase_wal_dir
- Required
- false
HDFS Root Directory
- Description
- The HDFS directory shared by HBase RegionServers.
- Related Name
-
hbase.rootdir
- Default Value
- /hbase
- API Name
-
hdfs_rootdir
- Required
- true
HDFS Service
- Description
- Name of the HDFS service that this HBase service instance depends on
- Related Name
- Default Value
- API Name
-
hdfs_service
- Required
- true
Ranger Service Name
- Description
- Name of the Ranger service/repository where service related data will be stored
- Related Name
-
ranger.plugin.hbase.service.name
- Default Value
- GENERATED_RANGER_SERVICE_NAME
- API Name
-
ranger_plugin_service_name
- Required
- false
Ranger Plugin Trusted Proxy IP Address
- Description
- Accepts a list of IP addresses of proxy servers for trusting.
- Related Name
-
ranger.plugin.hbase.trusted.proxy.ipaddress
- Default Value
- API Name
-
ranger_plugin_trusted_proxy_ipaddress
- Required
- false
Ranger Plugin Use X-Forwarded for IP Address
- Description
- The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
- Related Name
-
ranger.plugin.hbase.use.x-forwarded-for.ipaddress
- Default Value
- false
- API Name
-
ranger_plugin_use_x_forwarded_for_ipaddress
- Required
- false
Ranger Service
- Description
- Name of the Ranger service that this Hbase service instance depends on
- Related Name
- Default Value
- API Name
-
ranger_service
- Required
- false
ZooKeeper Connection Retry Pause Duration
- Description
- Period of time, in milliseconds, to pause between connection retries to ZooKeeper. Used together with ${zookeeper.retries} in an exponential backoff fashion when making queries to ZooKeeper.
- Related Name
-
zookeeper.pause
- Default Value
- API Name
-
zookeeper_pause
- Required
- false
ZooKeeper Connection Retries
- Description
- The number of times to retry connections to ZooKeeper. Used for reading and writing root region location. Used together with ${zookeeper.pause} in an exponential backoff fashion when making queries to ZooKeeper.
- Related Name
-
zookeeper.retries
- Default Value
- API Name
-
zookeeper_retries
- Required
- false
ZooKeeper Service
- Description
- Name of the ZooKeeper service that this HBase service instance depends on.
- Related Name
- Default Value
- API Name
-
zookeeper_service
- Required
- true
ZooKeeper Session Timeout
- Description
- ZooKeeper session timeout in milliseconds. HBase passes this to the ZooKeeper quorum as the suggested maximum time for a session. See http://hadoop.apache.org/zookeeper/docs/current/zookeeperProgrammers.html#ch_zkSessions The client sends a requested timeout, the server responds with the timeout that it can give the client.
- Related Name
-
zookeeper.session.timeout
- Default Value
- 60000
- API Name
-
zookeeper_session_timeout
- Required
- false
ZooKeeper Znode Parent
- Description
- The root znode for HBase in ZooKeeper. All of HBase's ZooKeeper files that are configured with a relative path will go under this node. By default, all of HBase's ZooKeeper file paths are configured with a relative path, so they will all go under this directory unless changed.
- Related Name
-
zookeeper.znode.parent
- Default Value
- /hbase
- API Name
-
zookeeper_znode_parent
- Required
- true
ZooKeeper Znode Rootserver
- Description
- Path to ZooKeeper Node holding root region location. This is written by the HBase Master and read by clients and RegionServers. If a relative path is given, the parent folder will be ${zookeeper.znode.parent}. By default, the root location is stored at /hbase/root-region-server.
- Related Name
-
zookeeper.znode.rootserver
- Default Value
- root-region-server
- API Name
-
zookeeper_znode_rootserver
- Required
- true
Performance
Enable HDFS Short-Circuit Read
- Description
- Enable HDFS short-circuit read. This allows a client colocated with the DataNode to read HDFS file blocks directly. This gives a performance boost to distributed clients that are aware of locality.
- Related Name
-
dfs.client.read.shortcircuit
- Default Value
- true
- API Name
-
dfs_client_read_shortcircuit
- Required
- false
HDFS Hedged Read Threadpool Size
- Description
- Size of the threadpool used for hedged reads in hdfs clients. If a read from a block is slow, a parallel 'hedged' read will be started against a different block replica. The first one to return with a result is used while the other one is cancelled. This 'hedged' read feature helps rein in the outliers. A value of zero disables the feature.
- Related Name
-
dfs.client.hedged.read.threadpool.size
- Default Value
- 0
- API Name
-
hbase_server_dfs_client_hedged_read_threadpool_size
- Required
- false
HDFS Hedged Read Delay Threshold
- Description
- Duration to wait before starting up a 'hedged' read.
- Related Name
-
dfs.client.hedged.read.threshold.millis
- Default Value
- 500 millisecond(s)
- API Name
-
hbase_server_dfs_client_hedged_read_threshold_millis
- Required
- false
SplitLog Manager Timeout
- Description
- Timeout (in ms) for the distributed log splitting manager to receive response from a worker.
- Related Name
-
hbase.splitlog.manager.timeout
- Default Value
- 2 minute(s)
- API Name
-
hbase_service_splitlog_manager_timeout
- Required
- false
Proxy
HBase Proxy User Groups
- Description
- Comma-delimited list of groups that you want to allow the HBase user to impersonate. The default '*' allows all groups. To disable entirely, use a string that does not correspond to a group name, such as '_no_group_'. Note: This property is used only if HBase REST/Thrift Server Authentication is enabled.
- Related Name
-
hadoop.proxyuser.hbase.groups
- Default Value
- *
- API Name
-
hbase_proxy_user_groups_list
- Required
- false
HBase Proxy User Hosts
- Description
- Comma-delimited list of hosts where you want to allow the HBase user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that does not correspond to a host name, such as '_no_host'. Note: This property is used only if HBase REST/Thrift Server Authentication is enabled.
- Related Name
-
hadoop.proxyuser.hbase.hosts
- Default Value
- *
- API Name
-
hbase_proxy_user_hosts_list
- Required
- false
Security
HBase Cell-Level ACLs
- Description
- Enable HBase cell-level ACLs.
- Related Name
-
hbase.security.access.early_out
- Default Value
- false
- API Name
-
hbase_cell_acl_authorization
- Required
- false
Web UI TLS/SSL Encryption Enabled
- Description
- Enable TLS/SSL encryption for HBase web UIs.
- Related Name
-
hbase.ssl.enabled
- Default Value
- false
- API Name
-
hbase_hadoop_ssl_enabled
- Required
- false
HBase REST Authentication
- Description
- If this is set to "kerberos", HBase REST Server will authenticate its clients. HBase Proxy User Hosts and Groups should be configured to allow specific users to access HBase through REST Server.
- Related Name
-
hbase.rest.authentication.type
- Default Value
- simple
- API Name
-
hbase_restserver_security_authentication
- Required
- false
HBase Row-Level Authorization
- Description
- Enable HBase row-level authorization.
- Related Name
-
hbase.row.level.authorization
- Default Value
- false
- API Name
-
hbase_row_level_authorization
- Required
- false
HBase Transport Security
- Description
- Configure the type of encrypted communication to be used with RPC.
- Related Name
-
hbase.rpc.protection
- Default Value
- authentication
- API Name
-
hbase_rpc_protection
- Required
- false
HBase Secure RPC Engine
- Description
- Set to true to use HBase Secure RPC Engine for remote procedure calls (RPC). This is only effective in simple authentication mode. Does not provide authentication for RPC calls, but provides user information in the audit logs. Changing this setting requires a restart of this and all dependent services and redeployment of client configurations, along with a restart of the Service Monitor management role.
- Related Name
-
hbase.secure.rpc.engine
- Default Value
- false
- API Name
-
hbase_secure_rpc_engine
- Required
- false
HBase Secure Authentication
- Description
- Choose the authentication mechanism used by HBase.
- Related Name
-
hbase.security.authentication
- Default Value
- simple
- API Name
-
hbase_security_authentication
- Required
- false
HBase Secure Authorization
- Description
- Enable HBase authorization.
- Related Name
-
hbase.security.authorization
- Default Value
- false
- API Name
-
hbase_security_authorization
- Required
- false
HBase Thrift Authentication
- Description
- If this is set, HBase Thrift Server authenticates its clients. HBase Proxy User Hosts and Groups should be configured to allow specific users to access HBase through Thrift Server.
- Related Name
-
hbase.thrift.security.qop
- Default Value
- none
- API Name
-
hbase_thriftserver_security_authentication
- Required
- true
Kerberos Principal
- Description
- Kerberos principal short name used by all roles of this service.
- Related Name
- Default Value
- hbase
- API Name
-
kerberos_princ_name
- Required
- true
Ranger DFS Audit Path
- Description
- The DFS path on which Ranger audits are written. The special placeholder '${ranger_base_audit_url}' should be used as the prefix, in order to use the centralized location defined in the Ranger service.
- Related Name
-
xasecure.audit.destination.hdfs.dir
- Default Value
- $ranger_base_audit_url/hbase
- API Name
-
ranger_audit_hdfs_dir
- Required
- false
Ranger Audit DFS Spool Dir
- Description
- Spool directory for Ranger audits being written to DFS.
- Related Name
-
xasecure.audit.destination.hdfs.batch.filespool.dir
- Default Value
- /var/log/hbase/audit/hdfs/spool
- API Name
-
ranger_audit_hdfs_spool_dir
- Required
- false
Ranger Audit Solr Spool Dir
- Description
- Spool directory for Ranger audits being written to Solr.
- Related Name
-
xasecure.audit.destination.solr.batch.filespool.dir
- Default Value
- /var/log/hbase/audit/solr/spool
- API Name
-
ranger_audit_solr_spool_dir
- Required
- false
Ranger Policy Cache Directory
- Description
- The directory where Ranger security policies are cached locally.
- Related Name
-
ranger.plugin.hbase.policy.cache.dir
- Default Value
- /var/lib/ranger/hbase/policy-cache
- API Name
-
ranger_policy_cache_dir
- Required
- false
HBase TLS/SSL Server Keystore Key Password
- Description
- The password that protects the private key contained in the keystore used when HBase is acting as a TLS/SSL server.
- Related Name
-
ssl.server.keystore.keypassword
- Default Value
- API Name
-
ssl_server_keystore_keypassword
- Required
- false
HBase TLS/SSL Server Keystore File Location
- Description
- The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HBase is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
- Related Name
-
ssl.server.keystore.location
- Default Value
- API Name
-
ssl_server_keystore_location
- Required
- false
HBase TLS/SSL Server Keystore File Password
- Description
- The password for the HBase keystore file.
- Related Name
-
ssl.server.keystore.password
- Default Value
- API Name
-
ssl_server_keystore_password
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Configuration Validator: Deploy Directory
- Description
- Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_client_config_root_dir
- Required
- true
Suppress Configuration Validator: HBase Client Scanner Timeout exceeds Lease Period Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Client Scanner Timeout exceeds Lease Period Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_client_server_scanner_rpc_timeout_validator
- Required
- true
Suppress Configuration Validator: Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Hadoop Metrics2 Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_metrics2_safety_valve
- Required
- true
Suppress Configuration Validator: BucketCache IOEngine
- Description
- Whether to suppress configuration warnings produced by the BucketCache IOEngine configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_bucketcache_ioengine
- Required
- true
Suppress Configuration Validator: HBase Client Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the HBase Client Advanced Configuration Snippet (Safety Valve) for hbase-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_config_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Client Environment Advanced Configuration Snippet (Safety Valve) for hbase-env.sh
- Description
- Whether to suppress configuration warnings produced by the HBase Client Environment Advanced Configuration Snippet (Safety Valve) for hbase-env.sh configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_env_safety_valve
- Required
- true
Suppress Configuration Validator: Client Java Configuration Options
- Description
- Whether to suppress configuration warnings produced by the Client Java Configuration Options configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_client_java_opts
- Required
- true
Suppress Configuration Validator: HBase Coprocessor Master Classes
- Description
- Whether to suppress configuration warnings produced by the HBase Coprocessor Master Classes configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_coprocessor_master_classes
- Required
- true
Suppress Configuration Validator: HBase Coprocessor Region Classes
- Description
- Whether to suppress configuration warnings produced by the HBase Coprocessor Region Classes configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_coprocessor_region_classes
- Required
- true
Suppress Configuration Validator: HBase HRegion Major Compaction
- Description
- Whether to suppress configuration warnings produced by the HBase HRegion Major Compaction configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_hregion_majorcompaction
- Required
- true
Suppress Configuration Validator: HBase Kerberos Secure Thrift Server Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Kerberos Secure Thrift Server Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_kerberos_secure_thrift_validator
- Required
- true
Suppress Configuration Validator: Master Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the Master Advanced Configuration Snippet (Safety Valve) for hbase-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_config_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Master DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the HBase Master DNS Network Interface configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_dns_interface
- Required
- true
Suppress Configuration Validator: HBase Master DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the HBase Master DNS Name Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_dns_nameserver
- Required
- true
Suppress Configuration Validator: HBase Master Web UI Address
- Description
- Whether to suppress configuration warnings produced by the HBase Master Web UI Address configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_info_bindaddress
- Required
- true
Suppress Configuration Validator: HBase Master Web UI Port
- Description
- Whether to suppress configuration warnings produced by the HBase Master Web UI Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_info_port
- Required
- true
Suppress Configuration Validator: Java Configuration Options for HBase Master
- Description
- Whether to suppress configuration warnings produced by the Java Configuration Options for HBase Master configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_java_opts
- Required
- true
Suppress Configuration Validator: Master Log Directory
- Description
- Whether to suppress configuration warnings produced by the Master Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_log_dir
- Required
- true
Suppress Configuration Validator: HBase Master Log Cleaner Plugins
- Description
- Whether to suppress configuration warnings produced by the HBase Master Log Cleaner Plugins configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_logcleaner_plugins
- Required
- true
Suppress Configuration Validator: HBase Master Port
- Description
- Whether to suppress configuration warnings produced by the HBase Master Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_master_port
- Required
- true
Suppress Configuration Validator: HBase RegionServer Interface Class
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Interface Class configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_class
- Required
- true
Suppress Configuration Validator: RegionServer Codecs
- Description
- Whether to suppress configuration warnings produced by the RegionServer Codecs configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_codecs
- Required
- true
Suppress Configuration Validator: RegionServer Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the RegionServer Advanced Configuration Snippet (Safety Valve) for hbase-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_config_safety_valve
- Required
- true
Suppress Configuration Validator: RegionServer DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the RegionServer DNS Network Interface configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_dns_interface
- Required
- true
Suppress Configuration Validator: RegionServer DNS Nameserver
- Description
- Whether to suppress configuration warnings produced by the RegionServer DNS Nameserver configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_dns_nameserver
- Required
- true
Suppress Configuration Validator: HBase Region Server Memstore Lower Limit Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Region Server Memstore Lower Limit Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_global_memstore_lowerlimit_validator
- Required
- true
Suppress Configuration Validator: HLog Reader Implementation
- Description
- Whether to suppress configuration warnings produced by the HLog Reader Implementation configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_hlog_reader_impl
- Required
- true
Suppress Configuration Validator: HLog Writer Implementation
- Description
- Whether to suppress configuration warnings produced by the HLog Writer Implementation configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_hlog_writer_impl
- Required
- true
Suppress Configuration Validator: HBase RegionServer Web UI Address
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Web UI Address configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_info_bindaddress
- Required
- true
Suppress Configuration Validator: HBase RegionServer Web UI port
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Web UI port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_info_port
- Required
- true
Suppress Configuration Validator: Java Heap Size of HBase RegionServer in Bytes
- Description
- Whether to suppress configuration warnings produced by the Java Heap Size of HBase RegionServer in Bytes configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_java_heapsize
- Required
- true
Suppress Configuration Validator: Java Configuration Options for HBase RegionServer
- Description
- Whether to suppress configuration warnings produced by the Java Configuration Options for HBase RegionServer configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_java_opts
- Required
- true
Suppress Configuration Validator: RegionServer Log Directory
- Description
- Whether to suppress configuration warnings produced by the RegionServer Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_log_dir
- Required
- true
Suppress Configuration Validator: HBase RegionServer Multiple HDFS WAL with Replication Validator
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Multiple HDFS WAL with Replication Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_multiwal_replication_validator
- Required
- true
Suppress Configuration Validator: HBase RegionServer Port
- Description
- Whether to suppress configuration warnings produced by the HBase RegionServer Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_port
- Required
- true
Suppress Configuration Validator: Write-Ahead Log (WAL) Codec Class
- Description
- Whether to suppress configuration warnings produced by the Write-Ahead Log (WAL) Codec Class configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_regionserver_wal_codec
- Required
- true
Suppress Configuration Validator: HBase REST Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_config_safety_valve
- Required
- true
Suppress Configuration Validator: HBase REST Server DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server DNS Network Interface configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_dns_interface
- Required
- true
Suppress Configuration Validator: HBase REST Server DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server DNS Name Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_dns_nameserver
- Required
- true
Suppress Configuration Validator: HBase REST Server Host Address
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Host Address configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_host
- Required
- true
Suppress Configuration Validator: HBase REST Server Web UI Port
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Web UI Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_info_port
- Required
- true
Suppress Configuration Validator: Java Configuration Options for HBase REST Server
- Description
- Whether to suppress configuration warnings produced by the Java Configuration Options for HBase REST Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_java_opts
- Required
- true
Suppress Configuration Validator: HBase REST Server TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server TLS/SSL Server Keystore File Location configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_file
- Required
- true
Suppress Configuration Validator: HBase REST Server TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server TLS/SSL Server Keystore Key Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_keypassword
- Required
- true
Suppress Configuration Validator: HBase REST Server TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server TLS/SSL Server Keystore File Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_keystore_password
- Required
- true
Suppress Configuration Validator: HBase REST Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_log_dir
- Required
- true
Suppress Configuration Validator: HBase REST Server Port
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_restserver_port
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Bind Address
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Bind Address configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_bindaddress
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Advanced Configuration Snippet (Safety Valve) for hbase-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_config_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Thrift Server DNS Network Interface
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server DNS Network Interface configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_dns_interface
- Required
- true
Suppress Configuration Validator: HBase Thrift Server DNS Name Server
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server DNS Name Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_dns_nameserver
- Required
- true
Suppress Configuration Validator: HBase Thrift Server over HTTP TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server over HTTP TLS/SSL Server Keystore File Location configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_file
- Required
- true
Suppress Configuration Validator: HBase Thrift Server over HTTP TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server over HTTP TLS/SSL Server Keystore Key Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_keypassword
- Required
- true
Suppress Configuration Validator: HBase Thrift Server over HTTP TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server over HTTP TLS/SSL Server Keystore File Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_http_keystore_password
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Web UI Port
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Web UI Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_info_port
- Required
- true
Suppress Configuration Validator: Java Configuration Options for HBase Thrift Server
- Description
- Whether to suppress configuration warnings produced by the Java Configuration Options for HBase Thrift Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_java_opts
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Log Directory
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_log_dir
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Port
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbase_thriftserver_port
- Required
- true
Suppress Configuration Validator: HBase REST Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbaserestserver_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hbasethriftserver_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: Master Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Master Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Configuration Validator: Rules to Extract Events from Log Files
- Description
- Whether to suppress configuration warnings produced by the Rules to Extract Events from Log Files configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_event_whitelist
- Required
- true
Suppress Configuration Validator: Master Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Master Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Master TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the HBase Master TLS/SSL Trust Store File configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_truststore_file
- Required
- true
Suppress Configuration Validator: HBase Master TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the HBase Master TLS/SSL Trust Store Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_master_truststore_password
- Required
- true
Suppress Configuration Validator: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Configuration Validator: RegionServer File Descriptor Limit Validator
- Description
- Whether to suppress configuration warnings produced by the RegionServer File Descriptor Limit Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_fd_limit_validator
- Required
- true
Suppress Configuration Validator: RegionServer Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the RegionServer Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: HBase Region Server TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the HBase Region Server TLS/SSL Trust Store File configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_truststore_file
- Required
- true
Suppress Configuration Validator: HBase Region Server TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the HBase Region Server TLS/SSL Trust Store Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_regionserver_truststore_password
- Required
- true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Configuration Validator: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Configuration Validator: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for atlas-application.properties
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for atlas-application.properties parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_application_properties_safety_valve
- Required
- true
Suppress Parameter Validation: Audit Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Audit Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_audit_event_log_dir
- Required
- true
Suppress Configuration Validator: Gateway Count Validator
- Description
- Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_gateway_count_validator
- Required
- true
Suppress Configuration Validator: Secure Web UI Validator
- Description
- Whether to suppress configuration warnings produced by the Secure Web UI Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hadoop_secure_web_ui
- Required
- true
Suppress Configuration Validator: HBase Authentication And Authorization Validation
- Description
- Whether to suppress configuration warnings produced by the HBase Authentication And Authorization Validation configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_authentication_and_authorization_validator
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for core-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_core_site_safety_valve
- Required
- true
Suppress Parameter Validation: Dynamic Jars Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Dynamic Jars Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_dynamic_jars_dir
- Required
- true
Suppress Parameter Validation: HBoss S3A Implementation Class
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBoss S3A Implementation Class parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_hboss_fs_s3a_impl
- Required
- true
Suppress Parameter Validation: HBoss Lock Implementation
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBoss Lock Implementation parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_hboss_fs_sync_impl
- Required
- true
Suppress Parameter Validation: HBoss Wrapped S3A Implementation Class
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBoss Wrapped S3A Implementation Class parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_hboss_wrapped_fs_s3a_impl
- Required
- true
Suppress Parameter Validation: HBase Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_proxy_user_groups_list
- Required
- true
Suppress Parameter Validation: HBase Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_proxy_user_hosts_list
- Required
- true
Suppress Parameter Validation: HBase Region Health Canary Exclude Tables
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Region Health Canary Exclude Tables parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_region_health_canary_exclude_tables
- Required
- true
Suppress Parameter Validation: HBase replication auxiliary info
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase replication auxiliary info parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_replication_auxiliary_info
- Required
- true
Suppress Parameter Validation: HBase replication setup status
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase replication setup status parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_replication_setup_statuses
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for hbase-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for hbase-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_service_config_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_service_env_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Snapshot Service Advanced Configuration Snippet (Safety Valve) for mapred-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Snapshot Service Advanced Configuration Snippet (Safety Valve) for mapred-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_snapshot_mapreduce_config_safety_valve
- Required
- true
Suppress Parameter Validation: AWS S3 Access Key ID for Remote Snapshots
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the AWS S3 Access Key ID for Remote Snapshots parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_snapshot_s3_access_key_id
- Required
- true
Suppress Parameter Validation: AWS S3 Path for Remote Snapshots
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the AWS S3 Path for Remote Snapshots parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_snapshot_s3_path
- Required
- true
Suppress Parameter Validation: Scheduler Pool for Remote Snapshots in AWS S3
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Scheduler Pool for Remote Snapshots in AWS S3 parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_snapshot_s3_scheduler_pool
- Required
- true
Suppress Parameter Validation: AWS S3 Secret Access Key for Remote Snapshots
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the AWS S3 Secret Access Key for Remote Snapshots parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_snapshot_s3_secret_access_key
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for ssl-server.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_ssl_server_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Superusers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Superusers parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_superuser
- Required
- true
Suppress Configuration Validator: Phoenix HBase Dynamic Jars Validator
- Description
- Whether to suppress configuration warnings produced by the Phoenix HBase Dynamic Jars Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_use_dynamic_jars_validator
- Required
- true
Suppress Parameter Validation: HBase User to Impersonate
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase User to Impersonate parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_user_to_impersonate
- Required
- true
Suppress Parameter Validation: HDFS WAL Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS WAL Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbase_wal_dir
- Required
- true
Suppress Configuration Validator: HBase REST Server Count Validator
- Description
- Whether to suppress configuration warnings produced by the HBase REST Server Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbaserestserver_count_validator
- Required
- true
Suppress Configuration Validator: HBase Thrift Server Count Validator
- Description
- Whether to suppress configuration warnings produced by the HBase Thrift Server Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hbasethriftserver_count_validator
- Required
- true
Suppress Parameter Validation: HDFS Root Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Root Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hdfs_rootdir
- Required
- true
Suppress Parameter Validation: Kerberos Principal
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_kerberos_princ_name
- Required
- true
Suppress Configuration Validator: Master Count Validator
- Description
- Whether to suppress configuration warnings produced by the Master Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_master_count_validator
- Required
- true
Suppress Parameter Validation: Audit Event Filter
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Audit Event Filter parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_navigator_audit_event_filter
- Required
- true
Suppress Parameter Validation: HBASE Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBASE Client Advanced Configuration Snippet (Safety Valve) for navigator.client.properties parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_navigator_client_config_safety_valve
- Required
- true
Suppress Parameter Validation: Audit Event Tracker
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Audit Event Tracker parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_navigator_event_tracker
- Required
- true
Suppress Parameter Validation: System Group
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_groupname
- Required
- true
Suppress Parameter Validation: System User
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_username
- Required
- true
Suppress Parameter Validation: Ranger DFS Audit Path
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger DFS Audit Path parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_audit_hdfs_dir
- Required
- true
Suppress Parameter Validation: Ranger Audit DFS Spool Dir
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit DFS Spool Dir parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_audit_hdfs_spool_dir
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-audit.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-audit.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_audit_safety_valve
- Required
- true
Suppress Parameter Validation: Ranger Audit Solr Spool Dir
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit Solr Spool Dir parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_audit_solr_spool_dir
- Required
- true
Suppress Parameter Validation: Ranger Service Name
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Service Name parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_plugin_service_name
- Required
- true
Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_plugin_trusted_proxy_ipaddress
- Required
- true
Suppress Parameter Validation: Ranger Policy Cache Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Policy Cache Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_policy_cache_dir
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-policymgr-ssl.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-policymgr-ssl.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_policymgr_ssl_safety_valve
- Required
- true
Suppress Parameter Validation: HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-security.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase Service Advanced Configuration Snippet (Safety Valve) for ranger-hbase-security.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ranger_security_safety_valve
- Required
- true
Suppress Configuration Validator: RegionServer Count Validator
- Description
- Whether to suppress configuration warnings produced by the RegionServer Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_regionserver_count_validator
- Required
- true
Suppress Parameter Validation: Service Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_service_triggers
- Required
- true
Suppress Configuration Validator: Short-Circuit Read Enabled Validator
- Description
- Whether to suppress configuration warnings produced by the Short-Circuit Read Enabled Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_short_circuit_read_validator
- Required
- true
Suppress Parameter Validation: Service Monitor Client Config Overrides
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Client Config Overrides parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_smon_client_config_overrides
- Required
- true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_smon_derived_configs_safety_valve
- Required
- true
Suppress Parameter Validation: HBase TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase TLS/SSL Server Keystore Key Password parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ssl_server_keystore_keypassword
- Required
- true
Suppress Parameter Validation: HBase TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase TLS/SSL Server Keystore File Location parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ssl_server_keystore_location
- Required
- true
Suppress Parameter Validation: HBase TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HBase TLS/SSL Server Keystore File Password parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_ssl_server_keystore_password
- Required
- true
Suppress Configuration Validator: ZooKeeper Max Session Timeout Validator
- Description
- Whether to suppress configuration warnings produced by the ZooKeeper Max Session Timeout Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_zookeeper_max_session_timeout_validator
- Required
- true
Suppress Parameter Validation: ZooKeeper Znode Parent
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Znode Parent parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_zookeeper_znode_parent
- Required
- true
Suppress Parameter Validation: ZooKeeper Znode Rootserver
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Znode Rootserver parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_zookeeper_znode_rootserver
- Required
- true
Suppress Health Test: HBase Master Health
- Description
- Whether to suppress the results of the HBase Master Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
service_health_suppression_hbase_master_health
- Required
- true
Suppress Health Test: RegionServer Health
- Description
- Whether to suppress the results of the RegionServer Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
service_health_suppression_hbase_region_servers_healthy
- Required
- true